Class: Stigg::Models::V1::Feature::Data

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

Overview

See Also:

Defined Under Namespace

Modules: FeatureStatus, FeatureType, MeterType Classes: EnumConfiguration, UnitTransformation

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(display_name:, value:) ⇒ Object

Parameters:

  • display_name (String) —

    The display name for the enum configuration entity

  • value (String) —

    The unique value identifier for the enum configuration entity




# File 'lib/stigg/models/v1/feature.rb', line 151

Instance Attribute Details

#created_at ⇒ Time

Timestamp of when the record was created

Returns:

  • (Time) 


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

required :created_at, Time, api_name: :createdAt

#description ⇒ String?

The description for the feature

Returns:

  • (String, nil) 


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

required :description, String, nil?: true

#display_name ⇒ String

The display name for the feature

Returns:

  • (String) 


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

required :display_name, String, api_name: :displayName

#enum_configuration ⇒ Array<Stigg::Models::V1::Feature::Data::EnumConfiguration>?

The configuration data for the feature

Returns:



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

required :enum_configuration,
-> { Stigg::Internal::Type::ArrayOf[Stigg::V1::Feature::Data::EnumConfiguration] },
api_name: :enumConfiguration,
nil?: true

#feature_status ⇒ Symbol, Stigg::Models::V1::Feature::Data::FeatureStatus

The status of the feature

Returns:



58
59
60
61
62
 
# File 'lib/stigg/models/v1/feature.rb', line 58

required :feature_status,
enum: -> {
  Stigg::V1::Feature::Data::FeatureStatus
},
api_name: :featureStatus

#feature_type ⇒ Symbol, Stigg::Models::V1::Feature::Data::FeatureType

The type of the feature

Returns:



68
 
# File 'lib/stigg/models/v1/feature.rb', line 68

required :feature_type, enum: -> { Stigg::V1::Feature::Data::FeatureType }, api_name: :featureType

#feature_units ⇒ String?

The units for the feature

Returns:

  • (String, nil) 


74
 
# File 'lib/stigg/models/v1/feature.rb', line 74

required :feature_units, String, api_name: :featureUnits, nil?: true

#feature_units_plural ⇒ String?

The plural units for the feature

Returns:

  • (String, nil) 


80
 
# File 'lib/stigg/models/v1/feature.rb', line 80

required :feature_units_plural, String, api_name: :featureUnitsPlural, nil?: true

#id ⇒ String

The unique identifier for the feature

Returns:

  • (String) 


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

required :id, String

#metadata ⇒ Hash{Symbol=>String}

The additional metadata for the feature

Returns:

  • (Hash{Symbol=>String}) 


86
 
# File 'lib/stigg/models/v1/feature.rb', line 86

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

#meter_type ⇒ Symbol, Stigg::Models::V1::Feature::Data::MeterType

The meter type for the feature

Returns:



92
 
# File 'lib/stigg/models/v1/feature.rb', line 92

required :meter_type, enum: -> { Stigg::V1::Feature::Data::MeterType }, api_name: :meterType

#unit_transformation ⇒ Stigg::Models::V1::Feature::Data::UnitTransformation?

Unit transformation to be applied to the reported usage

Returns:



98
99
100
101
 
# File 'lib/stigg/models/v1/feature.rb', line 98

required :unit_transformation,
-> { Stigg::V1::Feature::Data::UnitTransformation },
api_name: :unitTransformation,
nil?: true

#updated_at ⇒ Time

Timestamp of when the record was last updated

Returns:

  • (Time) 


107
 
# File 'lib/stigg/models/v1/feature.rb', line 107

required :updated_at, Time, api_name: :updatedAt

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/stigg/models/v1/feature.rb', line 167