orb-billing 1.47.0 → 1.48.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 +7 -0
- data/README.md +1 -1
- data/lib/orb/models/credit_block_update_params.rb +34 -0
- data/lib/orb/models/credit_block_update_response.rb +332 -0
- data/lib/orb/models/metric_archive_params.rb +20 -0
- data/lib/orb/models/metric_unarchive_params.rb +20 -0
- data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +9 -7
- data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +9 -7
- data/lib/orb/models.rb +6 -0
- data/lib/orb/resources/credit_blocks.rb +35 -0
- data/lib/orb/resources/metrics.rb +46 -0
- data/lib/orb/version.rb +1 -1
- data/lib/orb.rb +4 -0
- data/rbi/orb/models/credit_block_update_params.rbi +53 -0
- data/rbi/orb/models/credit_block_update_response.rbi +693 -0
- data/rbi/orb/models/metric_archive_params.rbi +33 -0
- data/rbi/orb/models/metric_unarchive_params.rbi +35 -0
- data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +12 -9
- data/rbi/orb/models.rbi +6 -0
- data/rbi/orb/resources/credit_blocks.rbi +26 -0
- data/rbi/orb/resources/metrics.rbi +28 -0
- data/sig/orb/models/credit_block_update_params.rbs +28 -0
- data/sig/orb/models/credit_block_update_response.rbs +263 -0
- data/sig/orb/models/metric_archive_params.rbs +23 -0
- data/sig/orb/models/metric_unarchive_params.rbs +23 -0
- data/sig/orb/models.rbs +6 -0
- data/sig/orb/resources/credit_blocks.rbs +6 -0
- data/sig/orb/resources/metrics.rbs +10 -0
- metadata +13 -1
|
@@ -29,9 +29,10 @@ module Orb
|
|
|
29
29
|
required :properties, Orb::Internal::Type::Unknown
|
|
30
30
|
|
|
31
31
|
# @!attribute subscription
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
# billing periods, plan phases and other
|
|
32
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
33
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
34
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
35
|
+
# derived fields.
|
|
35
36
|
#
|
|
36
37
|
# @return [Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription]
|
|
37
38
|
required :subscription, -> { Orb::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription }
|
|
@@ -57,7 +58,7 @@ module Orb
|
|
|
57
58
|
#
|
|
58
59
|
# @param properties [Object]
|
|
59
60
|
#
|
|
60
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription]
|
|
61
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
61
62
|
#
|
|
62
63
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Type] The event this payload describes.
|
|
63
64
|
|
|
@@ -137,9 +138,10 @@ module Orb
|
|
|
137
138
|
# {Orb::Models::Webhooks::SubscriptionCreatedStandardWebhookEvent::Subscription}
|
|
138
139
|
# for more details.
|
|
139
140
|
#
|
|
140
|
-
#
|
|
141
|
-
#
|
|
142
|
-
# billing periods, plan phases and other
|
|
141
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
142
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
143
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
144
|
+
# derived fields.
|
|
143
145
|
#
|
|
144
146
|
# @param id [String]
|
|
145
147
|
#
|
|
@@ -29,9 +29,10 @@ module Orb
|
|
|
29
29
|
required :properties, -> { Orb::Webhooks::SubscriptionEditedStandardWebhookEvent::Properties }
|
|
30
30
|
|
|
31
31
|
# @!attribute subscription
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
# billing periods, plan phases and other
|
|
32
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
33
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
34
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
35
|
+
# derived fields.
|
|
35
36
|
#
|
|
36
37
|
# @return [Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription]
|
|
37
38
|
required :subscription, -> { Orb::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription }
|
|
@@ -57,7 +58,7 @@ module Orb
|
|
|
57
58
|
#
|
|
58
59
|
# @param properties [Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Properties]
|
|
59
60
|
#
|
|
60
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription]
|
|
61
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
61
62
|
#
|
|
62
63
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Type] The event this payload describes.
|
|
63
64
|
|
|
@@ -189,9 +190,10 @@ module Orb
|
|
|
189
190
|
# {Orb::Models::Webhooks::SubscriptionEditedStandardWebhookEvent::Subscription}
|
|
190
191
|
# for more details.
|
|
191
192
|
#
|
|
192
|
-
#
|
|
193
|
-
#
|
|
194
|
-
# billing periods, plan phases and other
|
|
193
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
194
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
195
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
196
|
+
# derived fields.
|
|
195
197
|
#
|
|
196
198
|
# @param id [String]
|
|
197
199
|
#
|
|
@@ -29,9 +29,10 @@ module Orb
|
|
|
29
29
|
required :properties, Orb::Internal::Type::Unknown
|
|
30
30
|
|
|
31
31
|
# @!attribute subscription
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
# billing periods, plan phases and other
|
|
32
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
33
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
34
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
35
|
+
# derived fields.
|
|
35
36
|
#
|
|
36
37
|
# @return [Orb::Models::Webhooks::SubscriptionEndedStandardWebhookEvent::Subscription]
|
|
37
38
|
required :subscription, -> { Orb::Webhooks::SubscriptionEndedStandardWebhookEvent::Subscription }
|
|
@@ -56,7 +57,7 @@ module Orb
|
|
|
56
57
|
#
|
|
57
58
|
# @param properties [Object]
|
|
58
59
|
#
|
|
59
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionEndedStandardWebhookEvent::Subscription]
|
|
60
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionEndedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
60
61
|
#
|
|
61
62
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionEndedStandardWebhookEvent::Type] The event this payload describes.
|
|
62
63
|
|
|
@@ -135,9 +136,10 @@ module Orb
|
|
|
135
136
|
# {Orb::Models::Webhooks::SubscriptionEndedStandardWebhookEvent::Subscription} for
|
|
136
137
|
# more details.
|
|
137
138
|
#
|
|
138
|
-
#
|
|
139
|
-
#
|
|
140
|
-
# billing periods, plan phases and other
|
|
139
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
140
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
141
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
142
|
+
# derived fields.
|
|
141
143
|
#
|
|
142
144
|
# @param id [String]
|
|
143
145
|
#
|
data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb
CHANGED
|
@@ -31,9 +31,10 @@ module Orb
|
|
|
31
31
|
-> { Orb::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Properties }
|
|
32
32
|
|
|
33
33
|
# @!attribute subscription
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
# billing periods, plan phases and other
|
|
34
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
35
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
36
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
37
|
+
# derived fields.
|
|
37
38
|
#
|
|
38
39
|
# @return [Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Subscription]
|
|
39
40
|
required :subscription,
|
|
@@ -60,7 +61,7 @@ module Orb
|
|
|
60
61
|
#
|
|
61
62
|
# @param properties [Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Properties]
|
|
62
63
|
#
|
|
63
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Subscription]
|
|
64
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
64
65
|
#
|
|
65
66
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Type] The event this payload describes.
|
|
66
67
|
|
|
@@ -171,9 +172,10 @@ module Orb
|
|
|
171
172
|
# {Orb::Models::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Subscription}
|
|
172
173
|
# for more details.
|
|
173
174
|
#
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
# billing periods, plan phases and other
|
|
175
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
176
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
177
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
178
|
+
# derived fields.
|
|
177
179
|
#
|
|
178
180
|
# @param id [String]
|
|
179
181
|
#
|
|
@@ -31,9 +31,10 @@ module Orb
|
|
|
31
31
|
-> { Orb::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent::Properties }
|
|
32
32
|
|
|
33
33
|
# @!attribute subscription
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
# billing periods, plan phases and other
|
|
34
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
35
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
36
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
37
|
+
# derived fields.
|
|
37
38
|
#
|
|
38
39
|
# @return [Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent::Subscription]
|
|
39
40
|
required :subscription,
|
|
@@ -60,7 +61,7 @@ module Orb
|
|
|
60
61
|
#
|
|
61
62
|
# @param properties [Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent::Properties]
|
|
62
63
|
#
|
|
63
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent::Subscription]
|
|
64
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
64
65
|
#
|
|
65
66
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent::Type] The event this payload describes.
|
|
66
67
|
|
|
@@ -165,9 +166,10 @@ module Orb
|
|
|
165
166
|
# {Orb::Models::Webhooks::SubscriptionPlanChangeScheduledStandardWebhookEvent::Subscription}
|
|
166
167
|
# for more details.
|
|
167
168
|
#
|
|
168
|
-
#
|
|
169
|
-
#
|
|
170
|
-
# billing periods, plan phases and other
|
|
169
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
170
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
171
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
172
|
+
# derived fields.
|
|
171
173
|
#
|
|
172
174
|
# @param id [String]
|
|
173
175
|
#
|
|
@@ -30,9 +30,10 @@ module Orb
|
|
|
30
30
|
required :properties, -> { Orb::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Properties }
|
|
31
31
|
|
|
32
32
|
# @!attribute subscription
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# billing periods, plan phases and other
|
|
33
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
34
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
35
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
36
|
+
# derived fields.
|
|
36
37
|
#
|
|
37
38
|
# @return [Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Subscription]
|
|
38
39
|
required :subscription, -> { Orb::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Subscription }
|
|
@@ -58,7 +59,7 @@ module Orb
|
|
|
58
59
|
#
|
|
59
60
|
# @param properties [Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Properties]
|
|
60
61
|
#
|
|
61
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Subscription]
|
|
62
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
62
63
|
#
|
|
63
64
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Type] The event this payload describes.
|
|
64
65
|
|
|
@@ -149,9 +150,10 @@ module Orb
|
|
|
149
150
|
# {Orb::Models::Webhooks::SubscriptionPlanChangedStandardWebhookEvent::Subscription}
|
|
150
151
|
# for more details.
|
|
151
152
|
#
|
|
152
|
-
#
|
|
153
|
-
#
|
|
154
|
-
# billing periods, plan phases and other
|
|
153
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
154
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
155
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
156
|
+
# derived fields.
|
|
155
157
|
#
|
|
156
158
|
# @param id [String]
|
|
157
159
|
#
|
data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb
CHANGED
|
@@ -31,9 +31,10 @@ module Orb
|
|
|
31
31
|
-> { Orb::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Properties }
|
|
32
32
|
|
|
33
33
|
# @!attribute subscription
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
# billing periods, plan phases and other
|
|
34
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
35
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
36
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
37
|
+
# derived fields.
|
|
37
38
|
#
|
|
38
39
|
# @return [Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Subscription]
|
|
39
40
|
required :subscription,
|
|
@@ -61,7 +62,7 @@ module Orb
|
|
|
61
62
|
#
|
|
62
63
|
# @param properties [Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Properties]
|
|
63
64
|
#
|
|
64
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Subscription]
|
|
65
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
65
66
|
#
|
|
66
67
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Type] The event this payload describes.
|
|
67
68
|
|
|
@@ -166,9 +167,10 @@ module Orb
|
|
|
166
167
|
# {Orb::Models::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Subscription}
|
|
167
168
|
# for more details.
|
|
168
169
|
#
|
|
169
|
-
#
|
|
170
|
-
#
|
|
171
|
-
# billing periods, plan phases and other
|
|
170
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
171
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
172
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
173
|
+
# derived fields.
|
|
172
174
|
#
|
|
173
175
|
# @param id [String]
|
|
174
176
|
#
|
|
@@ -30,9 +30,10 @@ module Orb
|
|
|
30
30
|
required :properties, -> { Orb::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent::Properties }
|
|
31
31
|
|
|
32
32
|
# @!attribute subscription
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# billing periods, plan phases and other
|
|
33
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
34
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
35
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
36
|
+
# derived fields.
|
|
36
37
|
#
|
|
37
38
|
# @return [Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent::Subscription]
|
|
38
39
|
required :subscription,
|
|
@@ -59,7 +60,7 @@ module Orb
|
|
|
59
60
|
#
|
|
60
61
|
# @param properties [Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent::Properties]
|
|
61
62
|
#
|
|
62
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent::Subscription]
|
|
63
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
63
64
|
#
|
|
64
65
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent::Type] The event this payload describes.
|
|
65
66
|
|
|
@@ -164,9 +165,10 @@ module Orb
|
|
|
164
165
|
# {Orb::Models::Webhooks::SubscriptionPlanVersionChangedStandardWebhookEvent::Subscription}
|
|
165
166
|
# for more details.
|
|
166
167
|
#
|
|
167
|
-
#
|
|
168
|
-
#
|
|
169
|
-
# billing periods, plan phases and other
|
|
168
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
169
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
170
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
171
|
+
# derived fields.
|
|
170
172
|
#
|
|
171
173
|
# @param id [String]
|
|
172
174
|
#
|
|
@@ -30,9 +30,10 @@ module Orb
|
|
|
30
30
|
required :properties, -> { Orb::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Properties }
|
|
31
31
|
|
|
32
32
|
# @!attribute subscription
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# billing periods, plan phases and other
|
|
33
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
34
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
35
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
36
|
+
# derived fields.
|
|
36
37
|
#
|
|
37
38
|
# @return [Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Subscription]
|
|
38
39
|
required :subscription, -> { Orb::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Subscription }
|
|
@@ -59,7 +60,7 @@ module Orb
|
|
|
59
60
|
#
|
|
60
61
|
# @param properties [Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Properties]
|
|
61
62
|
#
|
|
62
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Subscription]
|
|
63
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
63
64
|
#
|
|
64
65
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Type] The event this payload describes.
|
|
65
66
|
|
|
@@ -609,9 +610,10 @@ module Orb
|
|
|
609
610
|
# {Orb::Models::Webhooks::SubscriptionSpendExceededStandardWebhookEvent::Subscription}
|
|
610
611
|
# for more details.
|
|
611
612
|
#
|
|
612
|
-
#
|
|
613
|
-
#
|
|
614
|
-
# billing periods, plan phases and other
|
|
613
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
614
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
615
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
616
|
+
# derived fields.
|
|
615
617
|
#
|
|
616
618
|
# @param id [String]
|
|
617
619
|
#
|
|
@@ -29,9 +29,10 @@ module Orb
|
|
|
29
29
|
required :properties, Orb::Internal::Type::Unknown
|
|
30
30
|
|
|
31
31
|
# @!attribute subscription
|
|
32
|
-
#
|
|
33
|
-
#
|
|
34
|
-
# billing periods, plan phases and other
|
|
32
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
33
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
34
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
35
|
+
# derived fields.
|
|
35
36
|
#
|
|
36
37
|
# @return [Orb::Models::Webhooks::SubscriptionStartedStandardWebhookEvent::Subscription]
|
|
37
38
|
required :subscription, -> { Orb::Webhooks::SubscriptionStartedStandardWebhookEvent::Subscription }
|
|
@@ -57,7 +58,7 @@ module Orb
|
|
|
57
58
|
#
|
|
58
59
|
# @param properties [Object]
|
|
59
60
|
#
|
|
60
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionStartedStandardWebhookEvent::Subscription]
|
|
61
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionStartedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
61
62
|
#
|
|
62
63
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionStartedStandardWebhookEvent::Type] The event this payload describes.
|
|
63
64
|
|
|
@@ -137,9 +138,10 @@ module Orb
|
|
|
137
138
|
# {Orb::Models::Webhooks::SubscriptionStartedStandardWebhookEvent::Subscription}
|
|
138
139
|
# for more details.
|
|
139
140
|
#
|
|
140
|
-
#
|
|
141
|
-
#
|
|
142
|
-
# billing periods, plan phases and other
|
|
141
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
142
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
143
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
144
|
+
# derived fields.
|
|
143
145
|
#
|
|
144
146
|
# @param id [String]
|
|
145
147
|
#
|
|
@@ -30,9 +30,10 @@ module Orb
|
|
|
30
30
|
required :properties, Orb::Internal::Type::Unknown
|
|
31
31
|
|
|
32
32
|
# @!attribute subscription
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# billing periods, plan phases and other
|
|
33
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
34
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
35
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
36
|
+
# derived fields.
|
|
36
37
|
#
|
|
37
38
|
# @return [Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription]
|
|
38
39
|
required :subscription, -> { Orb::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription }
|
|
@@ -58,7 +59,7 @@ module Orb
|
|
|
58
59
|
#
|
|
59
60
|
# @param properties [Object]
|
|
60
61
|
#
|
|
61
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription]
|
|
62
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
62
63
|
#
|
|
63
64
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Type] The event this payload describes.
|
|
64
65
|
|
|
@@ -138,9 +139,10 @@ module Orb
|
|
|
138
139
|
# {Orb::Models::Webhooks::SubscriptionTrialEndedStandardWebhookEvent::Subscription}
|
|
139
140
|
# for more details.
|
|
140
141
|
#
|
|
141
|
-
#
|
|
142
|
-
#
|
|
143
|
-
# billing periods, plan phases and other
|
|
142
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
143
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
144
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
145
|
+
# derived fields.
|
|
144
146
|
#
|
|
145
147
|
# @param id [String]
|
|
146
148
|
#
|
|
@@ -30,9 +30,10 @@ module Orb
|
|
|
30
30
|
required :properties, -> { Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Properties }
|
|
31
31
|
|
|
32
32
|
# @!attribute subscription
|
|
33
|
-
#
|
|
34
|
-
#
|
|
35
|
-
# billing periods, plan phases and other
|
|
33
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
34
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
35
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
36
|
+
# derived fields.
|
|
36
37
|
#
|
|
37
38
|
# @return [Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription]
|
|
38
39
|
required :subscription, -> { Orb::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription }
|
|
@@ -59,7 +60,7 @@ module Orb
|
|
|
59
60
|
#
|
|
60
61
|
# @param properties [Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Properties]
|
|
61
62
|
#
|
|
62
|
-
# @param subscription [Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription]
|
|
63
|
+
# @param subscription [Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription] A subscription's own fields, with its plan and customer as references, as listed
|
|
63
64
|
#
|
|
64
65
|
# @param type [Symbol, Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Type] The event this payload describes.
|
|
65
66
|
|
|
@@ -616,9 +617,10 @@ module Orb
|
|
|
616
617
|
# {Orb::Models::Webhooks::SubscriptionUsageExceededStandardWebhookEvent::Subscription}
|
|
617
618
|
# for more details.
|
|
618
619
|
#
|
|
619
|
-
#
|
|
620
|
-
#
|
|
621
|
-
# billing periods, plan phases and other
|
|
620
|
+
# A subscription's own fields, with its plan and customer as references, as listed
|
|
621
|
+
# by List subscription summaries and carried in standard webhook payloads. Fetch
|
|
622
|
+
# the subscription for its price intervals, billing periods, plan phases and other
|
|
623
|
+
# derived fields.
|
|
622
624
|
#
|
|
623
625
|
# @param id [String]
|
|
624
626
|
#
|
data/lib/orb/models.rb
CHANGED
|
@@ -140,6 +140,8 @@ module Orb
|
|
|
140
140
|
|
|
141
141
|
CreditBlockRetrieveParams = Orb::Models::CreditBlockRetrieveParams
|
|
142
142
|
|
|
143
|
+
CreditBlockUpdateParams = Orb::Models::CreditBlockUpdateParams
|
|
144
|
+
|
|
143
145
|
CreditNote = Orb::Models::CreditNote
|
|
144
146
|
|
|
145
147
|
CreditNoteAccountingSyncFailedWebhookEvent = Orb::Models::CreditNoteAccountingSyncFailedWebhookEvent
|
|
@@ -391,6 +393,8 @@ module Orb
|
|
|
391
393
|
|
|
392
394
|
MaximumInterval = Orb::Models::MaximumInterval
|
|
393
395
|
|
|
396
|
+
MetricArchiveParams = Orb::Models::MetricArchiveParams
|
|
397
|
+
|
|
394
398
|
MetricCreateParams = Orb::Models::MetricCreateParams
|
|
395
399
|
|
|
396
400
|
MetricEventsDroppedByWatermarkWebhookEvent = Orb::Models::MetricEventsDroppedByWatermarkWebhookEvent
|
|
@@ -399,6 +403,8 @@ module Orb
|
|
|
399
403
|
|
|
400
404
|
MetricListParams = Orb::Models::MetricListParams
|
|
401
405
|
|
|
406
|
+
MetricUnarchiveParams = Orb::Models::MetricUnarchiveParams
|
|
407
|
+
|
|
402
408
|
MetricUpdateParams = Orb::Models::MetricUpdateParams
|
|
403
409
|
|
|
404
410
|
Minimum = Orb::Models::Minimum
|
|
@@ -24,6 +24,41 @@ module Orb
|
|
|
24
24
|
)
|
|
25
25
|
end
|
|
26
26
|
|
|
27
|
+
# Some parameter documentations has been truncated, see
|
|
28
|
+
# {Orb::Models::CreditBlockUpdateParams} for more details.
|
|
29
|
+
#
|
|
30
|
+
# This endpoint updates the `metadata` of a credit block. Keys you pass are added
|
|
31
|
+
# to the block's existing metadata or overwrite the value already stored for that
|
|
32
|
+
# key, and setting a key to `null` removes it. Passing `null` for `metadata`
|
|
33
|
+
# clears all of the block's metadata. The block's `increment` entry in the
|
|
34
|
+
# [credits ledger](fetch-customer-credits-ledger) reports the block's metadata, so
|
|
35
|
+
# it shows the update too.
|
|
36
|
+
#
|
|
37
|
+
# Other fields on a credit block cannot be changed through this endpoint. Deleted
|
|
38
|
+
# credit blocks return a 404.
|
|
39
|
+
#
|
|
40
|
+
# @overload update(block_id, metadata: nil, request_options: {})
|
|
41
|
+
#
|
|
42
|
+
# @param block_id [String]
|
|
43
|
+
#
|
|
44
|
+
# @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
|
|
45
|
+
#
|
|
46
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
47
|
+
#
|
|
48
|
+
# @return [Orb::Models::CreditBlockUpdateResponse]
|
|
49
|
+
#
|
|
50
|
+
# @see Orb::Models::CreditBlockUpdateParams
|
|
51
|
+
def update(block_id, params = {})
|
|
52
|
+
parsed, options = Orb::CreditBlockUpdateParams.dump_request(params)
|
|
53
|
+
@client.request(
|
|
54
|
+
method: :put,
|
|
55
|
+
path: ["credit_blocks/%1$s", block_id],
|
|
56
|
+
body: parsed,
|
|
57
|
+
model: Orb::Models::CreditBlockUpdateResponse,
|
|
58
|
+
options: options
|
|
59
|
+
)
|
|
60
|
+
end
|
|
61
|
+
|
|
27
62
|
# This endpoint deletes a credit block by its ID.
|
|
28
63
|
#
|
|
29
64
|
# When a credit block is deleted:
|
|
@@ -123,6 +123,31 @@ module Orb
|
|
|
123
123
|
)
|
|
124
124
|
end
|
|
125
125
|
|
|
126
|
+
# This endpoint archives a [metric](/core-concepts#metric). Archived metrics are
|
|
127
|
+
# left out of `GET /v1/metrics` when filtering with `status=active`, and can't be
|
|
128
|
+
# chosen when creating new plans in the Orb dashboard.
|
|
129
|
+
#
|
|
130
|
+
# Archiving does not change existing prices, plans, or subscriptions that use the
|
|
131
|
+
# metric, and usage on those prices continues to be billed. A metric that is
|
|
132
|
+
# already archived cannot be archived again.
|
|
133
|
+
#
|
|
134
|
+
# @overload archive(metric_id, request_options: {})
|
|
135
|
+
#
|
|
136
|
+
# @param metric_id [String]
|
|
137
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
138
|
+
#
|
|
139
|
+
# @return [Orb::Models::BillableMetric]
|
|
140
|
+
#
|
|
141
|
+
# @see Orb::Models::MetricArchiveParams
|
|
142
|
+
def archive(metric_id, params = {})
|
|
143
|
+
@client.request(
|
|
144
|
+
method: :post,
|
|
145
|
+
path: ["metrics/%1$s/archive", metric_id],
|
|
146
|
+
model: Orb::BillableMetric,
|
|
147
|
+
options: params[:request_options]
|
|
148
|
+
)
|
|
149
|
+
end
|
|
150
|
+
|
|
126
151
|
# This endpoint is used to fetch [metric](/core-concepts#metric) details given a
|
|
127
152
|
# metric identifier. It returns information about the metrics including its name,
|
|
128
153
|
# description, and item.
|
|
@@ -144,6 +169,27 @@ module Orb
|
|
|
144
169
|
)
|
|
145
170
|
end
|
|
146
171
|
|
|
172
|
+
# This endpoint restores an archived [metric](/core-concepts#metric) to `active`,
|
|
173
|
+
# so it can be chosen for new plans again. Only archived metrics can be
|
|
174
|
+
# unarchived.
|
|
175
|
+
#
|
|
176
|
+
# @overload unarchive(metric_id, request_options: {})
|
|
177
|
+
#
|
|
178
|
+
# @param metric_id [String]
|
|
179
|
+
# @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
180
|
+
#
|
|
181
|
+
# @return [Orb::Models::BillableMetric]
|
|
182
|
+
#
|
|
183
|
+
# @see Orb::Models::MetricUnarchiveParams
|
|
184
|
+
def unarchive(metric_id, params = {})
|
|
185
|
+
@client.request(
|
|
186
|
+
method: :post,
|
|
187
|
+
path: ["metrics/%1$s/unarchive", metric_id],
|
|
188
|
+
model: Orb::BillableMetric,
|
|
189
|
+
options: params[:request_options]
|
|
190
|
+
)
|
|
191
|
+
end
|
|
192
|
+
|
|
147
193
|
# @api private
|
|
148
194
|
#
|
|
149
195
|
# @param client [Orb::Client]
|
data/lib/orb/version.rb
CHANGED
data/lib/orb.rb
CHANGED
|
@@ -107,6 +107,8 @@ require_relative "orb/models/credit_block_list_invoices_params"
|
|
|
107
107
|
require_relative "orb/models/credit_block_list_invoices_response"
|
|
108
108
|
require_relative "orb/models/credit_block_retrieve_params"
|
|
109
109
|
require_relative "orb/models/credit_block_retrieve_response"
|
|
110
|
+
require_relative "orb/models/credit_block_update_params"
|
|
111
|
+
require_relative "orb/models/credit_block_update_response"
|
|
110
112
|
require_relative "orb/models/credit_note"
|
|
111
113
|
require_relative "orb/models/credit_note_accounting_sync_failed_webhook_event"
|
|
112
114
|
require_relative "orb/models/credit_note_accounting_sync_succeeded_webhook_event"
|
|
@@ -304,10 +306,12 @@ require_relative "orb/models/matrix_value"
|
|
|
304
306
|
require_relative "orb/models/matrix_with_allocation_config"
|
|
305
307
|
require_relative "orb/models/maximum"
|
|
306
308
|
require_relative "orb/models/maximum_interval"
|
|
309
|
+
require_relative "orb/models/metric_archive_params"
|
|
307
310
|
require_relative "orb/models/metric_create_params"
|
|
308
311
|
require_relative "orb/models/metric_events_dropped_by_watermark_webhook_event"
|
|
309
312
|
require_relative "orb/models/metric_fetch_params"
|
|
310
313
|
require_relative "orb/models/metric_list_params"
|
|
314
|
+
require_relative "orb/models/metric_unarchive_params"
|
|
311
315
|
require_relative "orb/models/metric_update_params"
|
|
312
316
|
require_relative "orb/models/minimum"
|
|
313
317
|
require_relative "orb/models/minimum_interval"
|