Class: Telnyx::Models::IntegrationSecretCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/integration_secret_create_params.rb

Overview

See Also:

• Resources::IntegrationSecrets#create

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #identifier ⇒ String

  The unique identifier of the secret.

• #password ⇒ String^?

  The password for the secret.

• #token ⇒ String^?

  The token for the secret.

• #type ⇒ Symbol, Telnyx::Models::IntegrationSecretCreateParams::Type

  The type of secret.

• #username ⇒ String^?

  The username for the secret.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(identifier:, type:, token: nil, password: nil, username: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see IntegrationSecretCreateParams for more details.

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(identifier:, type:, token: nil, password: nil, username: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::IntegrationSecretCreateParams for more details.

Parameters:

• identifier (String) —

  The unique identifier of the secret.

• type (Symbol, Telnyx::Models::IntegrationSecretCreateParams::Type) —

  The type of secret.

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

  The token for the secret. Required for bearer type secrets, ignored otherwise.

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

  The password for the secret. Required for basic type secrets, ignored otherwise.

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

  The username for the secret. Required for basic type secrets, ignored otherwise.

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

# File 'lib/telnyx/models/integration_secret_create_params.rb', line 40

Instance Attribute Details

#identifier ⇒ String

The unique identifier of the secret.

Returns:

• (String)

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

required :identifier, String

#password ⇒ String^?

The password for the secret. Required for basic type secrets, ignored otherwise.

Returns:

• (String, nil)

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

optional :password, String

#token ⇒ String^?

The token for the secret. Required for bearer type secrets, ignored otherwise.

Returns:

• (String, nil)

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

optional :token, String

#type ⇒ Symbol, Telnyx::Models::IntegrationSecretCreateParams::Type

The type of secret.

Returns:

• (Symbol, Telnyx::Models::IntegrationSecretCreateParams::Type)

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

required :type, enum: -> { Telnyx::IntegrationSecretCreateParams::Type }

#username ⇒ String^?

The username for the secret. Required for basic type secrets, ignored otherwise.

Returns:

• (String, nil)

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

optional :username, String