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,974 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class SalesOrderAccountingSyncFailedStandardWebhookEvent < 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::SalesOrderAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord]
16
+ required :accounting_sync_record,
17
+ -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::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 invoice
26
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
27
+ # Fetch the invoice for those.
28
+ #
29
+ # @return [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice]
30
+ required :invoice, -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice }
31
+
32
+ # @!attribute payload_style
33
+ # The serialization style this payload was rendered in, as configured on the
34
+ # endpoint.
35
+ #
36
+ # @return [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::PayloadStyle]
37
+ required :payload_style,
38
+ enum: -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::PayloadStyle }
39
+
40
+ # @!attribute properties
41
+ #
42
+ # @return [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Properties]
43
+ required :properties, -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Properties }
44
+
45
+ # @!attribute type
46
+ # The event this payload describes.
47
+ #
48
+ # @return [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Type]
49
+ required :type, enum: -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Type }
50
+
51
+ # @!method initialize(id:, accounting_sync_record:, created_at:, invoice:, payload_style:, properties:, type:)
52
+ # Some parameter documentations has been truncated, see
53
+ # {Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent} for
54
+ # more details.
55
+ #
56
+ # Issued when a sales order accounting sync fails.
57
+ #
58
+ # @param id [String] The ID of this webhook event.
59
+ #
60
+ # @param accounting_sync_record [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord]
61
+ #
62
+ # @param created_at [Time] The time at which this event was created, to the second.
63
+ #
64
+ # @param invoice [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice] An invoice without its line items, subtotal, discounts, minimums or maximums. Fe
65
+ #
66
+ # @param payload_style [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::PayloadStyle] The serialization style this payload was rendered in, as configured on the endpo
67
+ #
68
+ # @param properties [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Properties]
69
+ #
70
+ # @param type [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Type] The event this payload describes.
71
+
72
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent#accounting_sync_record
73
+ class AccountingSyncRecord < Orb::Internal::Type::BaseModel
74
+ # @!attribute id
75
+ #
76
+ # @return [String]
77
+ required :id, String
78
+
79
+ # @!attribute customer_id
80
+ #
81
+ # @return [String]
82
+ required :customer_id, String
83
+
84
+ # @!attribute record_type
85
+ #
86
+ # @return [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord::RecordType]
87
+ required :record_type,
88
+ enum: -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord::RecordType }
89
+
90
+ # @!attribute error_details
91
+ #
92
+ # @return [Hash{Symbol=>Object}, nil]
93
+ optional :error_details, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown], nil?: true
94
+
95
+ # @!attribute invoice_id
96
+ #
97
+ # @return [String, nil]
98
+ optional :invoice_id, String, nil?: true
99
+
100
+ # @!attribute provider_customer_id
101
+ #
102
+ # @return [String, nil]
103
+ optional :provider_customer_id, String, nil?: true
104
+
105
+ # @!attribute status
106
+ #
107
+ # @return [String, nil]
108
+ optional :status, String, nil?: true
109
+
110
+ # @!attribute sync_action
111
+ #
112
+ # @return [String, nil]
113
+ optional :sync_action, String, nil?: true
114
+
115
+ # @!method initialize(id:, customer_id:, record_type:, error_details: nil, invoice_id: nil, provider_customer_id: nil, status: nil, sync_action: nil)
116
+ # @param id [String]
117
+ # @param customer_id [String]
118
+ # @param record_type [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord::RecordType]
119
+ # @param error_details [Hash{Symbol=>Object}, nil]
120
+ # @param invoice_id [String, nil]
121
+ # @param provider_customer_id [String, nil]
122
+ # @param status [String, nil]
123
+ # @param sync_action [String, nil]
124
+
125
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::AccountingSyncRecord#record_type
126
+ module RecordType
127
+ extend Orb::Internal::Type::Enum
128
+
129
+ CUSTOMER = :customer
130
+ INVOICE = :invoice
131
+ TRANSACTION = :transaction
132
+ CUSTOMER_BALANCE_TRANSACTION = :customer_balance_transaction
133
+ CREDIT_NOTE = :credit_note
134
+ SUBSCRIPTION = :subscription
135
+ SALES_ORDER = :sales_order
136
+ BLOCK = :block
137
+
138
+ # @!method self.values
139
+ # @return [Array<Symbol>]
140
+ end
141
+ end
142
+
143
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent#invoice
144
+ class Invoice < Orb::Internal::Type::BaseModel
145
+ # @!attribute id
146
+ #
147
+ # @return [String]
148
+ required :id, String
149
+
150
+ # @!attribute amount_due
151
+ # This is the final amount required to be charged to the customer and reflects the
152
+ # application of the customer balance to the `total` of the invoice.
153
+ #
154
+ # @return [String]
155
+ required :amount_due, String
156
+
157
+ # @!attribute auto_collection
158
+ #
159
+ # @return [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::AutoCollection]
160
+ required :auto_collection,
161
+ -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::AutoCollection }
162
+
163
+ # @!attribute billing_address
164
+ #
165
+ # @return [Orb::Models::Address, nil]
166
+ required :billing_address, -> { Orb::Address }, nil?: true
167
+
168
+ # @!attribute created_at
169
+ # The creation time of the resource in Orb.
170
+ #
171
+ # @return [Time]
172
+ required :created_at, Time
173
+
174
+ # @!attribute credit_notes
175
+ # A list of credit notes associated with the invoice
176
+ #
177
+ # @return [Array<Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CreditNote>]
178
+ required :credit_notes,
179
+ -> { Orb::Internal::Type::ArrayOf[Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CreditNote] }
180
+
181
+ # @!attribute currency
182
+ # An ISO 4217 currency string or `credits`
183
+ #
184
+ # @return [String]
185
+ required :currency, String
186
+
187
+ # @!attribute customer
188
+ #
189
+ # @return [Orb::Models::CustomerMinified]
190
+ required :customer, -> { Orb::CustomerMinified }
191
+
192
+ # @!attribute customer_balance_transactions
193
+ #
194
+ # @return [Array<Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction>]
195
+ required :customer_balance_transactions,
196
+ -> { Orb::Internal::Type::ArrayOf[Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction] }
197
+
198
+ # @!attribute customer_tax_id
199
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
200
+ # added to the headers of invoices.
201
+ #
202
+ # ### Supported Tax ID Countries and Types
203
+ #
204
+ # | Country | Type | Description |
205
+ # | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
206
+ # | Albania | `al_tin` | Albania Tax Identification Number |
207
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
208
+ # | Angola | `ao_tin` | Angola Tax Identification Number |
209
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
210
+ # | Armenia | `am_tin` | Armenia Tax Identification Number |
211
+ # | Aruba | `aw_tin` | Aruba Tax Identification Number |
212
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
213
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
214
+ # | Austria | `eu_vat` | European VAT Number |
215
+ # | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
216
+ # | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
217
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
218
+ # | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
219
+ # | Barbados | `bb_tin` | Barbados Tax Identification Number |
220
+ # | Belarus | `by_tin` | Belarus TIN Number |
221
+ # | Belgium | `eu_vat` | European VAT Number |
222
+ # | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
223
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
224
+ # | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
225
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
226
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
227
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
228
+ # | Bulgaria | `eu_vat` | European VAT Number |
229
+ # | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
230
+ # | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
231
+ # | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
232
+ # | Canada | `ca_bn` | Canadian BN |
233
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
234
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
235
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
236
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
237
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
238
+ # | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
239
+ # | Chile | `cl_tin` | Chilean TIN |
240
+ # | China | `cn_tin` | Chinese Tax ID |
241
+ # | Colombia | `co_nit` | Colombian NIT Number |
242
+ # | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
243
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
244
+ # | Croatia | `eu_vat` | European VAT Number |
245
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
246
+ # | Cyprus | `eu_vat` | European VAT Number |
247
+ # | Czech Republic | `eu_vat` | European VAT Number |
248
+ # | Denmark | `eu_vat` | European VAT Number |
249
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
250
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
251
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
252
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
253
+ # | Estonia | `eu_vat` | European VAT Number |
254
+ # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
255
+ # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
256
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
257
+ # | Finland | `eu_vat` | European VAT Number |
258
+ # | France | `eu_vat` | European VAT Number |
259
+ # | Georgia | `ge_vat` | Georgian VAT |
260
+ # | Germany | `de_stn` | German Tax Number (Steuernummer) |
261
+ # | Germany | `eu_vat` | European VAT Number |
262
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
263
+ # | Greece | `eu_vat` | European VAT Number |
264
+ # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
265
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
266
+ # | Hungary | `eu_vat` | European VAT Number |
267
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
268
+ # | Iceland | `is_vat` | Icelandic VAT |
269
+ # | India | `in_gst` | Indian GST Number |
270
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
271
+ # | Ireland | `eu_vat` | European VAT Number |
272
+ # | Israel | `il_vat` | Israel VAT |
273
+ # | Italy | `eu_vat` | European VAT Number |
274
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
275
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
276
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
277
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
278
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
279
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
280
+ # | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
281
+ # | Laos | `la_tin` | Laos Tax Identification Number |
282
+ # | Latvia | `eu_vat` | European VAT Number |
283
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
284
+ # | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
285
+ # | Lithuania | `eu_vat` | European VAT Number |
286
+ # | Luxembourg | `eu_vat` | European VAT Number |
287
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
288
+ # | Malaysia | `my_itn` | Malaysian ITN |
289
+ # | Malaysia | `my_sst` | Malaysian SST Number |
290
+ # | Malta | `eu_vat` | European VAT Number |
291
+ # | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
292
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
293
+ # | Moldova | `md_vat` | Moldova VAT Number |
294
+ # | Montenegro | `me_pib` | Montenegro PIB Number |
295
+ # | Morocco | `ma_vat` | Morocco VAT Number |
296
+ # | Nepal | `np_pan` | Nepal PAN Number |
297
+ # | Netherlands | `eu_vat` | European VAT Number |
298
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
299
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
300
+ # | North Macedonia | `mk_vat` | North Macedonia VAT Number |
301
+ # | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
302
+ # | Norway | `no_vat` | Norwegian VAT Number |
303
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
304
+ # | Oman | `om_vat` | Omani VAT Number |
305
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
306
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
307
+ # | Philippines | `ph_tin` | Philippines Tax Identification Number |
308
+ # | Poland | `eu_vat` | European VAT Number |
309
+ # | Poland | `pl_nip` | Polish Tax ID Number |
310
+ # | Portugal | `eu_vat` | European VAT Number |
311
+ # | Romania | `eu_vat` | European VAT Number |
312
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
313
+ # | Russia | `ru_inn` | Russian INN |
314
+ # | Russia | `ru_kpp` | Russian KPP |
315
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
316
+ # | Senegal | `sn_ninea` | Senegal NINEA Number |
317
+ # | Serbia | `rs_pib` | Serbian PIB Number |
318
+ # | Singapore | `sg_gst` | Singaporean GST |
319
+ # | Singapore | `sg_uen` | Singaporean UEN |
320
+ # | Slovakia | `eu_vat` | European VAT Number |
321
+ # | Slovenia | `eu_vat` | European VAT Number |
322
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
323
+ # | South Africa | `za_vat` | South African VAT Number |
324
+ # | South Korea | `kr_brn` | Korean BRN |
325
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
326
+ # | Spain | `eu_vat` | European VAT Number |
327
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
328
+ # | Suriname | `sr_fin` | Suriname FIN Number |
329
+ # | Sweden | `eu_vat` | European VAT Number |
330
+ # | Switzerland | `ch_uid` | Switzerland UID Number |
331
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
332
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
333
+ # | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
334
+ # | Tanzania | `tz_vat` | Tanzania VAT Number |
335
+ # | Thailand | `th_vat` | Thai VAT |
336
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
337
+ # | Uganda | `ug_tin` | Uganda Tax Identification Number |
338
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
339
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
340
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
341
+ # | United States | `us_ein` | United States EIN |
342
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
343
+ # | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
344
+ # | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
345
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
346
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
347
+ # | Zambia | `zm_tin` | Zambia Tax Identification Number |
348
+ # | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
349
+ #
350
+ # @return [Orb::Models::CustomerTaxID, nil]
351
+ required :customer_tax_id, -> { Orb::CustomerTaxID }, nil?: true
352
+
353
+ # @!attribute due_date
354
+ # When the invoice payment is due. The due date is null if the invoice is not yet
355
+ # finalized.
356
+ #
357
+ # @return [Time, nil]
358
+ required :due_date, Time, nil?: true
359
+
360
+ # @!attribute eligible_to_issue_at
361
+ # If the invoice has a status of `draft`, this will be the time that the invoice
362
+ # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
363
+ # true, the invoice will automatically begin issuing at this time.
364
+ #
365
+ # @return [Time, nil]
366
+ required :eligible_to_issue_at, Time, nil?: true
367
+
368
+ # @!attribute hosted_invoice_url
369
+ # A URL for the customer-facing invoice portal. This URL expires 60 days after the
370
+ # link is generated, or 30 days after the invoice's due date — whichever is later.
371
+ #
372
+ # @return [String, nil]
373
+ required :hosted_invoice_url, String, nil?: true
374
+
375
+ # @!attribute invoice_date
376
+ # The scheduled date of the invoice
377
+ #
378
+ # @return [Time]
379
+ required :invoice_date, Time
380
+
381
+ # @!attribute invoice_number
382
+ # Automatically generated invoice number to help track and reconcile invoices.
383
+ # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
384
+ # account or customer.
385
+ #
386
+ # @return [String]
387
+ required :invoice_number, String
388
+
389
+ # @!attribute invoice_pdf
390
+ # The link to download the PDF representation of the `Invoice`.
391
+ #
392
+ # @return [String, nil]
393
+ required :invoice_pdf, String, nil?: true
394
+
395
+ # @!attribute invoice_source
396
+ #
397
+ # @return [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::InvoiceSource]
398
+ required :invoice_source,
399
+ enum: -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::InvoiceSource }
400
+
401
+ # @!attribute issue_failed_at
402
+ # If the invoice failed to issue, this will be the last time it failed to issue
403
+ # (even if it is now in a different state.)
404
+ #
405
+ # @return [Time, nil]
406
+ required :issue_failed_at, Time, nil?: true
407
+
408
+ # @!attribute issued_at
409
+ # If the invoice has been issued, this will be the time it transitioned to
410
+ # `issued` (even if it is now in a different state.)
411
+ #
412
+ # @return [Time, nil]
413
+ required :issued_at, Time, nil?: true
414
+
415
+ # @!attribute memo
416
+ # Free-form text which is available on the invoice PDF and the Orb invoice portal.
417
+ #
418
+ # @return [String, nil]
419
+ required :memo, String, nil?: true
420
+
421
+ # @!attribute metadata
422
+ # User specified key-value pairs for the resource. If not present, this defaults
423
+ # to an empty dictionary. Individual keys can be removed by setting the value to
424
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
425
+ # `null`.
426
+ #
427
+ # @return [Hash{Symbol=>String}]
428
+ required :metadata, Orb::Internal::Type::HashOf[String]
429
+
430
+ # @!attribute paid_at
431
+ # If the invoice has a status of `paid`, this gives a timestamp when the invoice
432
+ # was paid.
433
+ #
434
+ # @return [Time, nil]
435
+ required :paid_at, Time, nil?: true
436
+
437
+ # @!attribute payment_attempts
438
+ # A list of payment attempts associated with the invoice
439
+ #
440
+ # @return [Array<Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::PaymentAttempt>]
441
+ required :payment_attempts,
442
+ -> { Orb::Internal::Type::ArrayOf[Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::PaymentAttempt] }
443
+
444
+ # @!attribute payment_failed_at
445
+ # If payment was attempted on this invoice but failed, this will be the time of
446
+ # the most recent attempt.
447
+ #
448
+ # @return [Time, nil]
449
+ required :payment_failed_at, Time, nil?: true
450
+
451
+ # @!attribute payment_received_at
452
+ # When payment for this invoice was received. For an invoice manually marked as
453
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
454
+ # through a payment provider, this is the settlement time reported by that
455
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
456
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
457
+ # when the invoice reached the `paid` status in Orb.
458
+ #
459
+ # @return [Time, nil]
460
+ required :payment_received_at, Time, nil?: true
461
+
462
+ # @!attribute payment_started_at
463
+ # If payment was attempted on this invoice, this will be the start time of the
464
+ # most recent attempt. This field is especially useful for delayed-notification
465
+ # payment mechanisms (like bank transfers), where payment can take 3 days or more.
466
+ #
467
+ # @return [Time, nil]
468
+ required :payment_started_at, Time, nil?: true
469
+
470
+ # @!attribute scheduled_issue_at
471
+ # If the invoice is in draft, this timestamp will reflect when the invoice is
472
+ # scheduled to be issued.
473
+ #
474
+ # @return [Time, nil]
475
+ required :scheduled_issue_at, Time, nil?: true
476
+
477
+ # @!attribute shipping_address
478
+ #
479
+ # @return [Orb::Models::Address, nil]
480
+ required :shipping_address, -> { Orb::Address }, nil?: true
481
+
482
+ # @!attribute status
483
+ #
484
+ # @return [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::Status]
485
+ required :status,
486
+ enum: -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::Status }
487
+
488
+ # @!attribute subscription
489
+ #
490
+ # @return [Orb::Models::SubscriptionMinified, nil]
491
+ required :subscription, -> { Orb::SubscriptionMinified }, nil?: true
492
+
493
+ # @!attribute sync_failed_at
494
+ # If the invoice failed to sync, this will be the last time an external invoicing
495
+ # provider sync was attempted. This field will always be `null` for invoices using
496
+ # Orb Invoicing.
497
+ #
498
+ # @return [Time, nil]
499
+ required :sync_failed_at, Time, nil?: true
500
+
501
+ # @!attribute total
502
+ # The total after any minimums and discounts have been applied.
503
+ #
504
+ # @return [String]
505
+ required :total, String
506
+
507
+ # @!attribute voided_at
508
+ # If the invoice has a status of `void`, this gives a timestamp when the invoice
509
+ # was voided.
510
+ #
511
+ # @return [Time, nil]
512
+ required :voided_at, Time, nil?: true
513
+
514
+ # @!attribute will_auto_issue
515
+ # This is true if the invoice will be automatically issued in the future, and
516
+ # false otherwise.
517
+ #
518
+ # @return [Boolean]
519
+ required :will_auto_issue, Orb::Internal::Type::Boolean
520
+
521
+ # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, memo:, metadata:, paid_at:, payment_attempts:, payment_failed_at:, payment_received_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
522
+ # Some parameter documentations has been truncated, see
523
+ # {Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice}
524
+ # for more details.
525
+ #
526
+ # An invoice without its line items, subtotal, discounts, minimums or maximums.
527
+ # Fetch the invoice for those.
528
+ #
529
+ # @param id [String]
530
+ #
531
+ # @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
532
+ #
533
+ # @param auto_collection [Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::AutoCollection]
534
+ #
535
+ # @param billing_address [Orb::Models::Address, nil]
536
+ #
537
+ # @param created_at [Time] The creation time of the resource in Orb.
538
+ #
539
+ # @param credit_notes [Array<Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CreditNote>] A list of credit notes associated with the invoice
540
+ #
541
+ # @param currency [String] An ISO 4217 currency string or `credits`
542
+ #
543
+ # @param customer [Orb::Models::CustomerMinified]
544
+ #
545
+ # @param customer_balance_transactions [Array<Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction>]
546
+ #
547
+ # @param customer_tax_id [Orb::Models::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
548
+ #
549
+ # @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
550
+ #
551
+ # @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
552
+ #
553
+ # @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 60 days after the
554
+ #
555
+ # @param invoice_date [Time] The scheduled date of the invoice
556
+ #
557
+ # @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv
558
+ #
559
+ # @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
560
+ #
561
+ # @param invoice_source [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::InvoiceSource]
562
+ #
563
+ # @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
564
+ #
565
+ # @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
566
+ #
567
+ # @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
568
+ #
569
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
570
+ #
571
+ # @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
572
+ #
573
+ # @param payment_attempts [Array<Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::PaymentAttempt>] A list of payment attempts associated with the invoice
574
+ #
575
+ # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
576
+ #
577
+ # @param payment_received_at [Time, nil] When payment for this invoice was received. For an invoice manually marked as pa
578
+ #
579
+ # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
580
+ #
581
+ # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
582
+ #
583
+ # @param shipping_address [Orb::Models::Address, nil]
584
+ #
585
+ # @param status [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::Status]
586
+ #
587
+ # @param subscription [Orb::Models::SubscriptionMinified, nil]
588
+ #
589
+ # @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing
590
+ #
591
+ # @param total [String] The total after any minimums and discounts have been applied.
592
+ #
593
+ # @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w
594
+ #
595
+ # @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
596
+
597
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice#auto_collection
598
+ class AutoCollection < Orb::Internal::Type::BaseModel
599
+ # @!attribute enabled
600
+ # True only if auto-collection is enabled for this invoice.
601
+ #
602
+ # @return [Boolean, nil]
603
+ required :enabled, Orb::Internal::Type::Boolean, nil?: true
604
+
605
+ # @!attribute next_attempt_at
606
+ # If the invoice is scheduled for auto-collection, this field will reflect when
607
+ # the next attempt will occur. If dunning has been exhausted, or auto-collection
608
+ # is not enabled for this invoice, this field will be `null`.
609
+ #
610
+ # @return [Time, nil]
611
+ required :next_attempt_at, Time, nil?: true
612
+
613
+ # @!attribute num_attempts
614
+ # Number of auto-collection payment attempts.
615
+ #
616
+ # @return [Integer, nil]
617
+ required :num_attempts, Integer, nil?: true
618
+
619
+ # @!attribute previously_attempted_at
620
+ # If Orb has ever attempted payment auto-collection for this invoice, this field
621
+ # will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
622
+ # this can be used to tell whether the invoice is currently in dunning (that is,
623
+ # `previously_attempted_at` is non-null, and `next_attempt_at` is non-null), or if
624
+ # dunning has been exhausted (`previously_attempted_at` is non-null, but
625
+ # `next_attempt_at` is null).
626
+ #
627
+ # @return [Time, nil]
628
+ required :previously_attempted_at, Time, nil?: true
629
+
630
+ # @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
631
+ # Some parameter documentations has been truncated, see
632
+ # {Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::AutoCollection}
633
+ # for more details.
634
+ #
635
+ # @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
636
+ #
637
+ # @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th
638
+ #
639
+ # @param num_attempts [Integer, nil] Number of auto-collection payment attempts.
640
+ #
641
+ # @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
642
+ end
643
+
644
+ class CreditNote < Orb::Internal::Type::BaseModel
645
+ # @!attribute id
646
+ #
647
+ # @return [String]
648
+ required :id, String
649
+
650
+ # @!attribute credit_note_number
651
+ #
652
+ # @return [String]
653
+ required :credit_note_number, String
654
+
655
+ # @!attribute memo
656
+ # An optional memo supplied on the credit note.
657
+ #
658
+ # @return [String, nil]
659
+ required :memo, String, nil?: true
660
+
661
+ # @!attribute reason
662
+ #
663
+ # @return [String]
664
+ required :reason, String
665
+
666
+ # @!attribute total
667
+ #
668
+ # @return [String]
669
+ required :total, String
670
+
671
+ # @!attribute type
672
+ #
673
+ # @return [String]
674
+ required :type, String
675
+
676
+ # @!attribute voided_at
677
+ # If the credit note has a status of `void`, this gives a timestamp when the
678
+ # credit note was voided.
679
+ #
680
+ # @return [Time, nil]
681
+ required :voided_at, Time, nil?: true
682
+
683
+ # @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
684
+ # Some parameter documentations has been truncated, see
685
+ # {Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CreditNote}
686
+ # for more details.
687
+ #
688
+ # @param id [String]
689
+ #
690
+ # @param credit_note_number [String]
691
+ #
692
+ # @param memo [String, nil] An optional memo supplied on the credit note.
693
+ #
694
+ # @param reason [String]
695
+ #
696
+ # @param total [String]
697
+ #
698
+ # @param type [String]
699
+ #
700
+ # @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
701
+ end
702
+
703
+ class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
704
+ # @!attribute id
705
+ # A unique id for this transaction.
706
+ #
707
+ # @return [String]
708
+ required :id, String
709
+
710
+ # @!attribute action
711
+ #
712
+ # @return [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action]
713
+ required :action,
714
+ enum: -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action }
715
+
716
+ # @!attribute amount
717
+ # The value of the amount changed in the transaction.
718
+ #
719
+ # @return [String]
720
+ required :amount, String
721
+
722
+ # @!attribute created_at
723
+ # The creation time of this transaction.
724
+ #
725
+ # @return [Time]
726
+ required :created_at, Time
727
+
728
+ # @!attribute credit_note
729
+ #
730
+ # @return [Orb::Models::CreditNoteTiny, nil]
731
+ required :credit_note, -> { Orb::CreditNoteTiny }, nil?: true
732
+
733
+ # @!attribute description
734
+ # An optional description provided for manual customer balance adjustments.
735
+ #
736
+ # @return [String, nil]
737
+ required :description, String, nil?: true
738
+
739
+ # @!attribute ending_balance
740
+ # The new value of the customer's balance prior to the transaction, in the
741
+ # customer's currency.
742
+ #
743
+ # @return [String]
744
+ required :ending_balance, String
745
+
746
+ # @!attribute invoice
747
+ #
748
+ # @return [Orb::Models::InvoiceTiny, nil]
749
+ required :invoice, -> { Orb::InvoiceTiny }, nil?: true
750
+
751
+ # @!attribute starting_balance
752
+ # The original value of the customer's balance prior to the transaction, in the
753
+ # customer's currency.
754
+ #
755
+ # @return [String]
756
+ required :starting_balance, String
757
+
758
+ # @!attribute type
759
+ #
760
+ # @return [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type]
761
+ required :type,
762
+ enum: -> { Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type }
763
+
764
+ # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
765
+ # Some parameter documentations has been truncated, see
766
+ # {Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction}
767
+ # for more details.
768
+ #
769
+ # @param id [String] A unique id for this transaction.
770
+ #
771
+ # @param action [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action]
772
+ #
773
+ # @param amount [String] The value of the amount changed in the transaction.
774
+ #
775
+ # @param created_at [Time] The creation time of this transaction.
776
+ #
777
+ # @param credit_note [Orb::Models::CreditNoteTiny, nil]
778
+ #
779
+ # @param description [String, nil] An optional description provided for manual customer balance adjustments.
780
+ #
781
+ # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
782
+ #
783
+ # @param invoice [Orb::Models::InvoiceTiny, nil]
784
+ #
785
+ # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
786
+ #
787
+ # @param type [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type]
788
+
789
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction#action
790
+ module Action
791
+ extend Orb::Internal::Type::Enum
792
+
793
+ APPLIED_TO_INVOICE = :applied_to_invoice
794
+ MANUAL_ADJUSTMENT = :manual_adjustment
795
+ PRORATED_REFUND = :prorated_refund
796
+ REVERT_PRORATED_REFUND = :revert_prorated_refund
797
+ RETURN_FROM_VOIDING = :return_from_voiding
798
+ CREDIT_NOTE_APPLIED = :credit_note_applied
799
+ CREDIT_NOTE_VOIDED = :credit_note_voided
800
+ OVERPAYMENT_REFUND = :overpayment_refund
801
+ EXTERNAL_PAYMENT = :external_payment
802
+ SMALL_INVOICE_CARRYOVER = :small_invoice_carryover
803
+ PREPAID_COMMIT_CANCEL = :prepaid_commit_cancel
804
+
805
+ # @!method self.values
806
+ # @return [Array<Symbol>]
807
+ end
808
+
809
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::CustomerBalanceTransaction#type
810
+ module Type
811
+ extend Orb::Internal::Type::Enum
812
+
813
+ INCREMENT = :increment
814
+ DECREMENT = :decrement
815
+
816
+ # @!method self.values
817
+ # @return [Array<Symbol>]
818
+ end
819
+ end
820
+
821
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice#invoice_source
822
+ module InvoiceSource
823
+ extend Orb::Internal::Type::Enum
824
+
825
+ SUBSCRIPTION = :subscription
826
+ PARTIAL = :partial
827
+ ONE_OFF = :one_off
828
+
829
+ # @!method self.values
830
+ # @return [Array<Symbol>]
831
+ end
832
+
833
+ class PaymentAttempt < Orb::Internal::Type::BaseModel
834
+ # @!attribute id
835
+ # The ID of the payment attempt.
836
+ #
837
+ # @return [String]
838
+ required :id, String
839
+
840
+ # @!attribute amount
841
+ # The amount of the payment attempt.
842
+ #
843
+ # @return [String]
844
+ required :amount, String
845
+
846
+ # @!attribute created_at
847
+ # The time at which the payment attempt was created.
848
+ #
849
+ # @return [Time]
850
+ required :created_at, Time
851
+
852
+ # @!attribute payment_provider
853
+ # The payment provider that attempted to collect the payment.
854
+ #
855
+ # @return [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider, nil]
856
+ required :payment_provider,
857
+ enum: -> {
858
+ Orb::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider
859
+ },
860
+ nil?: true
861
+
862
+ # @!attribute payment_provider_id
863
+ # The ID of the payment attempt in the payment provider.
864
+ #
865
+ # @return [String, nil]
866
+ required :payment_provider_id, String, nil?: true
867
+
868
+ # @!attribute receipt_pdf
869
+ # URL to the downloadable PDF version of the receipt. This field will be `null`
870
+ # for payment attempts that did not succeed.
871
+ #
872
+ # @return [String, nil]
873
+ required :receipt_pdf, String, nil?: true
874
+
875
+ # @!attribute succeeded
876
+ # Whether the payment attempt succeeded.
877
+ #
878
+ # @return [Boolean]
879
+ required :succeeded, Orb::Internal::Type::Boolean
880
+
881
+ # @!method initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, receipt_pdf:, succeeded:)
882
+ # Some parameter documentations has been truncated, see
883
+ # {Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::PaymentAttempt}
884
+ # for more details.
885
+ #
886
+ # @param id [String] The ID of the payment attempt.
887
+ #
888
+ # @param amount [String] The amount of the payment attempt.
889
+ #
890
+ # @param created_at [Time] The time at which the payment attempt was created.
891
+ #
892
+ # @param payment_provider [Symbol, Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
893
+ #
894
+ # @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider.
895
+ #
896
+ # @param receipt_pdf [String, nil] URL to the downloadable PDF version of the receipt. This field will be `null` fo
897
+ #
898
+ # @param succeeded [Boolean] Whether the payment attempt succeeded.
899
+
900
+ # The payment provider that attempted to collect the payment.
901
+ #
902
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice::PaymentAttempt#payment_provider
903
+ module PaymentProvider
904
+ extend Orb::Internal::Type::Enum
905
+
906
+ STRIPE = :stripe
907
+ ADYEN = :adyen
908
+
909
+ # @!method self.values
910
+ # @return [Array<Symbol>]
911
+ end
912
+ end
913
+
914
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent::Invoice#status
915
+ module Status
916
+ extend Orb::Internal::Type::Enum
917
+
918
+ ISSUED = :issued
919
+ PAID = :paid
920
+ SYNCED = :synced
921
+ VOID = :void
922
+ DRAFT = :draft
923
+
924
+ # @!method self.values
925
+ # @return [Array<Symbol>]
926
+ end
927
+ end
928
+
929
+ # The serialization style this payload was rendered in, as configured on the
930
+ # endpoint.
931
+ #
932
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent#payload_style
933
+ module PayloadStyle
934
+ extend Orb::Internal::Type::Enum
935
+
936
+ EXPANDED = :expanded
937
+ STANDARD = :standard
938
+
939
+ # @!method self.values
940
+ # @return [Array<Symbol>]
941
+ end
942
+
943
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent#properties
944
+ class Properties < Orb::Internal::Type::BaseModel
945
+ # @!attribute connection_type
946
+ #
947
+ # @return [String]
948
+ required :connection_type, String
949
+
950
+ # @!attribute failure_reason
951
+ #
952
+ # @return [String]
953
+ required :failure_reason, String
954
+
955
+ # @!method initialize(connection_type:, failure_reason:)
956
+ # @param connection_type [String]
957
+ # @param failure_reason [String]
958
+ end
959
+
960
+ # The event this payload describes.
961
+ #
962
+ # @see Orb::Models::Webhooks::SalesOrderAccountingSyncFailedStandardWebhookEvent#type
963
+ module Type
964
+ extend Orb::Internal::Type::Enum
965
+
966
+ SALES_ORDER_ACCOUNTING_SYNC_FAILED = :"sales_order.accounting_sync_failed"
967
+
968
+ # @!method self.values
969
+ # @return [Array<Symbol>]
970
+ end
971
+ end
972
+ end
973
+ end
974
+ end