Class: Stigg::Models::V1::Plans::PlanEntitlement::Data::Credit

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

Defined Under Namespace

Modules: Behavior, Cadence, HiddenFromWidget

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:, amount:, behavior:, cadence:, created_at:, description:, display_name_override:, hidden_from_widgets:, is_custom:, is_granted:, order:, updated_at:, dependency_feature_id: nil, type: :CREDIT) ⇒ Object

Some parameter documentations has been truncated, see Stigg::Models::V1::Plans::PlanEntitlement::Data::Credit for more details.

Credit entitlement response

Parameters:

  • id (String) —

    Unique identifier of the entitlement

  • amount (Float, nil) —

    Credit amount (for credit entitlements)

  • behavior (Symbol, Stigg::Models::V1::Plans::PlanEntitlement::Data::Credit::Behavior) —

    Entitlement behavior (Increment or Override)

  • cadence (Symbol, Stigg::Models::V1::Plans::PlanEntitlement::Data::Credit::Cadence, nil) —

    Credit grant cadence (for credit entitlements)

  • created_at (Time) —

    Timestamp of when the record was created

  • description (String, nil) —

    Optional description of the entitlement

  • display_name_override (String, nil) —

    Override display name for the entitlement

  • hidden_from_widgets (Array<Symbol, Stigg::Models::V1::Plans::PlanEntitlement::Data::Credit::HiddenFromWidget>) —

    Widget types where this entitlement is hidden

  • is_custom (Boolean, nil) —

    Whether this is a custom entitlement

  • is_granted (Boolean) —

    Whether the entitlement is granted

  • order (Float, nil) —

    Display order of the entitlement

  • updated_at (Time) —

    Timestamp of when the record was last updated

  • dependency_feature_id (String, nil) (defaults to: nil) —

    The feature ID this entitlement depends on (for credit entitlements). The entitl

  • type (Symbol, :CREDIT) (defaults to: :CREDIT) —

    Entitlement type (FEATURE or CREDIT)




# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 439

Instance Attribute Details

#amount ⇒ Float?

Credit amount (for credit entitlements)

Returns:

  • (Float, nil) 


355
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 355

required :amount, Float, nil?: true

#behavior ⇒ Symbol, Stigg::Models::V1::Plans::PlanEntitlement::Data::Credit::Behavior

Entitlement behavior (Increment or Override)

Returns:



361
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 361

required :behavior, enum: -> { Stigg::V1::Plans::PlanEntitlement::Data::Credit::Behavior }

#cadence ⇒ Symbol, ...

Credit grant cadence (for credit entitlements)

Returns:



367
368
369
370
371
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 367

required :cadence,
enum: -> {
  Stigg::V1::Plans::PlanEntitlement::Data::Credit::Cadence
},
nil?: true

#created_at ⇒ Time

Timestamp of when the record was created

Returns:

  • (Time) 


377
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 377

required :created_at, Time, api_name: :createdAt

#dependency_feature_id ⇒ String?

The feature ID this entitlement depends on (for credit entitlements). The entitlement value will be calculated as: base amount × dependency feature usage limit

Returns:

  • (String, nil) 


437
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 437

optional :dependency_feature_id, String, api_name: :dependencyFeatureId, nil?: true

#description ⇒ String?

Optional description of the entitlement

Returns:

  • (String, nil) 


383
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 383

required :description, String, nil?: true

#display_name_override ⇒ String?

Override display name for the entitlement

Returns:

  • (String, nil) 


389
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 389

required :display_name_override, String, api_name: :displayNameOverride, nil?: true

#hidden_from_widgets ⇒ Array<Symbol, Stigg::Models::V1::Plans::PlanEntitlement::Data::Credit::HiddenFromWidget>

Widget types where this entitlement is hidden

Returns:



395
396
397
398
399
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 395

required :hidden_from_widgets,
-> {
  Stigg::Internal::Type::ArrayOf[enum: Stigg::V1::Plans::PlanEntitlement::Data::Credit::HiddenFromWidget]
},
api_name: :hiddenFromWidgets

#id ⇒ String

Unique identifier of the entitlement

Returns:

  • (String) 


349
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 349

required :id, String

#is_custom ⇒ Boolean?

Whether this is a custom entitlement

Returns:

  • (Boolean, nil) 


405
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 405

required :is_custom, Stigg::Internal::Type::Boolean, api_name: :isCustom, nil?: true

#is_granted ⇒ Boolean

Whether the entitlement is granted

Returns:

  • (Boolean) 


411
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 411

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

#order ⇒ Float?

Display order of the entitlement

Returns:

  • (Float, nil) 


417
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 417

required :order, Float, nil?: true

#type ⇒ Symbol, :CREDIT

Entitlement type (FEATURE or CREDIT)

Returns:

  • (Symbol, :CREDIT) 


423
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 423

required :type, const: :CREDIT

#updated_at ⇒ Time

Timestamp of when the record was last updated

Returns:

  • (Time) 


429
 
# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 429

required :updated_at, Time, api_name: :updatedAt

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/plans/plan_entitlement.rb', line 482