Class: MetronomeSDK::Models::V1::ContractListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/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::V1::ContractListParams for more details.

Parameters:

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

    Optional RFC 3339 timestamp. If provided, the response will include only contrac

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

    Include archived contracts in the response

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

    Include the balance of credits and commits in the response. Setting this flag ma

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

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

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

    Optional RFC 3339 timestamp. If provided, the response will include only contrac

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



# File 'lib/metronome_sdk/models/v1/contract_list_params.rb', line 52

Instance Attribute Details

#covering_date ⇒ Time?

Optional RFC 3339 timestamp. If provided, the response will include only contracts effective on the provided date. This cannot be provided if the starting_at filter is provided.

Returns:

  • (Time, nil) 


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

optional :covering_date, Time

#customer_id ⇒ String

Returns:

  • (String) 


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

required :customer_id, String

#include_archived ⇒ Boolean?

Include archived contracts in the response

Returns:

  • (Boolean, nil) 


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

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 query to be slower.

Returns:

  • (Boolean, nil) 


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

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

#include_ledgers ⇒ Boolean?

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

Returns:

  • (Boolean, nil) 


42
 
# File 'lib/metronome_sdk/models/v1/contract_list_params.rb', line 42

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

#starting_at ⇒ Time?

Optional RFC 3339 timestamp. If provided, the response will include only contracts where effective_at is on or after the provided date. This cannot be provided if the covering_date filter is provided.

Returns:

  • (Time, nil) 


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

optional :starting_at, Time