Class: Telnyx::Models::Enterprises::Reputation::RemediationCreateParams

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

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance 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, 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(enterprise_id:, call_purpose:, phone_numbers:, contact_email: nil, webhook_url: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Enterprises::Reputation::RemediationCreateParams for more details.

Parameters:

  • enterprise_id (String)
  • call_purpose (String) —

    How the numbers are used (free text).

  • phone_numbers (Array<String>) —

    Phone numbers in E.164 format. Each must belong to this enterprise. Maximum 2,00

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

    Optional contact email for this remediation request.

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

    Optional https:// URL for status notifications.

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



# File 'lib/telnyx/models/enterprises/reputation/remediation_create_params.rb', line 42

Instance Attribute Details

#call_purpose ⇒ String

How the numbers are used (free text).

Returns:

  • (String) 


21
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_create_params.rb', line 21

required :call_purpose, String

#contact_email ⇒ String?

Optional contact email for this remediation request.

Returns:

  • (String, nil) 


34
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_create_params.rb', line 34

optional :contact_email, String

#enterprise_id ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_create_params.rb', line 15

required :enterprise_id, String

#phone_numbers ⇒ Array<String>

Phone numbers in E.164 format. Each must belong to this enterprise. Maximum 2,000 per request.

Returns:

  • (Array<String>) 


28
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_create_params.rb', line 28

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

#webhook_url ⇒ String?

Optional https:// URL for status notifications.

Returns:

  • (String, nil) 


40
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_create_params.rb', line 40

optional :webhook_url, String