stigg 0.1.0.pre.beta.27 → 0.1.0.pre.beta.29

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: a0a7c2c6fdc66ead706149e335c2731cc5a3a056707abdff7a32fda9a0b32dae
4
- data.tar.gz: 33df289e8225553631f314e28586056979c17f2ab7e2d06258914512b2388351
3
+ metadata.gz: c1ec9a0641725b36652f7810151575d13e9ce99ce4f4d1ba658659246026bfbd
4
+ data.tar.gz: 182ee1c0f53b5541e1c6106e5fa69c9b6f0a18287387f197fef31c35a6e1f9c7
5
5
  SHA512:
6
- metadata.gz: 2c50e93051e65de5887737ae575b463ab017463d00446a2a0bfb73df57eb822292f786a4d830e47486073652578a65bbe6fc84614741a243417205d5ce4afd3c
7
- data.tar.gz: eee8db03487a4c846f863156dc085e9e97c2f997c60373b435926d31141348551b514706e066481ddb41aabad2f6b30b5b56bb0ae67676614b43fb9889ec6754
6
+ metadata.gz: 221b3710b118b0eb06421ba88e4ea6e2754732f259f80e165c55775393a138c620a2217279617359099d78eb665d02817085e5dcaca9b98ebcf1999f63c8b7a7
7
+ data.tar.gz: b197dcaf50e6bed7a04d04db0e0c0776c4ba3a19eb21ce758df54c9b8a33eed6d39d5d12f59ea453b53c6f481ebe57d7801e72c82ea676bbbe5f54174799247a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.0-beta.29 (2026-06-22)
4
+
5
+ Full Changelog: [v0.1.0-beta.28...v0.1.0-beta.29](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.28...v0.1.0-beta.29)
6
+
7
+ ### Features
8
+
9
+ * **api:** add salesforce_id parameter to subscription update ([4383bca](https://github.com/stiggio/stigg-ruby/commit/4383bcae2efe0749130f80967c661f33b0ed5d98))
10
+
11
+ ## 0.1.0-beta.28 (2026-06-22)
12
+
13
+ Full Changelog: [v0.1.0-beta.27...v0.1.0-beta.28](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.27...v0.1.0-beta.28)
14
+
15
+ ### Features
16
+
17
+ * **api:** add credit field to usage report response ([48da7e7](https://github.com/stiggio/stigg-ruby/commit/48da7e753acc8cb02f3f5719ec06fe48752eca34))
18
+
3
19
  ## 0.1.0-beta.27 (2026-06-21)
4
20
 
5
21
  Full Changelog: [v0.1.0-beta.26...v0.1.0-beta.27](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.26...v0.1.0-beta.27)
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.27"
27
+ gem "stigg", "~> 0.1.0.pre.beta.29"
28
28
  ```
29
29
 
30
30
  <!-- x-release-please-end -->
@@ -104,6 +104,12 @@ module Stigg
104
104
  # @return [String, nil]
105
105
  optional :promotion_code, String, api_name: :promotionCode
106
106
 
107
+ # @!attribute salesforce_id
108
+ # Salesforce ID
109
+ #
110
+ # @return [String, nil]
111
+ optional :salesforce_id, String, api_name: :salesforceId, nil?: true
112
+
107
113
  # @!attribute schedule_strategy
108
114
  #
109
115
  # @return [Symbol, Stigg::Models::V1::SubscriptionUpdateParams::ScheduleStrategy, nil]
@@ -127,7 +133,7 @@ module Stigg
127
133
  # @return [String, nil]
128
134
  optional :x_environment_id, String
129
135
 
130
- # @!method initialize(id:, addons: nil, applied_coupon: nil, await_payment_confirmation: nil, billing_cycle_anchor: nil, billing_information: nil, billing_period: nil, budget: nil, cancellation_date: nil, charges: nil, entitlements: nil, metadata: nil, minimum_spend: nil, price_overrides: nil, promotion_code: nil, schedule_strategy: nil, trial_end_date: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
136
+ # @!method initialize(id:, addons: nil, applied_coupon: nil, await_payment_confirmation: nil, billing_cycle_anchor: nil, billing_information: nil, billing_period: nil, budget: nil, cancellation_date: nil, charges: nil, entitlements: nil, metadata: nil, minimum_spend: nil, price_overrides: nil, promotion_code: nil, salesforce_id: nil, schedule_strategy: nil, trial_end_date: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
131
137
  # @param id [String]
132
138
  #
133
139
  # @param addons [Array<Stigg::Models::V1::SubscriptionUpdateParams::Addon>]
@@ -158,6 +164,8 @@ module Stigg
158
164
  #
159
165
  # @param promotion_code [String] Promotion code
160
166
  #
167
+ # @param salesforce_id [String, nil] Salesforce ID
168
+ #
161
169
  # @param schedule_strategy [Symbol, Stigg::Models::V1::SubscriptionUpdateParams::ScheduleStrategy]
162
170
  #
163
171
  # @param trial_end_date [Time] Subscription trial end date
@@ -54,6 +54,12 @@ module Stigg
54
54
  # @return [Integer]
55
55
  required :value, Integer
56
56
 
57
+ # @!attribute credit
58
+ # Optimistic credit balance for a credit-backed feature
59
+ #
60
+ # @return [Stigg::Models::V1::UsageReportResponse::Data::Credit, nil]
61
+ optional :credit, -> { Stigg::Models::V1::UsageReportResponse::Data::Credit }, nil?: true
62
+
57
63
  # @!attribute current_usage
58
64
  # The current measured usage value
59
65
  #
@@ -86,7 +92,7 @@ module Stigg
86
92
  # @return [Time, nil]
87
93
  optional :usage_period_start, Time, api_name: :usagePeriodStart, nil?: true
88
94
 
89
- # @!method initialize(id:, created_at:, customer_id:, feature_id:, timestamp:, value:, current_usage: nil, next_reset_date: nil, resource_id: nil, usage_period_end: nil, usage_period_start: nil)
95
+ # @!method initialize(id:, created_at:, customer_id:, feature_id:, timestamp:, value:, credit: nil, current_usage: nil, next_reset_date: nil, resource_id: nil, usage_period_end: nil, usage_period_start: nil)
90
96
  # Some parameter documentations has been truncated, see
91
97
  # {Stigg::Models::V1::UsageReportResponse::Data} for more details.
92
98
  #
@@ -104,6 +110,8 @@ module Stigg
104
110
  #
105
111
  # @param value [Integer] The usage measurement record
106
112
  #
113
+ # @param credit [Stigg::Models::V1::UsageReportResponse::Data::Credit, nil] Optimistic credit balance for a credit-backed feature
114
+ #
107
115
  # @param current_usage [Float, nil] The current measured usage value
108
116
  #
109
117
  # @param next_reset_date [Time, nil] The date when the next usage reset will occur
@@ -113,6 +121,48 @@ module Stigg
113
121
  # @param usage_period_end [Time, nil] The end date of the usage period in which this measurement resides (for entitlem
114
122
  #
115
123
  # @param usage_period_start [Time, nil] The start date of the usage period in which this measurement resides (for entitl
124
+
125
+ # @see Stigg::Models::V1::UsageReportResponse::Data#credit
126
+ class Credit < Stigg::Internal::Type::BaseModel
127
+ # @!attribute currency_id
128
+ # The credit currency identifier
129
+ #
130
+ # @return [String]
131
+ required :currency_id, String, api_name: :currencyId
132
+
133
+ # @!attribute current_usage
134
+ # The credits consumed (optimistic — includes not-yet-reconciled usage)
135
+ #
136
+ # @return [Float]
137
+ required :current_usage, Float, api_name: :currentUsage
138
+
139
+ # @!attribute timestamp
140
+ # The grant-version timestamp of this balance, used by the SDK for last-write-wins
141
+ # reconciliation
142
+ #
143
+ # @return [Time]
144
+ required :timestamp, Time
145
+
146
+ # @!attribute usage_limit
147
+ # The total credits granted
148
+ #
149
+ # @return [Float]
150
+ required :usage_limit, Float, api_name: :usageLimit
151
+
152
+ # @!method initialize(currency_id:, current_usage:, timestamp:, usage_limit:)
153
+ # Some parameter documentations has been truncated, see
154
+ # {Stigg::Models::V1::UsageReportResponse::Data::Credit} for more details.
155
+ #
156
+ # Optimistic credit balance for a credit-backed feature
157
+ #
158
+ # @param currency_id [String] The credit currency identifier
159
+ #
160
+ # @param current_usage [Float] The credits consumed (optimistic — includes not-yet-reconciled usage)
161
+ #
162
+ # @param timestamp [Time] The grant-version timestamp of this balance, used by the SDK for last-write-wins
163
+ #
164
+ # @param usage_limit [Float] The total credits granted
165
+ end
116
166
  end
117
167
  end
118
168
  end
@@ -55,7 +55,7 @@ module Stigg
55
55
  # Updates an active subscription's properties including billing period, add-ons,
56
56
  # unit quantities, and discounts.
57
57
  #
58
- # @overload update(id, addons: nil, applied_coupon: nil, await_payment_confirmation: nil, billing_cycle_anchor: nil, billing_information: nil, billing_period: nil, budget: nil, cancellation_date: nil, charges: nil, entitlements: nil, metadata: nil, minimum_spend: nil, price_overrides: nil, promotion_code: nil, schedule_strategy: nil, trial_end_date: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
58
+ # @overload update(id, addons: nil, applied_coupon: nil, await_payment_confirmation: nil, billing_cycle_anchor: nil, billing_information: nil, billing_period: nil, budget: nil, cancellation_date: nil, charges: nil, entitlements: nil, metadata: nil, minimum_spend: nil, price_overrides: nil, promotion_code: nil, salesforce_id: nil, schedule_strategy: nil, trial_end_date: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
59
59
  #
60
60
  # @param id [String] Path param: The unique identifier of the entity
61
61
  #
@@ -87,6 +87,8 @@ module Stigg
87
87
  #
88
88
  # @param promotion_code [String] Body param: Promotion code
89
89
  #
90
+ # @param salesforce_id [String, nil] Body param: Salesforce ID
91
+ #
90
92
  # @param schedule_strategy [Symbol, Stigg::Models::V1::SubscriptionUpdateParams::ScheduleStrategy] Body param
91
93
  #
92
94
  # @param trial_end_date [Time] Body param: Subscription trial end date
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.27"
4
+ VERSION = "0.1.0.pre.beta.29"
5
5
  end
@@ -204,6 +204,10 @@ module Stigg
204
204
  sig { params(promotion_code: String).void }
205
205
  attr_writer :promotion_code
206
206
 
207
+ # Salesforce ID
208
+ sig { returns(T.nilable(String)) }
209
+ attr_accessor :salesforce_id
210
+
207
211
  sig do
208
212
  returns(
209
213
  T.nilable(
@@ -276,6 +280,7 @@ module Stigg
276
280
  Stigg::V1::SubscriptionUpdateParams::PriceOverride::OrHash
277
281
  ],
278
282
  promotion_code: String,
283
+ salesforce_id: T.nilable(String),
279
284
  schedule_strategy:
280
285
  Stigg::V1::SubscriptionUpdateParams::ScheduleStrategy::OrSymbol,
281
286
  trial_end_date: Time,
@@ -305,6 +310,8 @@ module Stigg
305
310
  price_overrides: nil,
306
311
  # Promotion code
307
312
  promotion_code: nil,
313
+ # Salesforce ID
314
+ salesforce_id: nil,
308
315
  schedule_strategy: nil,
309
316
  # Subscription trial end date
310
317
  trial_end_date: nil,
@@ -344,6 +351,7 @@ module Stigg
344
351
  price_overrides:
345
352
  T::Array[Stigg::V1::SubscriptionUpdateParams::PriceOverride],
346
353
  promotion_code: String,
354
+ salesforce_id: T.nilable(String),
347
355
  schedule_strategy:
348
356
  Stigg::V1::SubscriptionUpdateParams::ScheduleStrategy::OrSymbol,
349
357
  trial_end_date: Time,
@@ -70,6 +70,24 @@ module Stigg
70
70
  sig { returns(Integer) }
71
71
  attr_accessor :value
72
72
 
73
+ # Optimistic credit balance for a credit-backed feature
74
+ sig do
75
+ returns(
76
+ T.nilable(Stigg::Models::V1::UsageReportResponse::Data::Credit)
77
+ )
78
+ end
79
+ attr_reader :credit
80
+
81
+ sig do
82
+ params(
83
+ credit:
84
+ T.nilable(
85
+ Stigg::Models::V1::UsageReportResponse::Data::Credit::OrHash
86
+ )
87
+ ).void
88
+ end
89
+ attr_writer :credit
90
+
73
91
  # The current measured usage value
74
92
  sig { returns(T.nilable(Float)) }
75
93
  attr_accessor :current_usage
@@ -101,6 +119,10 @@ module Stigg
101
119
  feature_id: String,
102
120
  timestamp: Time,
103
121
  value: Integer,
122
+ credit:
123
+ T.nilable(
124
+ Stigg::Models::V1::UsageReportResponse::Data::Credit::OrHash
125
+ ),
104
126
  current_usage: T.nilable(Float),
105
127
  next_reset_date: T.nilable(Time),
106
128
  resource_id: T.nilable(String),
@@ -121,6 +143,8 @@ module Stigg
121
143
  timestamp:,
122
144
  # The usage measurement record
123
145
  value:,
146
+ # Optimistic credit balance for a credit-backed feature
147
+ credit: nil,
124
148
  # The current measured usage value
125
149
  current_usage: nil,
126
150
  # The date when the next usage reset will occur
@@ -145,6 +169,10 @@ module Stigg
145
169
  feature_id: String,
146
170
  timestamp: Time,
147
171
  value: Integer,
172
+ credit:
173
+ T.nilable(
174
+ Stigg::Models::V1::UsageReportResponse::Data::Credit
175
+ ),
148
176
  current_usage: T.nilable(Float),
149
177
  next_reset_date: T.nilable(Time),
150
178
  resource_id: T.nilable(String),
@@ -155,6 +183,68 @@ module Stigg
155
183
  end
156
184
  def to_hash
157
185
  end
186
+
187
+ class Credit < Stigg::Internal::Type::BaseModel
188
+ OrHash =
189
+ T.type_alias do
190
+ T.any(
191
+ Stigg::Models::V1::UsageReportResponse::Data::Credit,
192
+ Stigg::Internal::AnyHash
193
+ )
194
+ end
195
+
196
+ # The credit currency identifier
197
+ sig { returns(String) }
198
+ attr_accessor :currency_id
199
+
200
+ # The credits consumed (optimistic — includes not-yet-reconciled usage)
201
+ sig { returns(Float) }
202
+ attr_accessor :current_usage
203
+
204
+ # The grant-version timestamp of this balance, used by the SDK for last-write-wins
205
+ # reconciliation
206
+ sig { returns(Time) }
207
+ attr_accessor :timestamp
208
+
209
+ # The total credits granted
210
+ sig { returns(Float) }
211
+ attr_accessor :usage_limit
212
+
213
+ # Optimistic credit balance for a credit-backed feature
214
+ sig do
215
+ params(
216
+ currency_id: String,
217
+ current_usage: Float,
218
+ timestamp: Time,
219
+ usage_limit: Float
220
+ ).returns(T.attached_class)
221
+ end
222
+ def self.new(
223
+ # The credit currency identifier
224
+ currency_id:,
225
+ # The credits consumed (optimistic — includes not-yet-reconciled usage)
226
+ current_usage:,
227
+ # The grant-version timestamp of this balance, used by the SDK for last-write-wins
228
+ # reconciliation
229
+ timestamp:,
230
+ # The total credits granted
231
+ usage_limit:
232
+ )
233
+ end
234
+
235
+ sig do
236
+ override.returns(
237
+ {
238
+ currency_id: String,
239
+ current_usage: Float,
240
+ timestamp: Time,
241
+ usage_limit: Float
242
+ }
243
+ )
244
+ end
245
+ def to_hash
246
+ end
247
+ end
158
248
  end
159
249
  end
160
250
  end
@@ -78,6 +78,7 @@ module Stigg
78
78
  Stigg::V1::SubscriptionUpdateParams::PriceOverride::OrHash
79
79
  ],
80
80
  promotion_code: String,
81
+ salesforce_id: T.nilable(String),
81
82
  schedule_strategy:
82
83
  Stigg::V1::SubscriptionUpdateParams::ScheduleStrategy::OrSymbol,
83
84
  trial_end_date: Time,
@@ -117,6 +118,8 @@ module Stigg
117
118
  price_overrides: nil,
118
119
  # Body param: Promotion code
119
120
  promotion_code: nil,
121
+ # Body param: Salesforce ID
122
+ salesforce_id: nil,
120
123
  # Body param
121
124
  schedule_strategy: nil,
122
125
  # Body param: Subscription trial end date
@@ -18,6 +18,7 @@ module Stigg
18
18
  minimum_spend: Stigg::V1::SubscriptionUpdateParams::MinimumSpend?,
19
19
  price_overrides: ::Array[Stigg::V1::SubscriptionUpdateParams::PriceOverride],
20
20
  promotion_code: String,
21
+ salesforce_id: String?,
21
22
  schedule_strategy: Stigg::Models::V1::SubscriptionUpdateParams::schedule_strategy,
22
23
  trial_end_date: Time,
23
24
  x_account_id: String,
@@ -97,6 +98,8 @@ module Stigg
97
98
 
98
99
  def promotion_code=: (String) -> String
99
100
 
101
+ attr_accessor salesforce_id: String?
102
+
100
103
  attr_reader schedule_strategy: Stigg::Models::V1::SubscriptionUpdateParams::schedule_strategy?
101
104
 
102
105
  def schedule_strategy=: (
@@ -131,6 +134,7 @@ module Stigg
131
134
  ?minimum_spend: Stigg::V1::SubscriptionUpdateParams::MinimumSpend?,
132
135
  ?price_overrides: ::Array[Stigg::V1::SubscriptionUpdateParams::PriceOverride],
133
136
  ?promotion_code: String,
137
+ ?salesforce_id: String?,
134
138
  ?schedule_strategy: Stigg::Models::V1::SubscriptionUpdateParams::schedule_strategy,
135
139
  ?trial_end_date: Time,
136
140
  ?x_account_id: String,
@@ -154,6 +158,7 @@ module Stigg
154
158
  minimum_spend: Stigg::V1::SubscriptionUpdateParams::MinimumSpend?,
155
159
  price_overrides: ::Array[Stigg::V1::SubscriptionUpdateParams::PriceOverride],
156
160
  promotion_code: String,
161
+ salesforce_id: String?,
157
162
  schedule_strategy: Stigg::Models::V1::SubscriptionUpdateParams::schedule_strategy,
158
163
  trial_end_date: Time,
159
164
  x_account_id: String,
@@ -23,6 +23,7 @@ module Stigg
23
23
  feature_id: String,
24
24
  timestamp: Time,
25
25
  value: Integer,
26
+ credit: Stigg::Models::V1::UsageReportResponse::Data::Credit?,
26
27
  current_usage: Float?,
27
28
  next_reset_date: Time?,
28
29
  resource_id: String?,
@@ -43,6 +44,8 @@ module Stigg
43
44
 
44
45
  attr_accessor value: Integer
45
46
 
47
+ attr_accessor credit: Stigg::Models::V1::UsageReportResponse::Data::Credit?
48
+
46
49
  attr_accessor current_usage: Float?
47
50
 
48
51
  attr_accessor next_reset_date: Time?
@@ -60,6 +63,7 @@ module Stigg
60
63
  feature_id: String,
61
64
  timestamp: Time,
62
65
  value: Integer,
66
+ ?credit: Stigg::Models::V1::UsageReportResponse::Data::Credit?,
63
67
  ?current_usage: Float?,
64
68
  ?next_reset_date: Time?,
65
69
  ?resource_id: String?,
@@ -74,12 +78,45 @@ module Stigg
74
78
  feature_id: String,
75
79
  timestamp: Time,
76
80
  value: Integer,
81
+ credit: Stigg::Models::V1::UsageReportResponse::Data::Credit?,
77
82
  current_usage: Float?,
78
83
  next_reset_date: Time?,
79
84
  resource_id: String?,
80
85
  usage_period_end: Time?,
81
86
  usage_period_start: Time?
82
87
  }
88
+
89
+ type credit =
90
+ {
91
+ currency_id: String,
92
+ current_usage: Float,
93
+ timestamp: Time,
94
+ usage_limit: Float
95
+ }
96
+
97
+ class Credit < Stigg::Internal::Type::BaseModel
98
+ attr_accessor currency_id: String
99
+
100
+ attr_accessor current_usage: Float
101
+
102
+ attr_accessor timestamp: Time
103
+
104
+ attr_accessor usage_limit: Float
105
+
106
+ def initialize: (
107
+ currency_id: String,
108
+ current_usage: Float,
109
+ timestamp: Time,
110
+ usage_limit: Float
111
+ ) -> void
112
+
113
+ def to_hash: -> {
114
+ currency_id: String,
115
+ current_usage: Float,
116
+ timestamp: Time,
117
+ usage_limit: Float
118
+ }
119
+ end
83
120
  end
84
121
  end
85
122
  end
@@ -31,6 +31,7 @@ module Stigg
31
31
  ?minimum_spend: Stigg::V1::SubscriptionUpdateParams::MinimumSpend?,
32
32
  ?price_overrides: ::Array[Stigg::V1::SubscriptionUpdateParams::PriceOverride],
33
33
  ?promotion_code: String,
34
+ ?salesforce_id: String?,
34
35
  ?schedule_strategy: Stigg::Models::V1::SubscriptionUpdateParams::schedule_strategy,
35
36
  ?trial_end_date: Time,
36
37
  ?x_account_id: String,
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: stigg
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0.pre.beta.27
4
+ version: 0.1.0.pre.beta.29
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stigg
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-06-21 00:00:00.000000000 Z
11
+ date: 2026-06-22 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi