orb-billing 1.45.0 → 1.46.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (264) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -1
  3. data/README.md +1 -1
  4. data/lib/orb/models/webhooks/backfill_reflected_standard_webhook_event.rb +206 -0
  5. data/lib/orb/models/webhooks/backfill_reverted_standard_webhook_event.rb +206 -0
  6. data/lib/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rb +131 -0
  7. data/lib/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rb +537 -0
  8. data/lib/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rb +531 -0
  9. data/lib/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rb +188 -0
  10. data/lib/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rb +183 -0
  11. data/lib/orb/models/webhooks/credit_note_issued_standard_webhook_event.rb +90 -0
  12. data/lib/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rb +92 -0
  13. data/lib/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rb +198 -0
  14. data/lib/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rb +193 -0
  15. data/lib/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rb +240 -0
  16. data/lib/orb/models/webhooks/customer_created_standard_webhook_event.rb +106 -0
  17. data/lib/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rb +597 -0
  18. data/lib/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rb +603 -0
  19. data/lib/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rb +597 -0
  20. data/lib/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rb +509 -0
  21. data/lib/orb/models/webhooks/customer_edited_standard_webhook_event.rb +371 -0
  22. data/lib/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rb +130 -0
  23. data/lib/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rb +124 -0
  24. data/lib/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rb +134 -0
  25. data/lib/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rb +94 -0
  26. data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +972 -0
  27. data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +966 -0
  28. data/lib/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rb +367 -0
  29. data/lib/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rb +113 -0
  30. data/lib/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rb +101 -0
  31. data/lib/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rb +101 -0
  32. data/lib/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rb +95 -0
  33. data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +994 -0
  34. data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +988 -0
  35. data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +992 -0
  36. data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +942 -0
  37. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +1365 -0
  38. data/lib/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rb +151 -0
  39. data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +885 -0
  40. data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +884 -0
  41. data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +887 -0
  42. data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +899 -0
  43. data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +876 -0
  44. data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +899 -0
  45. data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +893 -0
  46. data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +908 -0
  47. data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +890 -0
  48. data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +892 -0
  49. data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +875 -0
  50. data/lib/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rb +125 -0
  51. data/lib/orb/models/webhooks/payment_method_created_standard_webhook_event.rb +184 -0
  52. data/lib/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rb +184 -0
  53. data/lib/orb/models/webhooks/plan_created_standard_webhook_event.rb +119 -0
  54. data/lib/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rb +139 -0
  55. data/lib/orb/models/webhooks/plan_edited_standard_webhook_event.rb +159 -0
  56. data/lib/orb/models/webhooks/plan_version_created_standard_webhook_event.rb +138 -0
  57. data/lib/orb/models/webhooks/price_edited_standard_webhook_event.rb +132 -0
  58. data/lib/orb/models/webhooks/resource_event_test_standard_webhook_event.rb +92 -0
  59. data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +972 -0
  60. data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +967 -0
  61. data/lib/orb/models/webhooks/standard_unwrap_standard_params.rb +16 -0
  62. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +322 -0
  63. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +316 -0
  64. data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +667 -0
  65. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +237 -0
  66. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +237 -0
  67. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +692 -0
  68. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +221 -0
  69. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +273 -0
  70. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +219 -0
  71. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +255 -0
  72. data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +693 -0
  73. data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +222 -0
  74. data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +244 -0
  75. data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +687 -0
  76. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +249 -0
  77. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +233 -0
  78. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +250 -0
  79. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +248 -0
  80. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +693 -0
  81. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +221 -0
  82. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +222 -0
  83. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +700 -0
  84. data/lib/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rb +270 -0
  85. data/lib/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rb +264 -0
  86. data/lib/orb/models/webhooks/unwrap_standard_webhook_event.rb +258 -0
  87. data/lib/orb/models.rb +2 -0
  88. data/lib/orb/resources/webhooks/standard.rb +24 -0
  89. data/lib/orb/resources/webhooks.rb +4 -0
  90. data/lib/orb/version.rb +1 -1
  91. data/lib/orb.rb +84 -0
  92. data/rbi/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbi +349 -0
  93. data/rbi/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbi +347 -0
  94. data/rbi/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbi +273 -0
  95. data/rbi/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbi +1106 -0
  96. data/rbi/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbi +1095 -0
  97. data/rbi/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbi +377 -0
  98. data/rbi/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbi +366 -0
  99. data/rbi/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbi +166 -0
  100. data/rbi/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbi +166 -0
  101. data/rbi/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbi +403 -0
  102. data/rbi/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbi +392 -0
  103. data/rbi/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbi +493 -0
  104. data/rbi/orb/models/webhooks/customer_created_standard_webhook_event.rbi +198 -0
  105. data/rbi/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbi +1151 -0
  106. data/rbi/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbi +1158 -0
  107. data/rbi/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbi +1151 -0
  108. data/rbi/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbi +1044 -0
  109. data/rbi/orb/models/webhooks/customer_edited_standard_webhook_event.rbi +678 -0
  110. data/rbi/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbi +236 -0
  111. data/rbi/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbi +230 -0
  112. data/rbi/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbi +275 -0
  113. data/rbi/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbi +192 -0
  114. data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +1705 -0
  115. data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +1694 -0
  116. data/rbi/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbi +670 -0
  117. data/rbi/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbi +210 -0
  118. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbi +195 -0
  119. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbi +195 -0
  120. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbi +188 -0
  121. data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +1713 -0
  122. data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +1708 -0
  123. data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +1713 -0
  124. data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +1628 -0
  125. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +2337 -0
  126. data/rbi/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbi +324 -0
  127. data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +1529 -0
  128. data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +1529 -0
  129. data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +1534 -0
  130. data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +1549 -0
  131. data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +1494 -0
  132. data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +1554 -0
  133. data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +1547 -0
  134. data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +1563 -0
  135. data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +1542 -0
  136. data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +1544 -0
  137. data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +1494 -0
  138. data/rbi/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbi +233 -0
  139. data/rbi/orb/models/webhooks/payment_method_created_standard_webhook_event.rbi +331 -0
  140. data/rbi/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbi +331 -0
  141. data/rbi/orb/models/webhooks/plan_created_standard_webhook_event.rbi +216 -0
  142. data/rbi/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbi +277 -0
  143. data/rbi/orb/models/webhooks/plan_edited_standard_webhook_event.rbi +337 -0
  144. data/rbi/orb/models/webhooks/plan_version_created_standard_webhook_event.rbi +271 -0
  145. data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi +311 -0
  146. data/rbi/orb/models/webhooks/resource_event_test_standard_webhook_event.rbi +191 -0
  147. data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +1705 -0
  148. data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +1694 -0
  149. data/rbi/orb/models/webhooks/standard_unwrap_standard_params.rbi +32 -0
  150. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +609 -0
  151. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +598 -0
  152. data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +1302 -0
  153. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +433 -0
  154. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +435 -0
  155. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +1298 -0
  156. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +398 -0
  157. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +520 -0
  158. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +398 -0
  159. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +458 -0
  160. data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +1321 -0
  161. data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +428 -0
  162. data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +477 -0
  163. data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +1319 -0
  164. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +453 -0
  165. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +433 -0
  166. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +457 -0
  167. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +457 -0
  168. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +1299 -0
  169. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +398 -0
  170. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +398 -0
  171. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +1305 -0
  172. data/rbi/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbi +516 -0
  173. data/rbi/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbi +505 -0
  174. data/rbi/orb/models/webhooks/unwrap_standard_webhook_event.rbi +107 -0
  175. data/rbi/orb/models.rbi +2 -0
  176. data/rbi/orb/resources/webhooks/standard.rbi +107 -0
  177. data/rbi/orb/resources/webhooks.rbi +3 -0
  178. data/sig/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbs +148 -0
  179. data/sig/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbs +148 -0
  180. data/sig/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbs +112 -0
  181. data/sig/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbs +435 -0
  182. data/sig/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbs +430 -0
  183. data/sig/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbs +165 -0
  184. data/sig/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbs +160 -0
  185. data/sig/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbs +68 -0
  186. data/sig/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbs +68 -0
  187. data/sig/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbs +160 -0
  188. data/sig/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbs +155 -0
  189. data/sig/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbs +189 -0
  190. data/sig/orb/models/webhooks/customer_created_standard_webhook_event.rbs +68 -0
  191. data/sig/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbs +396 -0
  192. data/sig/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbs +401 -0
  193. data/sig/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbs +396 -0
  194. data/sig/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbs +386 -0
  195. data/sig/orb/models/webhooks/customer_edited_standard_webhook_event.rbs +157 -0
  196. data/sig/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbs +110 -0
  197. data/sig/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbs +105 -0
  198. data/sig/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbs +122 -0
  199. data/sig/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbs +73 -0
  200. data/sig/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  201. data/sig/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  202. data/sig/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbs +331 -0
  203. data/sig/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbs +91 -0
  204. data/sig/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbs +75 -0
  205. data/sig/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbs +75 -0
  206. data/sig/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbs +73 -0
  207. data/sig/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbs +638 -0
  208. data/sig/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbs +633 -0
  209. data/sig/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbs +623 -0
  210. data/sig/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbs +586 -0
  211. data/sig/orb/models/webhooks/invoice_edited_standard_webhook_event.rbs +859 -0
  212. data/sig/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbs +129 -0
  213. data/sig/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbs +527 -0
  214. data/sig/orb/models/webhooks/invoice_issued_standard_webhook_event.rbs +527 -0
  215. data/sig/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbs +527 -0
  216. data/sig/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbs +540 -0
  217. data/sig/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbs +517 -0
  218. data/sig/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbs +544 -0
  219. data/sig/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbs +538 -0
  220. data/sig/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbs +549 -0
  221. data/sig/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbs +536 -0
  222. data/sig/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbs +536 -0
  223. data/sig/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbs +517 -0
  224. data/sig/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbs +100 -0
  225. data/sig/orb/models/webhooks/payment_method_created_standard_webhook_event.rbs +130 -0
  226. data/sig/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbs +130 -0
  227. data/sig/orb/models/webhooks/plan_created_standard_webhook_event.rbs +90 -0
  228. data/sig/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbs +112 -0
  229. data/sig/orb/models/webhooks/plan_edited_standard_webhook_event.rbs +134 -0
  230. data/sig/orb/models/webhooks/plan_version_created_standard_webhook_event.rbs +109 -0
  231. data/sig/orb/models/webhooks/price_edited_standard_webhook_event.rbs +95 -0
  232. data/sig/orb/models/webhooks/resource_event_test_standard_webhook_event.rbs +75 -0
  233. data/sig/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  234. data/sig/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  235. data/sig/orb/models/webhooks/standard_unwrap_standard_params.rbs +17 -0
  236. data/sig/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbs +256 -0
  237. data/sig/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbs +251 -0
  238. data/sig/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbs +466 -0
  239. data/sig/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbs +169 -0
  240. data/sig/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbs +169 -0
  241. data/sig/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbs +475 -0
  242. data/sig/orb/models/webhooks/subscription_created_standard_webhook_event.rbs +159 -0
  243. data/sig/orb/models/webhooks/subscription_edited_standard_webhook_event.rbs +218 -0
  244. data/sig/orb/models/webhooks/subscription_ended_standard_webhook_event.rbs +159 -0
  245. data/sig/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbs +191 -0
  246. data/sig/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbs +487 -0
  247. data/sig/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbs +176 -0
  248. data/sig/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbs +198 -0
  249. data/sig/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbs +482 -0
  250. data/sig/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbs +182 -0
  251. data/sig/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbs +169 -0
  252. data/sig/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbs +186 -0
  253. data/sig/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbs +186 -0
  254. data/sig/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbs +475 -0
  255. data/sig/orb/models/webhooks/subscription_started_standard_webhook_event.rbs +159 -0
  256. data/sig/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbs +159 -0
  257. data/sig/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbs +480 -0
  258. data/sig/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbs +223 -0
  259. data/sig/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbs +218 -0
  260. data/sig/orb/models/webhooks/unwrap_standard_webhook_event.rbs +94 -0
  261. data/sig/orb/models.rbs +2 -0
  262. data/sig/orb/resources/webhooks/standard.rbs +93 -0
  263. data/sig/orb/resources/webhooks.rbs +2 -0
  264. metadata +253 -1
@@ -0,0 +1,198 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class CustomerAccountingSyncFailedStandardWebhookEvent < 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 accounting_sync_record
14
+ #
15
+ # @return [Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord]
16
+ required :accounting_sync_record,
17
+ -> { Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord }
18
+
19
+ # @!attribute created_at
20
+ # The time at which this event was created, to the second.
21
+ #
22
+ # @return [Time]
23
+ required :created_at, Time
24
+
25
+ # @!attribute customer
26
+ # A customer is a buyer of your products, and the other party to the billing
27
+ # relationship.
28
+ #
29
+ # In Orb, customers are assigned system generated identifiers automatically, but
30
+ # it's often desirable to have these match existing identifiers in your system. To
31
+ # avoid having to denormalize Orb ID information, you can pass in an
32
+ # `external_customer_id` with your own identifier. See
33
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
34
+ # information about how these aliases work in Orb.
35
+ #
36
+ # In addition to having an identifier in your system, a customer may exist in a
37
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
38
+ # `payment_provider` enum field to express this mapping.
39
+ #
40
+ # A customer also has a timezone (from the standard
41
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
42
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
43
+ # information on what this timezone parameter influences within Orb.
44
+ #
45
+ # @return [Orb::Models::Customer]
46
+ required :customer, -> { Orb::Customer }
47
+
48
+ # @!attribute payload_style
49
+ # The serialization style this payload was rendered in, as configured on the
50
+ # endpoint.
51
+ #
52
+ # @return [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::PayloadStyle]
53
+ required :payload_style,
54
+ enum: -> { Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::PayloadStyle }
55
+
56
+ # @!attribute properties
57
+ #
58
+ # @return [Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::Properties]
59
+ required :properties, -> { Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::Properties }
60
+
61
+ # @!attribute type
62
+ # The event this payload describes.
63
+ #
64
+ # @return [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::Type]
65
+ required :type, enum: -> { Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::Type }
66
+
67
+ # @!method initialize(id:, accounting_sync_record:, created_at:, customer:, payload_style:, properties:, type:)
68
+ # Some parameter documentations has been truncated, see
69
+ # {Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent} for
70
+ # more details.
71
+ #
72
+ # Issued when a customer accounting sync fails.
73
+ #
74
+ # @param id [String] The ID of this webhook event.
75
+ #
76
+ # @param accounting_sync_record [Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord]
77
+ #
78
+ # @param created_at [Time] The time at which this event was created, to the second.
79
+ #
80
+ # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
81
+ #
82
+ # @param payload_style [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
83
+ #
84
+ # @param properties [Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::Properties]
85
+ #
86
+ # @param type [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::Type] The event this payload describes.
87
+
88
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent#accounting_sync_record
89
+ class AccountingSyncRecord < Orb::Internal::Type::BaseModel
90
+ # @!attribute id
91
+ #
92
+ # @return [String]
93
+ required :id, String
94
+
95
+ # @!attribute customer_id
96
+ #
97
+ # @return [String]
98
+ required :customer_id, String
99
+
100
+ # @!attribute record_type
101
+ #
102
+ # @return [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord::RecordType]
103
+ required :record_type,
104
+ enum: -> { Orb::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord::RecordType }
105
+
106
+ # @!attribute error_details
107
+ #
108
+ # @return [Hash{Symbol=>Object}, nil]
109
+ optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
110
+
111
+ # @!attribute provider_customer_id
112
+ #
113
+ # @return [String, nil]
114
+ optional :provider_customer_id, String, nil?: true
115
+
116
+ # @!attribute status
117
+ #
118
+ # @return [String, nil]
119
+ optional :status, String, nil?: true
120
+
121
+ # @!attribute sync_action
122
+ #
123
+ # @return [String, nil]
124
+ optional :sync_action, String, nil?: true
125
+
126
+ # @!method initialize(id:, customer_id:, record_type:, error_details: nil, provider_customer_id: nil, status: nil, sync_action: nil)
127
+ # @param id [String]
128
+ # @param customer_id [String]
129
+ # @param record_type [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord::RecordType]
130
+ # @param error_details [Hash{Symbol=>Object}, nil]
131
+ # @param provider_customer_id [String, nil]
132
+ # @param status [String, nil]
133
+ # @param sync_action [String, nil]
134
+
135
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord#record_type
136
+ module RecordType
137
+ extend Orb::Internal::Type::Enum
138
+
139
+ CUSTOMER = :customer
140
+ INVOICE = :invoice
141
+ TRANSACTION = :transaction
142
+ CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
143
+ CREDIT_NOTE = :credit_note
144
+ SUBSCRIPTION = :subscription
145
+ SALES_ORDER = :sales_order
146
+ BLOCK = :block
147
+
148
+ # @!method self.values
149
+ # @return [Array<Symbol>]
150
+ end
151
+ end
152
+
153
+ # The serialization style this payload was rendered in, as configured on the
154
+ # endpoint.
155
+ #
156
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent#payload_style
157
+ module PayloadStyle
158
+ extend Orb::Internal::Type::Enum
159
+
160
+ EXPANDED = :expanded
161
+ STANDARD = :standard
162
+
163
+ # @!method self.values
164
+ # @return [Array<Symbol>]
165
+ end
166
+
167
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent#properties
168
+ class Properties < Orb::Internal::Type::BaseModel
169
+ # @!attribute connection_type
170
+ #
171
+ # @return [String]
172
+ required :connection_type, String
173
+
174
+ # @!attribute failure_reason
175
+ #
176
+ # @return [String]
177
+ required :failure_reason, String
178
+
179
+ # @!method initialize(connection_type:, failure_reason:)
180
+ # @param connection_type [String]
181
+ # @param failure_reason [String]
182
+ end
183
+
184
+ # The event this payload describes.
185
+ #
186
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncFailedStandardWebhookEvent#type
187
+ module Type
188
+ extend Orb::Internal::Type::Enum
189
+
190
+ CUSTOMER_ACCOUNTING_SYNC_FAILED = :"customer.accounting_sync_failed"
191
+
192
+ # @!method self.values
193
+ # @return [Array<Symbol>]
194
+ end
195
+ end
196
+ end
197
+ end
198
+ end
@@ -0,0 +1,193 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class CustomerAccountingSyncSucceededStandardWebhookEvent < 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 accounting_sync_record
14
+ #
15
+ # @return [Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord]
16
+ required :accounting_sync_record,
17
+ -> { Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord }
18
+
19
+ # @!attribute created_at
20
+ # The time at which this event was created, to the second.
21
+ #
22
+ # @return [Time]
23
+ required :created_at, Time
24
+
25
+ # @!attribute customer
26
+ # A customer is a buyer of your products, and the other party to the billing
27
+ # relationship.
28
+ #
29
+ # In Orb, customers are assigned system generated identifiers automatically, but
30
+ # it's often desirable to have these match existing identifiers in your system. To
31
+ # avoid having to denormalize Orb ID information, you can pass in an
32
+ # `external_customer_id` with your own identifier. See
33
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
34
+ # information about how these aliases work in Orb.
35
+ #
36
+ # In addition to having an identifier in your system, a customer may exist in a
37
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
38
+ # `payment_provider` enum field to express this mapping.
39
+ #
40
+ # A customer also has a timezone (from the standard
41
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
42
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
43
+ # information on what this timezone parameter influences within Orb.
44
+ #
45
+ # @return [Orb::Models::Customer]
46
+ required :customer, -> { Orb::Customer }
47
+
48
+ # @!attribute payload_style
49
+ # The serialization style this payload was rendered in, as configured on the
50
+ # endpoint.
51
+ #
52
+ # @return [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::PayloadStyle]
53
+ required :payload_style,
54
+ enum: -> { Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::PayloadStyle }
55
+
56
+ # @!attribute properties
57
+ #
58
+ # @return [Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::Properties]
59
+ required :properties,
60
+ -> { Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::Properties }
61
+
62
+ # @!attribute type
63
+ # The event this payload describes.
64
+ #
65
+ # @return [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::Type]
66
+ required :type, enum: -> { Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::Type }
67
+
68
+ # @!method initialize(id:, accounting_sync_record:, created_at:, customer:, payload_style:, properties:, type:)
69
+ # Some parameter documentations has been truncated, see
70
+ # {Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent} for
71
+ # more details.
72
+ #
73
+ # Issued when a customer accounting sync succeeds.
74
+ #
75
+ # @param id [String] The ID of this webhook event.
76
+ #
77
+ # @param accounting_sync_record [Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord]
78
+ #
79
+ # @param created_at [Time] The time at which this event was created, to the second.
80
+ #
81
+ # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
82
+ #
83
+ # @param payload_style [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
84
+ #
85
+ # @param properties [Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::Properties]
86
+ #
87
+ # @param type [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::Type] The event this payload describes.
88
+
89
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent#accounting_sync_record
90
+ class AccountingSyncRecord < Orb::Internal::Type::BaseModel
91
+ # @!attribute id
92
+ #
93
+ # @return [String]
94
+ required :id, String
95
+
96
+ # @!attribute customer_id
97
+ #
98
+ # @return [String]
99
+ required :customer_id, String
100
+
101
+ # @!attribute record_type
102
+ #
103
+ # @return [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType]
104
+ required :record_type,
105
+ enum: -> { Orb::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType }
106
+
107
+ # @!attribute error_details
108
+ #
109
+ # @return [Hash{Symbol=>Object}, nil]
110
+ optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
111
+
112
+ # @!attribute provider_customer_id
113
+ #
114
+ # @return [String, nil]
115
+ optional :provider_customer_id, String, nil?: true
116
+
117
+ # @!attribute status
118
+ #
119
+ # @return [String, nil]
120
+ optional :status, String, nil?: true
121
+
122
+ # @!attribute sync_action
123
+ #
124
+ # @return [String, nil]
125
+ optional :sync_action, String, nil?: true
126
+
127
+ # @!method initialize(id:, customer_id:, record_type:, error_details: nil, provider_customer_id: nil, status: nil, sync_action: nil)
128
+ # @param id [String]
129
+ # @param customer_id [String]
130
+ # @param record_type [Symbol, Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType]
131
+ # @param error_details [Hash{Symbol=>Object}, nil]
132
+ # @param provider_customer_id [String, nil]
133
+ # @param status [String, nil]
134
+ # @param sync_action [String, nil]
135
+
136
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord#record_type
137
+ module RecordType
138
+ extend Orb::Internal::Type::Enum
139
+
140
+ CUSTOMER = :customer
141
+ INVOICE = :invoice
142
+ TRANSACTION = :transaction
143
+ CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
144
+ CREDIT_NOTE = :credit_note
145
+ SUBSCRIPTION = :subscription
146
+ SALES_ORDER = :sales_order
147
+ BLOCK = :block
148
+
149
+ # @!method self.values
150
+ # @return [Array<Symbol>]
151
+ end
152
+ end
153
+
154
+ # The serialization style this payload was rendered in, as configured on the
155
+ # endpoint.
156
+ #
157
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent#payload_style
158
+ module PayloadStyle
159
+ extend Orb::Internal::Type::Enum
160
+
161
+ EXPANDED = :expanded
162
+ STANDARD = :standard
163
+
164
+ # @!method self.values
165
+ # @return [Array<Symbol>]
166
+ end
167
+
168
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent#properties
169
+ class Properties < Orb::Internal::Type::BaseModel
170
+ # @!attribute connection_type
171
+ #
172
+ # @return [String]
173
+ required :connection_type, String
174
+
175
+ # @!method initialize(connection_type:)
176
+ # @param connection_type [String]
177
+ end
178
+
179
+ # The event this payload describes.
180
+ #
181
+ # @see Orb::Models::Webhooks::CustomerAccountingSyncSucceededStandardWebhookEvent#type
182
+ module Type
183
+ extend Orb::Internal::Type::Enum
184
+
185
+ CUSTOMER_ACCOUNTING_SYNC_SUCCEEDED = :"customer.accounting_sync_succeeded"
186
+
187
+ # @!method self.values
188
+ # @return [Array<Symbol>]
189
+ end
190
+ end
191
+ end
192
+ end
193
+ end
@@ -0,0 +1,240 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class CustomerBalanceTransactionCreatedStandardWebhookEvent < Orb::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The ID of this webhook event.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute created_at
14
+ # The time at which this event was created, to the second.
15
+ #
16
+ # @return [Time]
17
+ required :created_at, Time
18
+
19
+ # @!attribute customer
20
+ # A customer is a buyer of your products, and the other party to the billing
21
+ # relationship.
22
+ #
23
+ # In Orb, customers are assigned system generated identifiers automatically, but
24
+ # it's often desirable to have these match existing identifiers in your system. To
25
+ # avoid having to denormalize Orb ID information, you can pass in an
26
+ # `external_customer_id` with your own identifier. See
27
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
28
+ # information about how these aliases work in Orb.
29
+ #
30
+ # In addition to having an identifier in your system, a customer may exist in a
31
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
32
+ # `payment_provider` enum field to express this mapping.
33
+ #
34
+ # A customer also has a timezone (from the standard
35
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
36
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
37
+ # information on what this timezone parameter influences within Orb.
38
+ #
39
+ # @return [Orb::Models::Customer]
40
+ required :customer, -> { Orb::Customer }
41
+
42
+ # @!attribute payload_style
43
+ # The serialization style this payload was rendered in, as configured on the
44
+ # endpoint.
45
+ #
46
+ # @return [Symbol, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::PayloadStyle]
47
+ required :payload_style,
48
+ enum: -> { Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::PayloadStyle }
49
+
50
+ # @!attribute properties
51
+ #
52
+ # @return [Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties]
53
+ required :properties,
54
+ -> { Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties }
55
+
56
+ # @!attribute type
57
+ # The event this payload describes.
58
+ #
59
+ # @return [Symbol, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Type]
60
+ required :type, enum: -> { Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Type }
61
+
62
+ # @!method initialize(id:, created_at:, customer:, payload_style:, properties:, type:)
63
+ # Some parameter documentations has been truncated, see
64
+ # {Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent}
65
+ # for more details.
66
+ #
67
+ # Issued when a customer balance transaction is created.
68
+ #
69
+ # @param id [String] The ID of this webhook event.
70
+ #
71
+ # @param created_at [Time] The time at which this event was created, to the second.
72
+ #
73
+ # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
74
+ #
75
+ # @param payload_style [Symbol, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
76
+ #
77
+ # @param properties [Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties]
78
+ #
79
+ # @param type [Symbol, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Type] The event this payload describes.
80
+
81
+ # The serialization style this payload was rendered in, as configured on the
82
+ # endpoint.
83
+ #
84
+ # @see Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent#payload_style
85
+ module PayloadStyle
86
+ extend Orb::Internal::Type::Enum
87
+
88
+ EXPANDED = :expanded
89
+ STANDARD = :standard
90
+
91
+ # @!method self.values
92
+ # @return [Array<Symbol>]
93
+ end
94
+
95
+ # @see Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent#properties
96
+ class Properties < Orb::Internal::Type::BaseModel
97
+ # @!attribute balance_transaction
98
+ #
99
+ # @return [Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction]
100
+ required :balance_transaction,
101
+ -> { Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction }
102
+
103
+ # @!method initialize(balance_transaction:)
104
+ # @param balance_transaction [Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction]
105
+
106
+ # @see Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties#balance_transaction
107
+ class BalanceTransaction < Orb::Internal::Type::BaseModel
108
+ # @!attribute id
109
+ # A unique id for this transaction.
110
+ #
111
+ # @return [String]
112
+ required :id, String
113
+
114
+ # @!attribute action
115
+ #
116
+ # @return [Symbol, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction::Action]
117
+ required :action,
118
+ enum: -> { Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction::Action }
119
+
120
+ # @!attribute amount
121
+ # The value of the amount changed in the transaction.
122
+ #
123
+ # @return [String]
124
+ required :amount, String
125
+
126
+ # @!attribute created_at
127
+ # The creation time of this transaction.
128
+ #
129
+ # @return [Time]
130
+ required :created_at, Time
131
+
132
+ # @!attribute credit_note
133
+ #
134
+ # @return [Orb::Models::CreditNoteTiny, nil]
135
+ required :credit_note, -> { Orb::CreditNoteTiny }, nil?: true
136
+
137
+ # @!attribute description
138
+ # An optional description provided for manual customer balance adjustments.
139
+ #
140
+ # @return [String, nil]
141
+ required :description, String, nil?: true
142
+
143
+ # @!attribute ending_balance
144
+ # The new value of the customer's balance prior to the transaction, in the
145
+ # customer's currency.
146
+ #
147
+ # @return [String]
148
+ required :ending_balance, String
149
+
150
+ # @!attribute invoice
151
+ #
152
+ # @return [Orb::Models::InvoiceTiny, nil]
153
+ required :invoice, -> { Orb::InvoiceTiny }, nil?: true
154
+
155
+ # @!attribute starting_balance
156
+ # The original value of the customer's balance prior to the transaction, in the
157
+ # customer's currency.
158
+ #
159
+ # @return [String]
160
+ required :starting_balance, String
161
+
162
+ # @!attribute type
163
+ #
164
+ # @return [Symbol, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction::Type]
165
+ required :type,
166
+ enum: -> { Orb::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction::Type }
167
+
168
+ # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
169
+ # Some parameter documentations has been truncated, see
170
+ # {Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction}
171
+ # for more details.
172
+ #
173
+ # @param id [String] A unique id for this transaction.
174
+ #
175
+ # @param action [Symbol, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction::Action]
176
+ #
177
+ # @param amount [String] The value of the amount changed in the transaction.
178
+ #
179
+ # @param created_at [Time] The creation time of this transaction.
180
+ #
181
+ # @param credit_note [Orb::Models::CreditNoteTiny, nil]
182
+ #
183
+ # @param description [String, nil] An optional description provided for manual customer balance adjustments.
184
+ #
185
+ # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
186
+ #
187
+ # @param invoice [Orb::Models::InvoiceTiny, nil]
188
+ #
189
+ # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
190
+ #
191
+ # @param type [Symbol, Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction::Type]
192
+
193
+ # @see Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction#action
194
+ module Action
195
+ extend Orb::Internal::Type::Enum
196
+
197
+ APPLIED_TO_INVOICE = :applied_to_invoice
198
+ MANUAL_ADJUSTMENT = :manual_adjustment
199
+ PRORATED_REFUND = :prorated_refund
200
+ REVERT_PRORATED_REFUND = :revert_prorated_refund
201
+ RETURN_FROM_VOIDING = :return_from_voiding
202
+ CREDIT_NOTE_APPLIED = :credit_note_applied
203
+ CREDIT_NOTE_VOIDED = :credit_note_voided
204
+ OVERPAYMENT_REFUND = :overpayment_refund
205
+ EXTERNAL_PAYMENT = :external_payment
206
+ SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
207
+ PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
208
+
209
+ # @!method self.values
210
+ # @return [Array<Symbol>]
211
+ end
212
+
213
+ # @see Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent::Properties::BalanceTransaction#type
214
+ module Type
215
+ extend Orb::Internal::Type::Enum
216
+
217
+ INCREMENT = :increment
218
+ DECREMENT = :decrement
219
+
220
+ # @!method self.values
221
+ # @return [Array<Symbol>]
222
+ end
223
+ end
224
+ end
225
+
226
+ # The event this payload describes.
227
+ #
228
+ # @see Orb::Models::Webhooks::CustomerBalanceTransactionCreatedStandardWebhookEvent#type
229
+ module Type
230
+ extend Orb::Internal::Type::Enum
231
+
232
+ CUSTOMER_BALANCE_TRANSACTION_CREATED = :"customer.balance_transaction_created"
233
+
234
+ # @!method self.values
235
+ # @return [Array<Symbol>]
236
+ end
237
+ end
238
+ end
239
+ end
240
+ end