Class: Telnyx::Models::TrafficPolicyProfileCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/traffic_policy_profile_create_params.rb

Overview

See Also:

• Resources::TrafficPolicyProfiles#create

Defined Under Namespace

Modules: LimitBwKbps, Type

Instance Attribute Summary

• #domains ⇒ Array<String>^?

  Array of domain names.

• #ip_ranges ⇒ Array<String>^?

  Array of IP ranges in CIDR notation.

• #limit_bw_kbps ⇒ Integer, ...

  Bandwidth limit in kbps.

• #services ⇒ Array<String>^?

  Array of PCEF service IDs to include in the profile.

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

  The type of the traffic policy profile.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(type:, domains: nil, ip_ranges: nil, limit_bw_kbps: nil, services: 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(type:, domains: nil, ip_ranges: nil, limit_bw_kbps: nil, services: nil, request_options: {}) ⇒ Object

Parameters:

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

  The type of the traffic policy profile.

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

  Array of domain names.

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

  Array of IP ranges in CIDR notation.

• limit_bw_kbps (Integer, Telnyx::Models::TrafficPolicyProfileCreateParams::LimitBwKbps) (defaults to: nil) —

  Bandwidth limit in kbps. Must be 512 or 1024.

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

  Array of PCEF service IDs to include in the profile.

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

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

Instance Attribute Details

#domains ⇒ Array<String>^?

Array of domain names.

Returns:

• (Array<String>, nil)

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

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

#ip_ranges ⇒ Array<String>^?

Array of IP ranges in CIDR notation.

Returns:

• (Array<String>, nil)

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

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

#limit_bw_kbps ⇒ Integer, ...

Bandwidth limit in kbps. Must be 512 or 1024.

Returns:

• (Integer, Telnyx::Models::TrafficPolicyProfileCreateParams::LimitBwKbps, nil)

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

optional :limit_bw_kbps, enum: -> { Telnyx::TrafficPolicyProfileCreateParams::LimitBwKbps }

#services ⇒ Array<String>^?

Array of PCEF service IDs to include in the profile.

Returns:

• (Array<String>, nil)

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

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

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

The type of the traffic policy profile.

Returns:

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

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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/traffic_policy_profile_create_params.rb', line 60