orb-billing 1.46.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 (160) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -1
  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/invoice_issue_summary_response.rb +2 -1
  7. data/lib/orb/models/invoice_issued_summary_webhook_event.rb +5 -3
  8. data/lib/orb/models/invoice_list_summary_response.rb +2 -1
  9. data/lib/orb/models/metric_archive_params.rb +20 -0
  10. data/lib/orb/models/metric_list_params.rb +21 -1
  11. data/lib/orb/models/metric_unarchive_params.rb +20 -0
  12. data/lib/orb/models/metric_update_params.rb +17 -1
  13. data/lib/orb/models/plan_update_params.rb +9 -1
  14. data/lib/orb/models/plans/external_plan_id_update_params.rb +9 -1
  15. data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +5 -9
  16. data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +5 -9
  17. data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +5 -9
  18. data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +5 -9
  19. data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +5 -9
  20. data/lib/orb/models/webhook_endpoint.rb +28 -1
  21. data/lib/orb/models/webhook_endpoint_create_params.rb +22 -1
  22. data/lib/orb/models/webhook_endpoint_update_params.rb +22 -1
  23. data/lib/orb/models/webhook_endpoint_with_secret.rb +28 -1
  24. data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +5 -3
  25. data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
  26. data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +5 -3
  27. data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +5 -3
  28. data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +5 -3
  29. data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +5 -3
  30. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +5 -3
  31. data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +5 -3
  32. data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +5 -3
  33. data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +5 -3
  34. data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +5 -3
  35. data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +5 -3
  36. data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +5 -3
  37. data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +5 -3
  38. data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +5 -3
  39. data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +5 -3
  40. data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +5 -3
  41. data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +5 -3
  42. data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +5 -3
  43. data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +5 -3
  44. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +9 -7
  45. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +9 -7
  46. data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +5 -9
  47. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +9 -7
  48. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +9 -7
  49. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +9 -7
  50. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +9 -7
  51. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +9 -7
  52. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +9 -7
  53. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +9 -7
  54. data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +5 -9
  55. data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +5 -9
  56. data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +5 -9
  57. data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +5 -9
  58. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +9 -7
  59. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +9 -7
  60. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +9 -7
  61. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +9 -7
  62. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +9 -7
  63. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +9 -7
  64. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +9 -7
  65. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +9 -7
  66. data/lib/orb/models.rb +6 -0
  67. data/lib/orb/resources/credit_blocks.rb +35 -0
  68. data/lib/orb/resources/metrics.rb +61 -5
  69. data/lib/orb/resources/plans/external_plan_id.rb +6 -3
  70. data/lib/orb/resources/plans.rb +6 -3
  71. data/lib/orb/resources/webhook_endpoints.rb +6 -2
  72. data/lib/orb/version.rb +1 -1
  73. data/lib/orb.rb +4 -0
  74. data/rbi/orb/models/credit_block_update_params.rbi +53 -0
  75. data/rbi/orb/models/credit_block_update_response.rbi +693 -0
  76. data/rbi/orb/models/invoice_issue_summary_response.rbi +2 -1
  77. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +6 -3
  78. data/rbi/orb/models/invoice_list_summary_response.rbi +2 -1
  79. data/rbi/orb/models/metric_archive_params.rbi +33 -0
  80. data/rbi/orb/models/metric_list_params.rbi +29 -0
  81. data/rbi/orb/models/metric_unarchive_params.rbi +35 -0
  82. data/rbi/orb/models/metric_update_params.rbi +16 -0
  83. data/rbi/orb/models/plan_update_params.rbi +8 -0
  84. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
  85. data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +6 -12
  86. data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +6 -12
  87. data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +6 -12
  88. data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +6 -12
  89. data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +6 -12
  90. data/rbi/orb/models/webhook_endpoint.rbi +39 -0
  91. data/rbi/orb/models/webhook_endpoint_create_params.rbi +51 -0
  92. data/rbi/orb/models/webhook_endpoint_update_params.rbi +51 -0
  93. data/rbi/orb/models/webhook_endpoint_with_secret.rbi +50 -0
  94. data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +6 -3
  95. data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
  96. data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +6 -3
  97. data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +6 -3
  98. data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +6 -3
  99. data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +6 -3
  100. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +6 -3
  101. data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +6 -3
  102. data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +6 -3
  103. data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +6 -3
  104. data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +6 -3
  105. data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +6 -3
  106. data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +6 -3
  107. data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +6 -3
  108. data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +6 -3
  109. data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +6 -3
  110. data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +6 -3
  111. data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +6 -3
  112. data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +6 -3
  113. data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +6 -3
  114. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +12 -9
  115. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +12 -9
  116. data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +6 -12
  117. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +12 -9
  118. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +12 -9
  119. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +12 -9
  120. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +12 -9
  121. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +12 -9
  122. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +12 -9
  123. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +12 -9
  124. data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +6 -12
  125. data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +6 -12
  126. data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +6 -12
  127. data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +6 -12
  128. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +12 -9
  129. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +12 -9
  130. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +12 -9
  131. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +12 -9
  132. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +12 -9
  133. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +12 -9
  134. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +12 -9
  135. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +12 -9
  136. data/rbi/orb/models.rbi +6 -0
  137. data/rbi/orb/resources/credit_blocks.rbi +26 -0
  138. data/rbi/orb/resources/metrics.rbi +44 -3
  139. data/rbi/orb/resources/plans/external_plan_id.rbi +6 -2
  140. data/rbi/orb/resources/plans.rbi +6 -2
  141. data/rbi/orb/resources/webhook_endpoints.rbi +10 -0
  142. data/sig/orb/models/credit_block_update_params.rbs +28 -0
  143. data/sig/orb/models/credit_block_update_response.rbs +263 -0
  144. data/sig/orb/models/metric_archive_params.rbs +23 -0
  145. data/sig/orb/models/metric_list_params.rbs +18 -1
  146. data/sig/orb/models/metric_unarchive_params.rbs +23 -0
  147. data/sig/orb/models/metric_update_params.rbs +14 -1
  148. data/sig/orb/models/plan_update_params.rbs +6 -1
  149. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -1
  150. data/sig/orb/models/webhook_endpoint.rbs +16 -0
  151. data/sig/orb/models/webhook_endpoint_create_params.rbs +20 -1
  152. data/sig/orb/models/webhook_endpoint_update_params.rbs +16 -0
  153. data/sig/orb/models/webhook_endpoint_with_secret.rbs +16 -0
  154. data/sig/orb/models.rbs +6 -0
  155. data/sig/orb/resources/credit_blocks.rbs +6 -0
  156. data/sig/orb/resources/metrics.rbs +13 -0
  157. data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
  158. data/sig/orb/resources/plans.rbs +1 -0
  159. data/sig/orb/resources/webhook_endpoints.rbs +2 -0
  160. 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: the fields readable without
33
- # to_subscription_params(), which every interval, billing period and plan phase
34
- # depends on.
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: the fields readable without
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: the fields readable without
139
- # to_subscription_params(), which every interval, billing period and plan phase
140
- # depends on.
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: the fields readable without
35
- # to_subscription_params(), which every interval, billing period and plan phase
36
- # depends on.
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: the fields readable without
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: the fields readable without
175
- # to_subscription_params(), which every interval, billing period and plan phase
176
- # depends on.
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
  #
@@ -33,10 +33,8 @@ module Orb
33
33
  -> { Orb::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent::Properties }
34
34
 
35
35
  # @!attribute subscription
36
- # A lightweight subscription representation for webhook payloads.
37
- #
38
- # This avoids the expensive to_subscription_params() call required for full
39
- # serialization.
36
+ # The subscription in a license or grouped cost webhook payload: its status,
37
+ # dates, plan and customer.
40
38
  #
41
39
  # @return [Orb::Models::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent::Subscription]
42
40
  required :subscription,
@@ -63,7 +61,7 @@ module Orb
63
61
  #
64
62
  # @param properties [Orb::Models::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent::Properties] Every group that crossed a threshold for one alert, batched into a single messag
65
63
  #
66
- # @param subscription [Orb::Models::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent::Subscription] A lightweight subscription representation for webhook payloads.
64
+ # @param subscription [Orb::Models::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
67
65
  #
68
66
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent::Type] The event this payload describes.
69
67
 
@@ -619,10 +617,8 @@ module Orb
619
617
  enum: -> { Orb::Webhooks::SubscriptionGroupedCostExceededStandardWebhookEvent::Subscription::Status }
620
618
 
621
619
  # @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
622
- # A lightweight subscription representation for webhook payloads.
623
- #
624
- # This avoids the expensive to_subscription_params() call required for full
625
- # serialization.
620
+ # The subscription in a license or grouped cost webhook payload: its status,
621
+ # dates, plan and customer.
626
622
  #
627
623
  # @param id [String]
628
624
  # @param customer [Orb::Models::CustomerMinified]
@@ -31,10 +31,8 @@ module Orb
31
31
  -> { Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Properties }
32
32
 
33
33
  # @!attribute subscription
34
- # A lightweight subscription representation for webhook payloads.
35
- #
36
- # This avoids the expensive to_subscription_params() call required for full
37
- # serialization.
34
+ # The subscription in a license or grouped cost webhook payload: its status,
35
+ # dates, plan and customer.
38
36
  #
39
37
  # @return [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription]
40
38
  required :subscription,
@@ -63,7 +61,7 @@ module Orb
63
61
  #
64
62
  # @param properties [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Properties]
65
63
  #
66
- # @param subscription [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription] A lightweight subscription representation for webhook payloads.
64
+ # @param subscription [Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
67
65
  #
68
66
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Type] The event this payload describes.
69
67
 
@@ -148,10 +146,8 @@ module Orb
148
146
  enum: -> { Orb::Webhooks::SubscriptionInvoicingThresholdExceededStandardWebhookEvent::Subscription::Status }
149
147
 
150
148
  # @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
151
- # A lightweight subscription representation for webhook payloads.
152
- #
153
- # This avoids the expensive to_subscription_params() call required for full
154
- # serialization.
149
+ # The subscription in a license or grouped cost webhook payload: its status,
150
+ # dates, plan and customer.
155
151
  #
156
152
  # @param id [String]
157
153
  # @param customer [Orb::Models::CustomerMinified]
@@ -33,10 +33,8 @@ module Orb
33
33
  -> { Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Properties }
34
34
 
35
35
  # @!attribute subscription
36
- # A lightweight subscription representation for webhook payloads.
37
- #
38
- # This avoids the expensive to_subscription_params() call required for full
39
- # serialization.
36
+ # The subscription in a license or grouped cost webhook payload: its status,
37
+ # dates, plan and customer.
40
38
  #
41
39
  # @return [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription]
42
40
  required :subscription,
@@ -63,7 +61,7 @@ module Orb
63
61
  #
64
62
  # @param properties [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Properties] Fires at the start of a billing period when license allocations are replenished.
65
63
  #
66
- # @param subscription [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription] A lightweight subscription representation for webhook payloads.
64
+ # @param subscription [Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
67
65
  #
68
66
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Type] The event this payload describes.
69
67
 
@@ -170,10 +168,8 @@ module Orb
170
168
  enum: -> { Orb::Webhooks::SubscriptionLicenseAllocationResetStandardWebhookEvent::Subscription::Status }
171
169
 
172
170
  # @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
173
- # A lightweight subscription representation for webhook payloads.
174
- #
175
- # This avoids the expensive to_subscription_params() call required for full
176
- # serialization.
171
+ # The subscription in a license or grouped cost webhook payload: its status,
172
+ # dates, plan and customer.
177
173
  #
178
174
  # @param id [String]
179
175
  # @param customer [Orb::Models::CustomerMinified]
@@ -33,10 +33,8 @@ module Orb
33
33
  -> { Orb::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent::Properties }
34
34
 
35
35
  # @!attribute subscription
36
- # A lightweight subscription representation for webhook payloads.
37
- #
38
- # This avoids the expensive to_subscription_params() call required for full
39
- # serialization.
36
+ # The subscription in a license or grouped cost webhook payload: its status,
37
+ # dates, plan and customer.
40
38
  #
41
39
  # @return [Orb::Models::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent::Subscription]
42
40
  required :subscription,
@@ -64,7 +62,7 @@ module Orb
64
62
  #
65
63
  # @param properties [Orb::Models::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent::Properties] Every license that crossed a threshold for one alert, batched into a single mess
66
64
  #
67
- # @param subscription [Orb::Models::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent::Subscription] A lightweight subscription representation for webhook payloads.
65
+ # @param subscription [Orb::Models::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
68
66
  #
69
67
  # @param type [Symbol, Orb::Models::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent::Type] The event this payload describes.
70
68
 
@@ -613,10 +611,8 @@ module Orb
613
611
  enum: -> { Orb::Webhooks::SubscriptionLicenseBalanceThresholdReachedStandardWebhookEvent::Subscription::Status }
614
612
 
615
613
  # @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
616
- # A lightweight subscription representation for webhook payloads.
617
- #
618
- # This avoids the expensive to_subscription_params() call required for full
619
- # serialization.
614
+ # The subscription in a license or grouped cost webhook payload: its status,
615
+ # dates, plan and customer.
620
616
  #
621
617
  # @param id [String]
622
618
  # @param customer [Orb::Models::CustomerMinified]
@@ -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: the fields readable without
35
- # to_subscription_params(), which every interval, billing period and plan phase
36
- # depends on.
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: the fields readable without
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: the fields readable without
169
- # to_subscription_params(), which every interval, billing period and plan phase
170
- # depends on.
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: the fields readable without
34
- # to_subscription_params(), which every interval, billing period and plan phase
35
- # depends on.
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: the fields readable without
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: the fields readable without
153
- # to_subscription_params(), which every interval, billing period and plan phase
154
- # depends on.
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: the fields readable without
35
- # to_subscription_params(), which every interval, billing period and plan phase
36
- # depends on.
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: the fields readable without
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: the fields readable without
170
- # to_subscription_params(), which every interval, billing period and plan phase
171
- # depends on.
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: the fields readable without
34
- # to_subscription_params(), which every interval, billing period and plan phase
35
- # depends on.
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: the fields readable without
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: the fields readable without
168
- # to_subscription_params(), which every interval, billing period and plan phase
169
- # depends on.
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: the fields readable without
34
- # to_subscription_params(), which every interval, billing period and plan phase
35
- # depends on.
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: the fields readable without
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: the fields readable without
613
- # to_subscription_params(), which every interval, billing period and plan phase
614
- # depends on.
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: the fields readable without
33
- # to_subscription_params(), which every interval, billing period and plan phase
34
- # depends on.
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: the fields readable without
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: the fields readable without
141
- # to_subscription_params(), which every interval, billing period and plan phase
142
- # depends on.
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: the fields readable without
34
- # to_subscription_params(), which every interval, billing period and plan phase
35
- # depends on.
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: the fields readable without
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: the fields readable without
142
- # to_subscription_params(), which every interval, billing period and plan phase
143
- # depends on.
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: the fields readable without
34
- # to_subscription_params(), which every interval, billing period and plan phase
35
- # depends on.
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: the fields readable without
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: the fields readable without
620
- # to_subscription_params(), which every interval, billing period and plan phase
621
- # depends on.
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: