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

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_card_retrieve_rate_schedule_params.rb,
sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs

Overview

See Also:

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

Defined Under Namespace

Classes: Selector

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::MetronomeSDK

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 ⇒ Object 



42
 
# File 'sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs', line 42

def initialize: (

Instance Attribute Details

#ending_before ⇒ Time?

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

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


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

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# 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:



48
49
 
# 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

Parameters:

  • value (Time)

Returns:

  • (Time) 


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

required :starting_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


52
 
# File 'sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs', line 52

def to_hash: -> {