Class: VitableConnect::Models::AuthIssueAccessTokenParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/vitable_connect/models/auth_issue_access_token_params.rb

Overview

See Also:

• Resources::Auth#issue_access_token

Defined Under Namespace

Modules: GrantType Classes: BoundEntity

Instance Attribute Summary

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

  Optional entity to bind the token to for scoped access.

• #grant_type ⇒ Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::GrantType

  • ‘client_credentials` - client_credentials.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(grant_type:, bound_entity: nil, request_options: {}) ⇒ Object constructor

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(grant_type:, bound_entity: nil, request_options: {}) ⇒ Object

Parameters:

• grant_type (Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::GrantType) —

  • ‘client_credentials` - client_credentials

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

  Optional entity to bind the token to for scoped access

• request_options (VitableConnect::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/vitable_connect/models/auth_issue_access_token_params.rb', line 22

Instance Attribute Details

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

Optional entity to bind the token to for scoped access

Returns:

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

# File 'lib/vitable_connect/models/auth_issue_access_token_params.rb', line 20

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

#grant_type ⇒ Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::GrantType

• ‘client_credentials` - client_credentials

Returns:

• (Symbol, VitableConnect::Models::AuthIssueAccessTokenParams::GrantType)

# File 'lib/vitable_connect/models/auth_issue_access_token_params.rb', line 14

required :grant_type, enum: -> { VitableConnect::AuthIssueAccessTokenParams::GrantType }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/vitable_connect/models/auth_issue_access_token_params.rb', line 35