class Stripe::AppsApi

Defined in:

stripe/api/apps_api.cr

Constant Summary

GET_APPS_SECRETS_FIND_MAX_LENGTH_FOR_NAME = 5000
GET_APPS_SECRETS_MAX_LENGTH_FOR_ENDING_BEFORE = 5000
GET_APPS_SECRETS_MAX_LENGTH_FOR_STARTING_AFTER = 5000
POST_APPS_SECRETS_DELETE_MAX_LENGTH_FOR_NAME = 5000
POST_APPS_SECRETS_MAX_LENGTH_FOR_NAME = 5000
POST_APPS_SECRETS_MAX_LENGTH_FOR_PAYLOAD = 5000

Constructors

Instance Method Summary

Constructor Detail

def self.new(api_client : Stripe::ApiClient = ApiClient.default) #

[View source]

Instance Method Detail

def api_client : ApiClient #

[View source]
def api_client=(api_client : ApiClient) #

[View source]
def build_api_request_for_get_apps_secrets(*, scope : Stripe::ScopeParam | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_get_apps_secrets_find(*, name : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_apps_secrets(*, name : String | Nil = nil, payload : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def build_api_request_for_post_apps_secrets_delete(*, name : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(String) | Nil = nil) : Crest::Request #

@return Crest::Request


[View source]
def client_side_validation?(*args, **options) #

[View source]
def client_side_validation?(*args, **options, &) #

[View source]
def debugging?(*args, **options) #

[View source]
def debugging?(*args, **options, &) #

[View source]
def get_apps_secrets(*, scope : Stripe::ScopeParam | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::SecretServiceResourceSecretList #

List all secrets stored on the given scope.

@required @param scope [Stripe::ScopeParam?] Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. @optional @param ending_before [String?] A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. @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 expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::SecretServiceResourceSecretList]

[View source]
def get_apps_secrets(*, scope : Stripe::ScopeParam | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>List all secrets stored on the given scope.</p> @required @param scope [Stripe::ScopeParam?] Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @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 expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_apps_secrets_find(*, name : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Stripe::AppsSecret #

Finds a secret in the secret store by name and scope.

@required @param name [String?] A name for the secret that's unique within the scope. @required @param scope [Stripe::ScopeParam?] Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Stripe::AppsSecret]

[View source]
def get_apps_secrets_find(*, name : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(Array(String)) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Finds a secret in the secret store by name and scope.</p> @required @param name [String?] A name for the secret that's unique within the scope. @required @param scope [Stripe::ScopeParam?] Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return nil


[View source]
def get_apps_secrets_find_with_http_info(*, name : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::AppsSecret, Int32, Hash(String, Array(String) | String)) #

<p>Finds a secret in the secret store by name and scope.</p> @required @param name [String?] A name for the secret that's unique within the scope. @required @param scope [Stripe::ScopeParam?] Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. @optional @param expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::AppsSecret, Integer, Hash)] Stripe::AppsSecret, response status code and response headers


[View source]
def get_apps_secrets_with_http_info(*, scope : Stripe::ScopeParam | Nil = nil, ending_before : String | Nil = nil, starting_after : String | Nil = nil, limit : Int64 | Nil = nil, expand : Array(Array(String)) | Nil = nil) : Tuple(Stripe::SecretServiceResourceSecretList, Int32, Hash(String, Array(String) | String)) #

<p>List all secrets stored on the given scope.</p> @required @param scope [Stripe::ScopeParam?] Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user. @optional @param ending_before [String?] A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list. @optional @param starting_after [String?] A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list. @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 expand [Array(Array(String))?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::SecretServiceResourceSecretList, Integer, Hash)] Stripe::SecretServiceResourceSecretList, response status code and response headers


[View source]
def post_apps_secrets(*, name : String | Nil = nil, payload : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil) : Stripe::AppsSecret #

Create or replace a secret in the secret store.

@required @param name [String?] A name for the secret that's unique within the scope. @required @param payload [String?] The plaintext secret value to be stored. @required @param scope [Stripe::ScopeParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] The Unix timestamp for the expiry time of the secret, after which the secret deletes. @return [Stripe::AppsSecret]

[View source]
def post_apps_secrets(*, name : String | Nil = nil, payload : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Create or replace a secret in the secret store.</p> @required @param name [String?] A name for the secret that's unique within the scope. @required @param payload [String?] The plaintext secret value to be stored. @required @param scope [Stripe::ScopeParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] The Unix timestamp for the expiry time of the secret, after which the secret deletes. @return nil


[View source]
def post_apps_secrets_delete(*, name : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(String) | Nil = nil) : Stripe::AppsSecret #

Deletes a secret from the secret store by name and scope.

@required @param name [String?] A name for the secret that's unique within the scope. @required @param scope [Stripe::ScopeParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Stripe::AppsSecret]

[View source]
def post_apps_secrets_delete(*, name : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(String) | Nil = nil, &block : Crest::Response -> ) : Nil #

<p>Deletes a secret from the secret store by name and scope.</p> @required @param name [String?] A name for the secret that's unique within the scope. @required @param scope [Stripe::ScopeParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return nil


[View source]
def post_apps_secrets_delete_with_http_info(*, name : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(String) | Nil = nil) : Tuple(Stripe::AppsSecret, Int32, Hash(String, Array(String) | String)) #

<p>Deletes a secret from the secret store by name and scope.</p> @required @param name [String?] A name for the secret that's unique within the scope. @required @param scope [Stripe::ScopeParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @return [Tuple(Stripe::AppsSecret, Integer, Hash)] Stripe::AppsSecret, response status code and response headers


[View source]
def post_apps_secrets_with_http_info(*, name : String | Nil = nil, payload : String | Nil = nil, scope : Stripe::ScopeParam | Nil = nil, expand : Array(String) | Nil = nil, expires_at : Int64 | Nil = nil) : Tuple(Stripe::AppsSecret, Int32, Hash(String, Array(String) | String)) #

<p>Create or replace a secret in the secret store.</p> @required @param name [String?] A name for the secret that's unique within the scope. @required @param payload [String?] The plaintext secret value to be stored. @required @param scope [Stripe::ScopeParam?] @optional @param expand [Array(String)?] Specifies which fields in the response should be expanded. @optional @param expires_at [Int32?] The Unix timestamp for the expiry time of the secret, after which the secret deletes. @return [Tuple(Stripe::AppsSecret, Integer, Hash)] Stripe::AppsSecret, response status code and response headers


[View source]