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,663 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class SubscriptionAlertDisabledStandardWebhookEvent < 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 payload_style
20
+ # The serialization style this payload was rendered in, as configured on the
21
+ # endpoint.
22
+ #
23
+ # @return [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::PayloadStyle]
24
+ required :payload_style,
25
+ enum: -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::PayloadStyle }
26
+
27
+ # @!attribute properties
28
+ # Sent when the system disables an alert on its own, currently for
29
+ # cardinality-limit enforcement on grouped cost alerts.
30
+ #
31
+ # @return [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties]
32
+ required :properties, -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties }
33
+
34
+ # @!attribute subscription
35
+ # The subscription in a license or grouped cost webhook payload: its status,
36
+ # dates, plan and customer.
37
+ #
38
+ # @return [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription]
39
+ required :subscription, -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription }
40
+
41
+ # @!attribute type
42
+ # The event this payload describes.
43
+ #
44
+ # @return [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Type]
45
+ required :type, enum: -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Type }
46
+
47
+ # @!method initialize(id:, created_at:, payload_style:, properties:, subscription:, type:)
48
+ # Some parameter documentations has been truncated, see
49
+ # {Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent} for more
50
+ # details.
51
+ #
52
+ # Issued when an alert is automatically disabled by the system.
53
+ #
54
+ # @param id [String] The ID of this webhook event.
55
+ #
56
+ # @param created_at [Time] The time at which this event was created, to the second.
57
+ #
58
+ # @param payload_style [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
59
+ #
60
+ # @param properties [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties] Sent when the system disables an alert on its own, currently for cardinality-lim
61
+ #
62
+ # @param subscription [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription] The subscription in a license or grouped cost webhook payload: its status, dates
63
+ #
64
+ # @param type [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Type] The event this payload describes.
65
+
66
+ # The serialization style this payload was rendered in, as configured on the
67
+ # endpoint.
68
+ #
69
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent#payload_style
70
+ module PayloadStyle
71
+ extend Orb::Internal::Type::Enum
72
+
73
+ EXPANDED = :expanded
74
+ STANDARD = :standard
75
+
76
+ # @!method self.values
77
+ # @return [Array<Symbol>]
78
+ end
79
+
80
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent#properties
81
+ class Properties < Orb::Internal::Type::BaseModel
82
+ # @!attribute alert_configuration
83
+ # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
84
+ # usage, or credit balance and trigger webhooks when a threshold is exceeded.
85
+ #
86
+ # Alerts created through the API can be scoped to either customers or
87
+ # subscriptions.
88
+ #
89
+ # @return [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration]
90
+ required :alert_configuration,
91
+ -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration }
92
+
93
+ # @!attribute cardinality
94
+ #
95
+ # @return [Integer, nil]
96
+ required :cardinality, Integer, nil?: true
97
+
98
+ # @!attribute cardinality_limit
99
+ #
100
+ # @return [Integer, nil]
101
+ required :cardinality_limit, Integer, nil?: true
102
+
103
+ # @!attribute reason
104
+ #
105
+ # @return [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::Reason]
106
+ required :reason,
107
+ enum: -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::Reason }
108
+
109
+ # @!method initialize(alert_configuration:, cardinality:, cardinality_limit:, reason:)
110
+ # Some parameter documentations has been truncated, see
111
+ # {Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties}
112
+ # for more details.
113
+ #
114
+ # Sent when the system disables an alert on its own, currently for
115
+ # cardinality-limit enforcement on grouped cost alerts.
116
+ #
117
+ # @param alert_configuration [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration] [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
118
+ #
119
+ # @param cardinality [Integer, nil]
120
+ #
121
+ # @param cardinality_limit [Integer, nil]
122
+ #
123
+ # @param reason [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::Reason]
124
+
125
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties#alert_configuration
126
+ class AlertConfiguration < Orb::Internal::Type::BaseModel
127
+ # @!attribute id
128
+ # Also referred to as alert_id in this documentation.
129
+ #
130
+ # @return [String]
131
+ required :id, String
132
+
133
+ # @!attribute created_at
134
+ # The creation time of the resource in Orb.
135
+ #
136
+ # @return [Time]
137
+ required :created_at, Time
138
+
139
+ # @!attribute currency
140
+ # The name of the currency the credit balance or invoice cost is denominated in.
141
+ #
142
+ # @return [String, nil]
143
+ required :currency, String, nil?: true
144
+
145
+ # @!attribute customer
146
+ # The customer the alert applies to.
147
+ #
148
+ # @return [Orb::Models::CustomerMinified, nil]
149
+ required :customer, -> { Orb::CustomerMinified }, nil?: true
150
+
151
+ # @!attribute enabled
152
+ # Whether the alert is enabled or disabled.
153
+ #
154
+ # @return [Boolean]
155
+ required :enabled, Orb::Internal::Type::Boolean
156
+
157
+ # @!attribute metric
158
+ # The metric the alert applies to.
159
+ #
160
+ # @return [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Metric, nil]
161
+ required :metric,
162
+ -> {
163
+ Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Metric
164
+ },
165
+ nil?: true
166
+
167
+ # @!attribute plan
168
+ # The plan the alert applies to.
169
+ #
170
+ # @return [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Plan, nil]
171
+ required :plan,
172
+ -> {
173
+ Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Plan
174
+ },
175
+ nil?: true
176
+
177
+ # @!attribute subscription
178
+ # The subscription the alert applies to.
179
+ #
180
+ # @return [Orb::Models::SubscriptionMinified, nil]
181
+ required :subscription, -> { Orb::SubscriptionMinified }, nil?: true
182
+
183
+ # @!attribute thresholds
184
+ # The thresholds that define the conditions under which the alert will be
185
+ # triggered.
186
+ #
187
+ # @return [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Threshold>, nil]
188
+ required :thresholds,
189
+ -> {
190
+ Orb::Internal::Type::ArrayOf[Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Threshold]
191
+ },
192
+ nil?: true
193
+
194
+ # @!attribute type
195
+ # The type of alert. This must be a valid alert type.
196
+ #
197
+ # @return [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Type]
198
+ required :type,
199
+ enum: -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Type }
200
+
201
+ # @!attribute balance_alert_status
202
+ # The current status of the alert. This field is only present for credit balance
203
+ # alerts.
204
+ #
205
+ # @return [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus>, nil]
206
+ optional :balance_alert_status,
207
+ -> do
208
+ Orb::Internal::Type::ArrayOf[
209
+ Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus
210
+ ]
211
+ end,
212
+ nil?: true
213
+
214
+ # @!attribute grouping_keys
215
+ # The property keys to group cost alerts by. Only present for cost alerts with
216
+ # grouping enabled.
217
+ #
218
+ # @return [Array<String>, nil]
219
+ optional :grouping_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
220
+
221
+ # @!attribute license_type
222
+ # Minified license type for alert serialization.
223
+ #
224
+ # @return [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::LicenseType, nil]
225
+ optional :license_type,
226
+ -> {
227
+ Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::LicenseType
228
+ },
229
+ nil?: true
230
+
231
+ # @!attribute price_filters
232
+ # Filters scoping which prices are included in spend and grouped cost alert
233
+ # evaluation. Alerts use the price_id, item_id, and price_type fields only; the
234
+ # alert's pricing unit is reported by currency.
235
+ #
236
+ # @return [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter>, nil]
237
+ optional :price_filters,
238
+ -> {
239
+ Orb::Internal::Type::ArrayOf[Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter]
240
+ },
241
+ nil?: true
242
+
243
+ # @!attribute threshold_overrides
244
+ # Per-group threshold overrides. Each override maps a specific combination of
245
+ # grouping_keys values to a replacement threshold list. Only present for grouped
246
+ # cost alerts that have at least one override.
247
+ #
248
+ # @return [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride>, nil]
249
+ optional :threshold_overrides,
250
+ -> do
251
+ Orb::Internal::Type::ArrayOf[
252
+ Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride
253
+ ]
254
+ end,
255
+ nil?: true
256
+
257
+ # @!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)
258
+ # Some parameter documentations has been truncated, see
259
+ # {Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration}
260
+ # for more details.
261
+ #
262
+ # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
263
+ # usage, or credit balance and trigger webhooks when a threshold is exceeded.
264
+ #
265
+ # Alerts created through the API can be scoped to either customers or
266
+ # subscriptions.
267
+ #
268
+ # @param id [String] Also referred to as alert_id in this documentation.
269
+ #
270
+ # @param created_at [Time] The creation time of the resource in Orb.
271
+ #
272
+ # @param currency [String, nil] The name of the currency the credit balance or invoice cost is denominated in.
273
+ #
274
+ # @param customer [Orb::Models::CustomerMinified, nil] The customer the alert applies to.
275
+ #
276
+ # @param enabled [Boolean] Whether the alert is enabled or disabled.
277
+ #
278
+ # @param metric [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Metric, nil] The metric the alert applies to.
279
+ #
280
+ # @param plan [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Plan, nil] The plan the alert applies to.
281
+ #
282
+ # @param subscription [Orb::Models::SubscriptionMinified, nil] The subscription the alert applies to.
283
+ #
284
+ # @param thresholds [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
285
+ #
286
+ # @param type [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Type] The type of alert. This must be a valid alert type.
287
+ #
288
+ # @param balance_alert_status [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus>, nil] The current status of the alert. This field is only present for credit balance a
289
+ #
290
+ # @param grouping_keys [Array<String>, nil] The property keys to group cost alerts by. Only present for cost alerts with gro
291
+ #
292
+ # @param license_type [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::LicenseType, nil] Minified license type for alert serialization.
293
+ #
294
+ # @param price_filters [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter>, nil] Filters scoping which prices are included in spend and grouped cost alert evalua
295
+ #
296
+ # @param threshold_overrides [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride>, nil] Per-group threshold overrides. Each override maps a specific combination of grou
297
+
298
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration#metric
299
+ class Metric < Orb::Internal::Type::BaseModel
300
+ # @!attribute id
301
+ #
302
+ # @return [String]
303
+ required :id, String
304
+
305
+ # @!method initialize(id:)
306
+ # The metric the alert applies to.
307
+ #
308
+ # @param id [String]
309
+ end
310
+
311
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration#plan
312
+ class Plan < Orb::Internal::Type::BaseModel
313
+ # @!attribute id
314
+ #
315
+ # @return [String, nil]
316
+ required :id, String, nil?: true
317
+
318
+ # @!attribute external_plan_id
319
+ # An optional user-defined ID for this plan resource, used throughout the system
320
+ # as an alias for this Plan. Use this field to identify a plan by an existing
321
+ # identifier in your system.
322
+ #
323
+ # @return [String, nil]
324
+ required :external_plan_id, String, nil?: true
325
+
326
+ # @!attribute name
327
+ #
328
+ # @return [String, nil]
329
+ required :name, String, nil?: true
330
+
331
+ # @!attribute plan_version
332
+ #
333
+ # @return [String]
334
+ required :plan_version, String
335
+
336
+ # @!method initialize(id:, external_plan_id:, name:, plan_version:)
337
+ # Some parameter documentations has been truncated, see
338
+ # {Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Plan}
339
+ # for more details.
340
+ #
341
+ # The plan the alert applies to.
342
+ #
343
+ # @param id [String, nil]
344
+ #
345
+ # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
346
+ #
347
+ # @param name [String, nil]
348
+ #
349
+ # @param plan_version [String]
350
+ end
351
+
352
+ class Threshold < Orb::Internal::Type::BaseModel
353
+ # @!attribute value
354
+ # The value at which an alert will fire. For credit balance alerts, the alert will
355
+ # fire at or below this value. For usage and cost alerts, the alert will fire at
356
+ # or above this value.
357
+ #
358
+ # @return [String]
359
+ required :value, String
360
+
361
+ # @!method initialize(value:)
362
+ # Some parameter documentations has been truncated, see
363
+ # {Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::Threshold}
364
+ # for more details.
365
+ #
366
+ # Thresholds are used to define the conditions under which an alert will be
367
+ # triggered.
368
+ #
369
+ # @param value [String] The value at which an alert will fire. For credit balance alerts, the alert will
370
+ end
371
+
372
+ # The type of alert. This must be a valid alert type.
373
+ #
374
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration#type
375
+ module Type
376
+ extend Orb::Internal::Type::Enum
377
+
378
+ CREDIT_BALANCE_DEPLETED = :credit_balance_depleted
379
+ CREDIT_BALANCE_DROPPED = :credit_balance_dropped
380
+ CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
381
+ USAGE_EXCEEDED = :usage_exceeded
382
+ COST_EXCEEDED = :cost_exceeded
383
+ SPEND_EXCEEDED = :spend_exceeded
384
+ LICENSE_BALANCE_THRESHOLD_REACHED = :license_balance_threshold_reached
385
+
386
+ # @!method self.values
387
+ # @return [Array<Symbol>]
388
+ end
389
+
390
+ class BalanceAlertStatus < Orb::Internal::Type::BaseModel
391
+ # @!attribute in_alert
392
+ # Whether the alert is currently in-alert or not.
393
+ #
394
+ # @return [Boolean]
395
+ required :in_alert, Orb::Internal::Type::Boolean
396
+
397
+ # @!attribute threshold_value
398
+ # The value of the threshold that defines the alert status.
399
+ #
400
+ # @return [String]
401
+ required :threshold_value, String
402
+
403
+ # @!method initialize(in_alert:, threshold_value:)
404
+ # Alert status is used to determine if an alert is currently in-alert or not.
405
+ #
406
+ # @param in_alert [Boolean] Whether the alert is currently in-alert or not.
407
+ #
408
+ # @param threshold_value [String] The value of the threshold that defines the alert status.
409
+ end
410
+
411
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration#license_type
412
+ class LicenseType < Orb::Internal::Type::BaseModel
413
+ # @!attribute id
414
+ #
415
+ # @return [String]
416
+ required :id, String
417
+
418
+ # @!method initialize(id:)
419
+ # Minified license type for alert serialization.
420
+ #
421
+ # @param id [String]
422
+ end
423
+
424
+ class PriceFilter < Orb::Internal::Type::BaseModel
425
+ # @!attribute field
426
+ # The property of the price to filter on.
427
+ #
428
+ # @return [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field]
429
+ required :field,
430
+ enum: -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field }
431
+
432
+ # @!attribute operator
433
+ # Should prices that match the filter be included or excluded.
434
+ #
435
+ # @return [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator]
436
+ required :operator,
437
+ enum: -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator }
438
+
439
+ # @!attribute values
440
+ # The IDs or values that match this filter.
441
+ #
442
+ # @return [Array<String>]
443
+ required :values, Orb::Internal::Type::ArrayOf[String]
444
+
445
+ # @!method initialize(field:, operator:, values:)
446
+ # @param field [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field] The property of the price to filter on.
447
+ #
448
+ # @param operator [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator] Should prices that match the filter be included or excluded.
449
+ #
450
+ # @param values [Array<String>] The IDs or values that match this filter.
451
+
452
+ # The property of the price to filter on.
453
+ #
454
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter#field
455
+ module Field
456
+ extend Orb::Internal::Type::Enum
457
+
458
+ PRICE_ID = :price_id
459
+ ITEM_ID = :item_id
460
+ PRICE_TYPE = :price_type
461
+ CURRENCY = :currency
462
+ PRICING_UNIT_ID = :pricing_unit_id
463
+
464
+ # @!method self.values
465
+ # @return [Array<Symbol>]
466
+ end
467
+
468
+ # Should prices that match the filter be included or excluded.
469
+ #
470
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter#operator
471
+ module Operator
472
+ extend Orb::Internal::Type::Enum
473
+
474
+ INCLUDES = :includes
475
+ EXCLUDES = :excludes
476
+
477
+ # @!method self.values
478
+ # @return [Array<Symbol>]
479
+ end
480
+ end
481
+
482
+ class ThresholdOverride < Orb::Internal::Type::BaseModel
483
+ # @!attribute group_values
484
+ # The values identifying this group, ordered to match group_keys when set and the
485
+ # alert's grouping_keys otherwise.
486
+ #
487
+ # @return [Array<String>]
488
+ required :group_values, Orb::Internal::Type::ArrayOf[String]
489
+
490
+ # @!attribute thresholds
491
+ # The thresholds applied to this group. An empty list means the group is silenced.
492
+ #
493
+ # @return [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold>]
494
+ required :thresholds,
495
+ -> do
496
+ Orb::Internal::Type::ArrayOf[
497
+ Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold
498
+ ]
499
+ end
500
+
501
+ # @!attribute group_keys
502
+ # The subset of the alert's grouping_keys this override binds. Null when the
503
+ # override targets one exact group across every grouping key.
504
+ #
505
+ # @return [Array<String>, nil]
506
+ optional :group_keys, Orb::Internal::Type::ArrayOf[String], nil?: true
507
+
508
+ # @!method initialize(group_values:, thresholds:, group_keys: nil)
509
+ # Some parameter documentations has been truncated, see
510
+ # {Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride}
511
+ # for more details.
512
+ #
513
+ # A per-group threshold override on a grouped cost alert.
514
+ #
515
+ # An empty `thresholds` list means the group is silenced (never fires). A
516
+ # non-empty list fully replaces the default thresholds for that group.
517
+ #
518
+ # @param group_values [Array<String>] The values identifying this group, ordered to match group_keys when set and the
519
+ #
520
+ # @param thresholds [Array<Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold>] The thresholds applied to this group. An empty list means the group is silenced.
521
+ #
522
+ # @param group_keys [Array<String>, nil] The subset of the alert's grouping_keys this override binds. Null when the overr
523
+
524
+ class Threshold < Orb::Internal::Type::BaseModel
525
+ # @!attribute value
526
+ # The value at which an alert will fire. For credit balance alerts, the alert will
527
+ # fire at or below this value. For usage and cost alerts, the alert will fire at
528
+ # or above this value.
529
+ #
530
+ # @return [String]
531
+ required :value, String
532
+
533
+ # @!method initialize(value:)
534
+ # Some parameter documentations has been truncated, see
535
+ # {Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold}
536
+ # for more details.
537
+ #
538
+ # Thresholds are used to define the conditions under which an alert will be
539
+ # triggered.
540
+ #
541
+ # @param value [String] The value at which an alert will fire. For credit balance alerts, the alert will
542
+ end
543
+ end
544
+ end
545
+
546
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Properties#reason
547
+ module Reason
548
+ extend Orb::Internal::Type::Enum
549
+
550
+ USER = :user
551
+ SYSTEM_CARDINALITY_LIMIT = :system_cardinality_limit
552
+
553
+ # @!method self.values
554
+ # @return [Array<Symbol>]
555
+ end
556
+ end
557
+
558
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent#subscription
559
+ class Subscription < Orb::Internal::Type::BaseModel
560
+ # @!attribute id
561
+ #
562
+ # @return [String]
563
+ required :id, String
564
+
565
+ # @!attribute customer
566
+ #
567
+ # @return [Orb::Models::CustomerMinified]
568
+ required :customer, -> { Orb::CustomerMinified }
569
+
570
+ # @!attribute end_date
571
+ #
572
+ # @return [Time, nil]
573
+ required :end_date, Time, nil?: true
574
+
575
+ # @!attribute plan
576
+ #
577
+ # @return [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription::Plan, nil]
578
+ required :plan,
579
+ -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription::Plan },
580
+ nil?: true
581
+
582
+ # @!attribute start_date
583
+ #
584
+ # @return [Time]
585
+ required :start_date, Time
586
+
587
+ # @!attribute status
588
+ #
589
+ # @return [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription::Status]
590
+ required :status,
591
+ enum: -> { Orb::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription::Status }
592
+
593
+ # @!method initialize(id:, customer:, end_date:, plan:, start_date:, status:)
594
+ # The subscription in a license or grouped cost webhook payload: its status,
595
+ # dates, plan and customer.
596
+ #
597
+ # @param id [String]
598
+ # @param customer [Orb::Models::CustomerMinified]
599
+ # @param end_date [Time, nil]
600
+ # @param plan [Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription::Plan, nil]
601
+ # @param start_date [Time]
602
+ # @param status [Symbol, Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription::Status]
603
+
604
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription#plan
605
+ class Plan < Orb::Internal::Type::BaseModel
606
+ # @!attribute id
607
+ #
608
+ # @return [String, nil]
609
+ required :id, String, nil?: true
610
+
611
+ # @!attribute external_plan_id
612
+ # An optional user-defined ID for this plan resource, used throughout the system
613
+ # as an alias for this Plan. Use this field to identify a plan by an existing
614
+ # identifier in your system.
615
+ #
616
+ # @return [String, nil]
617
+ required :external_plan_id, String, nil?: true
618
+
619
+ # @!attribute name
620
+ #
621
+ # @return [String, nil]
622
+ required :name, String, nil?: true
623
+
624
+ # @!method initialize(id:, external_plan_id:, name:)
625
+ # Some parameter documentations has been truncated, see
626
+ # {Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription::Plan}
627
+ # for more details.
628
+ #
629
+ # @param id [String, nil]
630
+ #
631
+ # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
632
+ #
633
+ # @param name [String, nil]
634
+ end
635
+
636
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent::Subscription#status
637
+ module Status
638
+ extend Orb::Internal::Type::Enum
639
+
640
+ ACTIVE = :active
641
+ ENDED = :ended
642
+ UPCOMING = :upcoming
643
+
644
+ # @!method self.values
645
+ # @return [Array<Symbol>]
646
+ end
647
+ end
648
+
649
+ # The event this payload describes.
650
+ #
651
+ # @see Orb::Models::Webhooks::SubscriptionAlertDisabledStandardWebhookEvent#type
652
+ module Type
653
+ extend Orb::Internal::Type::Enum
654
+
655
+ SUBSCRIPTION_ALERT_DISABLED = :"subscription.alert_disabled"
656
+
657
+ # @!method self.values
658
+ # @return [Array<Symbol>]
659
+ end
660
+ end
661
+ end
662
+ end
663
+ end