Class: Inttegro::Price::CustomerSelectedAmountParams

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/price/customer_selected_amount_params.rb

Overview

Typed representation of the customer selected amount params object in the Inttegro API.

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#currency ⇒ Inttegro::Money::Currency (readonly)

Currency accepted for customer-selected amounts

Required in the API payload. Wire name: currency.

Returns:



44
45
46
47
48
49
 
# File 'lib/inttegro/price/customer_selected_amount_params.rb', line 44

class CustomerSelectedAmountParams < T::Struct
  const :currency, Inttegro::Money::Currency
  const :minimum, Integer
  const :maximum, T.nilable(Integer), default: nil
  const :suggested_amounts, T.nilable(T::Array[Inttegro::Price::SuggestedAmountParams]), default: nil
end

#maximum ⇒ Integer? (readonly)

Optional maximum selectable amount; it must be at least minimum

Optional in the API payload; omitted values default to nil. Wire name: maximum.

Returns:

  • (Integer, nil) 


44
45
46
47
48
49
 
# File 'lib/inttegro/price/customer_selected_amount_params.rb', line 44

class CustomerSelectedAmountParams < T::Struct
  const :currency, Inttegro::Money::Currency
  const :minimum, Integer
  const :maximum, T.nilable(Integer), default: nil
  const :suggested_amounts, T.nilable(T::Array[Inttegro::Price::SuggestedAmountParams]), default: nil
end

#minimum ⇒ Integer (readonly)

Minimum selectable amount in the currency's smallest unit

Required in the API payload. Wire name: minimum.

Returns:

  • (Integer) 


44
45
46
47
48
49
 
# File 'lib/inttegro/price/customer_selected_amount_params.rb', line 44

class CustomerSelectedAmountParams < T::Struct
  const :currency, Inttegro::Money::Currency
  const :minimum, Integer
  const :maximum, T.nilable(Integer), default: nil
  const :suggested_amounts, T.nilable(T::Array[Inttegro::Price::SuggestedAmountParams]), default: nil
end

#suggested_amounts ⇒ Array<Inttegro::Price::SuggestedAmountParams>? (readonly)

Convenient choices, not an allow-list. IDs and values must be unique and at most one can be recommended.

Optional in the API payload; omitted values default to nil. Wire name: suggested_amounts.

Returns:



44
45
46
47
48
49
 
# File 'lib/inttegro/price/customer_selected_amount_params.rb', line 44

class CustomerSelectedAmountParams < T::Struct
  const :currency, Inttegro::Money::Currency
  const :minimum, Integer
  const :maximum, T.nilable(Integer), default: nil
  const :suggested_amounts, T.nilable(T::Array[Inttegro::Price::SuggestedAmountParams]), default: nil
end