Class: Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Feature

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

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(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, type: :FEATURE) ⇒ Object

Feature entitlement configuration for a subscription

Parameters:




# File 'lib/stigg/models/v1/subscription_update_params.rb', line 778

Instance Attribute Details

#has_soft_limit ⇒ Boolean?

Whether the usage limit is a soft limit

Returns:

  • (Boolean, nil) 


723
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 723

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

#has_unlimited_usage ⇒ Boolean?

Whether usage is unlimited

Returns:

  • (Boolean, nil) 


729
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 729

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

#id ⇒ String

The feature ID to attach the entitlement to

Returns:

  • (String) 


711
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 711

required :id, String

#monthly_reset_period_configuration ⇒ Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Feature::MonthlyResetPeriodConfiguration?

Configuration for monthly reset period

Returns:



735
736
737
738
739
740
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 735

optional :monthly_reset_period_configuration,
-> {
  Stigg::V1::SubscriptionUpdateParams::Entitlement::Feature::MonthlyResetPeriodConfiguration
},
api_name: :monthlyResetPeriodConfiguration,
nil?: true

#reset_period ⇒ Symbol, ...

Period at which usage resets

Returns:



746
747
748
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 746

optional :reset_period,
enum: -> { Stigg::V1::SubscriptionUpdateParams::Entitlement::Feature::ResetPeriod },
api_name: :resetPeriod

#type ⇒ Symbol, :FEATURE

SubscriptionFeatureEntitlementRequest

Returns:

  • (Symbol, :FEATURE) 


717
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 717

required :type, const: :FEATURE

#usage_limit ⇒ Integer?

Maximum allowed usage for the feature

Returns:

  • (Integer, nil) 


754
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 754

optional :usage_limit, Integer, api_name: :usageLimit

#weekly_reset_period_configuration ⇒ Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Feature::WeeklyResetPeriodConfiguration?

Configuration for weekly reset period

Returns:



760
761
762
763
764
765
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 760

optional :weekly_reset_period_configuration,
-> {
  Stigg::V1::SubscriptionUpdateParams::Entitlement::Feature::WeeklyResetPeriodConfiguration
},
api_name: :weeklyResetPeriodConfiguration,
nil?: true

#yearly_reset_period_configuration ⇒ Stigg::Models::V1::SubscriptionUpdateParams::Entitlement::Feature::YearlyResetPeriodConfiguration?

Configuration for yearly reset period

Returns:



771
772
773
774
775
776
 
# File 'lib/stigg/models/v1/subscription_update_params.rb', line 771

optional :yearly_reset_period_configuration,
-> {
  Stigg::V1::SubscriptionUpdateParams::Entitlement::Feature::YearlyResetPeriodConfiguration
},
api_name: :yearlyResetPeriodConfiguration,
nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/subscription_update_params.rb', line 825