Class: MetronomeSDK::Models::V1::PaymentListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/payment_list_params.rb

Overview

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(customer_id: , invoice_id: , limit: nil, next_page: nil, statuses: nil, request_options: {}) ⇒ Object

Parameters:

  • customer_id (String) (defaults to: )
  • invoice_id (String) (defaults to: )
  • limit (Integer) (defaults to: nil)

    The maximum number of payments to return. Defaults to 25.

  • next_page (String) (defaults to: nil)

    The next page token from a previous response.

  • statuses (Array<Symbol, MetronomeSDK::Models::V1::PaymentStatus>) (defaults to: nil)
  • request_options (MetronomeSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})


# File 'lib/metronome_sdk/models/v1/payment_list_params.rb', line 38


Instance Attribute Details

#customer_idString

Returns:

  • (String)


14
# File 'lib/metronome_sdk/models/v1/payment_list_params.rb', line 14

required :customer_id, String

#invoice_idString

Returns:

  • (String)


19
# File 'lib/metronome_sdk/models/v1/payment_list_params.rb', line 19

required :invoice_id, String

#limitInteger?

The maximum number of payments to return. Defaults to 25.

Returns:

  • (Integer, nil)


25
# File 'lib/metronome_sdk/models/v1/payment_list_params.rb', line 25

optional :limit, Integer

#next_pageString?

The next page token from a previous response.

Returns:

  • (String, nil)


31
# File 'lib/metronome_sdk/models/v1/payment_list_params.rb', line 31

optional :next_page, String

#statusesArray<Symbol, MetronomeSDK::Models::V1::PaymentStatus>?

Returns:



36
# File 'lib/metronome_sdk/models/v1/payment_list_params.rb', line 36

optional :statuses, -> { MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::PaymentStatus] }