Class: MetronomeSDK::Models::V1::PlanListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::PlanListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/metronome_sdk/models/v1/plan_list_params.rb

Overview

See Also:

• Resources::V1::Plans#list

Instance Attribute Summary

• #limit ⇒ Integer^?

  Max number of results that should be returned.

• #next_page ⇒ String^?

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

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(limit: nil, next_page: nil, request_options: {}) ⇒ Object constructor

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(limit: nil, next_page: nil, request_options: {}) ⇒ Object

Parameters:

• limit (Integer) (defaults to: nil) —

  Max number of results that should be returned

• next_page (String) (defaults to: nil) —

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

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

# File 'lib/metronome_sdk/models/v1/plan_list_params.rb', line 23

Instance Attribute Details

#limit ⇒ Integer^?

Max number of results that should be returned

Returns:

• (Integer, nil)

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

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/plan_list_params.rb', line 21

optional :next_page, String