| 1 |
<?php |
| 2 |
|
| 3 |
// File generated from our OpenAPI spec |
| 4 |
|
| 5 |
namespace Stripe; |
| 6 |
|
| 7 |
/** |
| 8 |
* This is an object representing a file hosted on Stripe's servers. The file may |
| 9 |
* have been uploaded by yourself using the <a |
| 10 |
* href="https://stripe.com/docs/api#create_file">create file</a> request (for |
| 11 |
* example, when uploading dispute evidence) or it may have been created by Stripe |
| 12 |
* (for example, the results of a <a href="#scheduled_queries">Sigma scheduled |
| 13 |
* query</a>). |
| 14 |
* |
| 15 |
* Related guide: <a href="https://stripe.com/docs/file-upload">File Upload |
| 16 |
* Guide</a>. |
| 17 |
* |
| 18 |
* @property string $id Unique identifier for the object. |
| 19 |
* @property string $object String representing the object's type. Objects of the same type share the same value. |
| 20 |
* @property int $created Time at which the object was created. Measured in seconds since the Unix epoch. |
| 21 |
* @property null|int $expires_at The time at which the file expires and is no longer available in epoch seconds. |
| 22 |
* @property null|string $filename A filename for the file, suitable for saving to a filesystem. |
| 23 |
* @property null|\Stripe\Collection<\Stripe\FileLink> $links A list of <a href="https://stripe.com/docs/api#file_links">file links</a> that point at this file. |
| 24 |
* @property string $purpose The <a href="https://stripe.com/docs/file-upload#uploading-a-file">purpose</a> of the uploaded file. |
| 25 |
* @property int $size The size in bytes of the file object. |
| 26 |
* @property null|string $title A user friendly title for the document. |
| 27 |
* @property null|string $type The type of the file returned (e.g., <code>csv</code>, <code>pdf</code>, <code>jpg</code>, or <code>png</code>). |
| 28 |
* @property null|string $url The URL from which the file can be downloaded using your live secret API key. |
| 29 |
*/ |
| 30 |
class File extends ApiResource |
| 31 |
{ |
| 32 |
const OBJECT_NAME = 'file'; |
| 33 |
|
| 34 |
use ApiOperations\All; |
| 35 |
use ApiOperations\Retrieve; |
| 36 |
|
| 37 |
const PURPOSE_ACCOUNT_REQUIREMENT = 'account_requirement'; |
| 38 |
const PURPOSE_ADDITIONAL_VERIFICATION = 'additional_verification'; |
| 39 |
const PURPOSE_BUSINESS_ICON = 'business_icon'; |
| 40 |
const PURPOSE_BUSINESS_LOGO = 'business_logo'; |
| 41 |
const PURPOSE_CUSTOMER_SIGNATURE = 'customer_signature'; |
| 42 |
const PURPOSE_DISPUTE_EVIDENCE = 'dispute_evidence'; |
| 43 |
const PURPOSE_DOCUMENT_PROVIDER_IDENTITY_DOCUMENT = 'document_provider_identity_document'; |
| 44 |
const PURPOSE_FINANCE_REPORT_RUN = 'finance_report_run'; |
| 45 |
const PURPOSE_IDENTITY_DOCUMENT = 'identity_document'; |
| 46 |
const PURPOSE_IDENTITY_DOCUMENT_DOWNLOADABLE = 'identity_document_downloadable'; |
| 47 |
const PURPOSE_PCI_DOCUMENT = 'pci_document'; |
| 48 |
const PURPOSE_SELFIE = 'selfie'; |
| 49 |
const PURPOSE_SIGMA_SCHEDULED_QUERY = 'sigma_scheduled_query'; |
| 50 |
const PURPOSE_TAX_DOCUMENT_USER_UPLOAD = 'tax_document_user_upload'; |
| 51 |
|
| 52 |
// This resource can have two different object names. In latter API |
| 53 |
// versions, only `file` is used, but since stripe-php may be used with |
| 54 |
// any API version, we need to support deserializing the older |
| 55 |
// `file_upload` object into the same class. |
| 56 |
const OBJECT_NAME_ALT = 'file_upload'; |
| 57 |
|
| 58 |
use ApiOperations\Create { |
| 59 |
create as protected _create; |
| 60 |
} |
| 61 |
|
| 62 |
public static function classUrl() |
| 63 |
{ |
| 64 |
return '/v1/files'; |
| 65 |
} |
| 66 |
|
| 67 |
/** |
| 68 |
* @param null|array $params |
| 69 |
* @param null|array|string $opts |
| 70 |
* |
| 71 |
* @throws \Stripe\Exception\ApiErrorException if the request fails |
| 72 |
* |
| 73 |
* @return \Stripe\File the created file |
| 74 |
*/ |
| 75 |
public static function create($params = null, $opts = null) |
| 76 |
{ |
| 77 |
$opts = \Stripe\Util\RequestOptions::parse($opts); |
| 78 |
if (null === $opts->apiBase) { |
| 79 |
$opts->apiBase = Stripe::$apiUploadBase; |
| 80 |
} |
| 81 |
// Manually flatten params, otherwise curl's multipart encoder will |
| 82 |
// choke on nested arrays. |
| 83 |
$flatParams = \array_column(\Stripe\Util\Util::flattenParams($params), 1, 0); |
| 84 |
|
| 85 |
return static::_create($flatParams, $opts); |
| 86 |
} |
| 87 |
} |
| 88 |
|
