Class: Stigg::Models::V1::Addon::Data

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

Overview

See Also:

Defined Under Namespace

Modules: PricingType, Status Classes: Entitlement

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Stigg::Internal::Type::BaseModel

Instance Attribute Details

#billing_id ⇒ String?

The unique identifier for the entity in the billing provider

Returns:

  • (String, nil) 


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

required :billing_id, String, api_name: :billingId, nil?: true

#created_at ⇒ Time

Timestamp of when the record was created

Returns:

  • (Time) 


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

required :created_at, Time, api_name: :createdAt

#dependencies ⇒ Array<String>?

List of addons the addon is dependant on

Returns:

  • (Array<String>, nil) 


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

required :dependencies, Stigg::Internal::Type::ArrayOf[String], nil?: true

#description ⇒ String?

The description of the package

Returns:

  • (String, nil) 


49
 
# File 'lib/stigg/models/v1/addon.rb', line 49

required :description, String, nil?: true

#display_name ⇒ String

The display name of the package

Returns:

  • (String) 


55
 
# File 'lib/stigg/models/v1/addon.rb', line 55

required :display_name, String, api_name: :displayName

#entitlements ⇒ Array<Stigg::Models::V1::Addon::Data::Entitlement>

List of entitlements of the package

Returns:



61
 
# File 'lib/stigg/models/v1/addon.rb', line 61

required :entitlements, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::Addon::Data::Entitlement] }

#id ⇒ String

The unique identifier for the entity

Returns:

  • (String) 


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

required :id, String

#is_latest ⇒ Boolean?

Indicates if the package is the latest version

Returns:

  • (Boolean, nil) 


67
 
# File 'lib/stigg/models/v1/addon.rb', line 67

required :is_latest, Stigg::Internal::Type::Boolean, api_name: :isLatest, nil?: true

#max_quantity ⇒ Integer?

The maximum quantity of this addon that can be added to a subscription

Returns:

  • (Integer, nil) 


73
 
# File 'lib/stigg/models/v1/addon.rb', line 73

required :max_quantity, Integer, api_name: :maxQuantity, nil?: true

#metadata ⇒ Hash{Symbol=>String}

Metadata associated with the entity

Returns:

  • (Hash{Symbol=>String}) 


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

required :metadata, Stigg::Internal::Type::HashOf[String]

#pricing_type ⇒ Symbol, ...

The pricing type of the package

Returns:



85
86
87
88
 
# File 'lib/stigg/models/v1/addon.rb', line 85

required :pricing_type,
enum: -> { Stigg::V1::Addon::Data::PricingType },
api_name: :pricingType,
nil?: true

#product_id ⇒ String

The product id of the package

Returns:

  • (String) 


94
 
# File 'lib/stigg/models/v1/addon.rb', line 94

required :product_id, String, api_name: :productId

#status ⇒ Symbol, Stigg::Models::V1::Addon::Data::Status

The status of the package

Returns:



100
 
# File 'lib/stigg/models/v1/addon.rb', line 100

required :status, enum: -> { Stigg::V1::Addon::Data::Status }

#updated_at ⇒ Time

Timestamp of when the record was last updated

Returns:

  • (Time) 


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

required :updated_at, Time, api_name: :updatedAt

#version_number ⇒ Integer

The version number of the package

Returns:

  • (Integer) 


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

required :version_number, Integer, api_name: :versionNumber

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/addon.rb', line 173