Class: MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams

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

Overview

See Also:

Defined Under Namespace

Modules: Sort, WindowSize

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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: , ending_before: , starting_on: , credit_type_id: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, status: nil, window_size: nil, request_options: {}) ⇒ Object

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

Parameters:

  • customer_id (String) (defaults to: )
  • ending_before (Time) (defaults to: ) —

    RFC 3339 timestamp. Breakdowns will only be returned for time windows that end o

  • starting_on (Time) (defaults to: ) —

    RFC 3339 timestamp. Breakdowns will only be returned for time windows that start

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

    Only return invoices for the specified credit type

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

    Max number of results that should be returned. For daily breakdowns, the respons

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

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

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

    If set, all zero quantity line items will be filtered out of the response

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

    Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to date_a

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

    Invoice status, e.g. DRAFT or FINALIZED

  • window_size (Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::WindowSize) (defaults to: nil) —

    The granularity of the breakdowns to return. Defaults to day.

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



# File 'lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb', line 77

Instance Attribute Details

#credit_type_id ⇒ String?

Only return invoices for the specified credit type

Returns:

  • (String, nil) 


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

optional :credit_type_id, String

#customer_id ⇒ String

Returns:

  • (String) 


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

required :customer_id, String

#ending_before ⇒ Time

RFC 3339 timestamp. Breakdowns will only be returned for time windows that end on or before this time.

Returns:

  • (Time) 


22
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb', line 22

required :ending_before, Time

#limit ⇒ Integer?

Max number of results that should be returned. For daily breakdowns, the response can return up to 35 days worth of breakdowns. For hourly breakdowns, the response can return up to 24 hours. If there are more results, a cursor to the next page is returned.

Returns:

  • (Integer, nil) 


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

optional :limit, Integer

#next_page ⇒ String?

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

Returns:

  • (String, nil) 


50
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb', line 50

optional :next_page, String

#skip_zero_qty_line_items ⇒ Boolean?

If set, all zero quantity line items will be filtered out of the response

Returns:

  • (Boolean, nil) 


56
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb', line 56

optional :skip_zero_qty_line_items, MetronomeSDK::Internal::Type::Boolean

#sort ⇒ Symbol, ...

Invoice sort order by issued_at, e.g. date_asc or date_desc. Defaults to date_asc.

Returns:



63
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb', line 63

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

#starting_on ⇒ Time

RFC 3339 timestamp. Breakdowns will only be returned for time windows that start on or after this time.

Returns:

  • (Time) 


29
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb', line 29

required :starting_on, Time

#status ⇒ String?

Invoice status, e.g. DRAFT or FINALIZED

Returns:

  • (String, nil) 


69
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb', line 69

optional :status, String

#window_size ⇒ Symbol, ...

The granularity of the breakdowns to return. Defaults to day.

Returns:



75
 
# File 'lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb', line 75

optional :window_size, enum: -> { MetronomeSDK::V1::Customers::InvoiceListBreakdownsParams::WindowSize }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb', line 112