class Stripe::AppsSecret

• Stripe::AppsSecret
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

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(*, 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 Method Summary

• #==(other : self)

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

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #deleted : Bool | Nil
• #deleted=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #expires_at : Int64 | Nil
• #expires_at=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

• #name : String | Nil
• #name=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payload : String | Nil
• #payload=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #payload_present=(payload_present : Bool)
• #payload_present? : Bool
• #scope : Stripe::SecretServiceResourceScope | Nil
• #scope=(new_value : Stripe::SecretServiceResourceScope | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail