Class: Stigg::Models::V1::Plans::EntitlementCreateParams::Entitlement::Feature

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

Defined Under Namespace

Modules: Behavior, HiddenFromWidget, 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:, behavior: nil, description: nil, display_name_override: nil, enum_values: nil, has_soft_limit: nil, has_unlimited_usage: nil, hidden_from_widgets: nil, is_custom: nil, is_granted: nil, monthly_reset_period_configuration: nil, order: nil, reset_period: nil, usage_limit: nil, weekly_reset_period_configuration: nil, yearly_reset_period_configuration: nil, type: :FEATURE) ⇒ Object

Request to create a feature entitlement

Parameters:




# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 169

Instance Attribute Details

#behavior ⇒ Symbol, ...

Entitlement behavior (Increment or Override)

Returns:



60
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 60

optional :behavior, enum: -> { Stigg::V1::Plans::EntitlementCreateParams::Entitlement::Feature::Behavior }

#description ⇒ String?

Description of the entitlement

Returns:

  • (String, nil) 


66
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 66

optional :description, String

#display_name_override ⇒ String?

Override display name for the entitlement

Returns:

  • (String, nil) 


72
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 72

optional :display_name_override, String, api_name: :displayNameOverride

#enum_values ⇒ Array<String>?

Allowed enum values for the feature entitlement

Returns:

  • (Array<String>, nil) 


78
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 78

optional :enum_values, Stigg::Internal::Type::ArrayOf[String], api_name: :enumValues

#has_soft_limit ⇒ Boolean?

Whether the usage limit is a soft limit

Returns:

  • (Boolean, nil) 


84
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 84

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

#has_unlimited_usage ⇒ Boolean?

Whether usage is unlimited

Returns:

  • (Boolean, nil) 


90
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 90

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

#hidden_from_widgets ⇒ Array<Symbol, Stigg::Models::V1::Plans::EntitlementCreateParams::Entitlement::Feature::HiddenFromWidget>?

Widget types where this entitlement is hidden

Returns:



96
97
98
99
100
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 96

optional :hidden_from_widgets,
-> {
  Stigg::Internal::Type::ArrayOf[enum: Stigg::V1::Plans::EntitlementCreateParams::Entitlement::Feature::HiddenFromWidget]
},
api_name: :hiddenFromWidgets

#id ⇒ String

The feature ID to attach the entitlement to

Returns:

  • (String) 


48
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 48

required :id, String

#is_custom ⇒ Boolean?

Whether this is a custom entitlement

Returns:

  • (Boolean, nil) 


106
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 106

optional :is_custom, Stigg::Internal::Type::Boolean, api_name: :isCustom

#is_granted ⇒ Boolean?

Whether the entitlement is granted

Returns:

  • (Boolean, nil) 


112
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 112

optional :is_granted, Stigg::Internal::Type::Boolean, api_name: :isGranted

#monthly_reset_period_configuration ⇒ Stigg::Models::V1::Plans::EntitlementCreateParams::Entitlement::Feature::MonthlyResetPeriodConfiguration?

Configuration for monthly reset period

Returns:



118
119
120
121
122
123
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 118

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

#order ⇒ Float?

Display order of the entitlement

Returns:

  • (Float, nil) 


129
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 129

optional :order, Float

#reset_period ⇒ Symbol, ...

Period at which usage resets

Returns:



135
136
137
138
139
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 135

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

#type ⇒ Symbol, :FEATURE

CreateFeatureEntitlementRequest

Returns:

  • (Symbol, :FEATURE) 


54
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 54

required :type, const: :FEATURE

#usage_limit ⇒ Integer?

Maximum allowed usage for the feature

Returns:

  • (Integer, nil) 


145
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 145

optional :usage_limit, Integer, api_name: :usageLimit, nil?: true

#weekly_reset_period_configuration ⇒ Stigg::Models::V1::Plans::EntitlementCreateParams::Entitlement::Feature::WeeklyResetPeriodConfiguration?

Configuration for weekly reset period

Returns:



151
152
153
154
155
156
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 151

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

#yearly_reset_period_configuration ⇒ Stigg::Models::V1::Plans::EntitlementCreateParams::Entitlement::Feature::YearlyResetPeriodConfiguration?

Configuration for yearly reset period

Returns:



162
163
164
165
166
167
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 162

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 215