InvoiceRenderingTemplate.php — Booking for Appointments and Events Calendar – Amelia 2.4.4

ameliabooking / vendor / stripe / stripe-php / lib / InvoiceRenderingTemplate.php

ameliabooking / vendor / stripe / stripe-php / lib Last commit date

InvoiceRenderingTemplate.php

89 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace AmeliaVendor\Stripe;
5
6	/**
7	* Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates
8	* can be created from within the Dashboard, and they can be used over the API when creating invoices.
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 $created Time at which the object was created. Measured in seconds since the Unix epoch.
13	* @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.
14	* @property null\|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.
15	* @property null\|string $nickname A brief description of the template, hidden from customers
16	* @property string $status The status of the template, one of <code>active</code> or <code>archived</code>.
17	* @property int $version Version of this template; version increases by one when an update on the template changes any field that controls invoice rendering
18	*/
19	class InvoiceRenderingTemplate extends ApiResource
20	{
21	const OBJECT_NAME = 'invoice_rendering_template';
22	const STATUS_ACTIVE = 'active';
23	const STATUS_ARCHIVED = 'archived';
24	/**
25	* List all templates, ordered by creation date, with the most recently created
26	* template appearing first.
27	*
28	* @param null\|array{ending_before?: string, expand?: string[], limit?: int, starting_after?: string, status?: string} $params
29	* @param null\|array\|string $opts
30	*
31	* @return Collection<InvoiceRenderingTemplate> of ApiResources
32	*
33	* @throws Exception\ApiErrorException if the request fails
34	*/
35	public static function all($params = null, $opts = null)
36	{
37	$url = static::classUrl();
38	return static::_requestPage($url, Collection::class, $params, $opts);
39	}
40	/**
41	* Retrieves an invoice rendering template with the given ID. It by default returns
42	* the latest version of the template. Optionally, specify a version to see
43	* previous versions.
44	*
45	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
46	* @param null\|array\|string $opts
47	*
48	* @return InvoiceRenderingTemplate
49	*
50	* @throws Exception\ApiErrorException if the request fails
51	*/
52	public static function retrieve($id, $opts = null)
53	{
54	$opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts);
55	$instance = new static($id, $opts);
56	$instance->refresh();
57	return $instance;
58	}
59	/**
60	* @param null\|array $params
61	* @param null\|array\|string $opts
62	*
63	* @return InvoiceRenderingTemplate the archived invoice rendering template
64	*
65	* @throws Exception\ApiErrorException if the request fails
66	*/
67	public function archive($params = null, $opts = null)
68	{
69	$url = $this->instanceUrl() . '/archive';
70	list($response, $opts) = $this->_request('post', $url, $params, $opts);
71	$this->refreshFrom($response, $opts);
72	return $this;
73	}
74	/**
75	* @param null\|array $params
76	* @param null\|array\|string $opts
77	*
78	* @return InvoiceRenderingTemplate the unarchived invoice rendering template
79	*
80	* @throws Exception\ApiErrorException if the request fails
81	*/
82	public function unarchive($params = null, $opts = null)
83	{
84	$url = $this->instanceUrl() . '/unarchive';
85	list($response, $opts) = $this->_request('post', $url, $params, $opts);
86	$this->refreshFrom($response, $opts);
87	return $this;
88	}
89	}