178 lines
5.7 KiB
PHP
178 lines
5.7 KiB
PHP
<?php
|
|
|
|
// File generated from our OpenAPI spec
|
|
|
|
namespace Stripe\Service;
|
|
|
|
class QuoteService extends \Stripe\Service\AbstractService
|
|
{
|
|
/**
|
|
* Accepts the specified quote.
|
|
*
|
|
* @param string $id
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Quote
|
|
*/
|
|
public function accept($id, $params = null, $opts = null)
|
|
{
|
|
return $this->request('post', $this->buildPath('/v1/quotes/%s/accept', $id), $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* Returns a list of your quotes.
|
|
*
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Collection<\Stripe\Quote>
|
|
*/
|
|
public function all($params = null, $opts = null)
|
|
{
|
|
return $this->requestCollection('get', '/v1/quotes', $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* When retrieving a quote, there is an includable <a
|
|
* href="https://stripe.com/docs/api/quotes/object#quote_object-computed-upfront-line_items"><strong>computed.upfront.line_items</strong></a>
|
|
* property containing the first handful of those items. There is also a URL where
|
|
* you can retrieve the full (paginated) list of upfront line items.
|
|
*
|
|
* @param string $id
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Collection<\Stripe\Quote>
|
|
*/
|
|
public function allComputedUpfrontLineItems($id, $params = null, $opts = null)
|
|
{
|
|
return $this->requestCollection('get', $this->buildPath('/v1/quotes/%s/computed_upfront_line_items', $id), $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* When retrieving a quote, there is an includable <strong>line_items</strong>
|
|
* property containing the first handful of those items. There is also a URL where
|
|
* you can retrieve the full (paginated) list of line items.
|
|
*
|
|
* @param string $id
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Collection<\Stripe\Quote>
|
|
*/
|
|
public function allLineItems($id, $params = null, $opts = null)
|
|
{
|
|
return $this->requestCollection('get', $this->buildPath('/v1/quotes/%s/line_items', $id), $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* Cancels the quote.
|
|
*
|
|
* @param string $id
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Quote
|
|
*/
|
|
public function cancel($id, $params = null, $opts = null)
|
|
{
|
|
return $this->request('post', $this->buildPath('/v1/quotes/%s/cancel', $id), $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* A quote models prices and services for a customer. Default options for
|
|
* <code>header</code>, <code>description</code>, <code>footer</code>, and
|
|
* <code>expires_at</code> can be set in the dashboard via the <a
|
|
* href="https://dashboard.stripe.com/settings/billing/quote">quote template</a>.
|
|
*
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Quote
|
|
*/
|
|
public function create($params = null, $opts = null)
|
|
{
|
|
return $this->request('post', '/v1/quotes', $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* Finalizes the quote.
|
|
*
|
|
* @param string $id
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Quote
|
|
*/
|
|
public function finalizeQuote($id, $params = null, $opts = null)
|
|
{
|
|
return $this->request('post', $this->buildPath('/v1/quotes/%s/finalize', $id), $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* Retrieves the quote with the given ID.
|
|
*
|
|
* @param string $id
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Quote
|
|
*/
|
|
public function retrieve($id, $params = null, $opts = null)
|
|
{
|
|
return $this->request('get', $this->buildPath('/v1/quotes/%s', $id), $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* A quote models prices and services for a customer.
|
|
*
|
|
* @param string $id
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*
|
|
* @return \Stripe\Quote
|
|
*/
|
|
public function update($id, $params = null, $opts = null)
|
|
{
|
|
return $this->request('post', $this->buildPath('/v1/quotes/%s', $id), $params, $opts);
|
|
}
|
|
|
|
/**
|
|
* Download the PDF for a finalized quote.
|
|
*
|
|
* @param string $id
|
|
* @param callable $readBodyChunkCallable
|
|
* @param null|array $params
|
|
* @param null|array|\Stripe\Util\RequestOptions $opts
|
|
*
|
|
* @throws \Stripe\Exception\ApiErrorException if the request fails
|
|
*/
|
|
public function pdf($id, $readBodyChunkCallable, $params = null, $opts = null)
|
|
{
|
|
$opts = \Stripe\Util\RequestOptions::parse($opts);
|
|
if (!isset($opts->apiBase)) {
|
|
$opts->apiBase = $this->getClient()->getFilesBase();
|
|
}
|
|
$this->requestStream('get', $this->buildPath('/v1/quotes/%s/pdf', $id), $readBodyChunkCallable, $params, $opts);
|
|
}
|
|
}
|