class

Stripe::AccountSession

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components. We recommend that you create an AccountSession each time you need to display an embedded component to your user. Do not save AccountSessions to your database as they expire relatively quickly, and cannot be used more than once. Related guide: Connect embedded components

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [account_session]."
MAX_LENGTH_FOR_ACCOUNT = 5000
MAX_LENGTH_FOR_CLIENT_SECRET = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("account_session")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, account : String | Nil = nil, client_secret : String | Nil = nil, components : Stripe::ConnectEmbeddedAccountSessionCreateComponents | Nil = nil, expires_at : Int64 | Nil = nil, livemode : Bool | Nil = nil, object : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

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

account

The ID of the account the AccountSession was created for

Source
account=(new_value : String | Nil)

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

Source
client_secret

The client secret of this AccountSession. Used on the client to set up secure access to the given account. The client secret can be used to provide access to account from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs to setup Connect embedded components and learn about how client_secret should be handled.

Source
client_secret=(new_value : String | Nil)

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

Source
components
Source
components=(new_value : Stripe::ConnectEmbeddedAccountSessionCreateComponents | Nil)

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

Source
expires_at

The timestamp at which this AccountSession will expire.

Source
expires_at=(new_value : Int64 | Nil)

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

Source
hash(hasher)

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

list_invalid_properties

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

Source
livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source
livemode=(new_value : Bool | Nil)

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

Source
object

String representing the object's type. Objects of the same type share the same value.

Source
object=(new_value : String | Nil)

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

Source
valid?

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

Source