stigg 0.1.0.pre.beta.35 → 0.1.0.pre.beta.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/stigg/client.rb +1 -1
  5. data/lib/stigg/models/v1/events/beta/customer_retrieve_governance_response.rb +8 -8
  6. data/lib/stigg/models/v1_beta/customers/assignment_list_params.rb +4 -4
  7. data/lib/stigg/models/v1_beta/customers/assignment_list_response.rb +12 -13
  8. data/lib/stigg/models/v1_beta/customers/assignment_upsert_params.rb +10 -10
  9. data/lib/stigg/models/v1_beta/customers/assignment_upsert_response.rb +12 -13
  10. data/lib/stigg/models/v1_beta/customers/entity_list_params.rb +9 -9
  11. data/lib/stigg/models/v1_beta/customers/entity_list_response.rb +9 -9
  12. data/lib/stigg/models/v1_beta/customers/entity_retrieve_response.rb +9 -9
  13. data/lib/stigg/models/v1_beta/customers/entity_upsert_params.rb +11 -11
  14. data/lib/stigg/models/v1_beta/customers/entity_upsert_response.rb +9 -9
  15. data/lib/stigg/resources/v1/events/beta/customers.rb +1 -1
  16. data/lib/stigg/resources/v1_beta/customers/assignments.rb +2 -2
  17. data/lib/stigg/resources/v1_beta/customers/entities.rb +9 -6
  18. data/lib/stigg/version.rb +1 -1
  19. data/rbi/stigg/models/v1/events/beta/customer_retrieve_governance_response.rbi +8 -8
  20. data/rbi/stigg/models/v1_beta/customers/assignment_list_params.rbi +4 -4
  21. data/rbi/stigg/models/v1_beta/customers/assignment_list_response.rbi +14 -16
  22. data/rbi/stigg/models/v1_beta/customers/assignment_upsert_params.rbi +12 -12
  23. data/rbi/stigg/models/v1_beta/customers/assignment_upsert_response.rbi +14 -16
  24. data/rbi/stigg/models/v1_beta/customers/entity_list_params.rbi +11 -11
  25. data/rbi/stigg/models/v1_beta/customers/entity_list_response.rbi +8 -8
  26. data/rbi/stigg/models/v1_beta/customers/entity_retrieve_response.rbi +8 -8
  27. data/rbi/stigg/models/v1_beta/customers/entity_upsert_params.rbi +18 -18
  28. data/rbi/stigg/models/v1_beta/customers/entity_upsert_response.rbi +8 -8
  29. data/rbi/stigg/resources/v1/events/beta/customers.rbi +1 -1
  30. data/rbi/stigg/resources/v1_beta/customers/assignments.rbi +2 -2
  31. data/rbi/stigg/resources/v1_beta/customers/entities.rbi +5 -5
  32. data/sig/stigg/models/v1/events/beta/customer_retrieve_governance_response.rbs +4 -4
  33. data/sig/stigg/models/v1_beta/customers/entity_list_params.rbs +7 -7
  34. data/sig/stigg/models/v1_beta/customers/entity_list_response.rbs +5 -5
  35. data/sig/stigg/models/v1_beta/customers/entity_retrieve_response.rbs +5 -5
  36. data/sig/stigg/models/v1_beta/customers/entity_upsert_params.rbs +10 -10
  37. data/sig/stigg/models/v1_beta/customers/entity_upsert_response.rbs +5 -5
  38. data/sig/stigg/resources/v1_beta/customers/entities.rbs +1 -1
  39. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 37796b53d48cf3448b56cb9d463ed46c3308e729cf52f572513f959c7dacec50
4
- data.tar.gz: 5d16deb29b585ff6bef9e6a996e39e53069a93fc0bd0c2dc00a4a4f5552d96c3
3
+ metadata.gz: e8174994e13dfa023bdcabd912079e0521b319a6bd861ae13eaab54289c39977
4
+ data.tar.gz: ffd0b541acbb41ef6430ce8554c766bb58d35521118f25e786f13b299ecf96d8
5
5
  SHA512:
6
- metadata.gz: 8cdc6cb04e672018779405902befa35db1a420df3390f661dd126cc15ef9fc4b76c92dd3bedfb354814aecc51a8b5844181aa54b3bc00021d481260f6e1ded45
7
- data.tar.gz: 37357f0095e9611dd9cf877b09bbb3bc908279bf4fda021cb07d431c2844ce509379648ff91bda4ddd7ae1722dc4c67d526a1f45085f000dc1a3a85d3154fe15
6
+ metadata.gz: 9b903f04ba4092e8e7258f8b6bcc4b6b04a4f9b53115e227be333172f4c9848199b514514acceb0b4c73238c2b91324e3187b7cc53689258051709bfca062a3a
7
+ data.tar.gz: 8296bee9bb201f3cc47fe68f022123e1a208cbc4b9c9668984daa9dd65cd2acb5a1d0028c7d73d6b6fb9dbbe19ce77c0f0fa65f423c04f521e48b932436a2299
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.0-beta.36 (2026-07-05)
4
+
5
+ Full Changelog: [v0.1.0-beta.35...v0.1.0-beta.36](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.35...v0.1.0-beta.36)
6
+
7
+ ### Bug Fixes
8
+
9
+ * **api:** rename entity type fields to entity_type_id across governance/entities/assignments ([6669a6e](https://github.com/stiggio/stigg-ruby/commit/6669a6eb36df20c1cecb70697e467cf5fd62fadc))
10
+
3
11
  ## 0.1.0-beta.35 (2026-07-01)
4
12
 
5
13
  Full Changelog: [v0.1.0-beta.34...v0.1.0-beta.35](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.34...v0.1.0-beta.35)
data/README.md CHANGED
@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
24
24
  <!-- x-release-please-start-version -->
25
25
 
26
26
  ```ruby
27
- gem "stigg", "~> 0.1.0.pre.beta.35"
27
+ gem "stigg", "~> 0.1.0.pre.beta.36"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
data/lib/stigg/client.rb CHANGED
@@ -53,7 +53,7 @@ module Stigg
53
53
  initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
54
54
  max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
55
55
  )
56
- base_url ||= "https://api.stigg.io"
56
+ base_url ||= "https://edge.api.stigg.io"
57
57
 
58
58
  if api_key.nil?
59
59
  raise ArgumentError.new("api_key is required, and can be set via environ: \"STIGG_API_KEY\"")
@@ -47,11 +47,11 @@ module Stigg
47
47
  # @return [String]
48
48
  required :entity_id, String, api_name: :entityId
49
49
 
50
- # @!attribute entity_type
50
+ # @!attribute entity_type_id
51
51
  # External id of the entity type (e.g. `team`, `user`).
52
52
  #
53
53
  # @return [String]
54
- required :entity_type, String, api_name: :entityType
54
+ required :entity_type_id, String, api_name: :entityTypeId
55
55
 
56
56
  # @!attribute parent_id
57
57
  # External id of the parent entity in the tree; `null` for a root. Use it to
@@ -95,19 +95,19 @@ module Stigg
95
95
  required :utilization, Float, nil?: true
96
96
 
97
97
  # @!attribute currency_id
98
- # The metered currency refId (present when the configured capability is a credit
98
+ # The metered currency ID (present when the configured capability is a credit
99
99
  # currency).
100
100
  #
101
101
  # @return [String, nil]
102
102
  optional :currency_id, String, api_name: :currencyId
103
103
 
104
104
  # @!attribute feature_id
105
- # The metered feature refId (present when the configured capability is a feature).
105
+ # The metered feature ID (present when the configured capability is a feature).
106
106
  #
107
107
  # @return [String, nil]
108
108
  optional :feature_id, String, api_name: :featureId
109
109
 
110
- # @!method initialize(cadence:, current_usage:, entity_id:, entity_type:, parent_id:, scope_entity_ids:, usage_limit:, usage_period_end:, usage_period_start:, utilization:, currency_id: nil, feature_id: nil)
110
+ # @!method initialize(cadence:, current_usage:, entity_id:, entity_type_id:, parent_id:, scope_entity_ids:, usage_limit:, usage_period_end:, usage_period_start:, utilization:, currency_id: nil, feature_id: nil)
111
111
  # Some parameter documentations has been truncated, see
112
112
  # {Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data} for
113
113
  # more details.
@@ -123,7 +123,7 @@ module Stigg
123
123
  #
124
124
  # @param entity_id [String] External id of the entity at this node.
125
125
  #
126
- # @param entity_type [String] External id of the entity type (e.g. `team`, `user`).
126
+ # @param entity_type_id [String] External id of the entity type (e.g. `team`, `user`).
127
127
  #
128
128
  # @param parent_id [String, nil] External id of the parent entity in the tree; `null` for a root. Use it to rebui
129
129
  #
@@ -137,9 +137,9 @@ module Stigg
137
137
  #
138
138
  # @param utilization [Float, nil] `currentUsage / usageLimit` (1 when usageLimit is 0 — always at limit). The cros
139
139
  #
140
- # @param currency_id [String] The metered currency refId (present when the configured capability is a credit c
140
+ # @param currency_id [String] The metered currency ID (present when the configured capability is a credit curr
141
141
  #
142
- # @param feature_id [String] The metered feature refId (present when the configured capability is a feature).
142
+ # @param feature_id [String] The metered feature ID (present when the configured capability is a feature).
143
143
  end
144
144
 
145
145
  # @see Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse#pagination
@@ -27,13 +27,13 @@ module Stigg
27
27
  optional :before, String
28
28
 
29
29
  # @!attribute capability_id
30
- # Filter assignments to a specific capability refId
30
+ # Filter assignments to a specific capability ID
31
31
  #
32
32
  # @return [String, nil]
33
33
  optional :capability_id, String
34
34
 
35
35
  # @!attribute entity_id
36
- # Filter assignments to a specific entity refId
36
+ # Filter assignments to a specific entity ID
37
37
  #
38
38
  # @return [String, nil]
39
39
  optional :entity_id, String
@@ -61,9 +61,9 @@ module Stigg
61
61
  #
62
62
  # @param before [String] Return items that come before this cursor
63
63
  #
64
- # @param capability_id [String] Filter assignments to a specific capability refId
64
+ # @param capability_id [String] Filter assignments to a specific capability ID
65
65
  #
66
- # @param entity_id [String] Filter assignments to a specific entity refId
66
+ # @param entity_id [String] Filter assignments to a specific entity ID
67
67
  #
68
68
  # @param limit [Integer] Maximum number of items to return
69
69
  #
@@ -26,22 +26,21 @@ module Stigg
26
26
  required :created_at, Time, api_name: :createdAt
27
27
 
28
28
  # @!attribute entity_id
29
- # The entity refId this assignment is attached to
29
+ # The entity ID this assignment is attached to
30
30
  #
31
31
  # @return [String]
32
32
  required :entity_id, String, api_name: :entityId
33
33
 
34
34
  # @!attribute parent_id
35
- # Parent entity refId in the hierarchy, or `null` for a root.
35
+ # Parent entity ID in the hierarchy, or `null` for a root.
36
36
  #
37
37
  # @return [String, nil]
38
38
  required :parent_id, String, api_name: :parentId, nil?: true
39
39
 
40
40
  # @!attribute scope_entity_ids
41
- # Dimension-scoped sub-budget key: the set of entity refIds this budget applies
42
- # to. Empty is the node-wide budget that always matches; a non-empty set only
43
- # applies when every listed entity is present in the resolved set
44
- # (order-insensitive).
41
+ # Dimension-scoped sub-budget key: the set of entity IDs this budget applies to.
42
+ # Empty is the node-wide budget that always matches; a non-empty set only applies
43
+ # when every listed entity is present in the resolved set (order-insensitive).
45
44
  #
46
45
  # @return [Array<String>]
47
46
  required :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds
@@ -59,13 +58,13 @@ module Stigg
59
58
  required :usage_limit, Float, api_name: :usageLimit, nil?: true
60
59
 
61
60
  # @!attribute currency_id
62
- # Currency refId this assignment grants (present for credit capabilities).
61
+ # Currency ID this assignment grants (present for credit capabilities).
63
62
  #
64
63
  # @return [String, nil]
65
64
  optional :currency_id, String, api_name: :currencyId
66
65
 
67
66
  # @!attribute feature_id
68
- # Feature refId this assignment grants (present for feature capabilities).
67
+ # Feature ID this assignment grants (present for feature capabilities).
69
68
  #
70
69
  # @return [String, nil]
71
70
  optional :feature_id, String, api_name: :featureId
@@ -84,19 +83,19 @@ module Stigg
84
83
  #
85
84
  # @param created_at [Time] Timestamp of when the record was created
86
85
  #
87
- # @param entity_id [String] The entity refId this assignment is attached to
86
+ # @param entity_id [String] The entity ID this assignment is attached to
88
87
  #
89
- # @param parent_id [String, nil] Parent entity refId in the hierarchy, or `null` for a root.
88
+ # @param parent_id [String, nil] Parent entity ID in the hierarchy, or `null` for a root.
90
89
  #
91
- # @param scope_entity_ids [Array<String>] Dimension-scoped sub-budget key: the set of entity refIds this budget applies to
90
+ # @param scope_entity_ids [Array<String>] Dimension-scoped sub-budget key: the set of entity IDs this budget applies to. E
92
91
  #
93
92
  # @param updated_at [Time] Timestamp of when the record was last updated
94
93
  #
95
94
  # @param usage_limit [Float, nil] Maximum usage allowed within one cadence window
96
95
  #
97
- # @param currency_id [String] Currency refId this assignment grants (present for credit capabilities).
96
+ # @param currency_id [String] Currency ID this assignment grants (present for credit capabilities).
98
97
  #
99
- # @param feature_id [String] Feature refId this assignment grants (present for feature capabilities).
98
+ # @param feature_id [String] Feature ID this assignment grants (present for feature capabilities).
100
99
  end
101
100
  end
102
101
  end
@@ -44,7 +44,7 @@ module Stigg
44
44
 
45
45
  class Assignment < Stigg::Internal::Type::BaseModel
46
46
  # @!attribute entity_id
47
- # The entity refId this assignment is attached to
47
+ # The entity ID this assignment is attached to
48
48
  #
49
49
  # @return [String]
50
50
  required :entity_id, String, api_name: :entityId
@@ -57,22 +57,22 @@ module Stigg
57
57
  optional :cadence, String
58
58
 
59
59
  # @!attribute currency_id
60
- # Currency refId this assignment grants (credit budgets). Mutually exclusive with
60
+ # Currency ID this assignment grants (credit budgets). Mutually exclusive with
61
61
  # `featureId`.
62
62
  #
63
63
  # @return [String, nil]
64
64
  optional :currency_id, String, api_name: :currencyId
65
65
 
66
66
  # @!attribute feature_id
67
- # Feature refId this assignment grants. Mutually exclusive with `currencyId`.
67
+ # Feature ID this assignment grants. Mutually exclusive with `currencyId`.
68
68
  #
69
69
  # @return [String, nil]
70
70
  optional :feature_id, String, api_name: :featureId
71
71
 
72
72
  # @!attribute parent_id
73
- # Parent entity refId in the hierarchy. Omit to leave the current parent untouched
74
- # (a new node defaults to a root); `null` detaches to a root; a refId sets or
75
- # changes the parent. Reparenting an existing node is leaf-only.
73
+ # Parent entity ID in the hierarchy. Omit to leave the current parent untouched (a
74
+ # new node defaults to a root); `null` detaches to a root; an ID sets or changes
75
+ # the parent. Reparenting an existing node is leaf-only.
76
76
  #
77
77
  # @return [String, nil]
78
78
  optional :parent_id, String, api_name: :parentId, nil?: true
@@ -99,15 +99,15 @@ module Stigg
99
99
  # `cadence` are required; on update they may be omitted individually to preserve
100
100
  # the existing value.
101
101
  #
102
- # @param entity_id [String] The entity refId this assignment is attached to
102
+ # @param entity_id [String] The entity ID this assignment is attached to
103
103
  #
104
104
  # @param cadence [String] Usage-reset cadence (required on create) as an ISO-8601 single-unit duration, e.
105
105
  #
106
- # @param currency_id [String] Currency refId this assignment grants (credit budgets). Mutually exclusive with
106
+ # @param currency_id [String] Currency ID this assignment grants (credit budgets). Mutually exclusive with `fe
107
107
  #
108
- # @param feature_id [String] Feature refId this assignment grants. Mutually exclusive with `currencyId`.
108
+ # @param feature_id [String] Feature ID this assignment grants. Mutually exclusive with `currencyId`.
109
109
  #
110
- # @param parent_id [String, nil] Parent entity refId in the hierarchy. Omit to leave the current parent untouched
110
+ # @param parent_id [String, nil] Parent entity ID in the hierarchy. Omit to leave the current parent untouched (a
111
111
  #
112
112
  # @param scope_entity_ids [Array<String>]
113
113
  #
@@ -38,22 +38,21 @@ module Stigg
38
38
  required :created_at, Time, api_name: :createdAt
39
39
 
40
40
  # @!attribute entity_id
41
- # The entity refId this assignment is attached to
41
+ # The entity ID this assignment is attached to
42
42
  #
43
43
  # @return [String]
44
44
  required :entity_id, String, api_name: :entityId
45
45
 
46
46
  # @!attribute parent_id
47
- # Parent entity refId in the hierarchy, or `null` for a root.
47
+ # Parent entity ID in the hierarchy, or `null` for a root.
48
48
  #
49
49
  # @return [String, nil]
50
50
  required :parent_id, String, api_name: :parentId, nil?: true
51
51
 
52
52
  # @!attribute scope_entity_ids
53
- # Dimension-scoped sub-budget key: the set of entity refIds this budget applies
54
- # to. Empty is the node-wide budget that always matches; a non-empty set only
55
- # applies when every listed entity is present in the resolved set
56
- # (order-insensitive).
53
+ # Dimension-scoped sub-budget key: the set of entity IDs this budget applies to.
54
+ # Empty is the node-wide budget that always matches; a non-empty set only applies
55
+ # when every listed entity is present in the resolved set (order-insensitive).
57
56
  #
58
57
  # @return [Array<String>]
59
58
  required :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds
@@ -71,13 +70,13 @@ module Stigg
71
70
  required :usage_limit, Float, api_name: :usageLimit, nil?: true
72
71
 
73
72
  # @!attribute currency_id
74
- # Currency refId this assignment grants (present for credit capabilities).
73
+ # Currency ID this assignment grants (present for credit capabilities).
75
74
  #
76
75
  # @return [String, nil]
77
76
  optional :currency_id, String, api_name: :currencyId
78
77
 
79
78
  # @!attribute feature_id
80
- # Feature refId this assignment grants (present for feature capabilities).
79
+ # Feature ID this assignment grants (present for feature capabilities).
81
80
  #
82
81
  # @return [String, nil]
83
82
  optional :feature_id, String, api_name: :featureId
@@ -97,19 +96,19 @@ module Stigg
97
96
  #
98
97
  # @param created_at [Time] Timestamp of when the record was created
99
98
  #
100
- # @param entity_id [String] The entity refId this assignment is attached to
99
+ # @param entity_id [String] The entity ID this assignment is attached to
101
100
  #
102
- # @param parent_id [String, nil] Parent entity refId in the hierarchy, or `null` for a root.
101
+ # @param parent_id [String, nil] Parent entity ID in the hierarchy, or `null` for a root.
103
102
  #
104
- # @param scope_entity_ids [Array<String>] Dimension-scoped sub-budget key: the set of entity refIds this budget applies to
103
+ # @param scope_entity_ids [Array<String>] Dimension-scoped sub-budget key: the set of entity IDs this budget applies to. E
105
104
  #
106
105
  # @param updated_at [Time] Timestamp of when the record was last updated
107
106
  #
108
107
  # @param usage_limit [Float, nil] Maximum usage allowed within one cadence window
109
108
  #
110
- # @param currency_id [String] Currency refId this assignment grants (present for credit capabilities).
109
+ # @param currency_id [String] Currency ID this assignment grants (present for credit capabilities).
111
110
  #
112
- # @param feature_id [String] Feature refId this assignment grants (present for feature capabilities).
111
+ # @param feature_id [String] Feature ID this assignment grants (present for feature capabilities).
113
112
  end
114
113
  end
115
114
  end
@@ -26,6 +26,12 @@ module Stigg
26
26
  # @return [String, nil]
27
27
  optional :before, String
28
28
 
29
+ # @!attribute entity_type_id
30
+ # Filter results to entities of a specific entity type, by the type's ID
31
+ #
32
+ # @return [String, nil]
33
+ optional :entity_type_id, String
34
+
29
35
  # @!attribute include_archived
30
36
  # Whether to include archived entities. One of: true, false
31
37
  #
@@ -38,12 +44,6 @@ module Stigg
38
44
  # @return [Integer, nil]
39
45
  optional :limit, Integer
40
46
 
41
- # @!attribute type_ref_id
42
- # Filter results to entities of a specific entity type, by the type's refId
43
- #
44
- # @return [String, nil]
45
- optional :type_ref_id, String
46
-
47
47
  # @!attribute x_account_id
48
48
  #
49
49
  # @return [String, nil]
@@ -54,19 +54,19 @@ module Stigg
54
54
  # @return [String, nil]
55
55
  optional :x_environment_id, String
56
56
 
57
- # @!method initialize(id:, after: nil, before: nil, include_archived: nil, limit: nil, type_ref_id: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
57
+ # @!method initialize(id:, after: nil, before: nil, entity_type_id: nil, include_archived: nil, limit: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
58
58
  # @param id [String]
59
59
  #
60
60
  # @param after [String] Return items that come after this cursor
61
61
  #
62
62
  # @param before [String] Return items that come before this cursor
63
63
  #
64
+ # @param entity_type_id [String] Filter results to entities of a specific entity type, by the type's ID
65
+ #
64
66
  # @param include_archived [Symbol, Stigg::Models::V1Beta::Customers::EntityListParams::IncludeArchived] Whether to include archived entities. One of: true, false
65
67
  #
66
68
  # @param limit [Integer] Maximum number of items to return
67
69
  #
68
- # @param type_ref_id [String] Filter results to entities of a specific entity type, by the type's refId
69
- #
70
70
  # @param x_account_id [String]
71
71
  #
72
72
  # @param x_environment_id [String]
@@ -24,25 +24,25 @@ module Stigg
24
24
  # @return [Time]
25
25
  required :created_at, Time, api_name: :createdAt
26
26
 
27
+ # @!attribute entity_type_id
28
+ # The entity type identifier this entity instantiates
29
+ #
30
+ # @return [String]
31
+ required :entity_type_id, String, api_name: :entityTypeId
32
+
27
33
  # @!attribute metadata
28
34
  # Free-form key/value metadata attached to the entity
29
35
  #
30
36
  # @return [Hash{Symbol=>String}]
31
37
  required :metadata, Stigg::Internal::Type::HashOf[String]
32
38
 
33
- # @!attribute type_id
34
- # The entity type identifier this entity instantiates
35
- #
36
- # @return [String]
37
- required :type_id, String, api_name: :typeId
38
-
39
39
  # @!attribute updated_at
40
40
  # Timestamp of when the record was last updated
41
41
  #
42
42
  # @return [Time]
43
43
  required :updated_at, Time, api_name: :updatedAt
44
44
 
45
- # @!method initialize(id:, archived_at:, created_at:, metadata:, type_id:, updated_at:)
45
+ # @!method initialize(id:, archived_at:, created_at:, entity_type_id:, metadata:, updated_at:)
46
46
  # A stored entity instance tracked by the governance service for a given customer
47
47
  #
48
48
  # @param id [String] The unique identifier for the entity
@@ -51,9 +51,9 @@ module Stigg
51
51
  #
52
52
  # @param created_at [Time] Timestamp of when the record was created
53
53
  #
54
- # @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity
54
+ # @param entity_type_id [String] The entity type identifier this entity instantiates
55
55
  #
56
- # @param type_id [String] The entity type identifier this entity instantiates
56
+ # @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity
57
57
  #
58
58
  # @param updated_at [Time] Timestamp of when the record was last updated
59
59
  end
@@ -37,25 +37,25 @@ module Stigg
37
37
  # @return [Time]
38
38
  required :created_at, Time, api_name: :createdAt
39
39
 
40
+ # @!attribute entity_type_id
41
+ # The entity type identifier this entity instantiates
42
+ #
43
+ # @return [String]
44
+ required :entity_type_id, String, api_name: :entityTypeId
45
+
40
46
  # @!attribute metadata
41
47
  # Free-form key/value metadata attached to the entity
42
48
  #
43
49
  # @return [Hash{Symbol=>String}]
44
50
  required :metadata, Stigg::Internal::Type::HashOf[String]
45
51
 
46
- # @!attribute type_id
47
- # The entity type identifier this entity instantiates
48
- #
49
- # @return [String]
50
- required :type_id, String, api_name: :typeId
51
-
52
52
  # @!attribute updated_at
53
53
  # Timestamp of when the record was last updated
54
54
  #
55
55
  # @return [Time]
56
56
  required :updated_at, Time, api_name: :updatedAt
57
57
 
58
- # @!method initialize(id:, archived_at:, created_at:, metadata:, type_id:, updated_at:)
58
+ # @!method initialize(id:, archived_at:, created_at:, entity_type_id:, metadata:, updated_at:)
59
59
  # A stored entity instance tracked by the governance service for a given customer
60
60
  #
61
61
  # @param id [String] The unique identifier for the entity
@@ -64,9 +64,9 @@ module Stigg
64
64
  #
65
65
  # @param created_at [Time] Timestamp of when the record was created
66
66
  #
67
- # @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity
67
+ # @param entity_type_id [String] The entity type identifier this entity instantiates
68
68
  #
69
- # @param type_id [String] The entity type identifier this entity instantiates
69
+ # @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity
70
70
  #
71
71
  # @param updated_at [Time] Timestamp of when the record was last updated
72
72
  end
@@ -49,6 +49,14 @@ module Stigg
49
49
  # @return [String]
50
50
  required :id, String
51
51
 
52
+ # @!attribute entity_type_id
53
+ # The entity type ID this entity instantiates. Required when creating a new
54
+ # entity; on a re-upsert may be omitted to preserve the existing type. Governance
55
+ # returns 400 if missing on create.
56
+ #
57
+ # @return [String, nil]
58
+ optional :entity_type_id, String, api_name: :entityTypeId
59
+
52
60
  # @!attribute metadata
53
61
  # Free-form key/value metadata. Patch semantics: empty-string value removes a key,
54
62
  # omitted keys are preserved.
@@ -56,15 +64,7 @@ module Stigg
56
64
  # @return [Hash{Symbol=>String}, nil]
57
65
  optional :metadata, Stigg::Internal::Type::HashOf[String]
58
66
 
59
- # @!attribute type_ref_id
60
- # The entity type refId this entity instantiates. Required when creating a new
61
- # entity; on a re-upsert may be omitted to preserve the existing type. Governance
62
- # returns 400 if missing on create.
63
- #
64
- # @return [String, nil]
65
- optional :type_ref_id, String, api_name: :typeRefId
66
-
67
- # @!method initialize(id:, metadata: nil, type_ref_id: nil)
67
+ # @!method initialize(id:, entity_type_id: nil, metadata: nil)
68
68
  # Some parameter documentations has been truncated, see
69
69
  # {Stigg::Models::V1Beta::Customers::EntityUpsertParams::Entity} for more details.
70
70
  #
@@ -72,9 +72,9 @@ module Stigg
72
72
  #
73
73
  # @param id [String] The unique identifier for the entity
74
74
  #
75
- # @param metadata [Hash{Symbol=>String}] Free-form key/value metadata. Patch semantics: empty-string value removes a key,
75
+ # @param entity_type_id [String] The entity type ID this entity instantiates. Required when creating a new entity
76
76
  #
77
- # @param type_ref_id [String] The entity type refId this entity instantiates. Required when creating a new ent
77
+ # @param metadata [Hash{Symbol=>String}] Free-form key/value metadata. Patch semantics: empty-string value removes a key,
78
78
  end
79
79
  end
80
80
  end
@@ -36,25 +36,25 @@ module Stigg
36
36
  # @return [Time]
37
37
  required :created_at, Time, api_name: :createdAt
38
38
 
39
+ # @!attribute entity_type_id
40
+ # The entity type identifier this entity instantiates
41
+ #
42
+ # @return [String]
43
+ required :entity_type_id, String, api_name: :entityTypeId
44
+
39
45
  # @!attribute metadata
40
46
  # Free-form key/value metadata attached to the entity
41
47
  #
42
48
  # @return [Hash{Symbol=>String}]
43
49
  required :metadata, Stigg::Internal::Type::HashOf[String]
44
50
 
45
- # @!attribute type_id
46
- # The entity type identifier this entity instantiates
47
- #
48
- # @return [String]
49
- required :type_id, String, api_name: :typeId
50
-
51
51
  # @!attribute updated_at
52
52
  # Timestamp of when the record was last updated
53
53
  #
54
54
  # @return [Time]
55
55
  required :updated_at, Time, api_name: :updatedAt
56
56
 
57
- # @!method initialize(id:, archived_at:, created_at:, metadata:, type_id:, updated_at:)
57
+ # @!method initialize(id:, archived_at:, created_at:, entity_type_id:, metadata:, updated_at:)
58
58
  # A stored entity instance tracked by the governance service for a given customer
59
59
  #
60
60
  # @param id [String] The unique identifier for the entity
@@ -63,9 +63,9 @@ module Stigg
63
63
  #
64
64
  # @param created_at [Time] Timestamp of when the record was created
65
65
  #
66
- # @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity
66
+ # @param entity_type_id [String] The entity type identifier this entity instantiates
67
67
  #
68
- # @param type_id [String] The entity type identifier this entity instantiates
68
+ # @param metadata [Hash{Symbol=>String}] Free-form key/value metadata attached to the entity
69
69
  #
70
70
  # @param updated_at [Time] Timestamp of when the record was last updated
71
71
  end
@@ -18,7 +18,7 @@ module Stigg
18
18
  #
19
19
  # @overload retrieve_governance(id, after: nil, currency_ids: nil, entity_id_search: nil, entity_type_ids: nil, feature_ids: nil, limit: nil, min_utilization: nil, order: nil, scope: nil, sort_by: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
20
20
  #
21
- # @param id [String] Path param: The customer external id.
21
+ # @param id [String] Path param: The customer ID.
22
22
  #
23
23
  # @param after [String] Query param: Return items that come after this cursor
24
24
  #
@@ -20,9 +20,9 @@ module Stigg
20
20
  #
21
21
  # @param before [String] Query param: Return items that come before this cursor
22
22
  #
23
- # @param capability_id [String] Query param: Filter assignments to a specific capability refId
23
+ # @param capability_id [String] Query param: Filter assignments to a specific capability ID
24
24
  #
25
- # @param entity_id [String] Query param: Filter assignments to a specific entity refId
25
+ # @param entity_id [String] Query param: Filter assignments to a specific entity ID
26
26
  #
27
27
  # @param limit [Integer] Query param: Maximum number of items to return
28
28
  #
@@ -12,7 +12,7 @@ module Stigg
12
12
  #
13
13
  # @overload retrieve(entity_id, id:, x_account_id: nil, x_environment_id: nil, request_options: {})
14
14
  #
15
- # @param entity_id [String] Path param: The entity identifier (refId)
15
+ # @param entity_id [String] Path param: The entity identifier
16
16
  #
17
17
  # @param id [String] Path param: The customer identifier (owner) the entity belongs to
18
18
  #
@@ -48,7 +48,7 @@ module Stigg
48
48
  #
49
49
  # Retrieves a paginated list of entities for the given customer.
50
50
  #
51
- # @overload list(id, after: nil, before: nil, include_archived: nil, limit: nil, type_ref_id: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
51
+ # @overload list(id, after: nil, before: nil, entity_type_id: nil, include_archived: nil, limit: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
52
52
  #
53
53
  # @param id [String] Path param: The customer identifier (owner) the entities belong to
54
54
  #
@@ -56,12 +56,12 @@ module Stigg
56
56
  #
57
57
  # @param before [String] Query param: Return items that come before this cursor
58
58
  #
59
+ # @param entity_type_id [String] Query param: Filter results to entities of a specific entity type, by the type's
60
+ #
59
61
  # @param include_archived [Symbol, Stigg::Models::V1Beta::Customers::EntityListParams::IncludeArchived] Query param: Whether to include archived entities. One of: true, false
60
62
  #
61
63
  # @param limit [Integer] Query param: Maximum number of items to return
62
64
  #
63
- # @param type_ref_id [String] Query param: Filter results to entities of a specific entity type, by the type's
64
- #
65
65
  # @param x_account_id [String] Header param: Account ID — optional when authenticating with a user JWT (Bearer
66
66
  #
67
67
  # @param x_environment_id [String] Header param: Environment ID — required when authenticating with a user JWT (Bea
@@ -72,13 +72,16 @@ module Stigg
72
72
  #
73
73
  # @see Stigg::Models::V1Beta::Customers::EntityListParams
74
74
  def list(id, params = {})
75
- query_params = [:after, :before, :include_archived, :limit, :type_ref_id]
75
+ query_params = [:after, :before, :entity_type_id, :include_archived, :limit]
76
76
  parsed, options = Stigg::V1Beta::Customers::EntityListParams.dump_request(params)
77
77
  query = Stigg::Internal::Util.encode_query_params(parsed.slice(*query_params))
78
78
  @client.request(
79
79
  method: :get,
80
80
  path: ["api/v1-beta/customers/%1$s/entities", id],
81
- query: query.transform_keys(include_archived: "includeArchived", type_ref_id: "typeRefId"),
81
+ query: query.transform_keys(
82
+ entity_type_id: "entityTypeId",
83
+ include_archived: "includeArchived"
84
+ ),
82
85
  headers: parsed.except(*query_params).transform_keys(
83
86
  x_account_id: "x-account-id",
84
87
  x_environment_id: "x-environment-id"
data/lib/stigg/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Stigg
4
- VERSION = "0.1.0.pre.beta.35"
4
+ VERSION = "0.1.0.pre.beta.36"
5
5
  end