class Stripe::FilesApi

Defined in:

stripe/api/files_api.cr

Constant Summary

GET_FILES_FILE_MAX_LENGTH_FOR_FILE = 5000
GET_FILES_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_FILES_MAX_LENGTH_FOR_PURPOSE = 5000
GET_FILES_MAX_LENGTH_FOR_STARTING_AFTER = 5000
GET_FILES_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")
POST_FILES_VALID_VALUES_FOR_PURPOSE = String.static_array("account_requirement", "additional_verification", "business_icon", "business_logo", "customer_signature", "dispute_evidence", "identity_document", "issuing_regulatory_reporting", "pci_document", "tax_document_user_upload", "terminal_reader_splashscreen")

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Stripe::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_get_files(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, purpose : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_files_file(*, file : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_files(*, file : ::File | Nil = nil, purpose : String | Nil = nil, expand : Array(String) | Nil = nil, file_link_data : Stripe::FileLinkCreationParams | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def get_files(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, purpose : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::FileResourceFileList #

Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.

@optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param purpose [String?] Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return files that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::FileResourceFileList]

[View source]
def get_files(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, purpose : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param purpose [String?] Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return files that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_files_file(*, file : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::File #

Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.

@required @param file [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::File]

[View source]
def get_files_file(*, file : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to <a href=&quot;/docs/file-upload#download-file-contents&quot;>access file contents</a>.</p> @required @param file [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_files_file_with_http_info(*, file : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::File, Int32, Hash(String, Array(String) | String)) #

<p>Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to <a href=&quot;/docs/file-upload#download-file-contents&quot;>access file contents</a>.</p> @required @param file [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::File, Integer, Hash)] Stripe::File, response status code and response headers


[View source]
def get_files_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, purpose : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FileResourceFileList, Int32, Hash(String, Array(String) | String)) #

<p>Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.</p> @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @optional @param limit [Int32?] A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @optional @param purpose [String?] Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return files that were created during the given date interval. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FileResourceFileList, Integer, Hash)] Stripe::FileResourceFileList, response status code and response headers


[View source]
def post_files(*, file : ::File | Nil = nil, purpose : String | Nil = nil, expand : Array(String) | Nil = nil, file_link_data : Stripe::FileLinkCreationParams | Nil = nil) : Stripe::File #

To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.

All of Stripe’s officially supported Client libraries support sending multipart/form-data.

@required @param file [::File?] A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol. @required @param purpose [String?] The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param file_link_data [Stripe::FileLinkCreationParams?] @return [Stripe::File]

[View source]
def post_files(*, file : ::File | Nil = nil, purpose : String | Nil = nil, expand : Array(String) | Nil = nil, file_link_data : Stripe::FileLinkCreationParams | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>To upload a file to Stripe, you need to send a request of type <code>multipart/form-data</code>. Include the file you want to upload in the request, and the parameters for creating a file.</p> <p>All of Stripe’s officially supported Client libraries support sending <code>multipart/form-data</code>.</p> @required @param file [::File?] A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the multipart/form-data protocol. @required @param purpose [String?] The purpose of the uploaded file. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param file_link_data [Stripe::FileLinkCreationParams?] @return nil


[View source]
def post_files_with_http_info(*, file : ::File | Nil = nil, purpose : String | Nil = nil, expand : Array(String) | Nil = nil, file_link_data : Stripe::FileLinkCreationParams | Nil = nil) : Tuple(Stripe::File, Int32, Hash(String, Array(String) | String)) #

<p>To upload a file to Stripe, you need to send a request of type <code>multipart/form-data</code>. Include the file you want to upload in the request, and the parameters for creating a file.</p> <p>All of Stripe’s officially supported Client libraries support sending <code>multipart/form-data</code>.</p> @required @param file [::File?] A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the multipart/form-data protocol. @required @param purpose [String?] The purpose of the uploaded file. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param file_link_data [Stripe::FileLinkCreationParams?] @return [Tuple(Stripe::File, Integer, Hash)] Stripe::File, response status code and response headers


[View source]