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

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

Overview

See Also:

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 1153

Instance Attribute Details

#feature_id ⇒ String

The feature ID for the entitlement

Returns:

  • (String) 


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

required :feature_id, String, api_name: :featureId

#has_soft_limit ⇒ Boolean?

Whether the limit is soft (allows overage)

Returns:

  • (Boolean, nil) 


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

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

#has_unlimited_usage ⇒ Boolean?

Whether usage is unlimited

Returns:

  • (Boolean, nil) 


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

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:



1111
1112
1113
1114
1115
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1111

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

#reset_period ⇒ Symbol, ...

The usage reset period

Returns:



1121
1122
1123
1124
1125
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1121

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

#usage_limit ⇒ Float?

The usage limit before overage kicks in

Returns:

  • (Float, nil) 


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

optional :usage_limit, Float, api_name: :usageLimit

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

Weekly reset configuration

Returns:



1137
1138
1139
1140
1141
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1137

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:



1147
1148
1149
1150
1151
 
# File 'lib/stigg/models/v1/plan_update_params.rb', line 1147

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 1198