class Stripe::SetupAttempt

Overview

A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

Included Modules

Defined in:

stripe/models/setup_attempt.cr

Constant Summary

ERROR_MESSAGE_FOR_FLOW_DIRECTIONS = "invalid value for \"flow_directions\", must be one of [inbound, outbound]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [setup_attempt]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_STATUS = 5000
MAX_LENGTH_FOR_USAGE = 5000
VALID_VALUES_FOR_FLOW_DIRECTIONS = String.static_array("inbound", "outbound")
VALID_VALUES_FOR_OBJECT = String.static_array("setup_attempt")

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(*, application : Stripe::SetupAttemptApplication | Nil = nil, created : Int64 | Nil = nil, customer : Stripe::SetupAttemptCustomer | Nil = nil, flow_directions : Array(String) | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil, on_behalf_of : Stripe::SetupAttemptOnBehalfOf | Nil = nil, payment_method : Stripe::SetupAttemptPaymentMethod | Nil = nil, payment_method_details : Stripe::SetupAttemptPaymentMethodDetails | Nil = nil, setup_error : Stripe::SetupAttemptSetupError | Nil = nil, setup_intent : Stripe::SetupAttemptSetupIntent | Nil = nil, status : String | Nil = nil, usage : String | Nil = nil, attach_to_self : Bool | 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 application : Stripe::SetupAttemptApplication | Nil #

[View source]
def application=(new_value : Stripe::SetupAttemptApplication | Nil) #

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


[View source]
def attach_to_self : Bool | Nil #

[View source]
def attach_to_self=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] attach_to_self 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 customer : Stripe::SetupAttemptCustomer | Nil #

[View source]
def customer=(new_value : Stripe::SetupAttemptCustomer | Nil) #

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


[View source]
def flow_directions : Array(String) | Nil #

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

Custom attribute writer method checking allowed values (enum). @param [Object] flow_directions 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 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 livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[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 on_behalf_of : Stripe::SetupAttemptOnBehalfOf | Nil #

[View source]
def on_behalf_of=(new_value : Stripe::SetupAttemptOnBehalfOf | Nil) #

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


[View source]
def payment_method : Stripe::SetupAttemptPaymentMethod | Nil #

[View source]
def payment_method=(new_value : Stripe::SetupAttemptPaymentMethod | Nil) #

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


[View source]
def payment_method_details : Stripe::SetupAttemptPaymentMethodDetails | Nil #

[View source]
def payment_method_details=(new_value : Stripe::SetupAttemptPaymentMethodDetails | Nil) #

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


[View source]
def setup_error : Stripe::SetupAttemptSetupError | Nil #

[View source]
def setup_error=(new_value : Stripe::SetupAttemptSetupError | Nil) #

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


[View source]
def setup_intent : Stripe::SetupAttemptSetupIntent | Nil #

[View source]
def setup_intent=(new_value : Stripe::SetupAttemptSetupIntent | Nil) #

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


[View source]
def status : String | Nil #

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

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


[View source]
def usage : String | Nil #

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

Custom attribute writer method checking allowed values (enum). @param [Object] usage 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]