Class: Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement

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

Overview

See Also:

  • Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel#entitlement

Defined Under Namespace

Modules: ResetPeriod Classes: MonthlyResetPeriodConfiguration, WeeklyResetPeriodConfiguration, YearlyResetPeriodConfiguration

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(feature_id:, has_soft_limit: nil, has_unlimited_usage: nil, monthly_reset_period_configuration: nil, reset_period: nil, usage_limit: nil, weekly_reset_period_configuration: nil, yearly_reset_period_configuration: nil) ⇒ Object

Entitlement configuration for the overage feature

Parameters:




# File 'lib/stigg/models/v1/plan_update_params.rb', line 1213

Instance Attribute Details

#feature_id ⇒ String

The feature ID for the entitlement

Parameters:

  • value (String)

Returns:

  • (String) 


1153
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1153

required :feature_id, String, api_name: :featureId

#has_soft_limit ⇒ Boolean?

Whether the limit is soft (allows overage)

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


1159
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1159

optional :has_soft_limit, Stigg::Internal::Type::Boolean, api_name: :hasSoftLimit

#has_unlimited_usage ⇒ Boolean?

Whether usage is unlimited

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


1165
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1165

optional :has_unlimited_usage, Stigg::Internal::Type::Boolean, api_name: :hasUnlimitedUsage

#monthly_reset_period_configuration ⇒ Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement::MonthlyResetPeriodConfiguration?

Monthly reset configuration

Returns:



1171
1172
1173
1174
1175
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1171

optional :monthly_reset_period_configuration,
-> {
  Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement::MonthlyResetPeriodConfiguration
},
api_name: :monthlyResetPeriodConfiguration

#reset_period ⇒ Symbol, ...

The usage reset period

Returns:



1181
1182
1183
1184
1185
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1181

optional :reset_period,
enum: -> {
  Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement::ResetPeriod
},
api_name: :resetPeriod

#usage_limit ⇒ Float?

The usage limit before overage kicks in

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


1191
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1191

optional :usage_limit, Float, api_name: :usageLimit

#weekly_reset_period_configuration ⇒ Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement::WeeklyResetPeriodConfiguration?

Weekly reset configuration

Returns:



1197
1198
1199
1200
1201
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1197

optional :weekly_reset_period_configuration,
-> {
  Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement::WeeklyResetPeriodConfiguration
},
api_name: :weeklyResetPeriodConfiguration

#yearly_reset_period_configuration ⇒ Stigg::Models::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement::YearlyResetPeriodConfiguration?

Yearly reset configuration

Returns:



1207
1208
1209
1210
1211
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1207

optional :yearly_reset_period_configuration,
-> {
  Stigg::V1::PlanUpdateParams::Charges::OveragePricingModel::Entitlement::YearlyResetPeriodConfiguration
},
api_name: :yearlyResetPeriodConfiguration

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/plan_update_params.rb', line 1258

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1611
 
# File 'sig/stigg/models/v1/plan_update_params.rbs', line 1611

def to_hash: -> {