Class: VitableConnect::Models::AuthIssueAccessTokenResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• VitableConnect::Models::AuthIssueAccessTokenResponse

Defined in:

lib/vitable_connect/models/auth_issue_access_token_response.rb

Overview

See Also:

• Resources::Auth#issue_access_token

Defined Under Namespace

Classes: BoundEntity

Instance Attribute Summary

• #access_token ⇒ String

  The issued access token (vit*at**).

• #bound_entity ⇒ VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity^?

  Entity the token is bound to, if any.

• #expires_in ⇒ Integer

  Token lifetime in seconds.

• #token_type ⇒ String

  Token type, always ‘Bearer’.

Instance Method Summary

• #initialize(access_token:, expires_in:, token_type:, bound_entity: nil) ⇒ Object constructor

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_in:, token_type:, bound_entity: nil) ⇒ Object

Parameters:

• access_token (String) —

  The issued access token (vit*at**)

• expires_in (Integer) —

  Token lifetime in seconds

• token_type (String) —

  Token type, always ‘Bearer’

• bound_entity (VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity, nil) (defaults to: nil) —

  Entity the token is bound to, if any

# File 'lib/vitable_connect/models/auth_issue_access_token_response.rb', line 33

Instance Attribute Details

#access_token ⇒ String

The issued access token (vit*at**)

Returns:

• (String)

# File 'lib/vitable_connect/models/auth_issue_access_token_response.rb', line 11

required :access_token, String

#bound_entity ⇒ VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity^?

Entity the token is bound to, if any

Returns:

• (VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity, nil)

# File 'lib/vitable_connect/models/auth_issue_access_token_response.rb', line 29

optional :bound_entity,
-> { VitableConnect::Models::AuthIssueAccessTokenResponse::BoundEntity },
nil?: true

#expires_in ⇒ Integer

Token lifetime in seconds

Returns:

• (Integer)

# File 'lib/vitable_connect/models/auth_issue_access_token_response.rb', line 17

required :expires_in, Integer

#token_type ⇒ String

Token type, always ‘Bearer’

Returns:

• (String)

# File 'lib/vitable_connect/models/auth_issue_access_token_response.rb', line 23

required :token_type, String