Class: MetronomeSDK::Models::V1::Customers::CreditListParams

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

Overview

See Also:

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: , covering_date: nil, credit_id: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_credits: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::Customers::CreditListParams for more details.

Parameters:

  • customer_id (String) (defaults to: )
  • covering_date (Time) (defaults to: nil) —

    Return only credits that have access schedules that “cover” the provided date

  • credit_id (String) (defaults to: nil)
  • effective_before (Time) (defaults to: nil) —

    Include only credits that have any access before the provided date (exclusive)

  • include_archived (Boolean) (defaults to: nil) —

    Include archived credits and credits from archived contracts.

  • include_balance (Boolean) (defaults to: nil) —

    Include the balance in the response. Setting this flag may cause the query to be

  • include_contract_credits (Boolean) (defaults to: nil) —

    Include credits on the contract level.

  • include_ledgers (Boolean) (defaults to: nil) —

    Include credit ledgers in the response. Setting this flag may cause the query to

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

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

  • next_page (String) (defaults to: nil) —

    The next page token from a previous response.

  • starting_at (Time) (defaults to: nil) —

    Include only credits that have any access on or after the provided date

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



# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 78

Instance Attribute Details

#covering_date ⇒ Time?

Return only credits that have access schedules that “cover” the provided date

Returns:

  • (Time, nil) 


21
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 21

optional :covering_date, Time

#credit_id ⇒ String?

Returns:

  • (String, nil) 


26
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 26

optional :credit_id, String

#customer_id ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 15

required :customer_id, String

#effective_before ⇒ Time?

Include only credits that have any access before the provided date (exclusive)

Returns:

  • (Time, nil) 


32
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 32

optional :effective_before, Time

#include_archived ⇒ Boolean?

Include archived credits and credits from archived contracts.

Returns:

  • (Boolean, nil) 


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

optional :include_archived, MetronomeSDK::Internal::Type::Boolean

#include_balance ⇒ Boolean?

Include the balance in the response. Setting this flag may cause the query to be slower.

Returns:

  • (Boolean, nil) 


45
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 45

optional :include_balance, MetronomeSDK::Internal::Type::Boolean

#include_contract_credits ⇒ Boolean?

Include credits on the contract level.

Returns:

  • (Boolean, nil) 


51
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 51

optional :include_contract_credits, MetronomeSDK::Internal::Type::Boolean

#include_ledgers ⇒ Boolean?

Include credit ledgers in the response. Setting this flag may cause the query to be slower.

Returns:

  • (Boolean, nil) 


58
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 58

optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean

#limit ⇒ Integer?

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

Returns:

  • (Integer, nil) 


64
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 64

optional :limit, Integer

#next_page ⇒ String?

The next page token from a previous response.

Returns:

  • (String, nil) 


70
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 70

optional :next_page, String

#starting_at ⇒ Time?

Include only credits that have any access on or after the provided date

Returns:

  • (Time, nil) 


76
 
# File 'lib/metronome_sdk/models/v1/customers/credit_list_params.rb', line 76

optional :starting_at, Time