Class: Orb::Models::Customers::Credits::TopUpListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/customers/credits/top_up_list_params.rb,
sig/orb/models/customers/credits/top_up_list_params.rbs

Overview

See Also:

  • Orb::Resources::Customers::Credits::TopUps#list

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:, cursor: nil, limit: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Customers::Credits::TopUpListParams for more details.

Parameters:

  • customer_id (String)
  • cursor (String, nil) (defaults to: nil) —

    Cursor for pagination. This can be populated by the next_cursor value returned

  • limit (Integer) (defaults to: nil) —

    The number of items to fetch. Defaults to 20.

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/orb/models/customers/credits/top_up_list_params.rb', line 30

Instance Attribute Details

#cursor ⇒ String?

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


22
 
# File 'lib/orb/models/customers/credits/top_up_list_params.rb', line 22

optional :cursor, String, nil?: true

#customer_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/orb/models/customers/credits/top_up_list_params.rb', line 15

required :customer_id, String

#limit ⇒ Integer?

The number of items to fetch. Defaults to 20.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


28
 
# File 'lib/orb/models/customers/credits/top_up_list_params.rb', line 28

optional :limit, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


28
 
# File 'sig/orb/models/customers/credits/top_up_list_params.rbs', line 28

def to_hash: -> {