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