| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117 |
- <?php
- // File generated from our OpenAPI spec
- namespace Stripe\Issuing;
- /**
- * A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
- *
- * @property string $id Unique identifier for the object.
- * @property string $object String representing the object's type. Objects of the same type share the same value.
- * @property null|string|\Stripe\File $card_logo The file for the card logo to use with physical bundles that support card logos. Must have a <code>purpose</code> value of <code>issuing_logo</code>.
- * @property null|\Stripe\StripeObject $carrier_text Hash containing carrier text, for use with physical bundles that support carrier text.
- * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
- * @property bool $livemode Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.
- * @property null|string $lookup_key A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
- * @property \Stripe\StripeObject $metadata Set of <a href="https://stripe.com/docs/api/metadata">key-value pairs</a> that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
- * @property null|string $name Friendly display name.
- * @property string|\Stripe\Issuing\PhysicalBundle $physical_bundle The physical bundle object belonging to this personalization design.
- * @property \Stripe\StripeObject $preferences
- * @property \Stripe\StripeObject $rejection_reasons
- * @property string $status Whether this personalization design can be used to create cards.
- */
- class PersonalizationDesign extends \Stripe\ApiResource
- {
- const OBJECT_NAME = 'issuing.personalization_design';
- use \Stripe\ApiOperations\Update;
- const STATUS_ACTIVE = 'active';
- const STATUS_INACTIVE = 'inactive';
- const STATUS_REJECTED = 'rejected';
- const STATUS_REVIEW = 'review';
- /**
- * Creates a personalization design object.
- *
- * @param null|array $params
- * @param null|array|string $options
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Issuing\PersonalizationDesign the created resource
- */
- public static function create($params = null, $options = null)
- {
- self::_validateParams($params);
- $url = static::classUrl();
- list($response, $opts) = static::_staticRequest('post', $url, $params, $options);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
- $obj->setLastResponse($response);
- return $obj;
- }
- /**
- * Returns a list of personalization design objects. The objects are sorted in
- * descending order by creation date, with the most recently created object
- * appearing first.
- *
- * @param null|array $params
- * @param null|array|string $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Collection<\Stripe\Issuing\PersonalizationDesign> of ApiResources
- */
- public static function all($params = null, $opts = null)
- {
- $url = static::classUrl();
- return static::_requestPage($url, \Stripe\Collection::class, $params, $opts);
- }
- /**
- * Retrieves a personalization design object.
- *
- * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
- * @param null|array|string $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Issuing\PersonalizationDesign
- */
- public static function retrieve($id, $opts = null)
- {
- $opts = \Stripe\Util\RequestOptions::parse($opts);
- $instance = new static($id, $opts);
- $instance->refresh();
- return $instance;
- }
- /**
- * Updates a card personalization object.
- *
- * @param string $id the ID of the resource to update
- * @param null|array $params
- * @param null|array|string $opts
- *
- * @throws \Stripe\Exception\ApiErrorException if the request fails
- *
- * @return \Stripe\Issuing\PersonalizationDesign the updated resource
- */
- public static function update($id, $params = null, $opts = null)
- {
- self::_validateParams($params);
- $url = static::resourceUrl($id);
- list($response, $opts) = static::_staticRequest('post', $url, $params, $opts);
- $obj = \Stripe\Util\Util::convertToStripeObject($response->json, $opts);
- $obj->setLastResponse($response);
- return $obj;
- }
- }
|