Class: MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_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(contract_id: , customer_id: , schedule_name: , covering_date: nil, request_options: {}) ⇒ Object

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

Parameters:

  • contract_id (String) (defaults to: ) —

    ID of the contract whose named schedule is to be retrieved

  • customer_id (String) (defaults to: ) —

    ID of the customer whose named schedule is to be retrieved

  • schedule_name (String) (defaults to: ) —

    The identifier for the schedule to be retrieved

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

    If provided, at most one schedule segment will be returned (the one that covers

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



# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb', line 38

Instance Attribute Details

#contract_id ⇒ String

ID of the contract whose named schedule is to be retrieved

Returns:

  • (String) 


17
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb', line 17

required :contract_id, String

#covering_date ⇒ Time?

If provided, at most one schedule segment will be returned (the one that covers this date). If not provided, all segments will be returned.

Returns:

  • (Time, nil) 


36
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb', line 36

optional :covering_date, Time

#customer_id ⇒ String

ID of the customer whose named schedule is to be retrieved

Returns:

  • (String) 


23
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb', line 23

required :customer_id, String

#schedule_name ⇒ String

The identifier for the schedule to be retrieved

Returns:

  • (String) 


29
 
# File 'lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb', line 29

required :schedule_name, String