Class: Stigg::Models::V1Beta::Customers::AssignmentUpsertResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb,
sig/stigg/models/v1_beta/customers/assignment_upsert_response.rbs

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::AssignmentUpsertResponse::Data 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 (String) —

    Usage-reset cadence as an ISO-8601 single-unit duration, e.g. P1M, P30D, `PT

  • 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, nil) —

    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).



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 20

class Data < Stigg::Internal::Type::BaseModel
  # @!attribute id
  #   Synthetic UUID identifier — also the cursor anchor for paginated lists
  #
  #   @return [String]
  required :id, String

  # @!attribute cadence
  #   Usage-reset cadence as an ISO-8601 single-unit duration, e.g. `P1M`, `P30D`,
  #   `PT1M`.
  #
  #   @return [String]
  required :cadence, String

  # @!attribute created_at
  #   Timestamp of when the record was created
  #
  #   @return [Time]
  required :created_at, Time, api_name: :createdAt

  # @!attribute entity_id
  #   The entity refId this assignment is attached to
  #
  #   @return [String]
  required :entity_id, String, api_name: :entityId

  # @!attribute parent_id
  #   Parent entity refId in the hierarchy, or `null` for a root.
  #
  #   @return [String, nil]
  required :parent_id, String, api_name: :parentId, nil?: true

  # @!attribute scope_entity_ids
  #   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).
  #
  #   @return [Array<String>]
  required :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds

  # @!attribute updated_at
  #   Timestamp of when the record was last updated
  #
  #   @return [Time]
  required :updated_at, Time, api_name: :updatedAt

  # @!attribute usage_limit
  #   Maximum usage allowed within one cadence window
  #
  #   @return [Float, nil]
  required :usage_limit, Float, api_name: :usageLimit, nil?: true

  # @!attribute currency_id
  #   Currency refId this assignment grants (present for credit capabilities).
  #
  #   @return [String, nil]
  optional :currency_id, String, api_name: :currencyId

  # @!attribute feature_id
  #   Feature refId this assignment grants (present for feature capabilities).
  #
  #   @return [String, nil]
  optional :feature_id, String, api_name: :featureId

  # @!method initialize(id:, cadence:, created_at:, entity_id:, parent_id:, scope_entity_ids:, updated_at:, usage_limit:, currency_id: nil, feature_id: nil)
  #   Some parameter documentations has been truncated, see
  #   {Stigg::Models::V1Beta::Customers::AssignmentUpsertResponse::Data} 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`).
  #
  #   @param id [String] Synthetic UUID identifier — also the cursor anchor for paginated lists
  #
  #   @param cadence [String] Usage-reset cadence as an ISO-8601 single-unit duration, e.g. `P1M`, `P30D`, `PT
  #
  #   @param created_at [Time] Timestamp of when the record was created
  #
  #   @param entity_id [String] The entity refId this assignment is attached to
  #
  #   @param parent_id [String, nil] Parent entity refId in the hierarchy, or `null` for a root.
  #
  #   @param scope_entity_ids [Array<String>] Dimension-scoped sub-budget key: the set of entity refIds this budget applies to
  #
  #   @param updated_at [Time] Timestamp of when the record was last updated
  #
  #   @param usage_limit [Float, nil] Maximum usage allowed within one cadence window
  #
  #   @param currency_id [String] Currency refId this assignment grants (present for credit capabilities).
  #
  #   @param feature_id [String] Feature refId this assignment grants (present for feature capabilities).
end

Instance Attribute Details

#cadence ⇒ String

Usage-reset cadence as an ISO-8601 single-unit duration, e.g. P1M, P30D, PT1M.

Parameters:

  • value (String)

Returns:

  • (String) 


32
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 32

required :cadence, String

#created_at ⇒ Time

Timestamp of when the record was created

Parameters:

  • value (Time)

Returns:

  • (Time) 


38
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 38

required :created_at, Time, api_name: :createdAt

#currency_id ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


77
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 77

optional :currency_id, String, api_name: :currencyId

#entity_id ⇒ String

The entity refId this assignment is attached to

Parameters:

  • value (String)

Returns:

  • (String) 


44
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 44

required :entity_id, String, api_name: :entityId

#feature_id ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


83
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 83

optional :feature_id, String, api_name: :featureId

#id ⇒ String

Synthetic UUID identifier — also the cursor anchor for paginated lists

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :id, String

#parent_id ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


50
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 50

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).

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


59
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 59

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

#updated_at ⇒ Time

Timestamp of when the record was last updated

Parameters:

  • value (Time)

Returns:

  • (Time) 


65
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 65

required :updated_at, Time, api_name: :updatedAt

#usage_limit ⇒ Float?

Maximum usage allowed within one cadence window

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


71
 
# File 'lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb', line 71

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


73
 
# File 'sig/stigg/models/v1_beta/customers/assignment_upsert_response.rbs', line 73

def to_hash: -> {