Class: Zavudev::Models::PlanRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/plan_retrieve_response.rb,
sig/zavudev/models/plan_retrieve_response.rbs

Overview

See Also:

  • Zavudev::Resources::Plan#retrieve

Defined Under Namespace

Modules: BillingInterval, Status, Tier Classes: Limits

Instance Attribute Summary collapse

Class Method 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(billing_interval:, status:, tier:, cancel_at_period_end: nil, current_period_end: nil, current_period_start: nil, limits: nil) ⇒ Object

Parameters:




# File 'lib/zavudev/models/plan_retrieve_response.rb', line 45

Instance Attribute Details

#billing_interval ⇒ Symbol, Zavudev::Models::PlanRetrieveResponse::BillingInterval

Parameters:

  • value (Zavudev::Models::PlanRetrieveResponse::billing_interval)

Returns:



10
11
12
 
# File 'lib/zavudev/models/plan_retrieve_response.rb', line 10

required :billing_interval,
enum: -> { Zavudev::Models::PlanRetrieveResponse::BillingInterval },
api_name: :billingInterval

#cancel_at_period_end ⇒ Boolean?

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


28
 
# File 'lib/zavudev/models/plan_retrieve_response.rb', line 28

optional :cancel_at_period_end, Zavudev::Internal::Type::Boolean, api_name: :cancelAtPeriodEnd

#current_period_end ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


33
 
# File 'lib/zavudev/models/plan_retrieve_response.rb', line 33

optional :current_period_end, Time, api_name: :currentPeriodEnd

#current_period_start ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


38
 
# File 'lib/zavudev/models/plan_retrieve_response.rb', line 38

optional :current_period_start, Time, api_name: :currentPeriodStart

#limits ⇒ Zavudev::Models::PlanRetrieveResponse::Limits?

Returns:



43
 
# File 'lib/zavudev/models/plan_retrieve_response.rb', line 43

optional :limits, -> { Zavudev::Models::PlanRetrieveResponse::Limits }

#status ⇒ Symbol, Zavudev::Models::PlanRetrieveResponse::Status

Parameters:

  • value (Zavudev::Models::PlanRetrieveResponse::status)

Returns:



17
 
# File 'lib/zavudev/models/plan_retrieve_response.rb', line 17

required :status, enum: -> { Zavudev::Models::PlanRetrieveResponse::Status }

#tier ⇒ Symbol, Zavudev::Models::PlanRetrieveResponse::Tier

Current subscription tier.

Parameters:

  • value (Zavudev::Models::PlanRetrieveResponse::tier)

Returns:



23
 
# File 'lib/zavudev/models/plan_retrieve_response.rb', line 23

required :tier, enum: -> { Zavudev::Models::PlanRetrieveResponse::Tier }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/zavudev/models/plan_retrieve_response.rb', line 67

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


49
 
# File 'sig/zavudev/models/plan_retrieve_response.rbs', line 49

def to_hash: -> {