Class: MetronomeSDK::Models::V2::ContractListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v2/contract_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, include_archived: nil, include_balance: nil, include_ledgers: nil, starting_at: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V2::ContractListParams for more details.




# File 'lib/metronome_sdk/models/v2/contract_list_params.rb', line 50

Instance Attribute Details

#covering_date ⇒ Time?

Optional RFC 3339 timestamp. Only include contracts active on the provided date. This cannot be provided if starting_at filter is provided.



21
 
# File 'lib/metronome_sdk/models/v2/contract_list_params.rb', line 21

optional :covering_date, Time

#customer_id ⇒ String 



14
 
# File 'lib/metronome_sdk/models/v2/contract_list_params.rb', line 14

required :customer_id, String

#include_archived ⇒ Boolean?

Include archived contracts in the response.



27
 
# File 'lib/metronome_sdk/models/v2/contract_list_params.rb', line 27

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

#include_balance ⇒ Boolean?

Include the balance of credits and commits in the response. Setting this flag may cause the response to be slower.



34
 
# File 'lib/metronome_sdk/models/v2/contract_list_params.rb', line 34

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

#include_ledgers ⇒ Boolean?

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



41
 
# File 'lib/metronome_sdk/models/v2/contract_list_params.rb', line 41

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

#starting_at ⇒ Time?

Optional RFC 3339 timestamp. Only include contracts that started on or after this date. This cannot be provided if covering_date filter is provided.



48
 
# File 'lib/metronome_sdk/models/v2/contract_list_params.rb', line 48

optional :starting_at, Time