ApiOperations
2 years ago
BillingPortal
2 years ago
Checkout
2 years ago
Exception
4 years ago
FinancialConnections
2 years ago
HttpClient
2 years ago
Identity
2 years ago
Issuing
2 years ago
Radar
2 years ago
Reporting
4 years ago
Service
2 years ago
Sigma
4 years ago
Terminal
2 years ago
TestHelpers
2 years ago
Util
2 years ago
Account.php
2 years ago
AccountLink.php
4 years ago
AlipayAccount.php
4 years ago
ApiRequestor.php
2 years ago
ApiResource.php
2 years ago
ApiResponse.php
4 years ago
ApplePayDomain.php
4 years ago
ApplicationFee.php
2 years ago
ApplicationFeeRefund.php
4 years ago
Balance.php
4 years ago
BalanceTransaction.php
4 years ago
BankAccount.php
4 years ago
BaseStripeClient.php
2 years ago
BaseStripeClientInterface.php
4 years ago
BitcoinReceiver.php
2 years ago
BitcoinTransaction.php
4 years ago
Capability.php
4 years ago
Card.php
2 years ago
CashBalance.php
2 years ago
Charge.php
2 years ago
Collection.php
2 years ago
CountrySpec.php
4 years ago
Coupon.php
2 years ago
CreditNote.php
2 years ago
CreditNoteLineItem.php
4 years ago
Customer.php
2 years ago
CustomerBalanceTransaction.php
4 years ago
Discount.php
2 years ago
Dispute.php
4 years ago
EphemeralKey.php
4 years ago
ErrorObject.php
4 years ago
Event.php
2 years ago
ExchangeRate.php
4 years ago
File.php
2 years ago
FileLink.php
4 years ago
FundingInstructions.php
2 years ago
Invoice.php
2 years ago
InvoiceItem.php
2 years ago
InvoiceLineItem.php
2 years ago
LineItem.php
4 years ago
LoginLink.php
4 years ago
Mandate.php
4 years ago
OAuth.php
4 years ago
OAuthErrorObject.php
4 years ago
Order.php
2 years ago
OrderItem.php
4 years ago
OrderReturn.php
4 years ago
PaymentIntent.php
2 years ago
PaymentLink.php
2 years ago
PaymentMethod.php
2 years ago
Payout.php
4 years ago
Person.php
2 years ago
Plan.php
2 years ago
Price.php
2 years ago
Product.php
2 years ago
PromotionCode.php
2 years ago
Quote.php
2 years ago
Recipient.php
2 years ago
RecipientTransfer.php
4 years ago
Refund.php
2 years ago
RequestTelemetry.php
4 years ago
Review.php
4 years ago
SKU.php
2 years ago
SearchResult.php
2 years ago
SetupAttempt.php
4 years ago
SetupIntent.php
2 years ago
ShippingRate.php
2 years ago
SingletonApiResource.php
2 years ago
Source.php
4 years ago
SourceTransaction.php
4 years ago
Stripe.php
2 years ago
StripeClient.php
2 years ago
StripeClientInterface.php
4 years ago
StripeObject.php
2 years ago
StripeStreamingClientInterface.php
4 years ago
Subscription.php
2 years ago
SubscriptionItem.php
2 years ago
SubscriptionSchedule.php
2 years ago
TaxCode.php
2 years ago
TaxId.php
2 years ago
TaxRate.php
4 years ago
ThreeDSecure.php
4 years ago
Token.php
4 years ago
Topup.php
4 years ago
Transfer.php
2 years ago
TransferReversal.php
4 years ago
UsageRecord.php
4 years ago
UsageRecordSummary.php
4 years ago
Webhook.php
4 years ago
WebhookEndpoint.php
4 years ago
WebhookSignature.php
4 years ago
File.php
88 lines
| 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 |