Class: Stigg::Models::V1::Customers::PromotionalEntitlementListResponse

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

Overview

See Also:

Defined Under Namespace

Modules: Period, ResetPeriod, ResetPeriodConfiguration, Status

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:, created_at:, description:, end_date:, enum_values:, environment_id:, feature_group_ids:, feature_id:, has_soft_limit:, has_unlimited_usage:, is_visible:, period:, reset_period:, reset_period_configuration:, start_date:, status:, updated_at:, usage_limit:) ⇒ Object

Granted feature entitlement

Parameters:




# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 129

Instance Attribute Details

#created_at ⇒ Time

Timestamp of when the record was created

Returns:

  • (Time) 


19
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 19

required :created_at, Time, api_name: :createdAt

#description ⇒ String?

The description of the entitlement

Returns:

  • (String, nil) 


25
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 25

required :description, String, nil?: true

#end_date ⇒ Time?

The end date of the promotional entitlement

Returns:

  • (Time, nil) 


31
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 31

required :end_date, Time, api_name: :endDate, nil?: true

#enum_values ⇒ Array<String>?

The enum values of the entitlement

Returns:

  • (Array<String>, nil) 


37
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 37

required :enum_values, Stigg::Internal::Type::ArrayOf[String], api_name: :enumValues, nil?: true

#environment_id ⇒ String

The unique identifier for the environment

Returns:

  • (String) 


43
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 43

required :environment_id, String, api_name: :environmentId

#feature_group_ids ⇒ Array<String>?

Feature group IDs associated with this entitlement

Returns:

  • (Array<String>, nil) 


49
50
51
52
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 49

required :feature_group_ids,
Stigg::Internal::Type::ArrayOf[String],
api_name: :featureGroupIds,
nil?: true

#feature_id ⇒ String

The unique identifier of the entitlement feature

Returns:

  • (String) 


58
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 58

required :feature_id, String, api_name: :featureId

#has_soft_limit ⇒ Boolean?

Whether the entitlement has a soft limit

Returns:

  • (Boolean, nil) 


64
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 64

required :has_soft_limit, Stigg::Internal::Type::Boolean, api_name: :hasSoftLimit, nil?: true

#has_unlimited_usage ⇒ Boolean?

Whether the entitlement has an unlimited usage

Returns:

  • (Boolean, nil) 


70
71
72
73
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 70

required :has_unlimited_usage,
Stigg::Internal::Type::Boolean,
api_name: :hasUnlimitedUsage,
nil?: true

#id ⇒ String

Unique identifier for the entity

Returns:

  • (String) 


13
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 13

required :id, String

#is_visible ⇒ Boolean

Whether the entitlement is visible

Returns:

  • (Boolean) 


79
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 79

required :is_visible, Stigg::Internal::Type::Boolean, api_name: :isVisible

#period ⇒ Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementListResponse::Period

The grant period of the promotional entitlement

Returns:



85
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 85

required :period, enum: -> { Stigg::Models::V1::Customers::PromotionalEntitlementListResponse::Period }

#reset_period ⇒ Symbol, ...

The reset period of the entitlement

Returns:



91
92
93
94
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 91

required :reset_period,
enum: -> { Stigg::Models::V1::Customers::PromotionalEntitlementListResponse::ResetPeriod },
api_name: :resetPeriod,
nil?: true

#reset_period_configuration ⇒ Stigg::Models::V1::Customers::PromotionalEntitlementListResponse::ResetPeriodConfiguration::YearlyResetPeriodConfig, ...

The reset period configuration of the entitlement

Returns:



100
101
102
103
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 100

required :reset_period_configuration,
union: -> { Stigg::Models::V1::Customers::PromotionalEntitlementListResponse::ResetPeriodConfiguration },
api_name: :resetPeriodConfiguration,
nil?: true

#start_date ⇒ Time

The start date of the entitlement

Returns:

  • (Time) 


109
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 109

required :start_date, Time, api_name: :startDate

#status ⇒ Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementListResponse::Status

The status of the entitlement

Returns:



115
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 115

required :status, enum: -> { Stigg::Models::V1::Customers::PromotionalEntitlementListResponse::Status }

#updated_at ⇒ Time

Timestamp of when the record was last updated

Returns:

  • (Time) 


121
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 121

required :updated_at, Time, api_name: :updatedAt

#usage_limit ⇒ Float?

The usage limit of the entitlement

Returns:

  • (Float, nil) 


127
 
# File 'lib/stigg/models/v1/customers/promotional_entitlement_list_response.rb', line 127

required :usage_limit, Float, api_name: :usageLimit, nil?: true