stigg 0.1.0.pre.beta.23 → 0.1.0.pre.beta.24
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/stigg/models/v1/events/beta/customer_retrieve_governance_params.rb +173 -0
- data/lib/stigg/models/v1/events/beta/customer_retrieve_governance_response.rb +179 -0
- data/lib/stigg/resources/v1/events/beta/customers.rb +99 -0
- data/lib/stigg/resources/v1/events/beta.rb +22 -0
- data/lib/stigg/resources/v1/events.rb +4 -0
- data/lib/stigg/version.rb +1 -1
- data/lib/stigg.rb +4 -0
- data/rbi/stigg/models/v1/events/beta/customer_retrieve_governance_params.rbi +365 -0
- data/rbi/stigg/models/v1/events/beta/customer_retrieve_governance_response.rbi +291 -0
- data/rbi/stigg/resources/v1/events/beta/customers.rbi +89 -0
- data/rbi/stigg/resources/v1/events/beta.rbi +19 -0
- data/rbi/stigg/resources/v1/events.rbi +3 -0
- data/sig/stigg/models/v1/events/beta/customer_retrieve_governance_params.rbs +166 -0
- data/sig/stigg/models/v1/events/beta/customer_retrieve_governance_response.rbs +127 -0
- data/sig/stigg/resources/v1/events/beta/customers.rbs +30 -0
- data/sig/stigg/resources/v1/events/beta.rbs +13 -0
- data/sig/stigg/resources/v1/events.rbs +2 -0
- metadata +14 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 766be9befabaf0dd015fbc84a5445dc84fbdb35d770e2b5366303c0ed6e8c2b0
|
|
4
|
+
data.tar.gz: f5f1132a8f58061908fc25ad9a013c3b8e2f5470650d1d784a3de1c362cb6be1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: be9e4942faad0c1f23273a5568003e397bb0f0761850286ce65753ab125317c46e42d0d7ffee8f6cb033bec9f4e7e56b52fabff8340b4f639acbb3bba85fe96e
|
|
7
|
+
data.tar.gz: b12b78dd1ff7730be7ce7ec777509055d151ca884a0e5820c55e00bb1ef4c90e9253a05572879ad7c08e576240061a758ae80b3ddd270fb213625bb4dc726169
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.1.0-beta.24 (2026-06-18)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.1.0-beta.23...v0.1.0-beta.24](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.23...v0.1.0-beta.24)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** add retrieve_governance method to events/beta/customers ([95132a5](https://github.com/stiggio/stigg-ruby/commit/95132a50a901830feddb5ee9f48a06dce18c7d64))
|
|
10
|
+
|
|
3
11
|
## 0.1.0-beta.23 (2026-06-17)
|
|
4
12
|
|
|
5
13
|
Full Changelog: [v0.1.0-beta.22...v0.1.0-beta.23](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.22...v0.1.0-beta.23)
|
data/README.md
CHANGED
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Stigg
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
module Events
|
|
7
|
+
module Beta
|
|
8
|
+
# @see Stigg::Resources::V1::Events::Beta::Customers#retrieve_governance
|
|
9
|
+
class CustomerRetrieveGovernanceParams < Stigg::Internal::Type::BaseModel
|
|
10
|
+
extend Stigg::Internal::Type::RequestParameters::Converter
|
|
11
|
+
include Stigg::Internal::Type::RequestParameters
|
|
12
|
+
|
|
13
|
+
# @!attribute id
|
|
14
|
+
#
|
|
15
|
+
# @return [String]
|
|
16
|
+
required :id, String
|
|
17
|
+
|
|
18
|
+
# @!attribute after
|
|
19
|
+
# Return items that come after this cursor
|
|
20
|
+
#
|
|
21
|
+
# @return [String, nil]
|
|
22
|
+
optional :after, String
|
|
23
|
+
|
|
24
|
+
# @!attribute currency_ids
|
|
25
|
+
# Currency ids to include, repeated per value (e.g. `?currencyIds=credits`). Omit
|
|
26
|
+
# both featureIds and currencyIds for tree mode.
|
|
27
|
+
#
|
|
28
|
+
# @return [Array<String>, nil]
|
|
29
|
+
optional :currency_ids, Stigg::Internal::Type::ArrayOf[String]
|
|
30
|
+
|
|
31
|
+
# @!attribute entity_id_search
|
|
32
|
+
# Case-insensitive substring match on the entity id (`%`/`_` matched literally).
|
|
33
|
+
#
|
|
34
|
+
# @return [String, nil]
|
|
35
|
+
optional :entity_id_search, String
|
|
36
|
+
|
|
37
|
+
# @!attribute entity_type_ids
|
|
38
|
+
# Filter to one or more entity types, repeated per value (e.g.
|
|
39
|
+
# `?entityTypeIds=team&entityTypeIds=user`).
|
|
40
|
+
#
|
|
41
|
+
# @return [Array<String>, nil]
|
|
42
|
+
optional :entity_type_ids, Stigg::Internal::Type::ArrayOf[String]
|
|
43
|
+
|
|
44
|
+
# @!attribute feature_ids
|
|
45
|
+
# Feature ids to include, repeated per value (e.g.
|
|
46
|
+
# `?featureIds=ai-tokens&featureIds=seats`). Omit both featureIds and currencyIds
|
|
47
|
+
# for tree mode — every node in the hierarchy with no usage configuration
|
|
48
|
+
# attached.
|
|
49
|
+
#
|
|
50
|
+
# @return [Array<String>, nil]
|
|
51
|
+
optional :feature_ids, Stigg::Internal::Type::ArrayOf[String]
|
|
52
|
+
|
|
53
|
+
# @!attribute limit
|
|
54
|
+
# Maximum number of items to return
|
|
55
|
+
#
|
|
56
|
+
# @return [Integer, nil]
|
|
57
|
+
optional :limit, Integer
|
|
58
|
+
|
|
59
|
+
# @!attribute min_utilization
|
|
60
|
+
# Only nodes with utilization ≥ this value (e.g. 0.8 for ≥80%, 1 for at/over
|
|
61
|
+
# limit).
|
|
62
|
+
#
|
|
63
|
+
# @return [Float, nil]
|
|
64
|
+
optional :min_utilization, Float
|
|
65
|
+
|
|
66
|
+
# @!attribute order
|
|
67
|
+
# Sort direction: `asc` or `desc` (default `desc`).
|
|
68
|
+
#
|
|
69
|
+
# @return [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Order, nil]
|
|
70
|
+
optional :order, enum: -> { Stigg::V1::Events::Beta::CustomerRetrieveGovernanceParams::Order }
|
|
71
|
+
|
|
72
|
+
# @!attribute scope
|
|
73
|
+
# Filter by configuration scope: `all` (default), `nodeWide` (`[]` only), or
|
|
74
|
+
# `scoped` (non-empty only).
|
|
75
|
+
#
|
|
76
|
+
# @return [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Scope, nil]
|
|
77
|
+
optional :scope, enum: -> { Stigg::V1::Events::Beta::CustomerRetrieveGovernanceParams::Scope }
|
|
78
|
+
|
|
79
|
+
# @!attribute sort_by
|
|
80
|
+
# Sort key: `utilization` (default, cross-capability-safe), `currentUsage`,
|
|
81
|
+
# `usageLimit`, `scopeSize`, `id`, or `createdAt`.
|
|
82
|
+
#
|
|
83
|
+
# @return [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::SortBy, nil]
|
|
84
|
+
optional :sort_by, enum: -> { Stigg::V1::Events::Beta::CustomerRetrieveGovernanceParams::SortBy }
|
|
85
|
+
|
|
86
|
+
# @!attribute x_account_id
|
|
87
|
+
#
|
|
88
|
+
# @return [String, nil]
|
|
89
|
+
optional :x_account_id, String
|
|
90
|
+
|
|
91
|
+
# @!attribute x_environment_id
|
|
92
|
+
#
|
|
93
|
+
# @return [String, nil]
|
|
94
|
+
optional :x_environment_id, String
|
|
95
|
+
|
|
96
|
+
# @!method initialize(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: {})
|
|
97
|
+
# Some parameter documentations has been truncated, see
|
|
98
|
+
# {Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams} for more
|
|
99
|
+
# details.
|
|
100
|
+
#
|
|
101
|
+
# @param id [String]
|
|
102
|
+
#
|
|
103
|
+
# @param after [String] Return items that come after this cursor
|
|
104
|
+
#
|
|
105
|
+
# @param currency_ids [Array<String>] Currency ids to include, repeated per value (e.g. `?currencyIds=credits`). Omit
|
|
106
|
+
#
|
|
107
|
+
# @param entity_id_search [String] Case-insensitive substring match on the entity id (`%`/`_` matched literally).
|
|
108
|
+
#
|
|
109
|
+
# @param entity_type_ids [Array<String>] Filter to one or more entity types, repeated per value (e.g. `?entityTypeIds=tea
|
|
110
|
+
#
|
|
111
|
+
# @param feature_ids [Array<String>] Feature ids to include, repeated per value (e.g. `?featureIds=ai-tokens&featureI
|
|
112
|
+
#
|
|
113
|
+
# @param limit [Integer] Maximum number of items to return
|
|
114
|
+
#
|
|
115
|
+
# @param min_utilization [Float] Only nodes with utilization ≥ this value (e.g. 0.8 for ≥80%, 1 for at/over limit
|
|
116
|
+
#
|
|
117
|
+
# @param order [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Order] Sort direction: `asc` or `desc` (default `desc`).
|
|
118
|
+
#
|
|
119
|
+
# @param scope [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Scope] Filter by configuration scope: `all` (default), `nodeWide` (`[]` only), or `scop
|
|
120
|
+
#
|
|
121
|
+
# @param sort_by [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::SortBy] Sort key: `utilization` (default, cross-capability-safe), `currentUsage`, `usage
|
|
122
|
+
#
|
|
123
|
+
# @param x_account_id [String]
|
|
124
|
+
#
|
|
125
|
+
# @param x_environment_id [String]
|
|
126
|
+
#
|
|
127
|
+
# @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
|
|
128
|
+
|
|
129
|
+
# Sort direction: `asc` or `desc` (default `desc`).
|
|
130
|
+
module Order
|
|
131
|
+
extend Stigg::Internal::Type::Enum
|
|
132
|
+
|
|
133
|
+
ASC = :asc
|
|
134
|
+
DESC = :desc
|
|
135
|
+
|
|
136
|
+
# @!method self.values
|
|
137
|
+
# @return [Array<Symbol>]
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# Filter by configuration scope: `all` (default), `nodeWide` (`[]` only), or
|
|
141
|
+
# `scoped` (non-empty only).
|
|
142
|
+
module Scope
|
|
143
|
+
extend Stigg::Internal::Type::Enum
|
|
144
|
+
|
|
145
|
+
ALL = :all
|
|
146
|
+
NODE_WIDE = :nodeWide
|
|
147
|
+
SCOPED = :scoped
|
|
148
|
+
|
|
149
|
+
# @!method self.values
|
|
150
|
+
# @return [Array<Symbol>]
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
# Sort key: `utilization` (default, cross-capability-safe), `currentUsage`,
|
|
154
|
+
# `usageLimit`, `scopeSize`, `id`, or `createdAt`.
|
|
155
|
+
module SortBy
|
|
156
|
+
extend Stigg::Internal::Type::Enum
|
|
157
|
+
|
|
158
|
+
UTILIZATION = :utilization
|
|
159
|
+
CURRENT_USAGE = :currentUsage
|
|
160
|
+
USAGE_LIMIT = :usageLimit
|
|
161
|
+
SCOPE_SIZE = :scopeSize
|
|
162
|
+
ID = :id
|
|
163
|
+
CREATED_AT = :createdAt
|
|
164
|
+
|
|
165
|
+
# @!method self.values
|
|
166
|
+
# @return [Array<Symbol>]
|
|
167
|
+
end
|
|
168
|
+
end
|
|
169
|
+
end
|
|
170
|
+
end
|
|
171
|
+
end
|
|
172
|
+
end
|
|
173
|
+
end
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Stigg
|
|
4
|
+
module Models
|
|
5
|
+
module V1
|
|
6
|
+
module Events
|
|
7
|
+
module Beta
|
|
8
|
+
# @see Stigg::Resources::V1::Events::Beta::Customers#retrieve_governance
|
|
9
|
+
class CustomerRetrieveGovernanceResponse < Stigg::Internal::Type::BaseModel
|
|
10
|
+
# @!attribute data
|
|
11
|
+
#
|
|
12
|
+
# @return [Array<Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data>]
|
|
13
|
+
required :data,
|
|
14
|
+
-> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data] }
|
|
15
|
+
|
|
16
|
+
# @!attribute pagination
|
|
17
|
+
#
|
|
18
|
+
# @return [Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Pagination]
|
|
19
|
+
required :pagination,
|
|
20
|
+
-> { Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Pagination }
|
|
21
|
+
|
|
22
|
+
# @!method initialize(data:, pagination:)
|
|
23
|
+
# Paginated list of governance tree nodes, each with its usage configuration and
|
|
24
|
+
# current usage.
|
|
25
|
+
#
|
|
26
|
+
# @param data [Array<Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data>]
|
|
27
|
+
# @param pagination [Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Pagination]
|
|
28
|
+
|
|
29
|
+
class Data < Stigg::Internal::Type::BaseModel
|
|
30
|
+
# @!attribute cadence
|
|
31
|
+
# Usage-reset cadence. Currently only `MONTH` is supported.
|
|
32
|
+
#
|
|
33
|
+
# @return [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data::Cadence, nil]
|
|
34
|
+
required :cadence,
|
|
35
|
+
enum: -> { Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data::Cadence },
|
|
36
|
+
nil?: true
|
|
37
|
+
|
|
38
|
+
# @!attribute current_usage
|
|
39
|
+
# Usage consumed in the current cadence period (may lag the live counter by a
|
|
40
|
+
# short interval).
|
|
41
|
+
#
|
|
42
|
+
# @return [Float, nil]
|
|
43
|
+
required :current_usage, Float, api_name: :currentUsage, nil?: true
|
|
44
|
+
|
|
45
|
+
# @!attribute entity_id
|
|
46
|
+
# External id of the entity at this node.
|
|
47
|
+
#
|
|
48
|
+
# @return [String]
|
|
49
|
+
required :entity_id, String, api_name: :entityId
|
|
50
|
+
|
|
51
|
+
# @!attribute entity_type
|
|
52
|
+
# External id of the entity type (e.g. `team`, `user`).
|
|
53
|
+
#
|
|
54
|
+
# @return [String]
|
|
55
|
+
required :entity_type, String, api_name: :entityType
|
|
56
|
+
|
|
57
|
+
# @!attribute parent_id
|
|
58
|
+
# External id of the parent entity in the tree; `null` for a root. Use it to
|
|
59
|
+
# rebuild the tree.
|
|
60
|
+
#
|
|
61
|
+
# @return [String, nil]
|
|
62
|
+
required :parent_id, String, api_name: :parentId, nil?: true
|
|
63
|
+
|
|
64
|
+
# @!attribute scope_entity_ids
|
|
65
|
+
# The configuration scope (entity ids). Empty is the node-wide configuration; a
|
|
66
|
+
# non-empty set is a dimension-scoped sub-configuration.
|
|
67
|
+
#
|
|
68
|
+
# @return [Array<String>]
|
|
69
|
+
required :scope_entity_ids, Stigg::Internal::Type::ArrayOf[String], api_name: :scopeEntityIds
|
|
70
|
+
|
|
71
|
+
# @!attribute usage_limit
|
|
72
|
+
# Hard usage limit for this node per cadence period.
|
|
73
|
+
#
|
|
74
|
+
# @return [Float, nil]
|
|
75
|
+
required :usage_limit, Float, api_name: :usageLimit, nil?: true
|
|
76
|
+
|
|
77
|
+
# @!attribute usage_period_end
|
|
78
|
+
# Exclusive end of the cadence period — when usage resets; `null` once the period
|
|
79
|
+
# has rolled over.
|
|
80
|
+
#
|
|
81
|
+
# @return [Time, nil]
|
|
82
|
+
required :usage_period_end, Time, api_name: :usagePeriodEnd, nil?: true
|
|
83
|
+
|
|
84
|
+
# @!attribute usage_period_start
|
|
85
|
+
# Start of the cadence period the usage snapshot belongs to; `null` once the
|
|
86
|
+
# period has rolled over.
|
|
87
|
+
#
|
|
88
|
+
# @return [Time, nil]
|
|
89
|
+
required :usage_period_start, Time, api_name: :usagePeriodStart, nil?: true
|
|
90
|
+
|
|
91
|
+
# @!attribute utilization
|
|
92
|
+
# `currentUsage / usageLimit` (1 when usageLimit is 0 — always at limit). The
|
|
93
|
+
# cross-capability-safe sort key.
|
|
94
|
+
#
|
|
95
|
+
# @return [Float, nil]
|
|
96
|
+
required :utilization, Float, nil?: true
|
|
97
|
+
|
|
98
|
+
# @!attribute currency_id
|
|
99
|
+
# The metered currency refId (present when the configured capability is a credit
|
|
100
|
+
# currency).
|
|
101
|
+
#
|
|
102
|
+
# @return [String, nil]
|
|
103
|
+
optional :currency_id, String, api_name: :currencyId
|
|
104
|
+
|
|
105
|
+
# @!attribute feature_id
|
|
106
|
+
# The metered feature refId (present when the configured capability is a feature).
|
|
107
|
+
#
|
|
108
|
+
# @return [String, nil]
|
|
109
|
+
optional :feature_id, String, api_name: :featureId
|
|
110
|
+
|
|
111
|
+
# @!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)
|
|
112
|
+
# Some parameter documentations has been truncated, see
|
|
113
|
+
# {Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data} for
|
|
114
|
+
# more details.
|
|
115
|
+
#
|
|
116
|
+
# A node of the governance hierarchy tree with its usage configuration (limit,
|
|
117
|
+
# cadence, scope) and current usage. Usage is read from a periodically-refreshed
|
|
118
|
+
# read model and may lag the live counter by a short interval; it never gates
|
|
119
|
+
# access.
|
|
120
|
+
#
|
|
121
|
+
# @param cadence [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data::Cadence, nil] Usage-reset cadence. Currently only `MONTH` is supported.
|
|
122
|
+
#
|
|
123
|
+
# @param current_usage [Float, nil] Usage consumed in the current cadence period (may lag the live counter by a shor
|
|
124
|
+
#
|
|
125
|
+
# @param entity_id [String] External id of the entity at this node.
|
|
126
|
+
#
|
|
127
|
+
# @param entity_type [String] External id of the entity type (e.g. `team`, `user`).
|
|
128
|
+
#
|
|
129
|
+
# @param parent_id [String, nil] External id of the parent entity in the tree; `null` for a root. Use it to rebui
|
|
130
|
+
#
|
|
131
|
+
# @param scope_entity_ids [Array<String>] The configuration scope (entity ids). Empty is the node-wide configuration; a no
|
|
132
|
+
#
|
|
133
|
+
# @param usage_limit [Float, nil] Hard usage limit for this node per cadence period.
|
|
134
|
+
#
|
|
135
|
+
# @param usage_period_end [Time, nil] Exclusive end of the cadence period — when usage resets; `null` once the period
|
|
136
|
+
#
|
|
137
|
+
# @param usage_period_start [Time, nil] Start of the cadence period the usage snapshot belongs to; `null` once the perio
|
|
138
|
+
#
|
|
139
|
+
# @param utilization [Float, nil] `currentUsage / usageLimit` (1 when usageLimit is 0 — always at limit). The cros
|
|
140
|
+
#
|
|
141
|
+
# @param currency_id [String] The metered currency refId (present when the configured capability is a credit c
|
|
142
|
+
#
|
|
143
|
+
# @param feature_id [String] The metered feature refId (present when the configured capability is a feature).
|
|
144
|
+
|
|
145
|
+
# Usage-reset cadence. Currently only `MONTH` is supported.
|
|
146
|
+
#
|
|
147
|
+
# @see Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Data#cadence
|
|
148
|
+
module Cadence
|
|
149
|
+
extend Stigg::Internal::Type::Enum
|
|
150
|
+
|
|
151
|
+
MONTH = :MONTH
|
|
152
|
+
|
|
153
|
+
# @!method self.values
|
|
154
|
+
# @return [Array<Symbol>]
|
|
155
|
+
end
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# @see Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse#pagination
|
|
159
|
+
class Pagination < Stigg::Internal::Type::BaseModel
|
|
160
|
+
# @!attribute next_
|
|
161
|
+
# Cursor for fetching the next page of results, or null if no additional pages
|
|
162
|
+
# exist
|
|
163
|
+
#
|
|
164
|
+
# @return [String, nil]
|
|
165
|
+
required :next_, String, api_name: :next, nil?: true
|
|
166
|
+
|
|
167
|
+
# @!method initialize(next_:)
|
|
168
|
+
# Some parameter documentations has been truncated, see
|
|
169
|
+
# {Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse::Pagination}
|
|
170
|
+
# for more details.
|
|
171
|
+
#
|
|
172
|
+
# @param next_ [String, nil] Cursor for fetching the next page of results, or null if no additional pages exi
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
end
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
end
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Stigg
|
|
4
|
+
module Resources
|
|
5
|
+
class V1
|
|
6
|
+
class Events
|
|
7
|
+
class Beta
|
|
8
|
+
class Customers
|
|
9
|
+
# Some parameter documentations has been truncated, see
|
|
10
|
+
# {Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams} for more
|
|
11
|
+
# details.
|
|
12
|
+
#
|
|
13
|
+
# Queries the customer's governance hierarchy tree, returning a cursor-paginated
|
|
14
|
+
# list of nodes with their usage configuration (limit, cadence, scope) and current
|
|
15
|
+
# usage, sortable and filterable by usage. Each node carries `parentId` so the
|
|
16
|
+
# tree can be rebuilt client-side. Usage is read from a periodically-refreshed
|
|
17
|
+
# read model and never gates access.
|
|
18
|
+
#
|
|
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
|
+
#
|
|
21
|
+
# @param id [String] Path param: The customer external id.
|
|
22
|
+
#
|
|
23
|
+
# @param after [String] Query param: Return items that come after this cursor
|
|
24
|
+
#
|
|
25
|
+
# @param currency_ids [Array<String>] Query param: Currency ids to include, repeated per value (e.g. `?currencyIds=cre
|
|
26
|
+
#
|
|
27
|
+
# @param entity_id_search [String] Query param: Case-insensitive substring match on the entity id (`%`/`_` matched
|
|
28
|
+
#
|
|
29
|
+
# @param entity_type_ids [Array<String>] Query param: Filter to one or more entity types, repeated per value (e.g. `?enti
|
|
30
|
+
#
|
|
31
|
+
# @param feature_ids [Array<String>] Query param: Feature ids to include, repeated per value (e.g. `?featureIds=ai-to
|
|
32
|
+
#
|
|
33
|
+
# @param limit [Integer] Query param: Maximum number of items to return
|
|
34
|
+
#
|
|
35
|
+
# @param min_utilization [Float] Query param: Only nodes with utilization ≥ this value (e.g. 0.8 for ≥80%, 1 for
|
|
36
|
+
#
|
|
37
|
+
# @param order [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Order] Query param: Sort direction: `asc` or `desc` (default `desc`).
|
|
38
|
+
#
|
|
39
|
+
# @param scope [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::Scope] Query param: Filter by configuration scope: `all` (default), `nodeWide` (`[]` on
|
|
40
|
+
#
|
|
41
|
+
# @param sort_by [Symbol, Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams::SortBy] Query param: Sort key: `utilization` (default, cross-capability-safe), `currentU
|
|
42
|
+
#
|
|
43
|
+
# @param x_account_id [String] Header param: Account ID — optional when authenticating with a user JWT (Bearer
|
|
44
|
+
#
|
|
45
|
+
# @param x_environment_id [String] Header param: Environment ID — required when authenticating with a user JWT (Bea
|
|
46
|
+
#
|
|
47
|
+
# @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
48
|
+
#
|
|
49
|
+
# @return [Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse]
|
|
50
|
+
#
|
|
51
|
+
# @see Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceParams
|
|
52
|
+
def retrieve_governance(id, params = {})
|
|
53
|
+
query_params =
|
|
54
|
+
[
|
|
55
|
+
:after,
|
|
56
|
+
:currency_ids,
|
|
57
|
+
:entity_id_search,
|
|
58
|
+
:entity_type_ids,
|
|
59
|
+
:feature_ids,
|
|
60
|
+
:limit,
|
|
61
|
+
:min_utilization,
|
|
62
|
+
:order,
|
|
63
|
+
:scope,
|
|
64
|
+
:sort_by
|
|
65
|
+
]
|
|
66
|
+
parsed, options = Stigg::V1::Events::Beta::CustomerRetrieveGovernanceParams.dump_request(params)
|
|
67
|
+
query = Stigg::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
68
|
+
@client.request(
|
|
69
|
+
method: :get,
|
|
70
|
+
path: ["api/v1-beta/customers/%1$s/governance", id],
|
|
71
|
+
query: query.transform_keys(
|
|
72
|
+
currency_ids: "currencyIds",
|
|
73
|
+
entity_id_search: "entityIdSearch",
|
|
74
|
+
entity_type_ids: "entityTypeIds",
|
|
75
|
+
feature_ids: "featureIds",
|
|
76
|
+
min_utilization: "minUtilization",
|
|
77
|
+
sort_by: "sortBy"
|
|
78
|
+
),
|
|
79
|
+
headers: parsed.except(*query_params).transform_keys(
|
|
80
|
+
x_account_id: "x-account-id",
|
|
81
|
+
x_environment_id: "x-environment-id"
|
|
82
|
+
),
|
|
83
|
+
model: Stigg::Models::V1::Events::Beta::CustomerRetrieveGovernanceResponse,
|
|
84
|
+
options: options
|
|
85
|
+
)
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# @api private
|
|
89
|
+
#
|
|
90
|
+
# @param client [Stigg::Client]
|
|
91
|
+
def initialize(client:)
|
|
92
|
+
@client = client
|
|
93
|
+
end
|
|
94
|
+
end
|
|
95
|
+
end
|
|
96
|
+
end
|
|
97
|
+
end
|
|
98
|
+
end
|
|
99
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Stigg
|
|
4
|
+
module Resources
|
|
5
|
+
class V1
|
|
6
|
+
class Events
|
|
7
|
+
class Beta
|
|
8
|
+
# @return [Stigg::Resources::V1::Events::Beta::Customers]
|
|
9
|
+
attr_reader :customers
|
|
10
|
+
|
|
11
|
+
# @api private
|
|
12
|
+
#
|
|
13
|
+
# @param client [Stigg::Client]
|
|
14
|
+
def initialize(client:)
|
|
15
|
+
@client = client
|
|
16
|
+
@customers = Stigg::Resources::V1::Events::Beta::Customers.new(client: client)
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -8,6 +8,9 @@ module Stigg
|
|
|
8
8
|
# @return [Stigg::Resources::V1::Events::DataExport]
|
|
9
9
|
attr_reader :data_export
|
|
10
10
|
|
|
11
|
+
# @return [Stigg::Resources::V1::Events::Beta]
|
|
12
|
+
attr_reader :beta
|
|
13
|
+
|
|
11
14
|
# Some parameter documentations has been truncated, see
|
|
12
15
|
# {Stigg::Models::V1::EventReportParams} for more details.
|
|
13
16
|
#
|
|
@@ -46,6 +49,7 @@ module Stigg
|
|
|
46
49
|
def initialize(client:)
|
|
47
50
|
@client = client
|
|
48
51
|
@data_export = Stigg::Resources::V1::Events::DataExport.new(client: client)
|
|
52
|
+
@beta = Stigg::Resources::V1::Events::Beta.new(client: client)
|
|
49
53
|
end
|
|
50
54
|
end
|
|
51
55
|
end
|
data/lib/stigg/version.rb
CHANGED
data/lib/stigg.rb
CHANGED
|
@@ -134,6 +134,8 @@ require_relative "stigg/models/v1/customer_unarchive_params"
|
|
|
134
134
|
require_relative "stigg/models/v1/customer_update_params"
|
|
135
135
|
require_relative "stigg/models/v1/event_report_params"
|
|
136
136
|
require_relative "stigg/models/v1/event_report_response"
|
|
137
|
+
require_relative "stigg/models/v1/events/beta/customer_retrieve_governance_params"
|
|
138
|
+
require_relative "stigg/models/v1/events/beta/customer_retrieve_governance_response"
|
|
137
139
|
require_relative "stigg/models/v1/events/data_export/destination_create_params"
|
|
138
140
|
require_relative "stigg/models/v1/events/data_export/destination_create_response"
|
|
139
141
|
require_relative "stigg/models/v1/events/data_export/destination_delete_params"
|
|
@@ -242,6 +244,8 @@ require_relative "stigg/resources/v1/customers/integrations"
|
|
|
242
244
|
require_relative "stigg/resources/v1/customers/payment_method"
|
|
243
245
|
require_relative "stigg/resources/v1/customers/promotional_entitlements"
|
|
244
246
|
require_relative "stigg/resources/v1/events"
|
|
247
|
+
require_relative "stigg/resources/v1/events/beta"
|
|
248
|
+
require_relative "stigg/resources/v1/events/beta/customers"
|
|
245
249
|
require_relative "stigg/resources/v1/events/data_export"
|
|
246
250
|
require_relative "stigg/resources/v1/events/data_export/destinations"
|
|
247
251
|
require_relative "stigg/resources/v1/features"
|