stigg 0.1.0.pre.beta.55 → 0.1.0.pre.beta.57

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 22ad9d5621e65d220a1610dc9dcf3701d56317fb243354e3ac20b9218793d9a6
4
- data.tar.gz: e9cc80ef3ebbc84fb8579ebe7e63dcfaa2d2222955877744bb87af23ce46d38e
3
+ metadata.gz: 708a857f78b38d4be04cdf9404746325027c0e77ed8f8bb1b2cd33345d2c7e68
4
+ data.tar.gz: 8a6916176a4d58c67b6e8f23367799f0f1fb6df268da57d9985364148342f561
5
5
  SHA512:
6
- metadata.gz: 70be9b6e78f9a97c1966d62559d9dbd0dd523359a1b1375b9eca48cbb21ca4476c1d39b83c400813845b530c95e9242003e6ebeac2bd6622a3ed520afd276f1c
7
- data.tar.gz: 569fa41d256f010d8e6e0e025924f161d77462bfff09ae1cc5c9dc4fcacaa5bdc8b6fdce72f996e6a5df0e8c134b98d680ec52b82986ca25db33f4e150e86f23
6
+ metadata.gz: '0019d4cf46f41394aa8edd73d1ce79d9a5f8e04a8917d47897f752c1888969c2f1943a7c53cba3bba1ced27b5aff3537a2f1c1ee123f6bc5fddaa7604df102d2'
7
+ data.tar.gz: e2e66982a8445532733a13a3ed7ee52c3859b54de54e73bfddc9821ff9b3158fc5e1ed39d2830c2480f8c1998809e43223bb583cebcdee17b1b3a2a3e8183f15
data/CHANGELOG.md CHANGED
@@ -1,5 +1,29 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.1.0-beta.57](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.56...v0.1.0-beta.57) (2026-10-15)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * sync OpenAPI spec from stigg-api ([0eaa97f](https://github.com/stiggio/stigg-ruby/commit/0eaa97f8b2b65260e5da0e1a2c5d4f37f7dc7aef))
9
+
10
+
11
+ ### Chores
12
+
13
+ * normalize version.rb to gem prerelease format for stlc codegen ([28cab9a](https://github.com/stiggio/stigg-ruby/commit/28cab9a539b181421d39c03252513203d8f4968c))
14
+
15
+ ## [0.1.0-beta.56](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.55...v0.1.0-beta.56) (2026-10-15)
16
+
17
+
18
+ ### Bug Fixes
19
+
20
+ * sync OpenAPI spec from stigg-api ([c1194a0](https://github.com/stiggio/stigg-ruby/commit/c1194a0c5bf7b591e0b11d0ad6e254a6c931e5af))
21
+
22
+
23
+ ### Chores
24
+
25
+ * normalize version.rb to gem prerelease format for stlc codegen ([e0e9a99](https://github.com/stiggio/stigg-ruby/commit/e0e9a992fdadb8ded73fbe7246d574cae4d102b6))
26
+
3
27
  ## [0.1.0-beta.55](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.54...v0.1.0-beta.55) (2026-10-15)
4
28
 
5
29
 
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.54"
27
+ gem "stigg", "~> 0.1.0.pre.beta.56"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -40,8 +40,10 @@ module Stigg
40
40
  optional :end_date, Time
41
41
 
42
42
  # @!attribute group_by
43
- # Comma-separated list of feature dimension keys to group usage series by (up to
44
- # 3). Each key matches /^[a-zA-Z0-9_$-]+$/
43
+ # Comma-separated list of keys to group usage series by: up to 3 custom dimension
44
+ # keys, optionally combined with the reserved key `featureId` to also split each
45
+ # series by feature (e.g. `featureId,userId`). Each key matches
46
+ # /^[a-zA-Z0-9_$-]+$/
45
47
  #
46
48
  # @return [String, nil]
47
49
  optional :group_by, String
@@ -96,7 +98,7 @@ module Stigg
96
98
  #
97
99
  # @param end_date [Time] End date for the credit usage time range (ISO 8601). Defaults to now when startD
98
100
  #
99
- # @param group_by [String] Comma-separated list of feature dimension keys to group usage series by (up to 3
101
+ # @param group_by [String] Comma-separated list of keys to group usage series by: up to 3 custom dimension
100
102
  #
101
103
  # @param limit [Integer] Maximum number of items to return
102
104
  #
@@ -135,13 +135,14 @@ module Stigg
135
135
  required :event_count, Float, api_name: :eventCount
136
136
 
137
137
  # @!attribute feature_id
138
- # The feature ID; null when grouping by dimensions only
138
+ # The feature ID; null when grouping by dimensions without `featureId`
139
139
  #
140
140
  # @return [String, nil]
141
141
  required :feature_id, String, api_name: :featureId, nil?: true
142
142
 
143
143
  # @!attribute feature_name
144
- # The display name of the feature; null when grouping by dimensions only
144
+ # The display name of the feature; null when grouping by dimensions without
145
+ # `featureId`
145
146
  #
146
147
  # @return [String, nil]
147
148
  required :feature_name, String, api_name: :featureName, nil?: true
@@ -160,7 +161,8 @@ module Stigg
160
161
  required :total_credits, Float, api_name: :totalCredits
161
162
 
162
163
  # @!attribute tags
163
- # Dimension key/value pairs identifying this series when groupBy is applied
164
+ # Dimension key/value pairs identifying this series when groupBy includes
165
+ # dimension keys (`featureId` is returned in its own field, not as a tag)
164
166
  #
165
167
  # @return [Array<Stigg::Models::V1::CreditGetUsageResponse::Data::Series::Tag>, nil]
166
168
  optional :tags,
@@ -174,15 +176,15 @@ module Stigg
174
176
  #
175
177
  # @param event_count [Float] Number of distinct usage events that consumed credits in this series. This count
176
178
  #
177
- # @param feature_id [String, nil] The feature ID; null when grouping by dimensions only
179
+ # @param feature_id [String, nil] The feature ID; null when grouping by dimensions without `featureId`
178
180
  #
179
- # @param feature_name [String, nil] The display name of the feature; null when grouping by dimensions only
181
+ # @param feature_name [String, nil] The display name of the feature; null when grouping by dimensions without `featu
180
182
  #
181
183
  # @param points [Array<Stigg::Models::V1::CreditGetUsageResponse::Data::Series::Point>] Time-series data points for this feature
182
184
  #
183
185
  # @param total_credits [Float] Total credits consumed by this feature in the time range
184
186
  #
185
- # @param tags [Array<Stigg::Models::V1::CreditGetUsageResponse::Data::Series::Tag>] Dimension key/value pairs identifying this series when groupBy is applied
187
+ # @param tags [Array<Stigg::Models::V1::CreditGetUsageResponse::Data::Series::Tag>] Dimension key/value pairs identifying this series when groupBy includes dimensio
186
188
 
187
189
  class Point < Stigg::Internal::Type::BaseModel
188
190
  # @!attribute event_count
@@ -71,7 +71,7 @@ module Stigg
71
71
  #
72
72
  # @param end_date [Time] Query param: End date for the credit usage time range (ISO 8601). Defaults to no
73
73
  #
74
- # @param group_by [String] Query param: Comma-separated list of feature dimension keys to group usage serie
74
+ # @param group_by [String] Query param: Comma-separated list of keys to group usage series by: up to 3 cust
75
75
  #
76
76
  # @param limit [Integer] Query param: Maximum number of items to return
77
77
  #
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-beta.55"
4
+ VERSION = "0.1.0-beta.57"
5
5
  end
@@ -45,8 +45,10 @@ module Stigg
45
45
  sig { params(end_date: Time).void }
46
46
  attr_writer :end_date
47
47
 
48
- # Comma-separated list of feature dimension keys to group usage series by (up to
49
- # 3). Each key matches /^[a-zA-Z0-9_$-]+$/
48
+ # Comma-separated list of keys to group usage series by: up to 3 custom dimension
49
+ # keys, optionally combined with the reserved key `featureId` to also split each
50
+ # series by feature (e.g. `featureId,userId`). Each key matches
51
+ # /^[a-zA-Z0-9_$-]+$/
50
52
  sig { returns(T.nilable(String)) }
51
53
  attr_reader :group_by
52
54
 
@@ -132,8 +134,10 @@ module Stigg
132
134
  # End date for the credit usage time range (ISO 8601). Defaults to now when
133
135
  # startDate is provided
134
136
  end_date: nil,
135
- # Comma-separated list of feature dimension keys to group usage series by (up to
136
- # 3). Each key matches /^[a-zA-Z0-9_$-]+$/
137
+ # Comma-separated list of keys to group usage series by: up to 3 custom dimension
138
+ # keys, optionally combined with the reserved key `featureId` to also split each
139
+ # series by feature (e.g. `featureId,userId`). Each key matches
140
+ # /^[a-zA-Z0-9_$-]+$/
137
141
  group_by: nil,
138
142
  # Maximum number of items to return
139
143
  limit: nil,
@@ -269,11 +269,12 @@ module Stigg
269
269
  sig { returns(Float) }
270
270
  attr_accessor :event_count
271
271
 
272
- # The feature ID; null when grouping by dimensions only
272
+ # The feature ID; null when grouping by dimensions without `featureId`
273
273
  sig { returns(T.nilable(String)) }
274
274
  attr_accessor :feature_id
275
275
 
276
- # The display name of the feature; null when grouping by dimensions only
276
+ # The display name of the feature; null when grouping by dimensions without
277
+ # `featureId`
277
278
  sig { returns(T.nilable(String)) }
278
279
  attr_accessor :feature_name
279
280
 
@@ -291,7 +292,8 @@ module Stigg
291
292
  sig { returns(Float) }
292
293
  attr_accessor :total_credits
293
294
 
294
- # Dimension key/value pairs identifying this series when groupBy is applied
295
+ # Dimension key/value pairs identifying this series when groupBy includes
296
+ # dimension keys (`featureId` is returned in its own field, not as a tag)
295
297
  sig do
296
298
  returns(
297
299
  T.nilable(
@@ -335,15 +337,17 @@ module Stigg
335
337
  # is not additive across series, because an event matched by several meters
336
338
  # appears in more than one series.
337
339
  event_count:,
338
- # The feature ID; null when grouping by dimensions only
340
+ # The feature ID; null when grouping by dimensions without `featureId`
339
341
  feature_id:,
340
- # The display name of the feature; null when grouping by dimensions only
342
+ # The display name of the feature; null when grouping by dimensions without
343
+ # `featureId`
341
344
  feature_name:,
342
345
  # Time-series data points for this feature
343
346
  points:,
344
347
  # Total credits consumed by this feature in the time range
345
348
  total_credits:,
346
- # Dimension key/value pairs identifying this series when groupBy is applied
349
+ # Dimension key/value pairs identifying this series when groupBy includes
350
+ # dimension keys (`featureId` is returned in its own field, not as a tag)
347
351
  tags: nil
348
352
  )
349
353
  end
@@ -73,8 +73,10 @@ module Stigg
73
73
  # Query param: End date for the credit usage time range (ISO 8601). Defaults to
74
74
  # now when startDate is provided
75
75
  end_date: nil,
76
- # Query param: Comma-separated list of feature dimension keys to group usage
77
- # series by (up to 3). Each key matches /^[a-zA-Z0-9_$-]+$/
76
+ # Query param: Comma-separated list of keys to group usage series by: up to 3
77
+ # custom dimension keys, optionally combined with the reserved key `featureId` to
78
+ # also split each series by feature (e.g. `featureId,userId`). Each key matches
79
+ # /^[a-zA-Z0-9_$-]+$/
78
80
  group_by: nil,
79
81
  # Query param: Maximum number of items to return
80
82
  limit: nil,
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: stigg
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0.pre.beta.55
4
+ version: 0.1.0.pre.beta.57
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stigg