orb-billing 1.28.1 → 1.30.0
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 +14 -0
- data/README.md +1 -1
- data/lib/orb/models/alert.rb +13 -4
- data/lib/orb/models/alert_create_for_subscription_params.rb +14 -3
- data/lib/orb/models/alert_update_params.rb +14 -3
- data/lib/orb/resources/customers/credits/top_ups.rb +14 -2
- data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +4 -1
- data/lib/orb/resources/dimensional_price_groups.rb +11 -2
- data/lib/orb/resources/items.rb +3 -1
- data/lib/orb/resources/plans/migrations.rb +3 -1
- data/lib/orb/version.rb +1 -1
- data/rbi/orb/models/alert.rbi +17 -7
- data/rbi/orb/models/alert_create_for_subscription_params.rbi +21 -7
- data/rbi/orb/models/alert_update_params.rbi +21 -7
- data/rbi/orb/resources/customers/credits/top_ups.rbi +14 -2
- data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +4 -1
- data/rbi/orb/resources/dimensional_price_groups.rbi +11 -2
- data/rbi/orb/resources/items.rbi +3 -1
- data/rbi/orb/resources/plans/migrations.rbi +3 -1
- data/sig/orb/models/alert.rbs +11 -3
- data/sig/orb/models/alert_create_for_subscription_params.rbs +11 -3
- data/sig/orb/models/alert_update_params.rbs +11 -3
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d76a05385315f5843ea2bcc7db9a121d5990654a8c9e14b7c0f098f5e001ed6f
|
|
4
|
+
data.tar.gz: 021e9521889d0a5a3664260e921ab0b0c60bc0298e8abc389d3acdc4f7183e0c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 001d9531a4f619a877596c0162fc5eac4a42f2fb293e3f30750288501122f50226a851f712044daf7e46c16a4ff7ba8d8025916f690e691e3091abc601b63755
|
|
7
|
+
data.tar.gz: 3085bd9431a9ec2c15e3669a967fdffdeb6f83a39e7c8e77927093c88eb084f93ce5a61d73e387252a7c47e0bec5d38b81552c4f3773b26855bff2d73c3d5828
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.30.0](https://github.com/orbcorp/orb-ruby/compare/v1.29.0...v1.30.0) (2026-09-04)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **api:** api update ([759c873](https://github.com/orbcorp/orb-ruby/commit/759c8739c8a675a6c34af657ce340388c2e5585f))
|
|
9
|
+
|
|
10
|
+
## [1.29.0](https://github.com/orbcorp/orb-ruby/compare/v1.28.1...v1.29.0) (2026-09-03)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Features
|
|
14
|
+
|
|
15
|
+
* **api:** support partial grouping key targeting in alert threshold overrides ([df6a1c5](https://github.com/orbcorp/orb-ruby/commit/df6a1c56eb5008b4659900048b555e6fff7dcd30))
|
|
16
|
+
|
|
3
17
|
## [1.28.1](https://github.com/orbcorp/orb-ruby/compare/v1.28.0...v1.28.1) (2026-08-28)
|
|
4
18
|
|
|
5
19
|
|
data/README.md
CHANGED
data/lib/orb/models/alert.rb
CHANGED
|
@@ -308,8 +308,8 @@ module Orb
|
|
|
308
308
|
|
|
309
309
|
class ThresholdOverride < Orb::Internal::Type::BaseModel
|
|
310
310
|
# @!attribute group_values
|
|
311
|
-
# The values
|
|
312
|
-
#
|
|
311
|
+
# The values identifying this group, ordered to match group_keys when set and the
|
|
312
|
+
# alert's grouping_keys otherwise.
|
|
313
313
|
#
|
|
314
314
|
# @return [Array<String>]
|
|
315
315
|
required :group_values, Orb::Internal::Type::ArrayOf[String]
|
|
@@ -320,7 +320,14 @@ module Orb
|
|
|
320
320
|
# @return [Array<Orb::Models::Threshold>]
|
|
321
321
|
required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
|
|
322
322
|
|
|
323
|
-
# @!
|
|
323
|
+
# @!attribute group_keys
|
|
324
|
+
# The subset of the alert's grouping_keys this override binds. Null when the
|
|
325
|
+
# override targets one exact group across every grouping key.
|
|
326
|
+
#
|
|
327
|
+
# @return [Array<String>, nil]
|
|
328
|
+
optional :group_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
|
|
329
|
+
|
|
330
|
+
# @!method initialize(group_values:, thresholds:, group_keys: nil)
|
|
324
331
|
# Some parameter documentations has been truncated, see
|
|
325
332
|
# {Orb::Models::Alert::ThresholdOverride} for more details.
|
|
326
333
|
#
|
|
@@ -329,9 +336,11 @@ module Orb
|
|
|
329
336
|
# An empty `thresholds` list means the group is silenced (never fires). A
|
|
330
337
|
# non-empty list fully replaces the default thresholds for that group.
|
|
331
338
|
#
|
|
332
|
-
# @param group_values [Array<String>] The values
|
|
339
|
+
# @param group_values [Array<String>] The values identifying this group, ordered to match group_keys when set and the
|
|
333
340
|
#
|
|
334
341
|
# @param thresholds [Array<Orb::Models::Threshold>] The thresholds applied to this group. An empty list means the group is silenced.
|
|
342
|
+
#
|
|
343
|
+
# @param group_keys [Array<String>, nil] The subset of the alert's grouping_keys this override binds. Null when the overr
|
|
335
344
|
end
|
|
336
345
|
end
|
|
337
346
|
end
|
|
@@ -160,8 +160,8 @@ module Orb
|
|
|
160
160
|
class ThresholdOverride < Orb::Internal::Type::BaseModel
|
|
161
161
|
# @!attribute group_values
|
|
162
162
|
# The values of the grouping keys that identify this group. The list length must
|
|
163
|
-
# match
|
|
164
|
-
#
|
|
163
|
+
# match group_keys when it is set, and the alert's grouping_keys otherwise, with
|
|
164
|
+
# values in the same order as whichever applies.
|
|
165
165
|
#
|
|
166
166
|
# @return [Array<String>]
|
|
167
167
|
required :group_values, Orb::Internal::Type::ArrayOf[String]
|
|
@@ -173,7 +173,16 @@ module Orb
|
|
|
173
173
|
# @return [Array<Orb::Models::Threshold>]
|
|
174
174
|
required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
|
|
175
175
|
|
|
176
|
-
# @!
|
|
176
|
+
# @!attribute group_keys
|
|
177
|
+
# The subset of the alert's grouping_keys that this override binds. Any grouping
|
|
178
|
+
# key not named is unconstrained, so the override applies to every group matching
|
|
179
|
+
# the named values. When omitted, group_values must cover every grouping key in
|
|
180
|
+
# order.
|
|
181
|
+
#
|
|
182
|
+
# @return [Array<String>, nil]
|
|
183
|
+
optional :group_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
|
|
184
|
+
|
|
185
|
+
# @!method initialize(group_values:, thresholds:, group_keys: nil)
|
|
177
186
|
# Some parameter documentations has been truncated, see
|
|
178
187
|
# {Orb::Models::AlertCreateForSubscriptionParams::ThresholdOverride} for more
|
|
179
188
|
# details.
|
|
@@ -186,6 +195,8 @@ module Orb
|
|
|
186
195
|
# @param group_values [Array<String>] The values of the grouping keys that identify this group. The list length must m
|
|
187
196
|
#
|
|
188
197
|
# @param thresholds [Array<Orb::Models::Threshold>] The thresholds to apply to this group. An empty list silences alerts for this gr
|
|
198
|
+
#
|
|
199
|
+
# @param group_keys [Array<String>, nil] The subset of the alert's grouping_keys that this override binds. Any grouping k
|
|
189
200
|
end
|
|
190
201
|
end
|
|
191
202
|
end
|
|
@@ -112,8 +112,8 @@ module Orb
|
|
|
112
112
|
class ThresholdOverride < Orb::Internal::Type::BaseModel
|
|
113
113
|
# @!attribute group_values
|
|
114
114
|
# The values of the grouping keys that identify this group. The list length must
|
|
115
|
-
# match
|
|
116
|
-
#
|
|
115
|
+
# match group_keys when it is set, and the alert's grouping_keys otherwise, with
|
|
116
|
+
# values in the same order as whichever applies.
|
|
117
117
|
#
|
|
118
118
|
# @return [Array<String>]
|
|
119
119
|
required :group_values, Orb::Internal::Type::ArrayOf[String]
|
|
@@ -125,7 +125,16 @@ module Orb
|
|
|
125
125
|
# @return [Array<Orb::Models::Threshold>]
|
|
126
126
|
required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Threshold] }
|
|
127
127
|
|
|
128
|
-
# @!
|
|
128
|
+
# @!attribute group_keys
|
|
129
|
+
# The subset of the alert's grouping_keys that this override binds. Any grouping
|
|
130
|
+
# key not named is unconstrained, so the override applies to every group matching
|
|
131
|
+
# the named values. When omitted, group_values must cover every grouping key in
|
|
132
|
+
# order.
|
|
133
|
+
#
|
|
134
|
+
# @return [Array<String>, nil]
|
|
135
|
+
optional :group_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
|
|
136
|
+
|
|
137
|
+
# @!method initialize(group_values:, thresholds:, group_keys: nil)
|
|
129
138
|
# Some parameter documentations has been truncated, see
|
|
130
139
|
# {Orb::Models::AlertUpdateParams::ThresholdOverride} for more details.
|
|
131
140
|
#
|
|
@@ -137,6 +146,8 @@ module Orb
|
|
|
137
146
|
# @param group_values [Array<String>] The values of the grouping keys that identify this group. The list length must m
|
|
138
147
|
#
|
|
139
148
|
# @param thresholds [Array<Orb::Models::Threshold>] The thresholds to apply to this group. An empty list silences alerts for this gr
|
|
149
|
+
#
|
|
150
|
+
# @param group_keys [Array<String>, nil] The subset of the alert's grouping_keys that this override binds. Any grouping k
|
|
140
151
|
end
|
|
141
152
|
end
|
|
142
153
|
end
|
|
@@ -57,7 +57,13 @@ module Orb
|
|
|
57
57
|
# Some parameter documentations has been truncated, see
|
|
58
58
|
# {Orb::Models::Customers::Credits::TopUpListParams} for more details.
|
|
59
59
|
#
|
|
60
|
-
#
|
|
60
|
+
# This endpoint returns a list of a customer's active top-ups; a top-up that has
|
|
61
|
+
# been deactivated is not included. While a top-up is active, the customer's
|
|
62
|
+
# balance is increased by the top-up amount whenever it falls to the top-up's
|
|
63
|
+
# threshold.
|
|
64
|
+
#
|
|
65
|
+
# The response also includes pagination_metadata, which lets the caller retrieve
|
|
66
|
+
# the next page of results if they exist.
|
|
61
67
|
#
|
|
62
68
|
# @overload list(customer_id, cursor: nil, limit: nil, request_options: {})
|
|
63
69
|
#
|
|
@@ -192,7 +198,13 @@ module Orb
|
|
|
192
198
|
# Some parameter documentations has been truncated, see
|
|
193
199
|
# {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details.
|
|
194
200
|
#
|
|
195
|
-
#
|
|
201
|
+
# This endpoint returns a list of a customer's active top-ups; a top-up that has
|
|
202
|
+
# been deactivated is not included. While a top-up is active, the customer's
|
|
203
|
+
# balance is increased by the top-up amount whenever it falls to the top-up's
|
|
204
|
+
# threshold.
|
|
205
|
+
#
|
|
206
|
+
# The response also includes pagination_metadata, which lets the caller retrieve
|
|
207
|
+
# the next page of results if they exist.
|
|
196
208
|
#
|
|
197
209
|
# @overload list_by_external_id(external_customer_id, cursor: nil, limit: nil, request_options: {})
|
|
198
210
|
#
|
|
@@ -4,7 +4,10 @@ module Orb
|
|
|
4
4
|
module Resources
|
|
5
5
|
class DimensionalPriceGroups
|
|
6
6
|
class ExternalDimensionalPriceGroupID
|
|
7
|
-
#
|
|
7
|
+
# This endpoint returns a dimensional price group identified by the external ID
|
|
8
|
+
# you assigned it, rather than by its Orb ID. A dimensional price group partitions
|
|
9
|
+
# the result of a billable metric by a set of dimensions, and the prices in the
|
|
10
|
+
# group specify which partition their usage is derived from.
|
|
8
11
|
#
|
|
9
12
|
# @overload retrieve(external_dimensional_price_group_id, request_options: {})
|
|
10
13
|
#
|
|
@@ -46,7 +46,10 @@ module Orb
|
|
|
46
46
|
)
|
|
47
47
|
end
|
|
48
48
|
|
|
49
|
-
#
|
|
49
|
+
# This endpoint returns a dimensional price group identified by its ID. A
|
|
50
|
+
# dimensional price group partitions the result of a billable metric by a set of
|
|
51
|
+
# dimensions, and the prices in the group specify which partition their usage is
|
|
52
|
+
# derived from.
|
|
50
53
|
#
|
|
51
54
|
# @overload retrieve(dimensional_price_group_id, request_options: {})
|
|
52
55
|
#
|
|
@@ -99,7 +102,13 @@ module Orb
|
|
|
99
102
|
# Some parameter documentations has been truncated, see
|
|
100
103
|
# {Orb::Models::DimensionalPriceGroupListParams} for more details.
|
|
101
104
|
#
|
|
102
|
-
#
|
|
105
|
+
# This endpoint returns a list of all dimensional price groups for an account. A
|
|
106
|
+
# dimensional price group partitions the result of a billable metric by a set of
|
|
107
|
+
# dimensions, and the prices in the group specify which partition their usage is
|
|
108
|
+
# derived from.
|
|
109
|
+
#
|
|
110
|
+
# The response also includes pagination_metadata, which lets the caller retrieve
|
|
111
|
+
# the next page of results if they exist.
|
|
103
112
|
#
|
|
104
113
|
# @overload list(cursor: nil, limit: nil, request_options: {})
|
|
105
114
|
#
|
data/lib/orb/resources/items.rb
CHANGED
|
@@ -88,7 +88,9 @@ module Orb
|
|
|
88
88
|
)
|
|
89
89
|
end
|
|
90
90
|
|
|
91
|
-
#
|
|
91
|
+
# This endpoint archives an item, and cascades to archive every price for that
|
|
92
|
+
# item that is still active. An item that is already archived cannot be archived
|
|
93
|
+
# again.
|
|
92
94
|
#
|
|
93
95
|
# @overload archive(item_id, request_options: {})
|
|
94
96
|
#
|
|
@@ -8,7 +8,9 @@ module Orb
|
|
|
8
8
|
# subscription. You can see more about how to configure prices in the
|
|
9
9
|
# [Price resource](/reference/price).
|
|
10
10
|
class Migrations
|
|
11
|
-
#
|
|
11
|
+
# This endpoint returns a migration for a plan, identified by its ID. A migration
|
|
12
|
+
# moves a plan's subscriptions onto a new version of that plan; the response
|
|
13
|
+
# reports the effective time it is scheduled for and its current status.
|
|
12
14
|
#
|
|
13
15
|
# @overload retrieve(migration_id, plan_id:, request_options: {})
|
|
14
16
|
#
|
data/lib/orb/version.rb
CHANGED
data/rbi/orb/models/alert.rbi
CHANGED
|
@@ -442,8 +442,8 @@ module Orb
|
|
|
442
442
|
T.any(Orb::Alert::ThresholdOverride, Orb::Internal::AnyHash)
|
|
443
443
|
end
|
|
444
444
|
|
|
445
|
-
# The values
|
|
446
|
-
#
|
|
445
|
+
# The values identifying this group, ordered to match group_keys when set and the
|
|
446
|
+
# alert's grouping_keys otherwise.
|
|
447
447
|
sig { returns(T::Array[String]) }
|
|
448
448
|
attr_accessor :group_values
|
|
449
449
|
|
|
@@ -451,6 +451,11 @@ module Orb
|
|
|
451
451
|
sig { returns(T::Array[Orb::Threshold]) }
|
|
452
452
|
attr_accessor :thresholds
|
|
453
453
|
|
|
454
|
+
# The subset of the alert's grouping_keys this override binds. Null when the
|
|
455
|
+
# override targets one exact group across every grouping key.
|
|
456
|
+
sig { returns(T.nilable(T::Array[String])) }
|
|
457
|
+
attr_accessor :group_keys
|
|
458
|
+
|
|
454
459
|
# A per-group threshold override on a grouped cost alert.
|
|
455
460
|
#
|
|
456
461
|
# An empty `thresholds` list means the group is silenced (never fires). A
|
|
@@ -458,15 +463,19 @@ module Orb
|
|
|
458
463
|
sig do
|
|
459
464
|
params(
|
|
460
465
|
group_values: T::Array[String],
|
|
461
|
-
thresholds: T::Array[Orb::Threshold::OrHash]
|
|
466
|
+
thresholds: T::Array[Orb::Threshold::OrHash],
|
|
467
|
+
group_keys: T.nilable(T::Array[String])
|
|
462
468
|
).returns(T.attached_class)
|
|
463
469
|
end
|
|
464
470
|
def self.new(
|
|
465
|
-
# The values
|
|
466
|
-
#
|
|
471
|
+
# The values identifying this group, ordered to match group_keys when set and the
|
|
472
|
+
# alert's grouping_keys otherwise.
|
|
467
473
|
group_values:,
|
|
468
474
|
# The thresholds applied to this group. An empty list means the group is silenced.
|
|
469
|
-
thresholds
|
|
475
|
+
thresholds:,
|
|
476
|
+
# The subset of the alert's grouping_keys this override binds. Null when the
|
|
477
|
+
# override targets one exact group across every grouping key.
|
|
478
|
+
group_keys: nil
|
|
470
479
|
)
|
|
471
480
|
end
|
|
472
481
|
|
|
@@ -474,7 +483,8 @@ module Orb
|
|
|
474
483
|
override.returns(
|
|
475
484
|
{
|
|
476
485
|
group_values: T::Array[String],
|
|
477
|
-
thresholds: T::Array[Orb::Threshold]
|
|
486
|
+
thresholds: T::Array[Orb::Threshold],
|
|
487
|
+
group_keys: T.nilable(T::Array[String])
|
|
478
488
|
}
|
|
479
489
|
)
|
|
480
490
|
end
|
|
@@ -334,8 +334,8 @@ module Orb
|
|
|
334
334
|
end
|
|
335
335
|
|
|
336
336
|
# The values of the grouping keys that identify this group. The list length must
|
|
337
|
-
# match
|
|
338
|
-
#
|
|
337
|
+
# match group_keys when it is set, and the alert's grouping_keys otherwise, with
|
|
338
|
+
# values in the same order as whichever applies.
|
|
339
339
|
sig { returns(T::Array[String]) }
|
|
340
340
|
attr_accessor :group_values
|
|
341
341
|
|
|
@@ -344,6 +344,13 @@ module Orb
|
|
|
344
344
|
sig { returns(T::Array[Orb::Threshold]) }
|
|
345
345
|
attr_accessor :thresholds
|
|
346
346
|
|
|
347
|
+
# The subset of the alert's grouping_keys that this override binds. Any grouping
|
|
348
|
+
# key not named is unconstrained, so the override applies to every group matching
|
|
349
|
+
# the named values. When omitted, group_values must cover every grouping key in
|
|
350
|
+
# order.
|
|
351
|
+
sig { returns(T.nilable(T::Array[String])) }
|
|
352
|
+
attr_accessor :group_keys
|
|
353
|
+
|
|
347
354
|
# Per-group threshold override on a grouped cost alert.
|
|
348
355
|
#
|
|
349
356
|
# - An empty `thresholds` list silences alerts for this group (never fires).
|
|
@@ -351,17 +358,23 @@ module Orb
|
|
|
351
358
|
sig do
|
|
352
359
|
params(
|
|
353
360
|
group_values: T::Array[String],
|
|
354
|
-
thresholds: T::Array[Orb::Threshold::OrHash]
|
|
361
|
+
thresholds: T::Array[Orb::Threshold::OrHash],
|
|
362
|
+
group_keys: T.nilable(T::Array[String])
|
|
355
363
|
).returns(T.attached_class)
|
|
356
364
|
end
|
|
357
365
|
def self.new(
|
|
358
366
|
# The values of the grouping keys that identify this group. The list length must
|
|
359
|
-
# match
|
|
360
|
-
#
|
|
367
|
+
# match group_keys when it is set, and the alert's grouping_keys otherwise, with
|
|
368
|
+
# values in the same order as whichever applies.
|
|
361
369
|
group_values:,
|
|
362
370
|
# The thresholds to apply to this group. An empty list silences alerts for this
|
|
363
371
|
# group. A non-empty list fully replaces the default thresholds for this group.
|
|
364
|
-
thresholds
|
|
372
|
+
thresholds:,
|
|
373
|
+
# The subset of the alert's grouping_keys that this override binds. Any grouping
|
|
374
|
+
# key not named is unconstrained, so the override applies to every group matching
|
|
375
|
+
# the named values. When omitted, group_values must cover every grouping key in
|
|
376
|
+
# order.
|
|
377
|
+
group_keys: nil
|
|
365
378
|
)
|
|
366
379
|
end
|
|
367
380
|
|
|
@@ -369,7 +382,8 @@ module Orb
|
|
|
369
382
|
override.returns(
|
|
370
383
|
{
|
|
371
384
|
group_values: T::Array[String],
|
|
372
|
-
thresholds: T::Array[Orb::Threshold]
|
|
385
|
+
thresholds: T::Array[Orb::Threshold],
|
|
386
|
+
group_keys: T.nilable(T::Array[String])
|
|
373
387
|
}
|
|
374
388
|
)
|
|
375
389
|
end
|
|
@@ -212,8 +212,8 @@ module Orb
|
|
|
212
212
|
end
|
|
213
213
|
|
|
214
214
|
# The values of the grouping keys that identify this group. The list length must
|
|
215
|
-
# match
|
|
216
|
-
#
|
|
215
|
+
# match group_keys when it is set, and the alert's grouping_keys otherwise, with
|
|
216
|
+
# values in the same order as whichever applies.
|
|
217
217
|
sig { returns(T::Array[String]) }
|
|
218
218
|
attr_accessor :group_values
|
|
219
219
|
|
|
@@ -222,6 +222,13 @@ module Orb
|
|
|
222
222
|
sig { returns(T::Array[Orb::Threshold]) }
|
|
223
223
|
attr_accessor :thresholds
|
|
224
224
|
|
|
225
|
+
# The subset of the alert's grouping_keys that this override binds. Any grouping
|
|
226
|
+
# key not named is unconstrained, so the override applies to every group matching
|
|
227
|
+
# the named values. When omitted, group_values must cover every grouping key in
|
|
228
|
+
# order.
|
|
229
|
+
sig { returns(T.nilable(T::Array[String])) }
|
|
230
|
+
attr_accessor :group_keys
|
|
231
|
+
|
|
225
232
|
# Per-group threshold override on a grouped cost alert.
|
|
226
233
|
#
|
|
227
234
|
# - An empty `thresholds` list silences alerts for this group (never fires).
|
|
@@ -229,17 +236,23 @@ module Orb
|
|
|
229
236
|
sig do
|
|
230
237
|
params(
|
|
231
238
|
group_values: T::Array[String],
|
|
232
|
-
thresholds: T::Array[Orb::Threshold::OrHash]
|
|
239
|
+
thresholds: T::Array[Orb::Threshold::OrHash],
|
|
240
|
+
group_keys: T.nilable(T::Array[String])
|
|
233
241
|
).returns(T.attached_class)
|
|
234
242
|
end
|
|
235
243
|
def self.new(
|
|
236
244
|
# The values of the grouping keys that identify this group. The list length must
|
|
237
|
-
# match
|
|
238
|
-
#
|
|
245
|
+
# match group_keys when it is set, and the alert's grouping_keys otherwise, with
|
|
246
|
+
# values in the same order as whichever applies.
|
|
239
247
|
group_values:,
|
|
240
248
|
# The thresholds to apply to this group. An empty list silences alerts for this
|
|
241
249
|
# group. A non-empty list fully replaces the default thresholds for this group.
|
|
242
|
-
thresholds
|
|
250
|
+
thresholds:,
|
|
251
|
+
# The subset of the alert's grouping_keys that this override binds. Any grouping
|
|
252
|
+
# key not named is unconstrained, so the override applies to every group matching
|
|
253
|
+
# the named values. When omitted, group_values must cover every grouping key in
|
|
254
|
+
# order.
|
|
255
|
+
group_keys: nil
|
|
243
256
|
)
|
|
244
257
|
end
|
|
245
258
|
|
|
@@ -247,7 +260,8 @@ module Orb
|
|
|
247
260
|
override.returns(
|
|
248
261
|
{
|
|
249
262
|
group_values: T::Array[String],
|
|
250
|
-
thresholds: T::Array[Orb::Threshold]
|
|
263
|
+
thresholds: T::Array[Orb::Threshold],
|
|
264
|
+
group_keys: T.nilable(T::Array[String])
|
|
251
265
|
}
|
|
252
266
|
)
|
|
253
267
|
end
|
|
@@ -58,7 +58,13 @@ module Orb
|
|
|
58
58
|
)
|
|
59
59
|
end
|
|
60
60
|
|
|
61
|
-
#
|
|
61
|
+
# This endpoint returns a list of a customer's active top-ups; a top-up that has
|
|
62
|
+
# been deactivated is not included. While a top-up is active, the customer's
|
|
63
|
+
# balance is increased by the top-up amount whenever it falls to the top-up's
|
|
64
|
+
# threshold.
|
|
65
|
+
#
|
|
66
|
+
# The response also includes pagination_metadata, which lets the caller retrieve
|
|
67
|
+
# the next page of results if they exist.
|
|
62
68
|
sig do
|
|
63
69
|
params(
|
|
64
70
|
customer_id: String,
|
|
@@ -163,7 +169,13 @@ module Orb
|
|
|
163
169
|
)
|
|
164
170
|
end
|
|
165
171
|
|
|
166
|
-
#
|
|
172
|
+
# This endpoint returns a list of a customer's active top-ups; a top-up that has
|
|
173
|
+
# been deactivated is not included. While a top-up is active, the customer's
|
|
174
|
+
# balance is increased by the top-up amount whenever it falls to the top-up's
|
|
175
|
+
# threshold.
|
|
176
|
+
#
|
|
177
|
+
# The response also includes pagination_metadata, which lets the caller retrieve
|
|
178
|
+
# the next page of results if they exist.
|
|
167
179
|
sig do
|
|
168
180
|
params(
|
|
169
181
|
external_customer_id: String,
|
|
@@ -4,7 +4,10 @@ module Orb
|
|
|
4
4
|
module Resources
|
|
5
5
|
class DimensionalPriceGroups
|
|
6
6
|
class ExternalDimensionalPriceGroupID
|
|
7
|
-
#
|
|
7
|
+
# This endpoint returns a dimensional price group identified by the external ID
|
|
8
|
+
# you assigned it, rather than by its Orb ID. A dimensional price group partitions
|
|
9
|
+
# the result of a billable metric by a set of dimensions, and the prices in the
|
|
10
|
+
# group specify which partition their usage is derived from.
|
|
8
11
|
sig do
|
|
9
12
|
params(
|
|
10
13
|
external_dimensional_price_group_id: String,
|
|
@@ -42,7 +42,10 @@ module Orb
|
|
|
42
42
|
)
|
|
43
43
|
end
|
|
44
44
|
|
|
45
|
-
#
|
|
45
|
+
# This endpoint returns a dimensional price group identified by its ID. A
|
|
46
|
+
# dimensional price group partitions the result of a billable metric by a set of
|
|
47
|
+
# dimensions, and the prices in the group specify which partition their usage is
|
|
48
|
+
# derived from.
|
|
46
49
|
sig do
|
|
47
50
|
params(
|
|
48
51
|
dimensional_price_group_id: String,
|
|
@@ -78,7 +81,13 @@ module Orb
|
|
|
78
81
|
)
|
|
79
82
|
end
|
|
80
83
|
|
|
81
|
-
#
|
|
84
|
+
# This endpoint returns a list of all dimensional price groups for an account. A
|
|
85
|
+
# dimensional price group partitions the result of a billable metric by a set of
|
|
86
|
+
# dimensions, and the prices in the group specify which partition their usage is
|
|
87
|
+
# derived from.
|
|
88
|
+
#
|
|
89
|
+
# The response also includes pagination_metadata, which lets the caller retrieve
|
|
90
|
+
# the next page of results if they exist.
|
|
82
91
|
sig do
|
|
83
92
|
params(
|
|
84
93
|
cursor: T.nilable(String),
|
data/rbi/orb/resources/items.rbi
CHANGED
|
@@ -69,7 +69,9 @@ module Orb
|
|
|
69
69
|
)
|
|
70
70
|
end
|
|
71
71
|
|
|
72
|
-
#
|
|
72
|
+
# This endpoint archives an item, and cascades to archive every price for that
|
|
73
|
+
# item that is still active. An item that is already archived cannot be archived
|
|
74
|
+
# again.
|
|
73
75
|
sig do
|
|
74
76
|
params(
|
|
75
77
|
item_id: String,
|
|
@@ -8,7 +8,9 @@ module Orb
|
|
|
8
8
|
# subscription. You can see more about how to configure prices in the
|
|
9
9
|
# [Price resource](/reference/price).
|
|
10
10
|
class Migrations
|
|
11
|
-
#
|
|
11
|
+
# This endpoint returns a migration for a plan, identified by its ID. A migration
|
|
12
|
+
# moves a plan's subscriptions onto a new version of that plan; the response
|
|
13
|
+
# reports the effective time it is scheduled for and its current status.
|
|
12
14
|
sig do
|
|
13
15
|
params(
|
|
14
16
|
migration_id: String,
|
data/sig/orb/models/alert.rbs
CHANGED
|
@@ -227,21 +227,29 @@ module Orb
|
|
|
227
227
|
end
|
|
228
228
|
|
|
229
229
|
type threshold_override =
|
|
230
|
-
{
|
|
230
|
+
{
|
|
231
|
+
group_values: ::Array[String],
|
|
232
|
+
thresholds: ::Array[Orb::Threshold],
|
|
233
|
+
group_keys: ::Array[String]?
|
|
234
|
+
}
|
|
231
235
|
|
|
232
236
|
class ThresholdOverride < Orb::Internal::Type::BaseModel
|
|
233
237
|
attr_accessor group_values: ::Array[String]
|
|
234
238
|
|
|
235
239
|
attr_accessor thresholds: ::Array[Orb::Threshold]
|
|
236
240
|
|
|
241
|
+
attr_accessor group_keys: ::Array[String]?
|
|
242
|
+
|
|
237
243
|
def initialize: (
|
|
238
244
|
group_values: ::Array[String],
|
|
239
|
-
thresholds: ::Array[Orb::Threshold]
|
|
245
|
+
thresholds: ::Array[Orb::Threshold],
|
|
246
|
+
?group_keys: ::Array[String]?
|
|
240
247
|
) -> void
|
|
241
248
|
|
|
242
249
|
def to_hash: -> {
|
|
243
250
|
group_values: ::Array[String],
|
|
244
|
-
thresholds: ::Array[Orb::Threshold]
|
|
251
|
+
thresholds: ::Array[Orb::Threshold],
|
|
252
|
+
group_keys: ::Array[String]?
|
|
245
253
|
}
|
|
246
254
|
end
|
|
247
255
|
end
|
|
@@ -123,21 +123,29 @@ module Orb
|
|
|
123
123
|
end
|
|
124
124
|
|
|
125
125
|
type threshold_override =
|
|
126
|
-
{
|
|
126
|
+
{
|
|
127
|
+
group_values: ::Array[String],
|
|
128
|
+
thresholds: ::Array[Orb::Threshold],
|
|
129
|
+
group_keys: ::Array[String]?
|
|
130
|
+
}
|
|
127
131
|
|
|
128
132
|
class ThresholdOverride < Orb::Internal::Type::BaseModel
|
|
129
133
|
attr_accessor group_values: ::Array[String]
|
|
130
134
|
|
|
131
135
|
attr_accessor thresholds: ::Array[Orb::Threshold]
|
|
132
136
|
|
|
137
|
+
attr_accessor group_keys: ::Array[String]?
|
|
138
|
+
|
|
133
139
|
def initialize: (
|
|
134
140
|
group_values: ::Array[String],
|
|
135
|
-
thresholds: ::Array[Orb::Threshold]
|
|
141
|
+
thresholds: ::Array[Orb::Threshold],
|
|
142
|
+
?group_keys: ::Array[String]?
|
|
136
143
|
) -> void
|
|
137
144
|
|
|
138
145
|
def to_hash: -> {
|
|
139
146
|
group_values: ::Array[String],
|
|
140
|
-
thresholds: ::Array[Orb::Threshold]
|
|
147
|
+
thresholds: ::Array[Orb::Threshold],
|
|
148
|
+
group_keys: ::Array[String]?
|
|
141
149
|
}
|
|
142
150
|
end
|
|
143
151
|
end
|
|
@@ -91,21 +91,29 @@ module Orb
|
|
|
91
91
|
end
|
|
92
92
|
|
|
93
93
|
type threshold_override =
|
|
94
|
-
{
|
|
94
|
+
{
|
|
95
|
+
group_values: ::Array[String],
|
|
96
|
+
thresholds: ::Array[Orb::Threshold],
|
|
97
|
+
group_keys: ::Array[String]?
|
|
98
|
+
}
|
|
95
99
|
|
|
96
100
|
class ThresholdOverride < Orb::Internal::Type::BaseModel
|
|
97
101
|
attr_accessor group_values: ::Array[String]
|
|
98
102
|
|
|
99
103
|
attr_accessor thresholds: ::Array[Orb::Threshold]
|
|
100
104
|
|
|
105
|
+
attr_accessor group_keys: ::Array[String]?
|
|
106
|
+
|
|
101
107
|
def initialize: (
|
|
102
108
|
group_values: ::Array[String],
|
|
103
|
-
thresholds: ::Array[Orb::Threshold]
|
|
109
|
+
thresholds: ::Array[Orb::Threshold],
|
|
110
|
+
?group_keys: ::Array[String]?
|
|
104
111
|
) -> void
|
|
105
112
|
|
|
106
113
|
def to_hash: -> {
|
|
107
114
|
group_values: ::Array[String],
|
|
108
|
-
thresholds: ::Array[Orb::Threshold]
|
|
115
|
+
thresholds: ::Array[Orb::Threshold],
|
|
116
|
+
group_keys: ::Array[String]?
|
|
109
117
|
}
|
|
110
118
|
end
|
|
111
119
|
end
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: orb-billing
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.
|
|
4
|
+
version: 1.30.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Orb
|
|
@@ -1407,7 +1407,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
1407
1407
|
- !ruby/object:Gem::Version
|
|
1408
1408
|
version: '0'
|
|
1409
1409
|
requirements: []
|
|
1410
|
-
rubygems_version: 4.0.
|
|
1410
|
+
rubygems_version: 4.0.20
|
|
1411
1411
|
specification_version: 4
|
|
1412
1412
|
summary: Ruby library to access the Orb API
|
|
1413
1413
|
test_files: []
|