%PDF-
%PDF-
Mini Shell
Mini Shell
<?php
// File generated from our OpenAPI spec
namespace Stripe\Service\Climate;
/**
* @phpstan-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
*
* @psalm-import-type RequestOptionsArray from \Stripe\Util\RequestOptions
*/
class OrderService extends \Stripe\Service\AbstractService
{
/**
* Lists all Climate order objects. The orders are returned sorted by creation
* date, with the most recently created orders appearing first.
*
* @param null|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string} $params
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
*
* @return \Stripe\Collection<\Stripe\Climate\Order>
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function all($params = null, $opts = null)
{
return $this->requestCollection('get', '/v1/climate/orders', $params, $opts);
}
/**
* Cancels a Climate order. You can cancel an order within 24 hours of creation.
* Stripe refunds the reservation <code>amount_subtotal</code>, but not the
* <code>amount_fees</code> for user-triggered cancellations. Frontier might cancel
* reservations if suppliers fail to deliver. If Frontier cancels the reservation,
* Stripe provides 90 days advance notice and refunds the
* <code>amount_total</code>.
*
* @param string $id
* @param null|array{expand?: string[]} $params
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
*
* @return \Stripe\Climate\Order
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function cancel($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/climate/orders/%s/cancel', $id), $params, $opts);
}
/**
* Creates a Climate order object for a given Climate product. The order will be
* processed immediately after creation and payment will be deducted your Stripe
* balance.
*
* @param null|array{amount?: int, beneficiary?: array{public_name: string}, currency?: string, expand?: string[], metadata?: array<string, string>, metric_tons?: string, product: string} $params
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
*
* @return \Stripe\Climate\Order
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function create($params = null, $opts = null)
{
return $this->request('post', '/v1/climate/orders', $params, $opts);
}
/**
* Retrieves the details of a Climate order object with the given ID.
*
* @param string $id
* @param null|array{expand?: string[]} $params
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
*
* @return \Stripe\Climate\Order
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function retrieve($id, $params = null, $opts = null)
{
return $this->request('get', $this->buildPath('/v1/climate/orders/%s', $id), $params, $opts);
}
/**
* Updates the specified order by setting the values of the parameters passed.
*
* @param string $id
* @param null|array{beneficiary?: null|array{public_name: null|string}, expand?: string[], metadata?: array<string, string>} $params
* @param null|RequestOptionsArray|\Stripe\Util\RequestOptions $opts
*
* @return \Stripe\Climate\Order
*
* @throws \Stripe\Exception\ApiErrorException if the request fails
*/
public function update($id, $params = null, $opts = null)
{
return $this->request('post', $this->buildPath('/v1/climate/orders/%s', $id), $params, $opts);
}
}
Zerion Mini Shell 1.0