Class: Telnyx::Models::OAuthRetrieveAuthorizeParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::OAuthRetrieveAuthorizeParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/oauth_retrieve_authorize_params.rb

Overview

See Also:

• Resources::OAuth#retrieve_authorize

Defined Under Namespace

Modules: CodeChallengeMethod, ResponseType

Instance Attribute Summary

• #client_id ⇒ String

  OAuth client identifier.

• #code_challenge ⇒ String^?

  PKCE code challenge.

• #code_challenge_method ⇒ Symbol, ...

  PKCE code challenge method.

• #redirect_uri ⇒ String

  Redirect URI.

• #response_type ⇒ Symbol, Telnyx::Models::OAuthRetrieveAuthorizeParams::ResponseType

  OAuth response type.

• #scope ⇒ String^?

  Space-separated list of requested scopes.

• #state ⇒ String^?

  State parameter for CSRF protection.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(client_id:, redirect_uri:, response_type:, code_challenge: nil, code_challenge_method: nil, scope: nil, state: 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(client_id:, redirect_uri:, response_type:, code_challenge: nil, code_challenge_method: nil, scope: nil, state: nil, request_options: {}) ⇒ Object

Parameters:

• client_id (String) —

  OAuth client identifier

• redirect_uri (String) —

  Redirect URI

• response_type (Symbol, Telnyx::Models::OAuthRetrieveAuthorizeParams::ResponseType) —

  OAuth response type

• code_challenge (String) (defaults to: nil) —

  PKCE code challenge

• code_challenge_method (Symbol, Telnyx::Models::OAuthRetrieveAuthorizeParams::CodeChallengeMethod) (defaults to: nil) —

  PKCE code challenge method

• scope (String) (defaults to: nil) —

  Space-separated list of requested scopes

• state (String) (defaults to: nil) —

  State parameter for CSRF protection

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

# File 'lib/telnyx/models/oauth_retrieve_authorize_params.rb', line 52

Instance Attribute Details

#client_id ⇒ String

OAuth client identifier

Returns:

• (String)

# File 'lib/telnyx/models/oauth_retrieve_authorize_params.rb', line 14

required :client_id, String

#code_challenge ⇒ String^?

PKCE code challenge

Returns:

• (String, nil)

# File 'lib/telnyx/models/oauth_retrieve_authorize_params.rb', line 32

optional :code_challenge, String

#code_challenge_method ⇒ Symbol, ...

PKCE code challenge method

Returns:

• (Symbol, Telnyx::Models::OAuthRetrieveAuthorizeParams::CodeChallengeMethod, nil)

# File 'lib/telnyx/models/oauth_retrieve_authorize_params.rb', line 38

optional :code_challenge_method, enum: -> { Telnyx::OAuthRetrieveAuthorizeParams::CodeChallengeMethod }

#redirect_uri ⇒ String

Redirect URI

Returns:

• (String)

# File 'lib/telnyx/models/oauth_retrieve_authorize_params.rb', line 20

required :redirect_uri, String

#response_type ⇒ Symbol, Telnyx::Models::OAuthRetrieveAuthorizeParams::ResponseType

OAuth response type

Returns:

• (Symbol, Telnyx::Models::OAuthRetrieveAuthorizeParams::ResponseType)

# File 'lib/telnyx/models/oauth_retrieve_authorize_params.rb', line 26

required :response_type, enum: -> { Telnyx::OAuthRetrieveAuthorizeParams::ResponseType }

#scope ⇒ String^?

Space-separated list of requested scopes

Returns:

• (String, nil)

# File 'lib/telnyx/models/oauth_retrieve_authorize_params.rb', line 44

optional :scope, String

#state ⇒ String^?

State parameter for CSRF protection

Returns:

• (String, nil)

# File 'lib/telnyx/models/oauth_retrieve_authorize_params.rb', line 50

optional :state, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/oauth_retrieve_authorize_params.rb', line 75