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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/plans/entitlement_create_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(id:, amount:, cadence:, behavior: 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::Plans::EntitlementCreateParams::Entitlement::Credit for more details.

Request to create a credit entitlement

Parameters:




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

Instance Attribute Details

#amount ⇒ Float?

Credit grant amount

Returns:

  • (Float, nil) 


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

required :amount, Float, nil?: true

#behavior ⇒ Symbol, ...

Entitlement behavior (Increment or Override)

Returns:



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

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

#cadence ⇒ Symbol, Stigg::Models::V1::Plans::EntitlementCreateParams::Entitlement::Credit::Cadence

Credit grant cadence (MONTH or YEAR)

Returns:



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

required :cadence, enum: -> { Stigg::V1::Plans::EntitlementCreateParams::Entitlement::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) 


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

optional :dependency_feature_id, String, api_name: :dependencyFeatureId

#description ⇒ String?

Description of the entitlement

Returns:

  • (String, nil) 


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

optional :description, String

#display_name_override ⇒ String?

Override display name for the entitlement

Returns:

  • (String, nil) 


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

optional :display_name_override, String, api_name: :displayNameOverride

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

Widget types where this entitlement is hidden

Returns:



399
400
401
402
403
 
# File 'lib/stigg/models/v1/plans/entitlement_create_params.rb', line 399

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

#id ⇒ String

The custom currency ID for the credit entitlement

Returns:

  • (String) 


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

required :id, String

#is_custom ⇒ Boolean?

Whether this is a custom entitlement

Returns:

  • (Boolean, nil) 


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

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

#is_granted ⇒ Boolean?

Whether the entitlement is granted

Returns:

  • (Boolean, nil) 


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

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

#order ⇒ Float?

Display order of the entitlement

Returns:

  • (Float, nil) 


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

optional :order, Float

#type ⇒ Symbol, :CREDIT

CreateCreditEntitlementRequest

Returns:

  • (Symbol, :CREDIT) 


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

required :type, const: :CREDIT

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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