orb-billing 1.45.0 → 1.47.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 (316) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -1
  3. data/README.md +1 -1
  4. data/lib/orb/models/invoice_issue_summary_response.rb +2 -1
  5. data/lib/orb/models/invoice_issued_summary_webhook_event.rb +5 -3
  6. data/lib/orb/models/invoice_list_summary_response.rb +2 -1
  7. data/lib/orb/models/metric_list_params.rb +21 -1
  8. data/lib/orb/models/metric_update_params.rb +17 -1
  9. data/lib/orb/models/plan_update_params.rb +9 -1
  10. data/lib/orb/models/plans/external_plan_id_update_params.rb +9 -1
  11. data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +5 -9
  12. data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +5 -9
  13. data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +5 -9
  14. data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +5 -9
  15. data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +5 -9
  16. data/lib/orb/models/webhook_endpoint.rb +28 -1
  17. data/lib/orb/models/webhook_endpoint_create_params.rb +22 -1
  18. data/lib/orb/models/webhook_endpoint_update_params.rb +22 -1
  19. data/lib/orb/models/webhook_endpoint_with_secret.rb +28 -1
  20. data/lib/orb/models/webhooks/backfill_reflected_standard_webhook_event.rb +206 -0
  21. data/lib/orb/models/webhooks/backfill_reverted_standard_webhook_event.rb +206 -0
  22. data/lib/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rb +131 -0
  23. data/lib/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rb +537 -0
  24. data/lib/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rb +531 -0
  25. data/lib/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rb +188 -0
  26. data/lib/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rb +183 -0
  27. data/lib/orb/models/webhooks/credit_note_issued_standard_webhook_event.rb +90 -0
  28. data/lib/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rb +92 -0
  29. data/lib/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rb +198 -0
  30. data/lib/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rb +193 -0
  31. data/lib/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rb +240 -0
  32. data/lib/orb/models/webhooks/customer_created_standard_webhook_event.rb +106 -0
  33. data/lib/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rb +597 -0
  34. data/lib/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rb +603 -0
  35. data/lib/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rb +597 -0
  36. data/lib/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rb +509 -0
  37. data/lib/orb/models/webhooks/customer_edited_standard_webhook_event.rb +371 -0
  38. data/lib/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rb +130 -0
  39. data/lib/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rb +124 -0
  40. data/lib/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rb +134 -0
  41. data/lib/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rb +94 -0
  42. data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +974 -0
  43. data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +968 -0
  44. data/lib/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rb +367 -0
  45. data/lib/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rb +113 -0
  46. data/lib/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rb +101 -0
  47. data/lib/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rb +101 -0
  48. data/lib/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rb +95 -0
  49. data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +996 -0
  50. data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +990 -0
  51. data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +994 -0
  52. data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +944 -0
  53. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +1367 -0
  54. data/lib/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rb +151 -0
  55. data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +887 -0
  56. data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +886 -0
  57. data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +889 -0
  58. data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +901 -0
  59. data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +878 -0
  60. data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +901 -0
  61. data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +895 -0
  62. data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +910 -0
  63. data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +892 -0
  64. data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +894 -0
  65. data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +877 -0
  66. data/lib/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rb +125 -0
  67. data/lib/orb/models/webhooks/payment_method_created_standard_webhook_event.rb +184 -0
  68. data/lib/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rb +184 -0
  69. data/lib/orb/models/webhooks/plan_created_standard_webhook_event.rb +119 -0
  70. data/lib/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rb +139 -0
  71. data/lib/orb/models/webhooks/plan_edited_standard_webhook_event.rb +159 -0
  72. data/lib/orb/models/webhooks/plan_version_created_standard_webhook_event.rb +138 -0
  73. data/lib/orb/models/webhooks/price_edited_standard_webhook_event.rb +132 -0
  74. data/lib/orb/models/webhooks/resource_event_test_standard_webhook_event.rb +92 -0
  75. data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +974 -0
  76. data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +969 -0
  77. data/lib/orb/models/webhooks/standard_unwrap_standard_params.rb +16 -0
  78. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +322 -0
  79. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +316 -0
  80. data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +663 -0
  81. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +237 -0
  82. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +237 -0
  83. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +692 -0
  84. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +221 -0
  85. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +273 -0
  86. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +219 -0
  87. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +255 -0
  88. data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +689 -0
  89. data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +218 -0
  90. data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +240 -0
  91. data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +683 -0
  92. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +249 -0
  93. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +233 -0
  94. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +250 -0
  95. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +248 -0
  96. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +693 -0
  97. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +221 -0
  98. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +222 -0
  99. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +700 -0
  100. data/lib/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rb +270 -0
  101. data/lib/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rb +264 -0
  102. data/lib/orb/models/webhooks/unwrap_standard_webhook_event.rb +258 -0
  103. data/lib/orb/models.rb +2 -0
  104. data/lib/orb/resources/metrics.rb +15 -5
  105. data/lib/orb/resources/plans/external_plan_id.rb +6 -3
  106. data/lib/orb/resources/plans.rb +6 -3
  107. data/lib/orb/resources/webhook_endpoints.rb +6 -2
  108. data/lib/orb/resources/webhooks/standard.rb +24 -0
  109. data/lib/orb/resources/webhooks.rb +4 -0
  110. data/lib/orb/version.rb +1 -1
  111. data/lib/orb.rb +84 -0
  112. data/rbi/orb/models/invoice_issue_summary_response.rbi +2 -1
  113. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +6 -3
  114. data/rbi/orb/models/invoice_list_summary_response.rbi +2 -1
  115. data/rbi/orb/models/metric_list_params.rbi +29 -0
  116. data/rbi/orb/models/metric_update_params.rbi +16 -0
  117. data/rbi/orb/models/plan_update_params.rbi +8 -0
  118. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +8 -0
  119. data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +6 -12
  120. data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +6 -12
  121. data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +6 -12
  122. data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +6 -12
  123. data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +6 -12
  124. data/rbi/orb/models/webhook_endpoint.rbi +39 -0
  125. data/rbi/orb/models/webhook_endpoint_create_params.rbi +51 -0
  126. data/rbi/orb/models/webhook_endpoint_update_params.rbi +51 -0
  127. data/rbi/orb/models/webhook_endpoint_with_secret.rbi +50 -0
  128. data/rbi/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbi +349 -0
  129. data/rbi/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbi +347 -0
  130. data/rbi/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbi +273 -0
  131. data/rbi/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbi +1106 -0
  132. data/rbi/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbi +1095 -0
  133. data/rbi/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbi +377 -0
  134. data/rbi/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbi +366 -0
  135. data/rbi/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbi +166 -0
  136. data/rbi/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbi +166 -0
  137. data/rbi/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbi +403 -0
  138. data/rbi/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbi +392 -0
  139. data/rbi/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbi +493 -0
  140. data/rbi/orb/models/webhooks/customer_created_standard_webhook_event.rbi +198 -0
  141. data/rbi/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbi +1151 -0
  142. data/rbi/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbi +1158 -0
  143. data/rbi/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbi +1151 -0
  144. data/rbi/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbi +1044 -0
  145. data/rbi/orb/models/webhooks/customer_edited_standard_webhook_event.rbi +678 -0
  146. data/rbi/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbi +236 -0
  147. data/rbi/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbi +230 -0
  148. data/rbi/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbi +275 -0
  149. data/rbi/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbi +192 -0
  150. data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +1708 -0
  151. data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +1697 -0
  152. data/rbi/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbi +670 -0
  153. data/rbi/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbi +210 -0
  154. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbi +195 -0
  155. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbi +195 -0
  156. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbi +188 -0
  157. data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +1716 -0
  158. data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +1711 -0
  159. data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +1716 -0
  160. data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +1631 -0
  161. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +2340 -0
  162. data/rbi/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbi +324 -0
  163. data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +1532 -0
  164. data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +1532 -0
  165. data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +1537 -0
  166. data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +1552 -0
  167. data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +1497 -0
  168. data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +1557 -0
  169. data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +1550 -0
  170. data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +1566 -0
  171. data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +1545 -0
  172. data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +1547 -0
  173. data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +1497 -0
  174. data/rbi/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbi +233 -0
  175. data/rbi/orb/models/webhooks/payment_method_created_standard_webhook_event.rbi +331 -0
  176. data/rbi/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbi +331 -0
  177. data/rbi/orb/models/webhooks/plan_created_standard_webhook_event.rbi +216 -0
  178. data/rbi/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbi +277 -0
  179. data/rbi/orb/models/webhooks/plan_edited_standard_webhook_event.rbi +337 -0
  180. data/rbi/orb/models/webhooks/plan_version_created_standard_webhook_event.rbi +271 -0
  181. data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi +311 -0
  182. data/rbi/orb/models/webhooks/resource_event_test_standard_webhook_event.rbi +191 -0
  183. data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +1708 -0
  184. data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +1697 -0
  185. data/rbi/orb/models/webhooks/standard_unwrap_standard_params.rbi +32 -0
  186. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +609 -0
  187. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +598 -0
  188. data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +1296 -0
  189. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +433 -0
  190. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +435 -0
  191. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +1298 -0
  192. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +398 -0
  193. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +520 -0
  194. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +398 -0
  195. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +458 -0
  196. data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +1315 -0
  197. data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +422 -0
  198. data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +471 -0
  199. data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +1313 -0
  200. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +453 -0
  201. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +433 -0
  202. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +457 -0
  203. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +457 -0
  204. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +1299 -0
  205. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +398 -0
  206. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +398 -0
  207. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +1305 -0
  208. data/rbi/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbi +516 -0
  209. data/rbi/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbi +505 -0
  210. data/rbi/orb/models/webhooks/unwrap_standard_webhook_event.rbi +107 -0
  211. data/rbi/orb/models.rbi +2 -0
  212. data/rbi/orb/resources/metrics.rbi +16 -3
  213. data/rbi/orb/resources/plans/external_plan_id.rbi +6 -2
  214. data/rbi/orb/resources/plans.rbi +6 -2
  215. data/rbi/orb/resources/webhook_endpoints.rbi +10 -0
  216. data/rbi/orb/resources/webhooks/standard.rbi +107 -0
  217. data/rbi/orb/resources/webhooks.rbi +3 -0
  218. data/sig/orb/models/metric_list_params.rbs +18 -1
  219. data/sig/orb/models/metric_update_params.rbs +14 -1
  220. data/sig/orb/models/plan_update_params.rbs +6 -1
  221. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -1
  222. data/sig/orb/models/webhook_endpoint.rbs +16 -0
  223. data/sig/orb/models/webhook_endpoint_create_params.rbs +20 -1
  224. data/sig/orb/models/webhook_endpoint_update_params.rbs +16 -0
  225. data/sig/orb/models/webhook_endpoint_with_secret.rbs +16 -0
  226. data/sig/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbs +148 -0
  227. data/sig/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbs +148 -0
  228. data/sig/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbs +112 -0
  229. data/sig/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbs +435 -0
  230. data/sig/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbs +430 -0
  231. data/sig/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbs +165 -0
  232. data/sig/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbs +160 -0
  233. data/sig/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbs +68 -0
  234. data/sig/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbs +68 -0
  235. data/sig/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbs +160 -0
  236. data/sig/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbs +155 -0
  237. data/sig/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbs +189 -0
  238. data/sig/orb/models/webhooks/customer_created_standard_webhook_event.rbs +68 -0
  239. data/sig/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbs +396 -0
  240. data/sig/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbs +401 -0
  241. data/sig/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbs +396 -0
  242. data/sig/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbs +386 -0
  243. data/sig/orb/models/webhooks/customer_edited_standard_webhook_event.rbs +157 -0
  244. data/sig/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbs +110 -0
  245. data/sig/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbs +105 -0
  246. data/sig/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbs +122 -0
  247. data/sig/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbs +73 -0
  248. data/sig/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  249. data/sig/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  250. data/sig/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbs +331 -0
  251. data/sig/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbs +91 -0
  252. data/sig/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbs +75 -0
  253. data/sig/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbs +75 -0
  254. data/sig/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbs +73 -0
  255. data/sig/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbs +638 -0
  256. data/sig/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbs +633 -0
  257. data/sig/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbs +623 -0
  258. data/sig/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbs +586 -0
  259. data/sig/orb/models/webhooks/invoice_edited_standard_webhook_event.rbs +859 -0
  260. data/sig/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbs +129 -0
  261. data/sig/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbs +527 -0
  262. data/sig/orb/models/webhooks/invoice_issued_standard_webhook_event.rbs +527 -0
  263. data/sig/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbs +527 -0
  264. data/sig/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbs +540 -0
  265. data/sig/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbs +517 -0
  266. data/sig/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbs +544 -0
  267. data/sig/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbs +538 -0
  268. data/sig/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbs +549 -0
  269. data/sig/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbs +536 -0
  270. data/sig/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbs +536 -0
  271. data/sig/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbs +517 -0
  272. data/sig/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbs +100 -0
  273. data/sig/orb/models/webhooks/payment_method_created_standard_webhook_event.rbs +130 -0
  274. data/sig/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbs +130 -0
  275. data/sig/orb/models/webhooks/plan_created_standard_webhook_event.rbs +90 -0
  276. data/sig/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbs +112 -0
  277. data/sig/orb/models/webhooks/plan_edited_standard_webhook_event.rbs +134 -0
  278. data/sig/orb/models/webhooks/plan_version_created_standard_webhook_event.rbs +109 -0
  279. data/sig/orb/models/webhooks/price_edited_standard_webhook_event.rbs +95 -0
  280. data/sig/orb/models/webhooks/resource_event_test_standard_webhook_event.rbs +75 -0
  281. data/sig/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  282. data/sig/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  283. data/sig/orb/models/webhooks/standard_unwrap_standard_params.rbs +17 -0
  284. data/sig/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbs +256 -0
  285. data/sig/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbs +251 -0
  286. data/sig/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbs +466 -0
  287. data/sig/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbs +169 -0
  288. data/sig/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbs +169 -0
  289. data/sig/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbs +475 -0
  290. data/sig/orb/models/webhooks/subscription_created_standard_webhook_event.rbs +159 -0
  291. data/sig/orb/models/webhooks/subscription_edited_standard_webhook_event.rbs +218 -0
  292. data/sig/orb/models/webhooks/subscription_ended_standard_webhook_event.rbs +159 -0
  293. data/sig/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbs +191 -0
  294. data/sig/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbs +487 -0
  295. data/sig/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbs +176 -0
  296. data/sig/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbs +198 -0
  297. data/sig/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbs +482 -0
  298. data/sig/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbs +182 -0
  299. data/sig/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbs +169 -0
  300. data/sig/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbs +186 -0
  301. data/sig/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbs +186 -0
  302. data/sig/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbs +475 -0
  303. data/sig/orb/models/webhooks/subscription_started_standard_webhook_event.rbs +159 -0
  304. data/sig/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbs +159 -0
  305. data/sig/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbs +480 -0
  306. data/sig/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbs +223 -0
  307. data/sig/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbs +218 -0
  308. data/sig/orb/models/webhooks/unwrap_standard_webhook_event.rbs +94 -0
  309. data/sig/orb/models.rbs +2 -0
  310. data/sig/orb/resources/metrics.rbs +3 -0
  311. data/sig/orb/resources/plans/external_plan_id.rbs +1 -0
  312. data/sig/orb/resources/plans.rbs +1 -0
  313. data/sig/orb/resources/webhook_endpoints.rbs +2 -0
  314. data/sig/orb/resources/webhooks/standard.rbs +93 -0
  315. data/sig/orb/resources/webhooks.rbs +2 -0
  316. metadata +253 -1
@@ -0,0 +1,597 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class CustomerCreditBalanceRecoveredStandardWebhookEvent < Orb::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The ID of this webhook event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The time at which this event was created, to the second.
15
+ #
16
+ # @return [Time]
17
+ required :created_at, Time
18
+
19
+ # @!attribute customer
20
+ # A customer is a buyer of your products, and the other party to the billing
21
+ # relationship.
22
+ #
23
+ # In Orb, customers are assigned system generated identifiers automatically, but
24
+ # it's often desirable to have these match existing identifiers in your system. To
25
+ # avoid having to denormalize Orb ID information, you can pass in an
26
+ # `external_customer_id` with your own identifier. See
27
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
28
+ # information about how these aliases work in Orb.
29
+ #
30
+ # In addition to having an identifier in your system, a customer may exist in a
31
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
32
+ # `payment_provider` enum field to express this mapping.
33
+ #
34
+ # A customer also has a timezone (from the standard
35
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
36
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
37
+ # information on what this timezone parameter influences within Orb.
38
+ #
39
+ # @return [Orb::Models::Customer]
40
+ required :customer, -> { Orb::Customer }
41
+
42
+ # @!attribute payload_style
43
+ # The serialization style this payload was rendered in, as configured on the
44
+ # endpoint.
45
+ #
46
+ # @return [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle]
47
+ required :payload_style,
48
+ enum: -> { Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle }
49
+
50
+ # @!attribute properties
51
+ #
52
+ # @return [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties]
53
+ required :properties, -> { Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties }
54
+
55
+ # @!attribute type
56
+ # The event this payload describes.
57
+ #
58
+ # @return [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Type]
59
+ required :type, enum: -> { Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Type }
60
+
61
+ # @!method initialize(id:, created_at:, customer:, payload_style:, properties:, type:)
62
+ # Some parameter documentations has been truncated, see
63
+ # {Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent} for
64
+ # more details.
65
+ #
66
+ # Issued when a customer's credit balance recovers from depleted.
67
+ #
68
+ # @param id [String] The ID of this webhook event.
69
+ #
70
+ # @param created_at [Time] The time at which this event was created, to the second.
71
+ #
72
+ # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
73
+ #
74
+ # @param payload_style [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
75
+ #
76
+ # @param properties [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties]
77
+ #
78
+ # @param type [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Type] The event this payload describes.
79
+
80
+ # The serialization style this payload was rendered in, as configured on the
81
+ # endpoint.
82
+ #
83
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent#payload_style
84
+ module PayloadStyle
85
+ extend Orb::Internal::Type::Enum
86
+
87
+ EXPANDED = :expanded
88
+ STANDARD = :standard
89
+
90
+ # @!method self.values
91
+ # @return [Array<Symbol>]
92
+ end
93
+
94
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent#properties
95
+ class Properties < Orb::Internal::Type::BaseModel
96
+ # @!attribute alert_configuration
97
+ # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
98
+ # usage, or credit balance and trigger webhooks when a threshold is exceeded.
99
+ #
100
+ # Alerts created through the API can be scoped to either customers or
101
+ # subscriptions.
102
+ #
103
+ # @return [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration]
104
+ required :alert_configuration,
105
+ -> { Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration }
106
+
107
+ # @!attribute pricing_unit
108
+ # A currency or custom credit unit, as embedded in webhook payloads.
109
+ #
110
+ # @return [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit, nil]
111
+ required :pricing_unit,
112
+ -> {
113
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit
114
+ },
115
+ nil?: true
116
+
117
+ # @!method initialize(alert_configuration:, pricing_unit:)
118
+ # Some parameter documentations has been truncated, see
119
+ # {Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties}
120
+ # for more details.
121
+ #
122
+ # @param alert_configuration [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration] [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
123
+ #
124
+ # @param pricing_unit [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit, nil] A currency or custom credit unit, as embedded in webhook payloads.
125
+
126
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties#alert_configuration
127
+ class AlertConfiguration < Orb::Internal::Type::BaseModel
128
+ # @!attribute id
129
+ # Also referred to as alert_id in this documentation.
130
+ #
131
+ # @return [String]
132
+ required :id, String
133
+
134
+ # @!attribute created_at
135
+ # The creation time of the resource in Orb.
136
+ #
137
+ # @return [Time]
138
+ required :created_at, Time
139
+
140
+ # @!attribute currency
141
+ # The name of the currency the credit balance or invoice cost is denominated in.
142
+ #
143
+ # @return [String, nil]
144
+ required :currency, String, nil?: true
145
+
146
+ # @!attribute customer
147
+ # The customer the alert applies to.
148
+ #
149
+ # @return [Orb::Models::CustomerMinified, nil]
150
+ required :customer, -> { Orb::CustomerMinified }, nil?: true
151
+
152
+ # @!attribute enabled
153
+ # Whether the alert is enabled or disabled.
154
+ #
155
+ # @return [Boolean]
156
+ required :enabled, Orb::Internal::Type::Boolean
157
+
158
+ # @!attribute metric
159
+ # The metric the alert applies to.
160
+ #
161
+ # @return [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric, nil]
162
+ required :metric,
163
+ -> {
164
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric
165
+ },
166
+ nil?: true
167
+
168
+ # @!attribute plan
169
+ # The plan the alert applies to.
170
+ #
171
+ # @return [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan, nil]
172
+ required :plan,
173
+ -> {
174
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan
175
+ },
176
+ nil?: true
177
+
178
+ # @!attribute subscription
179
+ # The subscription the alert applies to.
180
+ #
181
+ # @return [Orb::Models::SubscriptionMinified, nil]
182
+ required :subscription, -> { Orb::SubscriptionMinified }, nil?: true
183
+
184
+ # @!attribute thresholds
185
+ # The thresholds that define the conditions under which the alert will be
186
+ # triggered.
187
+ #
188
+ # @return [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold>, nil]
189
+ required :thresholds,
190
+ -> do
191
+ Orb::Internal::Type::ArrayOf[
192
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold
193
+ ]
194
+ end,
195
+ nil?: true
196
+
197
+ # @!attribute type
198
+ # The type of alert. This must be a valid alert type.
199
+ #
200
+ # @return [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type]
201
+ required :type,
202
+ enum: -> { Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type }
203
+
204
+ # @!attribute balance_alert_status
205
+ # The current status of the alert. This field is only present for credit balance
206
+ # alerts.
207
+ #
208
+ # @return [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus>, nil]
209
+ optional :balance_alert_status,
210
+ -> do
211
+ Orb::Internal::Type::ArrayOf[
212
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus
213
+ ]
214
+ end,
215
+ nil?: true
216
+
217
+ # @!attribute grouping_keys
218
+ # The property keys to group cost alerts by. Only present for cost alerts with
219
+ # grouping enabled.
220
+ #
221
+ # @return [Array<String>, nil]
222
+ optional :grouping_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
223
+
224
+ # @!attribute license_type
225
+ # Minified license type for alert serialization.
226
+ #
227
+ # @return [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType, nil]
228
+ optional :license_type,
229
+ -> {
230
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType
231
+ },
232
+ nil?: true
233
+
234
+ # @!attribute price_filters
235
+ # Filters scoping which prices are included in spend and grouped cost alert
236
+ # evaluation. Alerts use the price_id, item_id, and price_type fields only; the
237
+ # alert's pricing unit is reported by currency.
238
+ #
239
+ # @return [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter>, nil]
240
+ optional :price_filters,
241
+ -> do
242
+ Orb::Internal::Type::ArrayOf[
243
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter
244
+ ]
245
+ end,
246
+ nil?: true
247
+
248
+ # @!attribute threshold_overrides
249
+ # Per-group threshold overrides. Each override maps a specific combination of
250
+ # grouping_keys values to a replacement threshold list. Only present for grouped
251
+ # cost alerts that have at least one override.
252
+ #
253
+ # @return [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride>, nil]
254
+ optional :threshold_overrides,
255
+ -> do
256
+ Orb::Internal::Type::ArrayOf[
257
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride
258
+ ]
259
+ end,
260
+ nil?: true
261
+
262
+ # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, balance_alert_status: nil, grouping_keys: nil, license_type: nil, price_filters: nil, threshold_overrides: nil)
263
+ # Some parameter documentations has been truncated, see
264
+ # {Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration}
265
+ # for more details.
266
+ #
267
+ # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
268
+ # usage, or credit balance and trigger webhooks when a threshold is exceeded.
269
+ #
270
+ # Alerts created through the API can be scoped to either customers or
271
+ # subscriptions.
272
+ #
273
+ # @param id [String] Also referred to as alert_id in this documentation.
274
+ #
275
+ # @param created_at [Time] The creation time of the resource in Orb.
276
+ #
277
+ # @param currency [String, nil] The name of the currency the credit balance or invoice cost is denominated in.
278
+ #
279
+ # @param customer [Orb::Models::CustomerMinified, nil] The customer the alert applies to.
280
+ #
281
+ # @param enabled [Boolean] Whether the alert is enabled or disabled.
282
+ #
283
+ # @param metric [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric, nil] The metric the alert applies to.
284
+ #
285
+ # @param plan [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan, nil] The plan the alert applies to.
286
+ #
287
+ # @param subscription [Orb::Models::SubscriptionMinified, nil] The subscription the alert applies to.
288
+ #
289
+ # @param thresholds [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
290
+ #
291
+ # @param type [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type] The type of alert. This must be a valid alert type.
292
+ #
293
+ # @param balance_alert_status [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus>, nil] The current status of the alert. This field is only present for credit balance a
294
+ #
295
+ # @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only present for cost alerts with gro
296
+ #
297
+ # @param license_type [Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType, nil] Minified license type for alert serialization.
298
+ #
299
+ # @param price_filters [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter>, nil] Filters scoping which prices are included in spend and grouped cost alert evalua
300
+ #
301
+ # @param threshold_overrides [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride>, nil] Per-group threshold overrides. Each override maps a specific combination of grou
302
+
303
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration#metric
304
+ class Metric < Orb::Internal::Type::BaseModel
305
+ # @!attribute id
306
+ #
307
+ # @return [String]
308
+ required :id, String
309
+
310
+ # @!method initialize(id:)
311
+ # The metric the alert applies to.
312
+ #
313
+ # @param id [String]
314
+ end
315
+
316
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration#plan
317
+ class Plan < Orb::Internal::Type::BaseModel
318
+ # @!attribute id
319
+ #
320
+ # @return [String, nil]
321
+ required :id, String, nil?: true
322
+
323
+ # @!attribute external_plan_id
324
+ # An optional user-defined ID for this plan resource, used throughout the system
325
+ # as an alias for this Plan. Use this field to identify a plan by an existing
326
+ # identifier in your system.
327
+ #
328
+ # @return [String, nil]
329
+ required :external_plan_id, String, nil?: true
330
+
331
+ # @!attribute name
332
+ #
333
+ # @return [String, nil]
334
+ required :name, String, nil?: true
335
+
336
+ # @!attribute plan_version
337
+ #
338
+ # @return [String]
339
+ required :plan_version, String
340
+
341
+ # @!method initialize(id:, external_plan_id:, name:, plan_version:)
342
+ # Some parameter documentations has been truncated, see
343
+ # {Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan}
344
+ # for more details.
345
+ #
346
+ # The plan the alert applies to.
347
+ #
348
+ # @param id [String, nil]
349
+ #
350
+ # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
351
+ #
352
+ # @param name [String, nil]
353
+ #
354
+ # @param plan_version [String]
355
+ end
356
+
357
+ class Threshold < Orb::Internal::Type::BaseModel
358
+ # @!attribute value
359
+ # The value at which an alert will fire. For credit balance alerts, the alert will
360
+ # fire at or below this value. For usage and cost alerts, the alert will fire at
361
+ # or above this value.
362
+ #
363
+ # @return [String]
364
+ required :value, String
365
+
366
+ # @!method initialize(value:)
367
+ # Some parameter documentations has been truncated, see
368
+ # {Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold}
369
+ # for more details.
370
+ #
371
+ # Thresholds are used to define the conditions under which an alert will be
372
+ # triggered.
373
+ #
374
+ # @param value [String] The value at which an alert will fire. For credit balance alerts, the alert will
375
+ end
376
+
377
+ # The type of alert. This must be a valid alert type.
378
+ #
379
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration#type
380
+ module Type
381
+ extend Orb::Internal::Type::Enum
382
+
383
+ CREDIT_BALANCE_DEPLETED = :credit_balance_depleted
384
+ CREDIT_BALANCE_DROPPED = :credit_balance_dropped
385
+ CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
386
+ USAGE_EXCEEDED = :usage_exceeded
387
+ COST_EXCEEDED = :cost_exceeded
388
+ SPEND_EXCEEDED = :spend_exceeded
389
+ LICENSE_BALANCE_THRESHOLD_REACHED = :license_balance_threshold_reached
390
+
391
+ # @!method self.values
392
+ # @return [Array<Symbol>]
393
+ end
394
+
395
+ class BalanceAlertStatus < Orb::Internal::Type::BaseModel
396
+ # @!attribute in_alert
397
+ # Whether the alert is currently in-alert or not.
398
+ #
399
+ # @return [Boolean]
400
+ required :in_alert, Orb::Internal::Type::Boolean
401
+
402
+ # @!attribute threshold_value
403
+ # The value of the threshold that defines the alert status.
404
+ #
405
+ # @return [String]
406
+ required :threshold_value, String
407
+
408
+ # @!method initialize(in_alert:, threshold_value:)
409
+ # Alert status is used to determine if an alert is currently in-alert or not.
410
+ #
411
+ # @param in_alert [Boolean] Whether the alert is currently in-alert or not.
412
+ #
413
+ # @param threshold_value [String] The value of the threshold that defines the alert status.
414
+ end
415
+
416
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration#license_type
417
+ class LicenseType < Orb::Internal::Type::BaseModel
418
+ # @!attribute id
419
+ #
420
+ # @return [String]
421
+ required :id, String
422
+
423
+ # @!method initialize(id:)
424
+ # Minified license type for alert serialization.
425
+ #
426
+ # @param id [String]
427
+ end
428
+
429
+ class PriceFilter < Orb::Internal::Type::BaseModel
430
+ # @!attribute field
431
+ # The property of the price to filter on.
432
+ #
433
+ # @return [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field]
434
+ required :field,
435
+ enum: -> { Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field }
436
+
437
+ # @!attribute operator
438
+ # Should prices that match the filter be included or excluded.
439
+ #
440
+ # @return [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator]
441
+ required :operator,
442
+ enum: -> { Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator }
443
+
444
+ # @!attribute values
445
+ # The IDs or values that match this filter.
446
+ #
447
+ # @return [Array<String>]
448
+ required :values, Orb::Internal::Type::ArrayOf[String]
449
+
450
+ # @!method initialize(field:, operator:, values:)
451
+ # @param field [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field] The property of the price to filter on.
452
+ #
453
+ # @param operator [Symbol, Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator] Should prices that match the filter be included or excluded.
454
+ #
455
+ # @param values [Array<String>] The IDs or values that match this filter.
456
+
457
+ # The property of the price to filter on.
458
+ #
459
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter#field
460
+ module Field
461
+ extend Orb::Internal::Type::Enum
462
+
463
+ PRICE_ID = :price_id
464
+ ITEM_ID = :item_id
465
+ PRICE_TYPE = :price_type
466
+ CURRENCY = :currency
467
+ PRICING_UNIT_ID = :pricing_unit_id
468
+
469
+ # @!method self.values
470
+ # @return [Array<Symbol>]
471
+ end
472
+
473
+ # Should prices that match the filter be included or excluded.
474
+ #
475
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter#operator
476
+ module Operator
477
+ extend Orb::Internal::Type::Enum
478
+
479
+ INCLUDES = :includes
480
+ EXCLUDES = :excludes
481
+
482
+ # @!method self.values
483
+ # @return [Array<Symbol>]
484
+ end
485
+ end
486
+
487
+ class ThresholdOverride < Orb::Internal::Type::BaseModel
488
+ # @!attribute group_values
489
+ # The values identifying this group, ordered to match group_keys when set and the
490
+ # alert's grouping_keys otherwise.
491
+ #
492
+ # @return [Array<String>]
493
+ required :group_values, Orb::Internal::Type::ArrayOf[String]
494
+
495
+ # @!attribute thresholds
496
+ # The thresholds applied to this group. An empty list means the group is silenced.
497
+ #
498
+ # @return [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold>]
499
+ required :thresholds,
500
+ -> do
501
+ Orb::Internal::Type::ArrayOf[
502
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold
503
+ ]
504
+ end
505
+
506
+ # @!attribute group_keys
507
+ # The subset of the alert's grouping_keys this override binds. Null when the
508
+ # override targets one exact group across every grouping key.
509
+ #
510
+ # @return [Array<String>, nil]
511
+ optional :group_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
512
+
513
+ # @!method initialize(group_values:, thresholds:, group_keys: nil)
514
+ # Some parameter documentations has been truncated, see
515
+ # {Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride}
516
+ # for more details.
517
+ #
518
+ # A per-group threshold override on a grouped cost alert.
519
+ #
520
+ # An empty `thresholds` list means the group is silenced (never fires). A
521
+ # non-empty list fully replaces the default thresholds for that group.
522
+ #
523
+ # @param group_values [Array<String>] The values identifying this group, ordered to match group_keys when set and the
524
+ #
525
+ # @param thresholds [Array<Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold>] The thresholds applied to this group. An empty list means the group is silenced.
526
+ #
527
+ # @param group_keys [Array<String>, nil] The subset of the alert's grouping_keys this override binds. Null when the overr
528
+
529
+ class Threshold < Orb::Internal::Type::BaseModel
530
+ # @!attribute value
531
+ # The value at which an alert will fire. For credit balance alerts, the alert will
532
+ # fire at or below this value. For usage and cost alerts, the alert will fire at
533
+ # or above this value.
534
+ #
535
+ # @return [String]
536
+ required :value, String
537
+
538
+ # @!method initialize(value:)
539
+ # Some parameter documentations has been truncated, see
540
+ # {Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold}
541
+ # for more details.
542
+ #
543
+ # Thresholds are used to define the conditions under which an alert will be
544
+ # triggered.
545
+ #
546
+ # @param value [String] The value at which an alert will fire. For credit balance alerts, the alert will
547
+ end
548
+ end
549
+ end
550
+
551
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties#pricing_unit
552
+ class PricingUnit < Orb::Internal::Type::BaseModel
553
+ # @!attribute id
554
+ #
555
+ # @return [String]
556
+ required :id, String
557
+
558
+ # @!attribute display_name
559
+ #
560
+ # @return [String, nil]
561
+ required :display_name, String, nil?: true
562
+
563
+ # @!attribute name
564
+ #
565
+ # @return [String]
566
+ required :name, String
567
+
568
+ # @!attribute symbol
569
+ #
570
+ # @return [String, nil]
571
+ required :symbol, String, nil?: true
572
+
573
+ # @!method initialize(id:, display_name:, name:, symbol:)
574
+ # A currency or custom credit unit, as embedded in webhook payloads.
575
+ #
576
+ # @param id [String]
577
+ # @param display_name [String, nil]
578
+ # @param name [String]
579
+ # @param symbol [String, nil]
580
+ end
581
+ end
582
+
583
+ # The event this payload describes.
584
+ #
585
+ # @see Orb::Models::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent#type
586
+ module Type
587
+ extend Orb::Internal::Type::Enum
588
+
589
+ CUSTOMER_CREDIT_BALANCE_RECOVERED = :"customer.credit_balance_recovered"
590
+
591
+ # @!method self.values
592
+ # @return [Array<Symbol>]
593
+ end
594
+ end
595
+ end
596
+ end
597
+ end