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

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

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

File.php

110 lines

1	<?php
2
3	// File generated from our OpenAPI spec
4	namespace AmeliaVendor\Stripe;
5
6	/**
7	* This object represents files hosted on Stripe's servers. You can upload
8	* files with the <a href="https://stripe.com/docs/api#create_file">create file</a> request
9	* (for example, when uploading dispute evidence). Stripe also
10	* creates files independently (for example, the results of a <a href="#scheduled_queries">Sigma scheduled
11	* query</a>).
12	*
13	* Related guide: <a href="https://stripe.com/docs/file-upload">File upload guide</a>
14	*
15	* @property string $id Unique identifier for the object.
16	* @property string $object String representing the object's type. Objects of the same type share the same value.
17	* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
18	* @property null\|int $expires_at The file expires and isn't available at this time in epoch seconds.
19	* @property null\|string $filename The suitable name for saving the file to a filesystem.
20	* @property null\|Collection<FileLink> $links A list of <a href="https://stripe.com/docs/api#file_links">file links</a> that point at this file.
21	* @property string $purpose The <a href="https://stripe.com/docs/file-upload#uploading-a-file">purpose</a> of the uploaded file.
22	* @property int $size The size of the file object in bytes.
23	* @property null\|string $title A suitable title for the document.
24	* @property null\|string $type The returned file type (for example, <code>csv</code>, <code>pdf</code>, <code>jpg</code>, or <code>png</code>).
25	* @property null\|string $url Use your live secret API key to download the file from this URL.
26	*/
27	class File extends ApiResource
28	{
29	const OBJECT_NAME = 'file';
30	const PURPOSE_ACCOUNT_REQUIREMENT = 'account_requirement';
31	const PURPOSE_ADDITIONAL_VERIFICATION = 'additional_verification';
32	const PURPOSE_BUSINESS_ICON = 'business_icon';
33	const PURPOSE_BUSINESS_LOGO = 'business_logo';
34	const PURPOSE_CUSTOMER_SIGNATURE = 'customer_signature';
35	const PURPOSE_DISPUTE_EVIDENCE = 'dispute_evidence';
36	const PURPOSE_DOCUMENT_PROVIDER_IDENTITY_DOCUMENT = 'document_provider_identity_document';
37	const PURPOSE_FINANCE_REPORT_RUN = 'finance_report_run';
38	const PURPOSE_FINANCIAL_ACCOUNT_STATEMENT = 'financial_account_statement';
39	const PURPOSE_IDENTITY_DOCUMENT = 'identity_document';
40	const PURPOSE_IDENTITY_DOCUMENT_DOWNLOADABLE = 'identity_document_downloadable';
41	const PURPOSE_ISSUING_REGULATORY_REPORTING = 'issuing_regulatory_reporting';
42	const PURPOSE_PCI_DOCUMENT = 'pci_document';
43	const PURPOSE_SELFIE = 'selfie';
44	const PURPOSE_SIGMA_SCHEDULED_QUERY = 'sigma_scheduled_query';
45	const PURPOSE_TAX_DOCUMENT_USER_UPLOAD = 'tax_document_user_upload';
46	const PURPOSE_TERMINAL_READER_SPLASHSCREEN = 'terminal_reader_splashscreen';
47	/**
48	* Returns a list of the files that your account has access to. Stripe sorts and
49	* returns the files by their creation dates, placing the most recently created
50	* files at the top.
51	*
52	* @param null\|array{created?: array\|int, ending_before?: string, expand?: string[], limit?: int, purpose?: string, starting_after?: string} $params
53	* @param null\|array\|string $opts
54	*
55	* @return Collection<File> of ApiResources
56	*
57	* @throws Exception\ApiErrorException if the request fails
58	*/
59	public static function all($params = null, $opts = null)
60	{
61	$url = static::classUrl();
62	return static::_requestPage($url, Collection::class, $params, $opts);
63	}
64	/**
65	* Retrieves the details of an existing file object. After you supply a unique file
66	* ID, Stripe returns the corresponding file object. Learn how to <a
67	* href="/docs/file-upload#download-file-contents">access file contents</a>.
68	*
69	* @param array\|string $id the ID of the API resource to retrieve, or an options array containing an `id` key
70	* @param null\|array\|string $opts
71	*
72	* @return File
73	*
74	* @throws Exception\ApiErrorException if the request fails
75	*/
76	public static function retrieve($id, $opts = null)
77	{
78	$opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts);
79	$instance = new static($id, $opts);
80	$instance->refresh();
81	return $instance;
82	}
83	// This resource can have two different object names. In latter API
84	// versions, only `file` is used, but since stripe-php may be used with
85	// any API version, we need to support deserializing the older
86	// `file_upload` object into the same class.
87	const OBJECT_NAME_ALT = 'file_upload';
88	use \AmeliaVendor\Stripe\ApiOperations\Create {
89	create as protected _create;
90	}
91	/**
92	* @param null\|array $params
93	* @param null\|array\|string $opts
94	*
95	* @return File the created file
96	*
97	* @throws Exception\ApiErrorException if the request fails
98	*/
99	public static function create($params = null, $opts = null)
100	{
101	$opts = \AmeliaVendor\Stripe\Util\RequestOptions::parse($opts);
102	if (null === $opts->apiBase) {
103	$opts->apiBase = Stripe::$apiUploadBase;
104	}
105	// Manually flatten params, otherwise curl's multipart encoder will
106	// choke on nested arrays.
107	$flatParams = \array_column(\AmeliaVendor\Stripe\Util\Util::flattenParams($params), 1, 0);
108	return static::_create($flatParams, $opts);
109	}
110	}