class

Stripe::ForwardingApi

Inherits Reference < Object

Constants

GET_FORWARDING_REQUESTS_ID_MAX_LENGTH_FOR_ID = 5000

GET_FORWARDING_REQUESTS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000

GET_FORWARDING_REQUESTS_MAX_LENGTH_FOR_STARTING_AFTER = 5000

POST_FORWARDING_REQUESTS_MAX_LENGTH_FOR_PAYMENT_METHOD = 5000

POST_FORWARDING_REQUESTS_MAX_LENGTH_FOR_URL = 5000

POST_FORWARDING_REQUESTS_VALID_VALUES_FOR_REPLACEMENTS = String.static_array("card_cvc", "card_expiry", "card_number", "cardholder_name")

Constructors

new(api_client : Stripe::ApiClient = ApiClient.default)

Instance methods

api_client

api_client=(api_client : ApiClient)

build_api_request_for_get_forwarding_requests(*, limit : Int64 | Nil = nil, starting_after : String | Nil = nil, ending_before : String | Nil = nil, created : Stripe::CreatedParam | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_get_forwarding_requests_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request

@return Crest::Request

build_api_request_for_post_forwarding_requests(*, payment_method : String | Nil = nil, replacements : Array(String) | Nil = nil, url : String | Nil = nil, expand : Array(String) | Nil = nil, request : Stripe::RequestParam | Nil = nil) : Crest::Request

@return Crest::Request

client_side_validation?(*args, **options)

client_side_validation?(*args, **options, &)

debugging?(*args, **options)

debugging?(*args, **options, &)

get_forwarding_requests(*, limit : Int64 | Nil = nil, starting_after : String | Nil = nil, ending_before : String | Nil = nil, created : Stripe::CreatedParam | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ForwardingRequestList

Lists all ForwardingRequest objects.

@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 starting_after [String?] A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID. @optional @param ending_before [String?] A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID. @optional @param created [Stripe::CreatedParam?] Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::ForwardingRequestList]

get_forwarding_requests(*, limit : Int64 | Nil = nil, starting_after : String | Nil = nil, ending_before : String | Nil = nil, created : Stripe::CreatedParam | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil

<p>Lists all ForwardingRequest objects.</p> @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 starting_after [String?] A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID. @optional @param ending_before [String?] A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID. @optional @param created [Stripe::CreatedParam?] Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

get_forwarding_requests_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::ForwardingRequest

Retrieves a ForwardingRequest object.

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

get_forwarding_requests_id(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil

<p>Retrieves a ForwardingRequest object.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil

get_forwarding_requests_id_with_http_info(*, id : String | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ForwardingRequest, Int32, Hash(String, Array(String) | String))

<p>Retrieves a ForwardingRequest object.</p> @required @param id [String?] @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ForwardingRequest, Integer, Hash)] Stripe::ForwardingRequest, response status code and response headers

get_forwarding_requests_with_http_info(*, limit : Int64 | Nil = nil, starting_after : String | Nil = nil, ending_before : String | Nil = nil, created : Stripe::CreatedParam | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::ForwardingRequestList, Int32, Hash(String, Array(String) | String))

<p>Lists all ForwardingRequest objects.</p> @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 starting_after [String?] A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID. @optional @param ending_before [String?] A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID. @optional @param created [Stripe::CreatedParam?] Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::ForwardingRequestList, Integer, Hash)] Stripe::ForwardingRequestList, response status code and response headers

post_forwarding_requests(*, payment_method : String | Nil = nil, replacements : Array(String) | Nil = nil, url : String | Nil = nil, expand : Array(String) | Nil = nil, request : Stripe::RequestParam | Nil = nil) : Stripe::ForwardingRequest

Creates a ForwardingRequest object.

@required @param payment_method [String?] The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. @required @param replacements [Array(String)?] The field kinds to be replaced in the forwarded request. @required @param url [String?] The destination URL for the forwarded request. Must be supported by the config. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param request [Stripe::RequestParam?] @return [Stripe::ForwardingRequest]

post_forwarding_requests(*, payment_method : String | Nil = nil, replacements : Array(String) | Nil = nil, url : String | Nil = nil, expand : Array(String) | Nil = nil, request : Stripe::RequestParam | Nil = nil, &block : Crest::Response -> ) : Nil

<p>Creates a ForwardingRequest object.</p> @required @param payment_method [String?] The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. @required @param replacements [Array(String)?] The field kinds to be replaced in the forwarded request. @required @param url [String?] The destination URL for the forwarded request. Must be supported by the config. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param request [Stripe::RequestParam?] @return nil

post_forwarding_requests_with_http_info(*, payment_method : String | Nil = nil, replacements : Array(String) | Nil = nil, url : String | Nil = nil, expand : Array(String) | Nil = nil, request : Stripe::RequestParam | Nil = nil) : Tuple(Stripe::ForwardingRequest, Int32, Hash(String, Array(String) | String))

<p>Creates a ForwardingRequest object.</p> @required @param payment_method [String?] The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed. @required @param replacements [Array(String)?] The field kinds to be replaced in the forwarded request. @required @param url [String?] The destination URL for the forwarded request. Must be supported by the config. @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param request [Stripe::RequestParam?] @return [Tuple(Stripe::ForwardingRequest, Integer, Hash)] Stripe::ForwardingRequest, response status code and response headers