Class: MetronomeSDK::Models::V1::PlanListCustomersResponse::PlanDetails

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/plan_list_customers_response.rb,
sig/metronome_sdk/models/v1/plan_list_customers_response.rbs

Overview

See Also:

  • MetronomeSDK::Models::V1::PlanListCustomersResponse#plan_details

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id:, custom_fields:, customer_plan_id:, name:, starting_on:, ending_before: nil) ⇒ Object

Parameters:

  • id (String)
  • custom_fields (Hash{Symbol=>String}) —

    Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

  • customer_plan_id (String)
  • name (String)
  • starting_on (Time) —

    The start date of the plan

  • ending_before (Time, nil) (defaults to: nil) —

    The end date of the plan




# File 'lib/metronome_sdk/models/v1/plan_list_customers_response.rb', line 57

Instance Attribute Details

#custom_fields ⇒ Hash{Symbol=>String}

Custom fields to be added eg. { "key1": "value1", "key2": "value2" }

Parameters:

  • value (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}) 


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

required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#customer_plan_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


38
 
# File 'lib/metronome_sdk/models/v1/plan_list_customers_response.rb', line 38

required :customer_plan_id, String

#ending_before ⇒ Time?

The end date of the plan

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


55
 
# File 'lib/metronome_sdk/models/v1/plan_list_customers_response.rb', line 55

optional :ending_before, Time, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


43
 
# File 'lib/metronome_sdk/models/v1/plan_list_customers_response.rb', line 43

required :name, String

#starting_on ⇒ Time

The start date of the plan

Parameters:

  • value (Time)

Returns:

  • (Time) 


49
 
# File 'lib/metronome_sdk/models/v1/plan_list_customers_response.rb', line 49

required :starting_on, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


57
 
# File 'sig/metronome_sdk/models/v1/plan_list_customers_response.rbs', line 57

def to_hash: -> {