Class: Telnyx::Models::OAuthClientCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/oauth_client_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: AllowedGrantType, ClientType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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, #initialize, 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

This class inherits a constructor from Telnyx::Internal::Type::BaseModel

Instance Attribute Details

#allowed_grant_types ⇒ Array<Symbol, Telnyx::Models::OAuthClientCreateParams::AllowedGrantType>

List of allowed OAuth grant types

Returns:



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

required :allowed_grant_types,
-> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::OAuthClientCreateParams::AllowedGrantType] }

#allowed_scopes ⇒ Array<String>

List of allowed OAuth scopes

Returns:

  • (Array<String>) 


21
 
# File 'lib/telnyx/models/oauth_client_create_params.rb', line 21

required :allowed_scopes, Telnyx::Internal::Type::ArrayOf[String]

#client_type ⇒ Symbol, Telnyx::Models::OAuthClientCreateParams::ClientType

OAuth client type

Returns:



27
 
# File 'lib/telnyx/models/oauth_client_create_params.rb', line 27

required :client_type, enum: -> { Telnyx::OAuthClientCreateParams::ClientType }

#logo_uri ⇒ String?

URL of the client logo

Returns:

  • (String, nil) 


39
 
# File 'lib/telnyx/models/oauth_client_create_params.rb', line 39

optional :logo_uri, String

#name ⇒ String

The name of the OAuth client

Returns:

  • (String) 


33
 
# File 'lib/telnyx/models/oauth_client_create_params.rb', line 33

required :name, String

#policy_uri ⇒ String?

URL of the client’s privacy policy

Returns:

  • (String, nil) 


45
 
# File 'lib/telnyx/models/oauth_client_create_params.rb', line 45

optional :policy_uri, String

#redirect_uris ⇒ Array<String>?

List of redirect URIs (required for authorization_code flow)

Returns:

  • (Array<String>, nil) 


51
 
# File 'lib/telnyx/models/oauth_client_create_params.rb', line 51

optional :redirect_uris, Telnyx::Internal::Type::ArrayOf[String]

#require_pkce ⇒ Boolean?

Whether PKCE (Proof Key for Code Exchange) is required for this client

Returns:

  • (Boolean, nil) 


57
 
# File 'lib/telnyx/models/oauth_client_create_params.rb', line 57

optional :require_pkce, Telnyx::Internal::Type::Boolean

#tos_uri ⇒ String?

URL of the client’s terms of service

Returns:

  • (String, nil) 


63
 
# File 'lib/telnyx/models/oauth_client_create_params.rb', line 63

optional :tos_uri, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/oauth_client_create_params.rb', line 93