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