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,1151 @@
1
+ # typed: strong
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class CustomerCreditBalanceRecoveredStandardWebhookEvent < Orb::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent,
11
+ Orb::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ # The ID of this webhook event.
16
+ sig { returns(String) }
17
+ attr_accessor :id
18
+
19
+ # The time at which this event was created, to the second.
20
+ sig { returns(Time) }
21
+ attr_accessor :created_at
22
+
23
+ # A customer is a buyer of your products, and the other party to the billing
24
+ # relationship.
25
+ #
26
+ # In Orb, customers are assigned system generated identifiers automatically, but
27
+ # it's often desirable to have these match existing identifiers in your system. To
28
+ # avoid having to denormalize Orb ID information, you can pass in an
29
+ # `external_customer_id` with your own identifier. See
30
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
31
+ # information about how these aliases work in Orb.
32
+ #
33
+ # In addition to having an identifier in your system, a customer may exist in a
34
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
35
+ # `payment_provider` enum field to express this mapping.
36
+ #
37
+ # A customer also has a timezone (from the standard
38
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
39
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
40
+ # information on what this timezone parameter influences within Orb.
41
+ sig { returns(Orb::Customer) }
42
+ attr_reader :customer
43
+
44
+ sig { params(customer: Orb::Customer::OrHash).void }
45
+ attr_writer :customer
46
+
47
+ # The serialization style this payload was rendered in, as configured on the
48
+ # endpoint.
49
+ sig do
50
+ returns(
51
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle::TaggedSymbol
52
+ )
53
+ end
54
+ attr_accessor :payload_style
55
+
56
+ sig do
57
+ returns(
58
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties
59
+ )
60
+ end
61
+ attr_reader :properties
62
+
63
+ sig do
64
+ params(
65
+ properties:
66
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::OrHash
67
+ ).void
68
+ end
69
+ attr_writer :properties
70
+
71
+ # The event this payload describes.
72
+ sig do
73
+ returns(
74
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Type::TaggedSymbol
75
+ )
76
+ end
77
+ attr_accessor :type
78
+
79
+ # Issued when a customer's credit balance recovers from depleted.
80
+ sig do
81
+ params(
82
+ id: String,
83
+ created_at: Time,
84
+ customer: Orb::Customer::OrHash,
85
+ payload_style:
86
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle::OrSymbol,
87
+ properties:
88
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::OrHash,
89
+ type:
90
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Type::OrSymbol
91
+ ).returns(T.attached_class)
92
+ end
93
+ def self.new(
94
+ # The ID of this webhook event.
95
+ id:,
96
+ # The time at which this event was created, to the second.
97
+ created_at:,
98
+ # A customer is a buyer of your products, and the other party to the billing
99
+ # relationship.
100
+ #
101
+ # In Orb, customers are assigned system generated identifiers automatically, but
102
+ # it's often desirable to have these match existing identifiers in your system. To
103
+ # avoid having to denormalize Orb ID information, you can pass in an
104
+ # `external_customer_id` with your own identifier. See
105
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
106
+ # information about how these aliases work in Orb.
107
+ #
108
+ # In addition to having an identifier in your system, a customer may exist in a
109
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
110
+ # `payment_provider` enum field to express this mapping.
111
+ #
112
+ # A customer also has a timezone (from the standard
113
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
114
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
115
+ # information on what this timezone parameter influences within Orb.
116
+ customer:,
117
+ # The serialization style this payload was rendered in, as configured on the
118
+ # endpoint.
119
+ payload_style:,
120
+ properties:,
121
+ # The event this payload describes.
122
+ type:
123
+ )
124
+ end
125
+
126
+ sig do
127
+ override.returns(
128
+ {
129
+ id: String,
130
+ created_at: Time,
131
+ customer: Orb::Customer,
132
+ payload_style:
133
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle::TaggedSymbol,
134
+ properties:
135
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties,
136
+ type:
137
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Type::TaggedSymbol
138
+ }
139
+ )
140
+ end
141
+ def to_hash
142
+ end
143
+
144
+ # The serialization style this payload was rendered in, as configured on the
145
+ # endpoint.
146
+ module PayloadStyle
147
+ extend Orb::Internal::Type::Enum
148
+
149
+ TaggedSymbol =
150
+ T.type_alias do
151
+ T.all(
152
+ Symbol,
153
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle
154
+ )
155
+ end
156
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
157
+
158
+ EXPANDED =
159
+ T.let(
160
+ :expanded,
161
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle::TaggedSymbol
162
+ )
163
+ STANDARD =
164
+ T.let(
165
+ :standard,
166
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle::TaggedSymbol
167
+ )
168
+
169
+ sig do
170
+ override.returns(
171
+ T::Array[
172
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::PayloadStyle::TaggedSymbol
173
+ ]
174
+ )
175
+ end
176
+ def self.values
177
+ end
178
+ end
179
+
180
+ class Properties < Orb::Internal::Type::BaseModel
181
+ OrHash =
182
+ T.type_alias do
183
+ T.any(
184
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties,
185
+ Orb::Internal::AnyHash
186
+ )
187
+ end
188
+
189
+ # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
190
+ # usage, or credit balance and trigger webhooks when a threshold is exceeded.
191
+ #
192
+ # Alerts created through the API can be scoped to either customers or
193
+ # subscriptions.
194
+ sig do
195
+ returns(
196
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration
197
+ )
198
+ end
199
+ attr_reader :alert_configuration
200
+
201
+ sig do
202
+ params(
203
+ alert_configuration:
204
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::OrHash
205
+ ).void
206
+ end
207
+ attr_writer :alert_configuration
208
+
209
+ # A currency or custom credit unit, as embedded in webhook payloads.
210
+ sig do
211
+ returns(
212
+ T.nilable(
213
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit
214
+ )
215
+ )
216
+ end
217
+ attr_reader :pricing_unit
218
+
219
+ sig do
220
+ params(
221
+ pricing_unit:
222
+ T.nilable(
223
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit::OrHash
224
+ )
225
+ ).void
226
+ end
227
+ attr_writer :pricing_unit
228
+
229
+ sig do
230
+ params(
231
+ alert_configuration:
232
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::OrHash,
233
+ pricing_unit:
234
+ T.nilable(
235
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit::OrHash
236
+ )
237
+ ).returns(T.attached_class)
238
+ end
239
+ def self.new(
240
+ # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
241
+ # usage, or credit balance and trigger webhooks when a threshold is exceeded.
242
+ #
243
+ # Alerts created through the API can be scoped to either customers or
244
+ # subscriptions.
245
+ alert_configuration:,
246
+ # A currency or custom credit unit, as embedded in webhook payloads.
247
+ pricing_unit:
248
+ )
249
+ end
250
+
251
+ sig do
252
+ override.returns(
253
+ {
254
+ alert_configuration:
255
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration,
256
+ pricing_unit:
257
+ T.nilable(
258
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit
259
+ )
260
+ }
261
+ )
262
+ end
263
+ def to_hash
264
+ end
265
+
266
+ class AlertConfiguration < Orb::Internal::Type::BaseModel
267
+ OrHash =
268
+ T.type_alias do
269
+ T.any(
270
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration,
271
+ Orb::Internal::AnyHash
272
+ )
273
+ end
274
+
275
+ # Also referred to as alert_id in this documentation.
276
+ sig { returns(String) }
277
+ attr_accessor :id
278
+
279
+ # The creation time of the resource in Orb.
280
+ sig { returns(Time) }
281
+ attr_accessor :created_at
282
+
283
+ # The name of the currency the credit balance or invoice cost is denominated in.
284
+ sig { returns(T.nilable(String)) }
285
+ attr_accessor :currency
286
+
287
+ # The customer the alert applies to.
288
+ sig { returns(T.nilable(Orb::CustomerMinified)) }
289
+ attr_reader :customer
290
+
291
+ sig do
292
+ params(customer: T.nilable(Orb::CustomerMinified::OrHash)).void
293
+ end
294
+ attr_writer :customer
295
+
296
+ # Whether the alert is enabled or disabled.
297
+ sig { returns(T::Boolean) }
298
+ attr_accessor :enabled
299
+
300
+ # The metric the alert applies to.
301
+ sig do
302
+ returns(
303
+ T.nilable(
304
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric
305
+ )
306
+ )
307
+ end
308
+ attr_reader :metric
309
+
310
+ sig do
311
+ params(
312
+ metric:
313
+ T.nilable(
314
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric::OrHash
315
+ )
316
+ ).void
317
+ end
318
+ attr_writer :metric
319
+
320
+ # The plan the alert applies to.
321
+ sig do
322
+ returns(
323
+ T.nilable(
324
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan
325
+ )
326
+ )
327
+ end
328
+ attr_reader :plan
329
+
330
+ sig do
331
+ params(
332
+ plan:
333
+ T.nilable(
334
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan::OrHash
335
+ )
336
+ ).void
337
+ end
338
+ attr_writer :plan
339
+
340
+ # The subscription the alert applies to.
341
+ sig { returns(T.nilable(Orb::SubscriptionMinified)) }
342
+ attr_reader :subscription
343
+
344
+ sig do
345
+ params(
346
+ subscription: T.nilable(Orb::SubscriptionMinified::OrHash)
347
+ ).void
348
+ end
349
+ attr_writer :subscription
350
+
351
+ # The thresholds that define the conditions under which the alert will be
352
+ # triggered.
353
+ sig do
354
+ returns(
355
+ T.nilable(
356
+ T::Array[
357
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold
358
+ ]
359
+ )
360
+ )
361
+ end
362
+ attr_accessor :thresholds
363
+
364
+ # The type of alert. This must be a valid alert type.
365
+ sig do
366
+ returns(
367
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol
368
+ )
369
+ end
370
+ attr_accessor :type
371
+
372
+ # The current status of the alert. This field is only present for credit balance
373
+ # alerts.
374
+ sig do
375
+ returns(
376
+ T.nilable(
377
+ T::Array[
378
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus
379
+ ]
380
+ )
381
+ )
382
+ end
383
+ attr_accessor :balance_alert_status
384
+
385
+ # The property keys to group cost alerts by. Only present for cost alerts with
386
+ # grouping enabled.
387
+ sig { returns(T.nilable(T::Array[String])) }
388
+ attr_accessor :grouping_keys
389
+
390
+ # Minified license type for alert serialization.
391
+ sig do
392
+ returns(
393
+ T.nilable(
394
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType
395
+ )
396
+ )
397
+ end
398
+ attr_reader :license_type
399
+
400
+ sig do
401
+ params(
402
+ license_type:
403
+ T.nilable(
404
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType::OrHash
405
+ )
406
+ ).void
407
+ end
408
+ attr_writer :license_type
409
+
410
+ # Filters scoping which prices are included in spend and grouped cost alert
411
+ # evaluation. Alerts use the price_id, item_id, and price_type fields only; the
412
+ # alert's pricing unit is reported by currency.
413
+ sig do
414
+ returns(
415
+ T.nilable(
416
+ T::Array[
417
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter
418
+ ]
419
+ )
420
+ )
421
+ end
422
+ attr_accessor :price_filters
423
+
424
+ # Per-group threshold overrides. Each override maps a specific combination of
425
+ # grouping_keys values to a replacement threshold list. Only present for grouped
426
+ # cost alerts that have at least one override.
427
+ sig do
428
+ returns(
429
+ T.nilable(
430
+ T::Array[
431
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride
432
+ ]
433
+ )
434
+ )
435
+ end
436
+ attr_accessor :threshold_overrides
437
+
438
+ # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
439
+ # usage, or credit balance and trigger webhooks when a threshold is exceeded.
440
+ #
441
+ # Alerts created through the API can be scoped to either customers or
442
+ # subscriptions.
443
+ sig do
444
+ params(
445
+ id: String,
446
+ created_at: Time,
447
+ currency: T.nilable(String),
448
+ customer: T.nilable(Orb::CustomerMinified::OrHash),
449
+ enabled: T::Boolean,
450
+ metric:
451
+ T.nilable(
452
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric::OrHash
453
+ ),
454
+ plan:
455
+ T.nilable(
456
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan::OrHash
457
+ ),
458
+ subscription: T.nilable(Orb::SubscriptionMinified::OrHash),
459
+ thresholds:
460
+ T.nilable(
461
+ T::Array[
462
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold::OrHash
463
+ ]
464
+ ),
465
+ type:
466
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::OrSymbol,
467
+ balance_alert_status:
468
+ T.nilable(
469
+ T::Array[
470
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus::OrHash
471
+ ]
472
+ ),
473
+ grouping_keys: T.nilable(T::Array[String]),
474
+ license_type:
475
+ T.nilable(
476
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType::OrHash
477
+ ),
478
+ price_filters:
479
+ T.nilable(
480
+ T::Array[
481
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::OrHash
482
+ ]
483
+ ),
484
+ threshold_overrides:
485
+ T.nilable(
486
+ T::Array[
487
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::OrHash
488
+ ]
489
+ )
490
+ ).returns(T.attached_class)
491
+ end
492
+ def self.new(
493
+ # Also referred to as alert_id in this documentation.
494
+ id:,
495
+ # The creation time of the resource in Orb.
496
+ created_at:,
497
+ # The name of the currency the credit balance or invoice cost is denominated in.
498
+ currency:,
499
+ # The customer the alert applies to.
500
+ customer:,
501
+ # Whether the alert is enabled or disabled.
502
+ enabled:,
503
+ # The metric the alert applies to.
504
+ metric:,
505
+ # The plan the alert applies to.
506
+ plan:,
507
+ # The subscription the alert applies to.
508
+ subscription:,
509
+ # The thresholds that define the conditions under which the alert will be
510
+ # triggered.
511
+ thresholds:,
512
+ # The type of alert. This must be a valid alert type.
513
+ type:,
514
+ # The current status of the alert. This field is only present for credit balance
515
+ # alerts.
516
+ balance_alert_status: nil,
517
+ # The property keys to group cost alerts by. Only present for cost alerts with
518
+ # grouping enabled.
519
+ grouping_keys: nil,
520
+ # Minified license type for alert serialization.
521
+ license_type: nil,
522
+ # Filters scoping which prices are included in spend and grouped cost alert
523
+ # evaluation. Alerts use the price_id, item_id, and price_type fields only; the
524
+ # alert's pricing unit is reported by currency.
525
+ price_filters: nil,
526
+ # Per-group threshold overrides. Each override maps a specific combination of
527
+ # grouping_keys values to a replacement threshold list. Only present for grouped
528
+ # cost alerts that have at least one override.
529
+ threshold_overrides: nil
530
+ )
531
+ end
532
+
533
+ sig do
534
+ override.returns(
535
+ {
536
+ id: String,
537
+ created_at: Time,
538
+ currency: T.nilable(String),
539
+ customer: T.nilable(Orb::CustomerMinified),
540
+ enabled: T::Boolean,
541
+ metric:
542
+ T.nilable(
543
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric
544
+ ),
545
+ plan:
546
+ T.nilable(
547
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan
548
+ ),
549
+ subscription: T.nilable(Orb::SubscriptionMinified),
550
+ thresholds:
551
+ T.nilable(
552
+ T::Array[
553
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold
554
+ ]
555
+ ),
556
+ type:
557
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol,
558
+ balance_alert_status:
559
+ T.nilable(
560
+ T::Array[
561
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus
562
+ ]
563
+ ),
564
+ grouping_keys: T.nilable(T::Array[String]),
565
+ license_type:
566
+ T.nilable(
567
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType
568
+ ),
569
+ price_filters:
570
+ T.nilable(
571
+ T::Array[
572
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter
573
+ ]
574
+ ),
575
+ threshold_overrides:
576
+ T.nilable(
577
+ T::Array[
578
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride
579
+ ]
580
+ )
581
+ }
582
+ )
583
+ end
584
+ def to_hash
585
+ end
586
+
587
+ class Metric < Orb::Internal::Type::BaseModel
588
+ OrHash =
589
+ T.type_alias do
590
+ T.any(
591
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Metric,
592
+ Orb::Internal::AnyHash
593
+ )
594
+ end
595
+
596
+ sig { returns(String) }
597
+ attr_accessor :id
598
+
599
+ # The metric the alert applies to.
600
+ sig { params(id: String).returns(T.attached_class) }
601
+ def self.new(id:)
602
+ end
603
+
604
+ sig { override.returns({ id: String }) }
605
+ def to_hash
606
+ end
607
+ end
608
+
609
+ class Plan < Orb::Internal::Type::BaseModel
610
+ OrHash =
611
+ T.type_alias do
612
+ T.any(
613
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Plan,
614
+ Orb::Internal::AnyHash
615
+ )
616
+ end
617
+
618
+ sig { returns(T.nilable(String)) }
619
+ attr_accessor :id
620
+
621
+ # An optional user-defined ID for this plan resource, used throughout the system
622
+ # as an alias for this Plan. Use this field to identify a plan by an existing
623
+ # identifier in your system.
624
+ sig { returns(T.nilable(String)) }
625
+ attr_accessor :external_plan_id
626
+
627
+ sig { returns(T.nilable(String)) }
628
+ attr_accessor :name
629
+
630
+ sig { returns(String) }
631
+ attr_accessor :plan_version
632
+
633
+ # The plan the alert applies to.
634
+ sig do
635
+ params(
636
+ id: T.nilable(String),
637
+ external_plan_id: T.nilable(String),
638
+ name: T.nilable(String),
639
+ plan_version: String
640
+ ).returns(T.attached_class)
641
+ end
642
+ def self.new(
643
+ id:,
644
+ # An optional user-defined ID for this plan resource, used throughout the system
645
+ # as an alias for this Plan. Use this field to identify a plan by an existing
646
+ # identifier in your system.
647
+ external_plan_id:,
648
+ name:,
649
+ plan_version:
650
+ )
651
+ end
652
+
653
+ sig do
654
+ override.returns(
655
+ {
656
+ id: T.nilable(String),
657
+ external_plan_id: T.nilable(String),
658
+ name: T.nilable(String),
659
+ plan_version: String
660
+ }
661
+ )
662
+ end
663
+ def to_hash
664
+ end
665
+ end
666
+
667
+ class Threshold < Orb::Internal::Type::BaseModel
668
+ OrHash =
669
+ T.type_alias do
670
+ T.any(
671
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Threshold,
672
+ Orb::Internal::AnyHash
673
+ )
674
+ end
675
+
676
+ # The value at which an alert will fire. For credit balance alerts, the alert will
677
+ # fire at or below this value. For usage and cost alerts, the alert will fire at
678
+ # or above this value.
679
+ sig { returns(String) }
680
+ attr_accessor :value
681
+
682
+ # Thresholds are used to define the conditions under which an alert will be
683
+ # triggered.
684
+ sig { params(value: String).returns(T.attached_class) }
685
+ def self.new(
686
+ # The value at which an alert will fire. For credit balance alerts, the alert will
687
+ # fire at or below this value. For usage and cost alerts, the alert will fire at
688
+ # or above this value.
689
+ value:
690
+ )
691
+ end
692
+
693
+ sig { override.returns({ value: String }) }
694
+ def to_hash
695
+ end
696
+ end
697
+
698
+ # The type of alert. This must be a valid alert type.
699
+ module Type
700
+ extend Orb::Internal::Type::Enum
701
+
702
+ TaggedSymbol =
703
+ T.type_alias do
704
+ T.all(
705
+ Symbol,
706
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type
707
+ )
708
+ end
709
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
710
+
711
+ CREDIT_BALANCE_DEPLETED =
712
+ T.let(
713
+ :credit_balance_depleted,
714
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol
715
+ )
716
+ CREDIT_BALANCE_DROPPED =
717
+ T.let(
718
+ :credit_balance_dropped,
719
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol
720
+ )
721
+ CREDIT_BALANCE_RECOVERED =
722
+ T.let(
723
+ :credit_balance_recovered,
724
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol
725
+ )
726
+ USAGE_EXCEEDED =
727
+ T.let(
728
+ :usage_exceeded,
729
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol
730
+ )
731
+ COST_EXCEEDED =
732
+ T.let(
733
+ :cost_exceeded,
734
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol
735
+ )
736
+ SPEND_EXCEEDED =
737
+ T.let(
738
+ :spend_exceeded,
739
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol
740
+ )
741
+ LICENSE_BALANCE_THRESHOLD_REACHED =
742
+ T.let(
743
+ :license_balance_threshold_reached,
744
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol
745
+ )
746
+
747
+ sig do
748
+ override.returns(
749
+ T::Array[
750
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::Type::TaggedSymbol
751
+ ]
752
+ )
753
+ end
754
+ def self.values
755
+ end
756
+ end
757
+
758
+ class BalanceAlertStatus < Orb::Internal::Type::BaseModel
759
+ OrHash =
760
+ T.type_alias do
761
+ T.any(
762
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::BalanceAlertStatus,
763
+ Orb::Internal::AnyHash
764
+ )
765
+ end
766
+
767
+ # Whether the alert is currently in-alert or not.
768
+ sig { returns(T::Boolean) }
769
+ attr_accessor :in_alert
770
+
771
+ # The value of the threshold that defines the alert status.
772
+ sig { returns(String) }
773
+ attr_accessor :threshold_value
774
+
775
+ # Alert status is used to determine if an alert is currently in-alert or not.
776
+ sig do
777
+ params(in_alert: T::Boolean, threshold_value: String).returns(
778
+ T.attached_class
779
+ )
780
+ end
781
+ def self.new(
782
+ # Whether the alert is currently in-alert or not.
783
+ in_alert:,
784
+ # The value of the threshold that defines the alert status.
785
+ threshold_value:
786
+ )
787
+ end
788
+
789
+ sig do
790
+ override.returns(
791
+ { in_alert: T::Boolean, threshold_value: String }
792
+ )
793
+ end
794
+ def to_hash
795
+ end
796
+ end
797
+
798
+ class LicenseType < Orb::Internal::Type::BaseModel
799
+ OrHash =
800
+ T.type_alias do
801
+ T.any(
802
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::LicenseType,
803
+ Orb::Internal::AnyHash
804
+ )
805
+ end
806
+
807
+ sig { returns(String) }
808
+ attr_accessor :id
809
+
810
+ # Minified license type for alert serialization.
811
+ sig { params(id: String).returns(T.attached_class) }
812
+ def self.new(id:)
813
+ end
814
+
815
+ sig { override.returns({ id: String }) }
816
+ def to_hash
817
+ end
818
+ end
819
+
820
+ class PriceFilter < Orb::Internal::Type::BaseModel
821
+ OrHash =
822
+ T.type_alias do
823
+ T.any(
824
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter,
825
+ Orb::Internal::AnyHash
826
+ )
827
+ end
828
+
829
+ # The property of the price to filter on.
830
+ sig do
831
+ returns(
832
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field::TaggedSymbol
833
+ )
834
+ end
835
+ attr_accessor :field
836
+
837
+ # Should prices that match the filter be included or excluded.
838
+ sig do
839
+ returns(
840
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator::TaggedSymbol
841
+ )
842
+ end
843
+ attr_accessor :operator
844
+
845
+ # The IDs or values that match this filter.
846
+ sig { returns(T::Array[String]) }
847
+ attr_accessor :values
848
+
849
+ sig do
850
+ params(
851
+ field:
852
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field::OrSymbol,
853
+ operator:
854
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator::OrSymbol,
855
+ values: T::Array[String]
856
+ ).returns(T.attached_class)
857
+ end
858
+ def self.new(
859
+ # The property of the price to filter on.
860
+ field:,
861
+ # Should prices that match the filter be included or excluded.
862
+ operator:,
863
+ # The IDs or values that match this filter.
864
+ values:
865
+ )
866
+ end
867
+
868
+ sig do
869
+ override.returns(
870
+ {
871
+ field:
872
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field::TaggedSymbol,
873
+ operator:
874
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator::TaggedSymbol,
875
+ values: T::Array[String]
876
+ }
877
+ )
878
+ end
879
+ def to_hash
880
+ end
881
+
882
+ # The property of the price to filter on.
883
+ module Field
884
+ extend Orb::Internal::Type::Enum
885
+
886
+ TaggedSymbol =
887
+ T.type_alias do
888
+ T.all(
889
+ Symbol,
890
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field
891
+ )
892
+ end
893
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
894
+
895
+ PRICE_ID =
896
+ T.let(
897
+ :price_id,
898
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field::TaggedSymbol
899
+ )
900
+ ITEM_ID =
901
+ T.let(
902
+ :item_id,
903
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field::TaggedSymbol
904
+ )
905
+ PRICE_TYPE =
906
+ T.let(
907
+ :price_type,
908
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field::TaggedSymbol
909
+ )
910
+ CURRENCY =
911
+ T.let(
912
+ :currency,
913
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field::TaggedSymbol
914
+ )
915
+ PRICING_UNIT_ID =
916
+ T.let(
917
+ :pricing_unit_id,
918
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field::TaggedSymbol
919
+ )
920
+
921
+ sig do
922
+ override.returns(
923
+ T::Array[
924
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Field::TaggedSymbol
925
+ ]
926
+ )
927
+ end
928
+ def self.values
929
+ end
930
+ end
931
+
932
+ # Should prices that match the filter be included or excluded.
933
+ module Operator
934
+ extend Orb::Internal::Type::Enum
935
+
936
+ TaggedSymbol =
937
+ T.type_alias do
938
+ T.all(
939
+ Symbol,
940
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator
941
+ )
942
+ end
943
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
944
+
945
+ INCLUDES =
946
+ T.let(
947
+ :includes,
948
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator::TaggedSymbol
949
+ )
950
+ EXCLUDES =
951
+ T.let(
952
+ :excludes,
953
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator::TaggedSymbol
954
+ )
955
+
956
+ sig do
957
+ override.returns(
958
+ T::Array[
959
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::PriceFilter::Operator::TaggedSymbol
960
+ ]
961
+ )
962
+ end
963
+ def self.values
964
+ end
965
+ end
966
+ end
967
+
968
+ class ThresholdOverride < Orb::Internal::Type::BaseModel
969
+ OrHash =
970
+ T.type_alias do
971
+ T.any(
972
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride,
973
+ Orb::Internal::AnyHash
974
+ )
975
+ end
976
+
977
+ # The values identifying this group, ordered to match group_keys when set and the
978
+ # alert's grouping_keys otherwise.
979
+ sig { returns(T::Array[String]) }
980
+ attr_accessor :group_values
981
+
982
+ # The thresholds applied to this group. An empty list means the group is silenced.
983
+ sig do
984
+ returns(
985
+ T::Array[
986
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold
987
+ ]
988
+ )
989
+ end
990
+ attr_accessor :thresholds
991
+
992
+ # The subset of the alert's grouping_keys this override binds. Null when the
993
+ # override targets one exact group across every grouping key.
994
+ sig { returns(T.nilable(T::Array[String])) }
995
+ attr_accessor :group_keys
996
+
997
+ # A per-group threshold override on a grouped cost alert.
998
+ #
999
+ # An empty `thresholds` list means the group is silenced (never fires). A
1000
+ # non-empty list fully replaces the default thresholds for that group.
1001
+ sig do
1002
+ params(
1003
+ group_values: T::Array[String],
1004
+ thresholds:
1005
+ T::Array[
1006
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold::OrHash
1007
+ ],
1008
+ group_keys: T.nilable(T::Array[String])
1009
+ ).returns(T.attached_class)
1010
+ end
1011
+ def self.new(
1012
+ # The values identifying this group, ordered to match group_keys when set and the
1013
+ # alert's grouping_keys otherwise.
1014
+ group_values:,
1015
+ # The thresholds applied to this group. An empty list means the group is silenced.
1016
+ thresholds:,
1017
+ # The subset of the alert's grouping_keys this override binds. Null when the
1018
+ # override targets one exact group across every grouping key.
1019
+ group_keys: nil
1020
+ )
1021
+ end
1022
+
1023
+ sig do
1024
+ override.returns(
1025
+ {
1026
+ group_values: T::Array[String],
1027
+ thresholds:
1028
+ T::Array[
1029
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold
1030
+ ],
1031
+ group_keys: T.nilable(T::Array[String])
1032
+ }
1033
+ )
1034
+ end
1035
+ def to_hash
1036
+ end
1037
+
1038
+ class Threshold < Orb::Internal::Type::BaseModel
1039
+ OrHash =
1040
+ T.type_alias do
1041
+ T.any(
1042
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::AlertConfiguration::ThresholdOverride::Threshold,
1043
+ Orb::Internal::AnyHash
1044
+ )
1045
+ end
1046
+
1047
+ # The value at which an alert will fire. For credit balance alerts, the alert will
1048
+ # fire at or below this value. For usage and cost alerts, the alert will fire at
1049
+ # or above this value.
1050
+ sig { returns(String) }
1051
+ attr_accessor :value
1052
+
1053
+ # Thresholds are used to define the conditions under which an alert will be
1054
+ # triggered.
1055
+ sig { params(value: String).returns(T.attached_class) }
1056
+ def self.new(
1057
+ # The value at which an alert will fire. For credit balance alerts, the alert will
1058
+ # fire at or below this value. For usage and cost alerts, the alert will fire at
1059
+ # or above this value.
1060
+ value:
1061
+ )
1062
+ end
1063
+
1064
+ sig { override.returns({ value: String }) }
1065
+ def to_hash
1066
+ end
1067
+ end
1068
+ end
1069
+ end
1070
+
1071
+ class PricingUnit < Orb::Internal::Type::BaseModel
1072
+ OrHash =
1073
+ T.type_alias do
1074
+ T.any(
1075
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Properties::PricingUnit,
1076
+ Orb::Internal::AnyHash
1077
+ )
1078
+ end
1079
+
1080
+ sig { returns(String) }
1081
+ attr_accessor :id
1082
+
1083
+ sig { returns(T.nilable(String)) }
1084
+ attr_accessor :display_name
1085
+
1086
+ sig { returns(String) }
1087
+ attr_accessor :name
1088
+
1089
+ sig { returns(T.nilable(String)) }
1090
+ attr_accessor :symbol
1091
+
1092
+ # A currency or custom credit unit, as embedded in webhook payloads.
1093
+ sig do
1094
+ params(
1095
+ id: String,
1096
+ display_name: T.nilable(String),
1097
+ name: String,
1098
+ symbol: T.nilable(String)
1099
+ ).returns(T.attached_class)
1100
+ end
1101
+ def self.new(id:, display_name:, name:, symbol:)
1102
+ end
1103
+
1104
+ sig do
1105
+ override.returns(
1106
+ {
1107
+ id: String,
1108
+ display_name: T.nilable(String),
1109
+ name: String,
1110
+ symbol: T.nilable(String)
1111
+ }
1112
+ )
1113
+ end
1114
+ def to_hash
1115
+ end
1116
+ end
1117
+ end
1118
+
1119
+ # The event this payload describes.
1120
+ module Type
1121
+ extend Orb::Internal::Type::Enum
1122
+
1123
+ TaggedSymbol =
1124
+ T.type_alias do
1125
+ T.all(
1126
+ Symbol,
1127
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Type
1128
+ )
1129
+ end
1130
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1131
+
1132
+ CUSTOMER_CREDIT_BALANCE_RECOVERED =
1133
+ T.let(
1134
+ :"customer.credit_balance_recovered",
1135
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Type::TaggedSymbol
1136
+ )
1137
+
1138
+ sig do
1139
+ override.returns(
1140
+ T::Array[
1141
+ Orb::Webhooks::CustomerCreditBalanceRecoveredStandardWebhookEvent::Type::TaggedSymbol
1142
+ ]
1143
+ )
1144
+ end
1145
+ def self.values
1146
+ end
1147
+ end
1148
+ end
1149
+ end
1150
+ end
1151
+ end