Class: Stigg::Models::V1::Addons::EntitlementUpdateParams::Body::Credit

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/addons/entitlement_update_params.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(amount: nil, behavior: nil, cadence: nil, dependency_feature_id: nil, description: nil, display_name_override: nil, hidden_from_widgets: nil, is_custom: nil, is_granted: nil, order: nil, type: :CREDIT) ⇒ Object

Some parameter documentations has been truncated, see Stigg::Models::V1::Addons::EntitlementUpdateParams::Body::Credit for more details.

Fields to update on a credit entitlement

Parameters:

  • amount (Float) (defaults to: nil) —

    Credit grant amount

  • behavior (Symbol, Stigg::Models::V1::Addons::EntitlementUpdateParams::Body::Credit::Behavior) (defaults to: nil) —

    Entitlement behavior (Increment or Override)

  • cadence (Symbol, Stigg::Models::V1::Addons::EntitlementUpdateParams::Body::Credit::Cadence) (defaults to: nil) —

    Credit grant cadence (MONTH or YEAR)

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

    The feature ID this entitlement depends on. The entitlement value will be calcul

  • description (String) (defaults to: nil) —

    Description of the entitlement

  • display_name_override (String) (defaults to: nil) —

    Override display name for the entitlement

  • hidden_from_widgets (Array<Symbol, Stigg::Models::V1::Addons::EntitlementUpdateParams::Body::Credit::HiddenFromWidget>) (defaults to: nil) —

    Widget types where this entitlement is hidden

  • is_custom (Boolean) (defaults to: nil) —

    Whether this is a custom entitlement

  • is_granted (Boolean) (defaults to: nil) —

    Whether the entitlement is granted

  • order (Float) (defaults to: nil) —

    Display order of the entitlement

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

    UpdateCreditEntitlementRequest




# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 413

Instance Attribute Details

#amount ⇒ Float?

Credit grant amount

Returns:

  • (Float, nil) 


352
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 352

optional :amount, Float

#behavior ⇒ Symbol, ...

Entitlement behavior (Increment or Override)

Returns:



358
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 358

optional :behavior, enum: -> { Stigg::V1::Addons::EntitlementUpdateParams::Body::Credit::Behavior }

#cadence ⇒ Symbol, ...

Credit grant cadence (MONTH or YEAR)

Returns:



364
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 364

optional :cadence, enum: -> { Stigg::V1::Addons::EntitlementUpdateParams::Body::Credit::Cadence }

#dependency_feature_id ⇒ String?

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

Returns:

  • (String, nil) 


371
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 371

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

#description ⇒ String?

Description of the entitlement

Returns:

  • (String, nil) 


377
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 377

optional :description, String

#display_name_override ⇒ String?

Override display name for the entitlement

Returns:

  • (String, nil) 


383
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 383

optional :display_name_override, String, api_name: :displayNameOverride

#hidden_from_widgets ⇒ Array<Symbol, Stigg::Models::V1::Addons::EntitlementUpdateParams::Body::Credit::HiddenFromWidget>?

Widget types where this entitlement is hidden

Returns:



389
390
391
392
393
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 389

optional :hidden_from_widgets,
-> {
  Stigg::Internal::Type::ArrayOf[enum: Stigg::V1::Addons::EntitlementUpdateParams::Body::Credit::HiddenFromWidget]
},
api_name: :hiddenFromWidgets

#is_custom ⇒ Boolean?

Whether this is a custom entitlement

Returns:

  • (Boolean, nil) 


399
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 399

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

#is_granted ⇒ Boolean?

Whether the entitlement is granted

Returns:

  • (Boolean, nil) 


405
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 405

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

#order ⇒ Float?

Display order of the entitlement

Returns:

  • (Float, nil) 


411
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 411

optional :order, Float

#type ⇒ Symbol, :CREDIT

UpdateCreditEntitlementRequest

Returns:

  • (Symbol, :CREDIT) 


346
 
# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 346

required :type, const: :CREDIT

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/addons/entitlement_update_params.rb', line 451