summaryrefslogtreecommitdiffstats
path: root/vendor/stripe/stripe-php/lib/File.php
diff options
context:
space:
mode:
authorAnton Luka Šijanec <anton@sijanec.eu>2022-01-11 12:35:47 +0100
committerAnton Luka Šijanec <anton@sijanec.eu>2022-01-11 12:35:47 +0100
commit19985dbb8c0aa66dc4bf7905abc1148de909097d (patch)
tree2cd5a5d20d7e80fc2a51adf60d838d8a2c40999e /vendor/stripe/stripe-php/lib/File.php
download1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.gz
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.bz2
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.lz
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.xz
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.tar.zst
1ka-19985dbb8c0aa66dc4bf7905abc1148de909097d.zip
Diffstat (limited to 'vendor/stripe/stripe-php/lib/File.php')
-rw-r--r--vendor/stripe/stripe-php/lib/File.php87
1 files changed, 87 insertions, 0 deletions
diff --git a/vendor/stripe/stripe-php/lib/File.php b/vendor/stripe/stripe-php/lib/File.php
new file mode 100644
index 0000000..9f60564
--- /dev/null
+++ b/vendor/stripe/stripe-php/lib/File.php
@@ -0,0 +1,87 @@
+<?php
+
+// File generated from our OpenAPI spec
+
+namespace Stripe;
+
+/**
+ * This is an object representing a file hosted on Stripe's servers. The file may
+ * have been uploaded by yourself using the <a
+ * href="https://stripe.com/docs/api#create_file">create file</a> request (for
+ * example, when uploading dispute evidence) or it may have been created by Stripe
+ * (for example, the results of a <a href="#scheduled_queries">Sigma scheduled
+ * query</a>).
+ *
+ * Related guide: <a href="https://stripe.com/docs/file-upload">File Upload
+ * Guide</a>.
+ *
+ * @property string $id Unique identifier for the object.
+ * @property string $object String representing the object's type. Objects of the same type share the same value.
+ * @property int $created Time at which the object was created. Measured in seconds since the Unix epoch.
+ * @property null|int $expires_at The time at which the file expires and is no longer available in epoch seconds.
+ * @property null|string $filename A filename for the file, suitable for saving to a filesystem.
+ * @property null|\Stripe\Collection $links A list of <a href="https://stripe.com/docs/api#file_links">file links</a> that point at this file.
+ * @property string $purpose The <a href="https://stripe.com/docs/file-upload#uploading-a-file">purpose</a> of the uploaded file.
+ * @property int $size The size in bytes of the file object.
+ * @property null|string $title A user friendly title for the document.
+ * @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>).
+ * @property null|string $url The URL from which the file can be downloaded using your live secret API key.
+ */
+class File extends ApiResource
+{
+ const OBJECT_NAME = 'file';
+
+ use ApiOperations\All;
+ use ApiOperations\Retrieve;
+
+ const PURPOSE_ACCOUNT_REQUIREMENT = 'account_requirement';
+ const PURPOSE_ADDITIONAL_VERIFICATION = 'additional_verification';
+ const PURPOSE_BUSINESS_ICON = 'business_icon';
+ const PURPOSE_BUSINESS_LOGO = 'business_logo';
+ const PURPOSE_CUSTOMER_SIGNATURE = 'customer_signature';
+ const PURPOSE_DISPUTE_EVIDENCE = 'dispute_evidence';
+ const PURPOSE_DOCUMENT_PROVIDER_IDENTITY_DOCUMENT = 'document_provider_identity_document';
+ const PURPOSE_FINANCE_REPORT_RUN = 'finance_report_run';
+ const PURPOSE_IDENTITY_DOCUMENT = 'identity_document';
+ const PURPOSE_IDENTITY_DOCUMENT_DOWNLOADABLE = 'identity_document_downloadable';
+ const PURPOSE_PCI_DOCUMENT = 'pci_document';
+ const PURPOSE_SELFIE = 'selfie';
+ const PURPOSE_SIGMA_SCHEDULED_QUERY = 'sigma_scheduled_query';
+ const PURPOSE_TAX_DOCUMENT_USER_UPLOAD = 'tax_document_user_upload';
+
+ // This resource can have two different object names. In latter API
+ // versions, only `file` is used, but since stripe-php may be used with
+ // any API version, we need to support deserializing the older
+ // `file_upload` object into the same class.
+ const OBJECT_NAME_ALT = 'file_upload';
+
+ use ApiOperations\Create {
+ create as protected _create;
+ }
+
+ public static function classUrl()
+ {
+ return '/v1/files';
+ }
+
+ /**
+ * @param null|array $params
+ * @param null|array|string $opts
+ *
+ * @throws \Stripe\Exception\ApiErrorException if the request fails
+ *
+ * @return \Stripe\File the created file
+ */
+ public static function create($params = null, $opts = null)
+ {
+ $opts = \Stripe\Util\RequestOptions::parse($opts);
+ if (null === $opts->apiBase) {
+ $opts->apiBase = Stripe::$apiUploadBase;
+ }
+ // Manually flatten params, otherwise curl's multipart encoder will
+ // choke on nested arrays.
+ $flatParams = \array_column(\Stripe\Util\Util::flattenParams($params), 1, 0);
+
+ return static::_create($flatParams, $opts);
+ }
+}