Class: MetronomeSDK::Models::V1::CreditGrantListEntriesParams

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

Overview

See Also:

Defined Under Namespace

Modules: Sort

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(next_page: nil, sort: nil, credit_type_ids: nil, customer_ids: nil, ending_before: nil, starting_on: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    Cursor that indicates where the next page of results should start.

  • sort (Symbol, MetronomeSDK::Models::V1::CreditGrantListEntriesParams::Sort) (defaults to: nil) —

    Ledgers sort order by date, asc or desc. Defaults to asc.

  • credit_type_ids (Array<String>) (defaults to: nil) —

    A list of Metronome credit type IDs to fetch ledger entries for. If absent, ledg

  • customer_ids (Array<String>) (defaults to: nil) —

    A list of Metronome customer IDs to fetch ledger entries for. If absent, ledger

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

    If supplied, ledger entries will only be returned with an effective_at before th

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

    If supplied, only ledger entries effective at or after this time will be returne

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



# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb', line 53

Instance Attribute Details

#credit_type_ids ⇒ Array<String>?

A list of Metronome credit type IDs to fetch ledger entries for. If absent, ledger entries for all credit types will be returned.

Returns:

  • (Array<String>, nil) 


28
 
# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb', line 28

optional :credit_type_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#customer_ids ⇒ Array<String>?

A list of Metronome customer IDs to fetch ledger entries for. If absent, ledger entries for all customers will be returned.

Returns:

  • (Array<String>, nil) 


35
 
# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb', line 35

optional :customer_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#ending_before ⇒ Time?

If supplied, ledger entries will only be returned with an effective_at before this time. This timestamp must not be in the future. If no timestamp is supplied, all entries up to the start of the customer’s next billing period will be returned.

Returns:

  • (Time, nil) 


44
 
# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb', line 44

optional :ending_before, Time

#next_page ⇒ String?

Cursor that indicates where the next page of results should start.

Returns:

  • (String, nil) 


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

optional :next_page, String

#sort ⇒ Symbol, ...

Ledgers sort order by date, asc or desc. Defaults to asc.

Returns:



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

optional :sort, enum: -> { MetronomeSDK::V1::CreditGrantListEntriesParams::Sort }

#starting_on ⇒ Time?

If supplied, only ledger entries effective at or after this time will be returned.

Returns:

  • (Time, nil) 


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

optional :starting_on, Time