Order.php
135 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace ProfilePressVendor\Stripe\Climate; |
| 5 | |
| 6 | /** |
| 7 | * Orders represent your intent to purchase a particular Climate product. When you create an order, the |
| 8 | * payment is deducted from your merchant balance. |
| 9 | * |
| 10 | * @property string $id Unique identifier for the object. |
| 11 | * @property string $object String representing the object's type. Objects of the same type share the same value. |
| 12 | * @property int $amount_fees Total amount of <a href="https://frontierclimate.com/">Frontier</a>'s service fees in the currency's smallest unit. |
| 13 | * @property int $amount_subtotal Total amount of the carbon removal in the currency's smallest unit. |
| 14 | * @property int $amount_total Total amount of the order including fees in the currency's smallest unit. |
| 15 | * @property null|\Stripe\StripeObject $beneficiary |
| 16 | * @property null|int $canceled_at Time at which the order was canceled. Measured in seconds since the Unix epoch. |
| 17 | * @property null|string $cancellation_reason Reason for the cancellation of this order. |
| 18 | * @property null|string $certificate For delivered orders, a URL to a delivery certificate for the order. |
| 19 | * @property null|int $confirmed_at Time at which the order was confirmed. Measured in seconds since the Unix epoch. |
| 20 | * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 21 | * @property string $currency Three-letter <a href="https://www.iso.org/iso-4217-currency-codes.html">ISO currency code</a>, in lowercase, representing the currency for this order. |
| 22 | * @property null|int $delayed_at Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch. |
| 23 | * @property null|int $delivered_at Time at which the order was delivered. Measured in seconds since the Unix epoch. |
| 24 | * @property \Stripe\StripeObject[] $delivery_details Details about the delivery of carbon removal for this order. |
| 25 | * @property int $expected_delivery_year The year this order is expected to be delivered. |
| 26 | * @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. |
| 27 | * @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. |
| 28 | * @property string $metric_tons Quantity of carbon removal that is included in this order. |
| 29 | * @property string|\Stripe\Climate\Product $product Unique ID for the Climate <code>Product</code> this order is purchasing. |
| 30 | * @property null|int $product_substituted_at Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch. |
| 31 | * @property string $status The current status of this order. |
| 32 | */ |
| 33 | class Order extends \ProfilePressVendor\Stripe\ApiResource |
| 34 | { |
| 35 | const OBJECT_NAME = 'climate.order'; |
| 36 | use \ProfilePressVendor\Stripe\ApiOperations\Update; |
| 37 | const CANCELLATION_REASON_EXPIRED = 'expired'; |
| 38 | const CANCELLATION_REASON_PRODUCT_UNAVAILABLE = 'product_unavailable'; |
| 39 | const CANCELLATION_REASON_REQUESTED = 'requested'; |
| 40 | const STATUS_AWAITING_FUNDS = 'awaiting_funds'; |
| 41 | const STATUS_CANCELED = 'canceled'; |
| 42 | const STATUS_CONFIRMED = 'confirmed'; |
| 43 | const STATUS_DELIVERED = 'delivered'; |
| 44 | const STATUS_OPEN = 'open'; |
| 45 | /** |
| 46 | * Creates a Climate order object for a given Climate product. The order will be |
| 47 | * processed immediately after creation and payment will be deducted your Stripe |
| 48 | * balance. |
| 49 | * |
| 50 | * @param null|array $params |
| 51 | * @param null|array|string $options |
| 52 | * |
| 53 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 54 | * |
| 55 | * @return \Stripe\Climate\Order the created resource |
| 56 | */ |
| 57 | public static function create($params = null, $options = null) |
| 58 | { |
| 59 | self::_validateParams($params); |
| 60 | $url = static::classUrl(); |
| 61 | list($response, $opts) = static::_staticRequest('post', $url, $params, $options); |
| 62 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 63 | $obj->setLastResponse($response); |
| 64 | return $obj; |
| 65 | } |
| 66 | /** |
| 67 | * Lists all Climate order objects. The orders are returned sorted by creation |
| 68 | * date, with the most recently created orders appearing first. |
| 69 | * |
| 70 | * @param null|array $params |
| 71 | * @param null|array|string $opts |
| 72 | * |
| 73 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 74 | * |
| 75 | * @return \Stripe\Collection<\Stripe\Climate\Order> of ApiResources |
| 76 | */ |
| 77 | public static function all($params = null, $opts = null) |
| 78 | { |
| 79 | $url = static::classUrl(); |
| 80 | return static::_requestPage($url, \ProfilePressVendor\Stripe\Collection::class, $params, $opts); |
| 81 | } |
| 82 | /** |
| 83 | * Retrieves the details of a Climate order object with the given ID. |
| 84 | * |
| 85 | * @param array|string $id the ID of the API resource to retrieve, or an options array containing an `id` key |
| 86 | * @param null|array|string $opts |
| 87 | * |
| 88 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 89 | * |
| 90 | * @return \Stripe\Climate\Order |
| 91 | */ |
| 92 | public static function retrieve($id, $opts = null) |
| 93 | { |
| 94 | $opts = \ProfilePressVendor\Stripe\Util\RequestOptions::parse($opts); |
| 95 | $instance = new static($id, $opts); |
| 96 | $instance->refresh(); |
| 97 | return $instance; |
| 98 | } |
| 99 | /** |
| 100 | * Updates the specified order by setting the values of the parameters passed. |
| 101 | * |
| 102 | * @param string $id the ID of the resource to update |
| 103 | * @param null|array $params |
| 104 | * @param null|array|string $opts |
| 105 | * |
| 106 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 107 | * |
| 108 | * @return \Stripe\Climate\Order the updated resource |
| 109 | */ |
| 110 | public static function update($id, $params = null, $opts = null) |
| 111 | { |
| 112 | self::_validateParams($params); |
| 113 | $url = static::resourceUrl($id); |
| 114 | list($response, $opts) = static::_staticRequest('post', $url, $params, $opts); |
| 115 | $obj = \ProfilePressVendor\Stripe\Util\Util::convertToStripeObject($response->json, $opts); |
| 116 | $obj->setLastResponse($response); |
| 117 | return $obj; |
| 118 | } |
| 119 | /** |
| 120 | * @param null|array $params |
| 121 | * @param null|array|string $opts |
| 122 | * |
| 123 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 124 | * |
| 125 | * @return \Stripe\Climate\Order the canceled order |
| 126 | */ |
| 127 | public function cancel($params = null, $opts = null) |
| 128 | { |
| 129 | $url = $this->instanceUrl() . '/cancel'; |
| 130 | list($response, $opts) = $this->_request('post', $url, $params, $opts); |
| 131 | $this->refreshFrom($response, $opts); |
| 132 | return $this; |
| 133 | } |
| 134 | } |
| 135 |