class

Stripe::AppsSecret

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

Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends. The primary resource in Secret Store is a secret. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control. All Dashboard users and the app backend share account scoped secrets. Use the account scope for secrets that don't change per-user, like a third-party API key. A user scoped secret is accessible by the app backend and one specific Dashboard user. Use the user scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions. Related guide: Store data between page reloads

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [apps.secret]."

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_NAME = 5000

MAX_LENGTH_FOR_PAYLOAD = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("apps.secret")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, created : Int64 | Nil = nil, expires_at : Int64 | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, name : String | Nil = nil, object : String | Nil = nil, scope : Stripe::SecretServiceResourceScope | Nil = nil, deleted : Bool | Nil = nil, payload : String | Nil = nil)

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

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

created

Time at which the object was created. Measured in seconds since the Unix epoch.

created=(new_value : Int64 | Nil)

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

deleted

If true, indicates that this secret has been deleted

deleted=(new_value : Bool | Nil)

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

expires_at

The Unix timestamp for the expiry time of the secret, after which the secret deletes.

expires_at=(new_value : Int64 | Nil)

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

hash(hasher)

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

id

Unique identifier for the object.

id=(new_value : String | Nil)

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

list_invalid_properties

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

livemode

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

livemode=(new_value : Bool | Nil)

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

name

A name for the secret that's unique within the scope.

name=(new_value : String | Nil)

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

object

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

object=(new_value : String | Nil)

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

payload

The plaintext secret value to be stored.

payload=(new_value : String | Nil)

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

payload_present=(payload_present : Bool)

payload_present?

scope

scope=(new_value : Stripe::SecretServiceResourceScope | Nil)

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

valid?

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