This object represents files hosted on Stripe's servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query). Related guide: File upload guide
Constants
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [file]."
ERROR_MESSAGE_FOR_PURPOSE = "invalid value for \"purpose\", must be one of [account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, document_provider_identity_document, finance_report_run, identity_document, identity_document_downloadable, issuing_regulatory_reporting, pci_document, selfie, sigma_scheduled_query, tax_document_user_upload, terminal_reader_splashscreen]."
MAX_LENGTH_FOR__TYPE = 5000
MAX_LENGTH_FOR_FILENAME = 5000
MAX_LENGTH_FOR_TITLE = 5000
MAX_LENGTH_FOR_URL = 5000
VALID_VALUES_FOR_OBJECT =
String.static_array("file")
VALID_VALUES_FOR_PURPOSE =
String.static_array("account_requirement", "additional_verification", "business_icon", "business_logo", "customer_signature", "dispute_evidence", "document_provider_identity_document", "finance_report_run", "identity_document", "identity_document_downloadable", "issuing_regulatory_reporting", "pci_document", "selfie", "sigma_scheduled_query", "tax_document_user_upload", "terminal_reader_splashscreen")
Constructors
new(*, created :
Int64 |
Nil = nil, expires_at :
Int64 |
Nil = nil, filename :
String |
Nil = nil, id :
String |
Nil = nil, object :
String |
Nil = nil, purpose :
String |
Nil = nil, size :
Int64 |
Nil = nil, title :
String |
Nil = nil, _type :
String |
Nil = nil, url :
String |
Nil = nil, links :
Stripe::FileResourceFileLinkList |
Nil = nil)
Initializes the object
@param [Hash] attributes Model attributes in the form of hash
Instance methods
==(other : self)
Generates #hash and #== methods from all fields
#== @return [Bool]
#hash calculates hash code according to all attributes.
#hash @return [UInt64] Hash code
_type
The returned file type (for example, csv, pdf, jpg, or png).
_type=(new_value :
String |
Nil)
Custom attribute writer method checking allowed values (enum).
@param [Object] _type Object to be assigned
created
Time at which the object was created. Measured in seconds since the Unix epoch.
created=(new_value :
Int64 |
Nil)
Custom attribute writer method checking allowed values (enum).
@param [Object] created Object to be assigned
expires_at
The file expires and isn't available at this time in epoch seconds.
expires_at=(new_value :
Int64 |
Nil)
Custom attribute writer method checking allowed values (enum).
@param [Object] expires_at Object to be assigned
filename
The suitable name for saving the file to a filesystem.
filename=(new_value :
String |
Nil)
Custom attribute writer method checking allowed values (enum).
@param [Object] filename Object to be assigned
hash(hasher)
Generates #hash and #== methods from all fields
#== @return [Bool]
#hash calculates hash code according to all attributes.
#hash @return [UInt64] Hash code
id
Unique identifier for the object.
Custom attribute writer method checking allowed values (enum).
@param [Object] id Object to be assigned
Custom attribute writer method checking allowed values (enum).
@param [Object] links Object to be assigned
list_invalid_properties
Show invalid properties with the reasons. Usually used together with valid?
@return Array for valid properties with the reasons
object
String representing the object's type. Objects of the same type share the same value.
object=(new_value :
String |
Nil)
Custom attribute writer method checking allowed values (enum).
@param [Object] object Object to be assigned
purpose=(new_value :
String |
Nil)
Custom attribute writer method checking allowed values (enum).
@param [Object] purpose Object to be assigned
size
The size of the file object in bytes.
size=(new_value :
Int64 |
Nil)
Custom attribute writer method checking allowed values (enum).
@param [Object] size Object to be assigned
title
A suitable title for the document.
title=(new_value :
String |
Nil)
Custom attribute writer method checking allowed values (enum).
@param [Object] title Object to be assigned
url
Use your live secret API key to download the file from this URL.
url=(new_value :
String |
Nil)
Custom attribute writer method checking allowed values (enum).
@param [Object] url Object to be assigned
valid?
Check to see if the all the properties in the model are valid
@return true if the model is valid