class Stripe::File

Overview

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

Included Modules

Defined in:

stripe/models/file.cr

Constant Summary

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_ID = 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

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def _type : String | Nil #

[View source]
def _type=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] _type Object to be assigned


[View source]
def created : Int64 | Nil #

[View source]
def created=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned


[View source]
def expires_at : Int64 | Nil #

[View source]
def expires_at=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] expires_at Object to be assigned


[View source]
def filename : String | Nil #

[View source]
def filename=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] filename Object to be assigned


[View source]
def hash(hasher) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned


[View source]
def links : Stripe::FileResourceFileLinkList | Nil #

[View source]
def links=(new_value : Stripe::FileResourceFileLinkList | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] links Object to be assigned


[View source]
def links_present=(links_present : Bool) #

[View source]
def links_present? : Bool #

[View source]
def list_invalid_properties : Array(String) #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned


[View source]
def purpose : String | Nil #

[View source]
def purpose=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] purpose Object to be assigned


[View source]
def size : Int64 | Nil #

[View source]
def size=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] size Object to be assigned


[View source]
def title : String | Nil #

[View source]
def title=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] title Object to be assigned


[View source]
def url : String | Nil #

[View source]
def url=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] url Object to be assigned


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]