Class: Telnyx::Models::OAuthClient

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/oauth_client.rb

Overview

See Also:

Defined Under Namespace

Modules: AllowedGrantType, ClientType, RecordType

Instance Attribute Summary collapse

Class Method 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(client_id:, client_type:, created_at:, name:, org_id:, record_type:, require_pkce:, updated_at:, user_id:, allowed_grant_types: nil, allowed_scopes: nil, client_secret: nil, logo_uri: nil, policy_uri: nil, redirect_uris: nil, tos_uri: nil) ⇒ Object

Parameters:

  • client_id (String) —

    OAuth client identifier

  • client_type (Symbol, Telnyx::Models::OAuthClient::ClientType) —

    OAuth client type

  • created_at (Time) —

    Timestamp when the client was created

  • name (String) —

    Human-readable name for the OAuth client

  • org_id (String) —

    Organization ID that owns this OAuth client

  • record_type (Symbol, Telnyx::Models::OAuthClient::RecordType) —

    Record type identifier

  • require_pkce (Boolean) —

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

  • updated_at (Time) —

    Timestamp when the client was last updated

  • user_id (String) —

    User ID that created this OAuth client

  • allowed_grant_types (Array<Symbol, Telnyx::Models::OAuthClient::AllowedGrantType>) (defaults to: nil) —

    List of allowed OAuth grant types

  • allowed_scopes (Array<String>) (defaults to: nil) —

    List of allowed OAuth scopes

  • client_secret (String, nil) (defaults to: nil) —

    Client secret (only included when available, for confidential clients)

  • logo_uri (String, nil) (defaults to: nil) —

    URL of the client logo

  • policy_uri (String, nil) (defaults to: nil) —

    URL of the client’s privacy policy

  • redirect_uris (Array<String>) (defaults to: nil) —

    List of allowed redirect URIs

  • tos_uri (String, nil) (defaults to: nil) —

    URL of the client’s terms of service




# File 'lib/telnyx/models/oauth_client.rb', line 104

Instance Attribute Details

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

List of allowed OAuth grant types

Returns:



65
66
 
# File 'lib/telnyx/models/oauth_client.rb', line 65

optional :allowed_grant_types,
-> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::OAuthClient::AllowedGrantType] }

#allowed_scopes ⇒ Array<String>?

List of allowed OAuth scopes

Returns:

  • (Array<String>, nil) 


72
 
# File 'lib/telnyx/models/oauth_client.rb', line 72

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

#client_id ⇒ String

OAuth client identifier

Returns:

  • (String) 


11
 
# File 'lib/telnyx/models/oauth_client.rb', line 11

required :client_id, String

#client_secret ⇒ String?

Client secret (only included when available, for confidential clients)

Returns:

  • (String, nil) 


78
 
# File 'lib/telnyx/models/oauth_client.rb', line 78

optional :client_secret, String, nil?: true

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

OAuth client type

Returns:



17
 
# File 'lib/telnyx/models/oauth_client.rb', line 17

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

#created_at ⇒ Time

Timestamp when the client was created

Returns:

  • (Time) 


23
 
# File 'lib/telnyx/models/oauth_client.rb', line 23

required :created_at, Time

#logo_uri ⇒ String?

URL of the client logo

Returns:

  • (String, nil) 


84
 
# File 'lib/telnyx/models/oauth_client.rb', line 84

optional :logo_uri, String, nil?: true

#name ⇒ String

Human-readable name for the OAuth client

Returns:

  • (String) 


29
 
# File 'lib/telnyx/models/oauth_client.rb', line 29

required :name, String

#org_id ⇒ String

Organization ID that owns this OAuth client

Returns:

  • (String) 


35
 
# File 'lib/telnyx/models/oauth_client.rb', line 35

required :org_id, String

#policy_uri ⇒ String?

URL of the client’s privacy policy

Returns:

  • (String, nil) 


90
 
# File 'lib/telnyx/models/oauth_client.rb', line 90

optional :policy_uri, String, nil?: true

#record_type ⇒ Symbol, Telnyx::Models::OAuthClient::RecordType

Record type identifier

Returns:



41
 
# File 'lib/telnyx/models/oauth_client.rb', line 41

required :record_type, enum: -> { Telnyx::OAuthClient::RecordType }

#redirect_uris ⇒ Array<String>?

List of allowed redirect URIs

Returns:

  • (Array<String>, nil) 


96
 
# File 'lib/telnyx/models/oauth_client.rb', line 96

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) 


47
 
# File 'lib/telnyx/models/oauth_client.rb', line 47

required :require_pkce, Telnyx::Internal::Type::Boolean

#tos_uri ⇒ String?

URL of the client’s terms of service

Returns:

  • (String, nil) 


102
 
# File 'lib/telnyx/models/oauth_client.rb', line 102

optional :tos_uri, String, nil?: true

#updated_at ⇒ Time

Timestamp when the client was last updated

Returns:

  • (Time) 


53
 
# File 'lib/telnyx/models/oauth_client.rb', line 53

required :updated_at, Time

#user_id ⇒ String

User ID that created this OAuth client

Returns:

  • (String) 


59
 
# File 'lib/telnyx/models/oauth_client.rb', line 59

required :user_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/oauth_client.rb', line 146