Class: MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rb

Overview

See Also:

• Resources::V1::Customers::NamedSchedules#retrieve

Instance Attribute Summary

• #covering_date ⇒ Time^?

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

• #customer_id ⇒ String

  ID of the customer whose named schedule is to be retrieved.

• #schedule_name ⇒ String

  The identifier for the schedule to be retrieved.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(customer_id: , schedule_name: , covering_date: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see NamedScheduleRetrieveParams for more details.

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: , schedule_name: , covering_date: nil, request_options: {}) ⇒ Object

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

# File 'lib/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rb', line 31

Instance Attribute Details

#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.

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

optional :covering_date, Time

#customer_id ⇒ String

ID of the customer whose named schedule is to be retrieved

# File 'lib/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rb', line 16

required :customer_id, String

#schedule_name ⇒ String

The identifier for the schedule to be retrieved

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

required :schedule_name, String