Class: Telnyx::Models::Pricing::ProductRetrieveResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Pricing::ProductRetrieveResponse

Defined in:

lib/telnyx/models/pricing/product_retrieve_response.rb,
sig/telnyx/models/pricing/product_retrieve_response.rbs

Overview

See Also:

• Telnyx::Resources::Pricing::Products#retrieve

Defined Under Namespace

Modules: Rate

Instance Attribute Summary

• #cached_input_rate ⇒ String^?

  Cached input token rate.

• #cached_input_tiers ⇒ Array<Telnyx::Models::Pricing::PricingTier>^?

  Cached input token tiered pricing.

• #country_iso ⇒ String^?

  ISO country code.

• #currency ⇒ String^?

  ISO currency code (e.g., USD).

• #direction ⇒ String^?

  Direction (e.g., termination).

• #input_rate ⇒ String^?

  Input token rate.

• #input_tiers ⇒ Array<Telnyx::Models::Pricing::PricingTier>^?

  Input token tiered pricing.

• #model ⇒ String^?

  Model identifier.

• #name ⇒ String^?

  Human-readable name describing the pricing entry.

• #note ⇒ String^?

  Additional note for rate-deck products (e.g., "Pricing is determined by the WhatsApp rate deck.").

• #output_rate ⇒ String^?

  Output token rate.

• #output_tiers ⇒ Array<Telnyx::Models::Pricing::PricingTier>^?

  Output token tiered pricing.

• #pricing_type ⇒ String^?

  Pricing type for non-standard products (e.g., rate_deck).

• #rate ⇒ Float, ...

  Per-unit rate.

• #tiers ⇒ Array<Telnyx::Models::Pricing::PricingTier>^?

  Volume-based tiered pricing.

• #type ⇒ String^?

  Pricing type (e.g., usage).

• #unit ⇒ String^?

  Unit of measurement (e.g., part, message, GB, per_1k_tokens).

Instance Method Summary

• #initialize(cached_input_rate: nil, cached_input_tiers: nil, country_iso: nil, currency: nil, direction: nil, input_rate: nil, input_tiers: nil, model: nil, name: nil, note: nil, output_rate: nil, output_tiers: nil, pricing_type: nil, rate: nil, tiers: nil, type: nil, unit: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

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(cached_input_rate: nil, cached_input_tiers: nil, country_iso: nil, currency: nil, direction: nil, input_rate: nil, input_tiers: nil, model: nil, name: nil, note: nil, output_rate: nil, output_tiers: nil, pricing_type: nil, rate: nil, tiers: nil, type: nil, unit: nil) ⇒ Object

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

A single pricing entry. Standard products include rate, unit, currency, type, country_iso, direction, and tiers. Inference products include model, input_rate, output_rate, cached_input_rate, and their respective tier arrays. Rate-deck products include pricing_type and note fields with null rate and empty tiers.

Parameters:

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

  Cached input token rate. Present only on inference product entries.

• cached_input_tiers (Array<Telnyx::Models::Pricing::PricingTier>) (defaults to: nil) —

  Cached input token tiered pricing. Present only on inference product entries.

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

  ISO country code. Null for non-geographic products.

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

  ISO currency code (e.g., USD).

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

  Direction (e.g., termination). Null for non-directional products.

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

  Input token rate. Present only on inference product entries.

• input_tiers (Array<Telnyx::Models::Pricing::PricingTier>) (defaults to: nil) —

  Input token tiered pricing. Present only on inference product entries.

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

  Model identifier. Present only on inference product entries.

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

  Human-readable name describing the pricing entry.

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

  Additional note for rate-deck products (e.g., "Pricing is determined by the What

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

  Output token rate. Present only on inference product entries.

• output_tiers (Array<Telnyx::Models::Pricing::PricingTier>) (defaults to: nil) —

  Output token tiered pricing. Present only on inference product entries.

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

  Pricing type for non-standard products (e.g., rate_deck). Absent on standard pro

• rate (Float, String, nil) (defaults to: nil) —

  Per-unit rate. Numeric for standard products, string for inference products. Nul

• tiers (Array<Telnyx::Models::Pricing::PricingTier>) (defaults to: nil) —

  Volume-based tiered pricing. Empty for rate-deck products.

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

  Pricing type (e.g., usage).

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

  Unit of measurement (e.g., part, message, GB, per_1k_tokens).

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 113

Instance Attribute Details

#cached_input_rate ⇒ String^?

Cached input token rate. Present only on inference product entries.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 12

optional :cached_input_rate, String

#cached_input_tiers ⇒ Array<Telnyx::Models::Pricing::PricingTier>^?

Cached input token tiered pricing. Present only on inference product entries.

Returns:

• (Array<Telnyx::Models::Pricing::PricingTier>, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 18

optional :cached_input_tiers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Pricing::PricingTier] }

#country_iso ⇒ String^?

ISO country code. Null for non-geographic products.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 24

optional :country_iso, String, nil?: true

#currency ⇒ String^?

ISO currency code (e.g., USD).

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 30

optional :currency, String

#direction ⇒ String^?

Direction (e.g., termination). Null for non-directional products.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 36

optional :direction, String, nil?: true

#input_rate ⇒ String^?

Input token rate. Present only on inference product entries.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 42

optional :input_rate, String

#input_tiers ⇒ Array<Telnyx::Models::Pricing::PricingTier>^?

Input token tiered pricing. Present only on inference product entries.

Returns:

• (Array<Telnyx::Models::Pricing::PricingTier>, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 48

optional :input_tiers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Pricing::PricingTier] }

#model ⇒ String^?

Model identifier. Present only on inference product entries.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 54

optional :model, String

#name ⇒ String^?

Human-readable name describing the pricing entry.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :name, String

#note ⇒ String^?

Additional note for rate-deck products (e.g., "Pricing is determined by the WhatsApp rate deck.").

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 67

optional :note, String, nil?: true

#output_rate ⇒ String^?

Output token rate. Present only on inference product entries.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 73

optional :output_rate, String

#output_tiers ⇒ Array<Telnyx::Models::Pricing::PricingTier>^?

Output token tiered pricing. Present only on inference product entries.

Returns:

• (Array<Telnyx::Models::Pricing::PricingTier>, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 79

optional :output_tiers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Pricing::PricingTier] }

#pricing_type ⇒ String^?

Pricing type for non-standard products (e.g., rate_deck). Absent on standard products.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 86

optional :pricing_type, String, nil?: true

#rate ⇒ Float, ...

Per-unit rate. Numeric for standard products, string for inference products. Null for rate-deck products.

Parameters:

• value (Telnyx::Models::Pricing::ProductRetrieveResponse::rate, nil)

Returns:

• (Float, String, nil)

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

optional :rate, union: -> { Telnyx::Models::Pricing::ProductRetrieveResponse::Rate }, nil?: true

#tiers ⇒ Array<Telnyx::Models::Pricing::PricingTier>^?

Volume-based tiered pricing. Empty for rate-deck products.

Returns:

• (Array<Telnyx::Models::Pricing::PricingTier>, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 99

optional :tiers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Pricing::PricingTier] }

#type ⇒ String^?

Pricing type (e.g., usage).

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 105

optional :type, String

#unit ⇒ String^?

Unit of measurement (e.g., part, message, GB, per_1k_tokens).

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/pricing/product_retrieve_response.rb', line 111

optional :unit, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/pricing/product_retrieve_response.rbs', line 112

def to_hash: -> {