ApiOperations
1 year ago
Apps
1 year ago
Billing
1 year ago
BillingPortal
1 year ago
Checkout
1 year ago
Climate
1 year ago
Entitlements
1 year ago
EventData
1 year ago
Events
1 year ago
Exception
1 year ago
FinancialConnections
1 year ago
Forwarding
1 year ago
HttpClient
1 year ago
Identity
1 year ago
Issuing
1 year ago
Radar
1 year ago
Reporting
1 year ago
Service
1 year ago
Sigma
1 year ago
Tax
1 year ago
Terminal
1 year ago
TestHelpers
1 year ago
Treasury
1 year ago
Util
1 year ago
V2
1 year ago
Account.php
1 year ago
AccountLink.php
1 year ago
AccountSession.php
1 year ago
ApiRequestor.php
1 year ago
ApiResource.php
2 years ago
ApiResponse.php
2 years ago
ApplePayDomain.php
1 year ago
Application.php
2 years ago
ApplicationFee.php
1 year ago
ApplicationFeeRefund.php
2 years ago
Balance.php
1 year ago
BalanceTransaction.php
1 year ago
BankAccount.php
1 year ago
BaseStripeClient.php
1 year ago
BaseStripeClientInterface.php
1 year ago
Capability.php
1 year ago
Card.php
1 year ago
CashBalance.php
2 years ago
Charge.php
1 year ago
Collection.php
1 year ago
ConfirmationToken.php
1 year ago
ConnectCollectionTransfer.php
2 years ago
CountrySpec.php
1 year ago
Coupon.php
1 year ago
CreditNote.php
1 year ago
CreditNoteLineItem.php
1 year ago
Customer.php
1 year ago
CustomerBalanceTransaction.php
2 years ago
CustomerCashBalanceTransaction.php
2 years ago
CustomerSession.php
1 year ago
Discount.php
1 year ago
Dispute.php
1 year ago
EphemeralKey.php
1 year ago
ErrorObject.php
1 year ago
Event.php
1 year ago
ExchangeRate.php
1 year ago
File.php
1 year ago
FileLink.php
1 year ago
FundingInstructions.php
2 years ago
Invoice.php
1 year ago
InvoiceItem.php
1 year ago
InvoiceLineItem.php
1 year ago
InvoiceRenderingTemplate.php
1 year ago
LineItem.php
1 year ago
LoginLink.php
1 year ago
Mandate.php
1 year ago
OAuth.php
2 years ago
OAuthErrorObject.php
1 year ago
PaymentIntent.php
1 year ago
PaymentLink.php
1 year ago
PaymentMethod.php
1 year ago
PaymentMethodConfiguration.php
1 year ago
PaymentMethodDomain.php
1 year ago
Payout.php
1 year ago
Person.php
1 year ago
Plan.php
1 year ago
Price.php
1 year ago
Product.php
1 year ago
ProductFeature.php
1 year ago
PromotionCode.php
1 year ago
Quote.php
1 year ago
Reason.php
1 year ago
RecipientTransfer.php
2 years ago
Refund.php
1 year ago
RelatedObject.php
1 year ago
RequestTelemetry.php
2 years ago
ReserveTransaction.php
2 years ago
Review.php
1 year ago
SearchResult.php
1 year ago
SetupAttempt.php
1 year ago
SetupIntent.php
1 year ago
ShippingRate.php
1 year ago
SingletonApiResource.php
2 years ago
Source.php
1 year ago
SourceMandateNotification.php
2 years ago
SourceTransaction.php
2 years ago
Stripe.php
1 year ago
StripeClient.php
1 year ago
StripeClientInterface.php
2 years ago
StripeObject.php
1 year ago
StripeStreamingClientInterface.php
2 years ago
Subscription.php
1 year ago
SubscriptionItem.php
1 year ago
SubscriptionSchedule.php
1 year ago
TaxCode.php
1 year ago
TaxDeductedAtSource.php
2 years ago
TaxId.php
1 year ago
TaxRate.php
1 year ago
ThinEvent.php
1 year ago
Token.php
1 year ago
Topup.php
1 year ago
Transfer.php
1 year ago
TransferReversal.php
1 year ago
UsageRecord.php
1 year ago
UsageRecordSummary.php
1 year ago
Webhook.php
1 year ago
WebhookEndpoint.php
1 year ago
WebhookSignature.php
2 years ago
File.php
111 lines
| 1 | <?php |
| 2 | |
| 3 | // File generated from our OpenAPI spec |
| 4 | namespace WPForms\Vendor\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|\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. |
| 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 $params |
| 53 | * @param null|array|string $opts |
| 54 | * |
| 55 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 56 | * |
| 57 | * @return \Stripe\Collection<\Stripe\File> of ApiResources |
| 58 | */ |
| 59 | public static function all($params = null, $opts = null) |
| 60 | { |
| 61 | $url = static::classUrl(); |
| 62 | return static::_requestPage($url, \WPForms\Vendor\Stripe\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 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 73 | * |
| 74 | * @return \Stripe\File |
| 75 | */ |
| 76 | public static function retrieve($id, $opts = null) |
| 77 | { |
| 78 | $opts = \WPForms\Vendor\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 ApiOperations\Create { |
| 89 | create as protected _create; |
| 90 | } |
| 91 | /** |
| 92 | * @param null|array $params |
| 93 | * @param null|array|string $opts |
| 94 | * |
| 95 | * @throws \Stripe\Exception\ApiErrorException if the request fails |
| 96 | * |
| 97 | * @return \Stripe\File the created file |
| 98 | */ |
| 99 | public static function create($params = null, $opts = null) |
| 100 | { |
| 101 | $opts = \WPForms\Vendor\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(\WPForms\Vendor\Stripe\Util\Util::flattenParams($params), 1, 0); |
| 108 | return static::_create($flatParams, $opts); |
| 109 | } |
| 110 | } |
| 111 |