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.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/credit_block_update_params.rb +34 -0
  5. data/lib/orb/models/credit_block_update_response.rb +332 -0
  6. data/lib/orb/models/metric_archive_params.rb +20 -0
  7. data/lib/orb/models/metric_unarchive_params.rb +20 -0
  8. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +9 -7
  9. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +9 -7
  10. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +9 -7
  11. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +9 -7
  12. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +9 -7
  13. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +9 -7
  14. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +9 -7
  15. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +9 -7
  16. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +9 -7
  17. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +9 -7
  18. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +9 -7
  19. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +9 -7
  20. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +9 -7
  21. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +9 -7
  22. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +9 -7
  23. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +9 -7
  24. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +9 -7
  25. data/lib/orb/models.rb +6 -0
  26. data/lib/orb/resources/credit_blocks.rb +35 -0
  27. data/lib/orb/resources/metrics.rb +46 -0
  28. data/lib/orb/version.rb +1 -1
  29. data/lib/orb.rb +4 -0
  30. data/rbi/orb/models/credit_block_update_params.rbi +53 -0
  31. data/rbi/orb/models/credit_block_update_response.rbi +693 -0
  32. data/rbi/orb/models/metric_archive_params.rbi +33 -0
  33. data/rbi/orb/models/metric_unarchive_params.rbi +35 -0
  34. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +12 -9
  35. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +12 -9
  36. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +12 -9
  37. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +12 -9
  38. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +12 -9
  39. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +12 -9
  40. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +12 -9
  41. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +12 -9
  42. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +12 -9
  43. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +12 -9
  44. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +12 -9
  45. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +12 -9
  46. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +12 -9
  47. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +12 -9
  48. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +12 -9
  49. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +12 -9
  50. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +12 -9
  51. data/rbi/orb/models.rbi +6 -0
  52. data/rbi/orb/resources/credit_blocks.rbi +26 -0
  53. data/rbi/orb/resources/metrics.rbi +28 -0
  54. data/sig/orb/models/credit_block_update_params.rbs +28 -0
  55. data/sig/orb/models/credit_block_update_response.rbs +263 -0
  56. data/sig/orb/models/metric_archive_params.rbs +23 -0
  57. data/sig/orb/models/metric_unarchive_params.rbs +23 -0
  58. data/sig/orb/models.rbs +6 -0
  59. data/sig/orb/resources/credit_blocks.rbs +6 -0
  60. data/sig/orb/resources/metrics.rbs +10 -0
  61. metadata +13 -1
@@ -29,9 +29,10 @@ module Orb
29
29
  required :properties, Orb::Internal::Type::Unknown
30
30
 
31
31
  # @!attribute subscription
32
- # The subscription in a standard webhook payload: its own fields, with its plan
33
- # and customer as references. Fetch the subscription for its price intervals,
34
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
141
- # and customer as references. Fetch the subscription for its price intervals,
142
- # billing periods, plan phases and other derived fields.
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
- # The subscription in a standard webhook payload: its own fields, with its plan
33
- # and customer as references. Fetch the subscription for its price intervals,
34
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
193
- # and customer as references. Fetch the subscription for its price intervals,
194
- # billing periods, plan phases and other derived fields.
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
- # The subscription in a standard webhook payload: its own fields, with its plan
33
- # and customer as references. Fetch the subscription for its price intervals,
34
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
139
- # and customer as references. Fetch the subscription for its price intervals,
140
- # billing periods, plan phases and other derived fields.
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
  #
@@ -31,9 +31,10 @@ module Orb
31
31
  -> { Orb::Webhooks::SubscriptionFixedFeeQuantityUpdatedStandardWebhookEvent::Properties }
32
32
 
33
33
  # @!attribute subscription
34
- # The subscription in a standard webhook payload: its own fields, with its plan
35
- # and customer as references. Fetch the subscription for its price intervals,
36
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
175
- # and customer as references. Fetch the subscription for its price intervals,
176
- # billing periods, plan phases and other derived fields.
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
- # The subscription in a standard webhook payload: its own fields, with its plan
35
- # and customer as references. Fetch the subscription for its price intervals,
36
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
169
- # and customer as references. Fetch the subscription for its price intervals,
170
- # billing periods, plan phases and other derived fields.
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
- # The subscription in a standard webhook payload: its own fields, with its plan
34
- # and customer as references. Fetch the subscription for its price intervals,
35
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
153
- # and customer as references. Fetch the subscription for its price intervals,
154
- # billing periods, plan phases and other derived fields.
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
  #
@@ -31,9 +31,10 @@ module Orb
31
31
  -> { Orb::Webhooks::SubscriptionPlanVersionChangeScheduledStandardWebhookEvent::Properties }
32
32
 
33
33
  # @!attribute subscription
34
- # The subscription in a standard webhook payload: its own fields, with its plan
35
- # and customer as references. Fetch the subscription for its price intervals,
36
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
170
- # and customer as references. Fetch the subscription for its price intervals,
171
- # billing periods, plan phases and other derived fields.
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
- # The subscription in a standard webhook payload: its own fields, with its plan
34
- # and customer as references. Fetch the subscription for its price intervals,
35
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
168
- # and customer as references. Fetch the subscription for its price intervals,
169
- # billing periods, plan phases and other derived fields.
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
- # The subscription in a standard webhook payload: its own fields, with its plan
34
- # and customer as references. Fetch the subscription for its price intervals,
35
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
613
- # and customer as references. Fetch the subscription for its price intervals,
614
- # billing periods, plan phases and other derived fields.
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
- # The subscription in a standard webhook payload: its own fields, with its plan
33
- # and customer as references. Fetch the subscription for its price intervals,
34
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
141
- # and customer as references. Fetch the subscription for its price intervals,
142
- # billing periods, plan phases and other derived fields.
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
- # The subscription in a standard webhook payload: its own fields, with its plan
34
- # and customer as references. Fetch the subscription for its price intervals,
35
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
142
- # and customer as references. Fetch the subscription for its price intervals,
143
- # billing periods, plan phases and other derived fields.
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
- # The subscription in a standard webhook payload: its own fields, with its plan
34
- # and customer as references. Fetch the subscription for its price intervals,
35
- # billing periods, plan phases and other derived fields.
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] The subscription in a standard webhook payload: its own fields, with its plan an
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
- # The subscription in a standard webhook payload: its own fields, with its plan
620
- # and customer as references. Fetch the subscription for its price intervals,
621
- # billing periods, plan phases and other derived fields.
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
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Orb
4
- VERSION = "1.47.0"
4
+ VERSION = "1.48.0"
5
5
  end
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"