Class: MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Selector

Instance Attribute Summary collapse

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

#at ⇒ Time?

optional timestamp which overlaps with the returned rate schedule segments. When not specified, the current timestamp will be used.

Returns:

  • (Time, nil) 


40
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 40

optional :at, Time

#contract_id ⇒ String

ID of the contract to get the rate schedule for.

Returns:

  • (String) 


15
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 15

required :contract_id, String

#customer_id ⇒ String

ID of the customer for whose contract to get the rate schedule for.

Returns:

  • (String) 


21
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 21

required :customer_id, String

#limit ⇒ Integer?

Max number of results that should be returned

Returns:

  • (Integer, nil) 


27
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 27

optional :limit, Integer

#next_page ⇒ String?

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

Returns:

  • (String, nil) 


33
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 33

optional :next_page, String

#selectors ⇒ Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector>?

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

Returns:



47
48
 
# File 'lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb', line 47

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