class Stripe::FileLinksApi
- Stripe::FileLinksApi
- Reference
- Object
Defined in:
stripe/api/file_links_api.crConstant Summary
-
GET_FILE_LINKS_MAX_LENGTH_FOR_FILE =
5000 -
POST_FILE_LINKS_MAX_LENGTH_FOR_FILE =
5000
Constructors
Instance Method Summary
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_get_file_links(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expired : Bool | Nil = nil, file : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_get_file_links_link(*, link : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_file_links(*, file : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_post_file_links_link(*, link : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Stripe::PostFileLinksLinkRequestExpiresAt | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#get_file_links(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expired : Bool | Nil = nil, file : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::FileResourceFileLinkList
Returns a list of file links.
@optional @param ending_before [String?] A cursor for use in pagination. -
#get_file_links(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expired : Bool | Nil = nil, file : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Returns a list of file links.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#get_file_links_link(*, link : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::FileLink
Retrieves the file link with the given ID.
@required @param link [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. -
#get_file_links_link(*, link : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Retrieves the file link with the given ID.</p> @required @param link [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_file_links_link_with_http_info(*, link : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FileLink, Int32, Hash(String, Array(String) | String))
<p>Retrieves the file link with the given ID.</p> @required @param link [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded.
-
#get_file_links_with_http_info(*, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expired : Bool | Nil = nil, file : String | Nil = nil, created : Stripe::GetAccountsCreatedParameter | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::FileResourceFileLinkList, Int32, Hash(String, Array(String) | String))
<p>Returns a list of file links.</p> @optional @param ending_before [String?] A cursor for use in pagination.
-
#post_file_links(*, file : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::FileLink
Creates a new file link object.
@required @param file [String?] The ID of the file. -
#post_file_links(*, file : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Creates a new file link object.</p> @required @param file [String?] The ID of the file.
-
#post_file_links_link(*, link : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Stripe::PostFileLinksLinkRequestExpiresAt | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Stripe::FileLink
Updates an existing file link object.
-
#post_file_links_link(*, link : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Stripe::PostFileLinksLinkRequestExpiresAt | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil, &block : Crest::Response -> ) : Nil
<p>Updates an existing file link object.
-
#post_file_links_link_with_http_info(*, link : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Stripe::PostFileLinksLinkRequestExpiresAt | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::FileLink, Int32, Hash(String, Array(String) | String))
<p>Updates an existing file link object.
-
#post_file_links_with_http_info(*, file : String | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, metadata : Stripe::PostAccountsRequestMetadata | Nil = nil) : Tuple(Stripe::FileLink, Int32, Hash(String, Array(String) | String))
<p>Creates a new file link object.</p> @required @param file [String?] The ID of the file.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
Returns a list of file links.
@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 expired [Bool?] Filter links by their expiration status. By default, Stripe returns all links. @optional @param file [String?] Only return links for the given file. @optional @param created [Stripe::GetAccountsCreatedParameter?] Only return links 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::FileResourceFileLinkList]<p>Returns a list of file links.</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 expired [Bool?] Filter links by their expiration status. By default, Stripe returns all links.
@optional @param file [String?] Only return links for the given file.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return links 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
Retrieves the file link with the given ID.
@required @param link [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::FileLink]<p>Retrieves the file link with the given ID.</p> @required @param link [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil
<p>Retrieves the file link with the given ID.</p> @required @param link [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::FileLink, Integer, Hash)] Stripe::FileLink, response status code and response headers
<p>Returns a list of file links.</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 expired [Bool?] Filter links by their expiration status. By default, Stripe returns all links.
@optional @param file [String?] Only return links for the given file.
@optional @param created [Stripe::GetAccountsCreatedParameter?] Only return links 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::FileResourceFileLinkList, Integer, Hash)] Stripe::FileResourceFileLinkList, response status code and response headers
Creates a new file link object.
@required @param file [String?] The ID of the file. The file's `purpose` must be one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `finance_report_run`, `identity_document_downloadable`, `issuing_regulatory_reporting`, `pci_document`, `selfie`, `sigma_scheduled_query`, `tax_document_user_upload`, or `terminal_reader_splashscreen`. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] The link isn't usable after this future timestamp. @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Stripe::FileLink]<p>Creates a new file link object.</p>
@required @param file [String?] The ID of the file. The file's purpose must be one of the following: business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, identity_document_downloadable, issuing_regulatory_reporting, pci_document, selfie, sigma_scheduled_query, tax_document_user_upload, or terminal_reader_splashscreen.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param expires_at [Int32?] The link isn't usable after this future timestamp.
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@return nil
Updates an existing file link object. Expired links can no longer be updated.
@required @param link [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Stripe::PostFileLinksLinkRequestExpiresAt?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Stripe::FileLink]<p>Updates an existing file link object. Expired links can no longer be updated.</p> @required @param link [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Stripe::PostFileLinksLinkRequestExpiresAt?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return nil
<p>Updates an existing file link object. Expired links can no longer be updated.</p> @required @param link [String?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Stripe::PostFileLinksLinkRequestExpiresAt?] @optional @param metadata [Stripe::PostAccountsRequestMetadata?] @return [Tuple(Stripe::FileLink, Integer, Hash)] Stripe::FileLink, response status code and response headers
<p>Creates a new file link object.</p>
@required @param file [String?] The ID of the file. The file's purpose must be one of the following: business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, identity_document_downloadable, issuing_regulatory_reporting, pci_document, selfie, sigma_scheduled_query, tax_document_user_upload, or terminal_reader_splashscreen.
@optional @param expand [Array(String)?] Specifies which fields in the response should be expanded.
@optional @param expires_at [Int32?] The link isn't usable after this future timestamp.
@optional @param metadata [Stripe::PostAccountsRequestMetadata?]
@return [Tuple(Stripe::FileLink, Integer, Hash)] Stripe::FileLink, response status code and response headers