Class: Stigg::Models::V1Beta::Customers::AssignmentListResponse

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

Overview

See Also:

Defined Under Namespace

Modules: Cadence

Instance Attribute 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:, cadence:, created_at:, entity_id:, parent_id:, scope_entity_ids:, updated_at:, usage_limit:, currency_id: nil, feature_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Stigg::Models::V1Beta::Customers::AssignmentListResponse for more details.

A capability assignment for an entity belonging to a customer. Defines how much of the capability the entity may consume (‘usageLimit`) and how often the counter resets (`cadence`).

Parameters:

  • id (String) —

    Synthetic UUID identifier — also the cursor anchor for paginated lists

  • cadence (Symbol, Stigg::Models::V1Beta::Customers::AssignmentListResponse::Cadence) —

    Usage-reset cadence. Currently only ‘MONTH` is supported

  • created_at (Time) —

    Timestamp of when the record was created

  • entity_id (String) —

    The entity refId this assignment is attached to

  • parent_id (String, nil) —

    Parent entity refId in the hierarchy, or ‘null` for a root.

  • scope_entity_ids (Array<String>) —

    Dimension-scoped sub-budget key: the set of entity refIds this budget applies to

  • updated_at (Time) —

    Timestamp of when the record was last updated

  • usage_limit (Float) —

    Maximum usage allowed within one cadence window

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

    Currency refId this assignment grants (present for credit capabilities).

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

    Feature refId this assignment grants (present for feature capabilities).




# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 72

Instance Attribute Details

#cadence ⇒ Symbol, Stigg::Models::V1Beta::Customers::AssignmentListResponse::Cadence

Usage-reset cadence. Currently only ‘MONTH` is supported

Returns:



19
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 19

required :cadence, enum: -> { Stigg::Models::V1Beta::Customers::AssignmentListResponse::Cadence }

#created_at ⇒ Time

Timestamp of when the record was created

Returns:

  • (Time) 


25
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 25

required :created_at, Time, api_name: :createdAt

#currency_id ⇒ String?

Currency refId this assignment grants (present for credit capabilities).

Returns:

  • (String, nil) 


64
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 64

optional :currency_id, String, api_name: :currencyId

#entity_id ⇒ String

The entity refId this assignment is attached to

Returns:

  • (String) 


31
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 31

required :entity_id, String, api_name: :entityId

#feature_id ⇒ String?

Feature refId this assignment grants (present for feature capabilities).

Returns:

  • (String, nil) 


70
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 70

optional :feature_id, String, api_name: :featureId

#id ⇒ String

Synthetic UUID identifier — also the cursor anchor for paginated lists

Returns:

  • (String) 


13
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 13

required :id, String

#parent_id ⇒ String?

Parent entity refId in the hierarchy, or ‘null` for a root.

Returns:

  • (String, nil) 


37
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 37

required :parent_id, String, api_name: :parentId, nil?: true

#scope_entity_ids ⇒ Array<String>

Dimension-scoped sub-budget key: the set of entity refIds this budget applies to. Empty is the node-wide budget that always matches; a non-empty set only applies when every listed entity is present in the resolved set (order-insensitive).

Returns:

  • (Array<String>) 


46
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 46

required :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds

#updated_at ⇒ Time

Timestamp of when the record was last updated

Returns:

  • (Time) 


52
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 52

required :updated_at, Time, api_name: :updatedAt

#usage_limit ⇒ Float

Maximum usage allowed within one cadence window

Returns:

  • (Float) 


58
 
# File 'lib/stigg/models/v1_beta/customers/assignment_list_response.rb', line 58

required :usage_limit, Float, api_name: :usageLimit