Class: Stigg::Models::V1::Credits::CustomCurrencyCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::Credits::CustomCurrencyCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/stigg/models/v1/credits/custom_currency_create_params.rb

Overview

See Also:

• Resources::V1::Credits::CustomCurrencies#create

Defined Under Namespace

Classes: Units

Instance Attribute Summary

• #description ⇒ String^?

  Description of the currency.

• #display_name ⇒ String

  The display name of the custom currency.

• #id ⇒ String

  The unique identifier for the new custom currency.

• #metadata ⇒ Hash{Symbol=>String}^?

  Additional metadata to attach to the custom currency.

• #symbol ⇒ String^?

  The symbol used to represent the custom currency.

• #units ⇒ Stigg::Models::V1::Credits::CustomCurrencyCreateParams::Units^?

  Singular and plural unit labels for a custom currency.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from Stigg::Internal::Type::BaseModel

Instance Attribute Details

#description ⇒ String^?

Description of the currency

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/credits/custom_currency_create_params.rb', line 28

optional :description, String

#display_name ⇒ String

The display name of the custom currency

Returns:

• (String)

# File 'lib/stigg/models/v1/credits/custom_currency_create_params.rb', line 22

required :display_name, String, api_name: :displayName

#id ⇒ String

The unique identifier for the new custom currency

Returns:

• (String)

# File 'lib/stigg/models/v1/credits/custom_currency_create_params.rb', line 16

required :id, String

#metadata ⇒ Hash{Symbol=>String}^?

Additional metadata to attach to the custom currency

Returns:

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

# File 'lib/stigg/models/v1/credits/custom_currency_create_params.rb', line 34

optional :metadata, Stigg::Internal::Type::HashOf[String]

#symbol ⇒ String^?

The symbol used to represent the custom currency

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/credits/custom_currency_create_params.rb', line 40

optional :symbol, String

#units ⇒ Stigg::Models::V1::Credits::CustomCurrencyCreateParams::Units^?

Singular and plural unit labels for a custom currency. Both fields are required when supplied.

Returns:

• (Stigg::Models::V1::Credits::CustomCurrencyCreateParams::Units, nil)

# File 'lib/stigg/models/v1/credits/custom_currency_create_params.rb', line 47

optional :units, -> { Stigg::V1::Credits::CustomCurrencyCreateParams::Units }