Class: MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb

Overview

See Also:

• Resources::V1::Contracts::RateCards#retrieve_rate_schedule

Defined Under Namespace

Classes: Selector

Instance Attribute Summary

• #ending_before ⇒ Time^?

  optional exclusive end date for the rates schedule.

• #limit ⇒ Integer^?

  Max number of results that should be returned.

• #next_page ⇒ String^?

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

• #rate_card_id ⇒ String

  ID of the rate card to get the schedule for.

• #selectors ⇒ Array<MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>^?

  List of rate selectors, rates matching ANY of the selector will be included in the response Passing no selectors will result in all rates being returned.

• #starting_at ⇒ Time

  inclusive starting point for the rates schedule.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from MetronomeSDK::Internal::Type::BaseModel

Instance Attribute Details

#ending_before ⇒ Time^?

optional exclusive end date for the rates schedule. When not specified rates will show all future schedule segments.

Returns:

• (Time, nil)

# File 'lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb', line 41

optional :ending_before, Time

#limit ⇒ Integer^?

Max number of results that should be returned

Returns:

• (Integer, nil)

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

optional :limit, Integer

#next_page ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb', line 34

optional :next_page, String

#rate_card_id ⇒ String

ID of the rate card to get the schedule for

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb', line 16

required :rate_card_id, String

#selectors ⇒ Array<MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>^?

List of rate selectors, rates matching ANY of the selector will be included in the response Passing no selectors will result in all rates being returned.

Returns:

• (Array<MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>, nil)

# File 'lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb', line 48

optional :selectors,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector] }

#starting_at ⇒ Time

inclusive starting point for the rates schedule

Returns:

• (Time)

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

required :starting_at, Time