Class: SafetyKit::Models::AccessTokenCreateAccessTokenResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/safety_kit/models/access_token_create_access_token_response.rb,
sig/safety_kit/models/access_token_create_access_token_response.rbs

Overview

See Also:

  • SafetyKit::Resources::AccessTokens#create_access_token

Defined Under Namespace

Modules: TokenType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(access_token:, expires_at:, expires_in:, token_type:) ⇒ Object

Some parameter documentations has been truncated, see SafetyKit::Models::AccessTokenCreateAccessTokenResponse for more details.

Response containing the newly created short-lived access token.

Parameters:

  • access_token (String) —

    Short-lived bearer token. Use it in the Authorization header exactly like a long

  • expires_at (Time) —

    ISO 8601 timestamp at which the access token expires.

  • expires_in (Integer) —

    Number of seconds until the access token expires.

  • token_type (Symbol, SafetyKit::Models::AccessTokenCreateAccessTokenResponse::TokenType) —

    Token type. Always Bearer.




# File 'lib/safety_kit/models/access_token_create_access_token_response.rb', line 32

Instance Attribute Details

#access_token ⇒ String

Short-lived bearer token. Use it in the Authorization header exactly like a long-lived API key. It cannot be used to create additional access tokens.

Parameters:

  • value (String)

Returns:

  • (String) 


12
 
# File 'lib/safety_kit/models/access_token_create_access_token_response.rb', line 12

required :access_token, String

#expires_at ⇒ Time

ISO 8601 timestamp at which the access token expires.

Parameters:

  • value (Time)

Returns:

  • (Time) 


18
 
# File 'lib/safety_kit/models/access_token_create_access_token_response.rb', line 18

required :expires_at, Time

#expires_in ⇒ Integer

Number of seconds until the access token expires.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


24
 
# File 'lib/safety_kit/models/access_token_create_access_token_response.rb', line 24

required :expires_in, Integer

#token_type ⇒ Symbol, SafetyKit::Models::AccessTokenCreateAccessTokenResponse::TokenType

Token type. Always Bearer.

Parameters:

  • value (SafetyKit::Models::AccessTokenCreateAccessTokenResponse::token_type)

Returns:



30
 
# File 'lib/safety_kit/models/access_token_create_access_token_response.rb', line 30

required :token_type, enum: -> { SafetyKit::Models::AccessTokenCreateAccessTokenResponse::TokenType }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


27
 
# File 'sig/safety_kit/models/access_token_create_access_token_response.rbs', line 27

def to_hash: -> {