Class: Stigg::Models::V1::CustomerRetrieveEntitlementsResponse::Data::Entitlement::Credit::Currency

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/stigg/models/v1/customer_retrieve_entitlements_response.rb

Overview

See Also:

Instance Attribute 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(currency_id:, display_name:, description: nil, metadata: nil, unit_plural: nil, unit_singular: nil) ⇒ Object

The currency associated with a credit entitlement.

Parameters:

  • currency_id (String) —

    The unique identifier of the custom currency.

  • display_name (String) —

    The display name of the currency.

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

    A description of the currency.

  • metadata (Hash{Symbol=>String}, nil) (defaults to: nil) —

    Additional metadata associated with the currency.

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

    The plural form of the currency unit.

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

    The singular form of the currency unit.




# File 'lib/stigg/models/v1/customer_retrieve_entitlements_response.rb', line 428

Instance Attribute Details

#currency_id ⇒ String

The unique identifier of the custom currency.

Returns:

  • (String) 


396
 
# File 'lib/stigg/models/v1/customer_retrieve_entitlements_response.rb', line 396

required :currency_id, String, api_name: :currencyId

#description ⇒ String?

A description of the currency.

Returns:

  • (String, nil) 


408
 
# File 'lib/stigg/models/v1/customer_retrieve_entitlements_response.rb', line 408

optional :description, String, nil?: true

#display_name ⇒ String

The display name of the currency.

Returns:

  • (String) 


402
 
# File 'lib/stigg/models/v1/customer_retrieve_entitlements_response.rb', line 402

required :display_name, String, api_name: :displayName

#metadata ⇒ Hash{Symbol=>String}?

Additional metadata associated with the currency.

Returns:

  • (Hash{Symbol=>String}, nil) 


414
 
# File 'lib/stigg/models/v1/customer_retrieve_entitlements_response.rb', line 414

optional :metadata, Stigg::Internal::Type::HashOf[String], nil?: true

#unit_plural ⇒ String?

The plural form of the currency unit.

Returns:

  • (String, nil) 


420
 
# File 'lib/stigg/models/v1/customer_retrieve_entitlements_response.rb', line 420

optional :unit_plural, String, api_name: :unitPlural, nil?: true

#unit_singular ⇒ String?

The singular form of the currency unit.

Returns:

  • (String, nil) 


426
 
# File 'lib/stigg/models/v1/customer_retrieve_entitlements_response.rb', line 426

optional :unit_singular, String, api_name: :unitSingular, nil?: true