orb-billing 1.44.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 (507) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +1 -1
  4. data/lib/orb/models/backfill_reflected_webhook_event.rb +24 -1
  5. data/lib/orb/models/backfill_reverted_webhook_event.rb +24 -1
  6. data/lib/orb/models/billable_metric_edited_webhook_event.rb +24 -1
  7. data/lib/orb/models/credit_block_accounting_sync_failed_webhook_event.rb +27 -1
  8. data/lib/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rb +27 -1
  9. data/lib/orb/models/credit_note_accounting_sync_failed_webhook_event.rb +24 -1
  10. data/lib/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rb +24 -1
  11. data/lib/orb/models/credit_note_issued_webhook_event.rb +24 -1
  12. data/lib/orb/models/credit_note_marked_as_void_webhook_event.rb +24 -1
  13. data/lib/orb/models/customer_accounting_sync_failed_webhook_event.rb +24 -1
  14. data/lib/orb/models/customer_accounting_sync_succeeded_webhook_event.rb +24 -1
  15. data/lib/orb/models/customer_balance_transaction_created_webhook_event.rb +24 -1
  16. data/lib/orb/models/customer_created_webhook_event.rb +24 -1
  17. data/lib/orb/models/customer_credit_balance_depleted_webhook_event.rb +24 -1
  18. data/lib/orb/models/customer_credit_balance_dropped_webhook_event.rb +24 -1
  19. data/lib/orb/models/customer_credit_balance_recovered_webhook_event.rb +24 -1
  20. data/lib/orb/models/customer_credit_ledger_incremented_webhook_event.rb +24 -1
  21. data/lib/orb/models/customer_edited_webhook_event.rb +24 -1
  22. data/lib/orb/models/data_exports_transfer_error_webhook_event.rb +27 -1
  23. data/lib/orb/models/data_exports_transfer_success_webhook_event.rb +27 -1
  24. data/lib/orb/models/event_unmatched_event_webhook_event.rb +27 -1
  25. data/lib/orb/models/ingestion_unmatched_customer_ids_webhook_event.rb +27 -1
  26. data/lib/orb/models/invoice_accounting_sync_failed_webhook_event.rb +24 -1
  27. data/lib/orb/models/invoice_accounting_sync_succeeded_webhook_event.rb +24 -1
  28. data/lib/orb/models/invoice_automation_schedule_step_executed_webhook_event.rb +24 -1
  29. data/lib/orb/models/invoice_cost_data_exported_webhook_event.rb +27 -1
  30. data/lib/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rb +27 -1
  31. data/lib/orb/models/invoice_due_date_recalculation_completed_webhook_event.rb +28 -1
  32. data/lib/orb/models/invoice_due_date_recalculation_started_webhook_event.rb +27 -1
  33. data/lib/orb/models/invoice_dunning_schedule_created_webhook_event.rb +24 -1
  34. data/lib/orb/models/invoice_dunning_schedule_ended_webhook_event.rb +24 -1
  35. data/lib/orb/models/invoice_dunning_schedule_reset_webhook_event.rb +24 -1
  36. data/lib/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rb +24 -1
  37. data/lib/orb/models/invoice_edited_webhook_event.rb +24 -1
  38. data/lib/orb/models/invoice_invoice_date_elapsed_webhook_event.rb +27 -1
  39. data/lib/orb/models/invoice_issue_failed_webhook_event.rb +24 -1
  40. data/lib/orb/models/invoice_issued_summary_webhook_event.rb +27 -1
  41. data/lib/orb/models/invoice_issued_webhook_event.rb +24 -1
  42. data/lib/orb/models/invoice_manually_marked_as_paid_webhook_event.rb +24 -1
  43. data/lib/orb/models/invoice_manually_marked_as_void_webhook_event.rb +24 -1
  44. data/lib/orb/models/invoice_payment_failed_webhook_event.rb +24 -1
  45. data/lib/orb/models/invoice_payment_processing_webhook_event.rb +24 -1
  46. data/lib/orb/models/invoice_payment_succeeded_webhook_event.rb +24 -1
  47. data/lib/orb/models/invoice_sync_failed_webhook_event.rb +24 -1
  48. data/lib/orb/models/invoice_sync_succeeded_webhook_event.rb +24 -1
  49. data/lib/orb/models/invoice_undo_mark_as_paid_webhook_event.rb +24 -1
  50. data/lib/orb/models/metric_events_dropped_by_watermark_webhook_event.rb +24 -1
  51. data/lib/orb/models/payment_method_created_webhook_event.rb +24 -1
  52. data/lib/orb/models/payment_method_deleted_webhook_event.rb +24 -1
  53. data/lib/orb/models/plan_created_webhook_event.rb +27 -1
  54. data/lib/orb/models/plan_default_version_set_webhook_event.rb +27 -1
  55. data/lib/orb/models/plan_edited_webhook_event.rb +24 -1
  56. data/lib/orb/models/plan_version_created_webhook_event.rb +27 -1
  57. data/lib/orb/models/price_edited_webhook_event.rb +24 -1
  58. data/lib/orb/models/resource_event_test_webhook_event.rb +27 -1
  59. data/lib/orb/models/sales_order_accounting_sync_failed_webhook_event.rb +24 -1
  60. data/lib/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rb +24 -1
  61. data/lib/orb/models/subscription_accounting_sync_failed_webhook_event.rb +24 -1
  62. data/lib/orb/models/subscription_accounting_sync_succeeded_webhook_event.rb +24 -1
  63. data/lib/orb/models/subscription_alert_disabled_webhook_event.rb +24 -1
  64. data/lib/orb/models/subscription_cancellation_scheduled_webhook_event.rb +24 -1
  65. data/lib/orb/models/subscription_cancellation_unscheduled_webhook_event.rb +24 -1
  66. data/lib/orb/models/subscription_cost_exceeded_webhook_event.rb +24 -1
  67. data/lib/orb/models/subscription_created_webhook_event.rb +24 -1
  68. data/lib/orb/models/subscription_edited_webhook_event.rb +24 -1
  69. data/lib/orb/models/subscription_ended_webhook_event.rb +24 -1
  70. data/lib/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rb +24 -1
  71. data/lib/orb/models/subscription_grouped_cost_exceeded_webhook_event.rb +24 -1
  72. data/lib/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rb +25 -1
  73. data/lib/orb/models/subscription_license_allocation_reset_webhook_event.rb +24 -1
  74. data/lib/orb/models/subscription_license_balance_threshold_reached_webhook_event.rb +25 -1
  75. data/lib/orb/models/subscription_plan_change_scheduled_webhook_event.rb +24 -1
  76. data/lib/orb/models/subscription_plan_changed_webhook_event.rb +24 -1
  77. data/lib/orb/models/subscription_plan_version_change_scheduled_webhook_event.rb +25 -1
  78. data/lib/orb/models/subscription_plan_version_changed_webhook_event.rb +24 -1
  79. data/lib/orb/models/subscription_spend_exceeded_webhook_event.rb +24 -1
  80. data/lib/orb/models/subscription_started_webhook_event.rb +24 -1
  81. data/lib/orb/models/subscription_trial_ended_webhook_event.rb +24 -1
  82. data/lib/orb/models/subscription_usage_exceeded_webhook_event.rb +24 -1
  83. data/lib/orb/models/transaction_accounting_sync_failed_webhook_event.rb +27 -1
  84. data/lib/orb/models/transaction_accounting_sync_succeeded_webhook_event.rb +27 -1
  85. data/lib/orb/models/webhooks/backfill_reflected_standard_webhook_event.rb +206 -0
  86. data/lib/orb/models/webhooks/backfill_reverted_standard_webhook_event.rb +206 -0
  87. data/lib/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rb +131 -0
  88. data/lib/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rb +537 -0
  89. data/lib/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rb +531 -0
  90. data/lib/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rb +188 -0
  91. data/lib/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rb +183 -0
  92. data/lib/orb/models/webhooks/credit_note_issued_standard_webhook_event.rb +90 -0
  93. data/lib/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rb +92 -0
  94. data/lib/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rb +198 -0
  95. data/lib/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rb +193 -0
  96. data/lib/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rb +240 -0
  97. data/lib/orb/models/webhooks/customer_created_standard_webhook_event.rb +106 -0
  98. data/lib/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rb +597 -0
  99. data/lib/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rb +603 -0
  100. data/lib/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rb +597 -0
  101. data/lib/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rb +509 -0
  102. data/lib/orb/models/webhooks/customer_edited_standard_webhook_event.rb +371 -0
  103. data/lib/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rb +130 -0
  104. data/lib/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rb +124 -0
  105. data/lib/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rb +134 -0
  106. data/lib/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rb +94 -0
  107. data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +972 -0
  108. data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +966 -0
  109. data/lib/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rb +367 -0
  110. data/lib/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rb +113 -0
  111. data/lib/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rb +101 -0
  112. data/lib/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rb +101 -0
  113. data/lib/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rb +95 -0
  114. data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +994 -0
  115. data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +988 -0
  116. data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +992 -0
  117. data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +942 -0
  118. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +1365 -0
  119. data/lib/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rb +151 -0
  120. data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +885 -0
  121. data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +884 -0
  122. data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +887 -0
  123. data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +899 -0
  124. data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +876 -0
  125. data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +899 -0
  126. data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +893 -0
  127. data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +908 -0
  128. data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +890 -0
  129. data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +892 -0
  130. data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +875 -0
  131. data/lib/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rb +125 -0
  132. data/lib/orb/models/webhooks/payment_method_created_standard_webhook_event.rb +184 -0
  133. data/lib/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rb +184 -0
  134. data/lib/orb/models/webhooks/plan_created_standard_webhook_event.rb +119 -0
  135. data/lib/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rb +139 -0
  136. data/lib/orb/models/webhooks/plan_edited_standard_webhook_event.rb +159 -0
  137. data/lib/orb/models/webhooks/plan_version_created_standard_webhook_event.rb +138 -0
  138. data/lib/orb/models/webhooks/price_edited_standard_webhook_event.rb +132 -0
  139. data/lib/orb/models/webhooks/resource_event_test_standard_webhook_event.rb +92 -0
  140. data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +972 -0
  141. data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +967 -0
  142. data/lib/orb/models/webhooks/standard_unwrap_standard_params.rb +16 -0
  143. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +322 -0
  144. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +316 -0
  145. data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +667 -0
  146. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +237 -0
  147. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +237 -0
  148. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +692 -0
  149. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +221 -0
  150. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +273 -0
  151. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +219 -0
  152. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +255 -0
  153. data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +693 -0
  154. data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +222 -0
  155. data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +244 -0
  156. data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +687 -0
  157. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +249 -0
  158. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +233 -0
  159. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +250 -0
  160. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +248 -0
  161. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +693 -0
  162. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +221 -0
  163. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +222 -0
  164. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +700 -0
  165. data/lib/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rb +270 -0
  166. data/lib/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rb +264 -0
  167. data/lib/orb/models/webhooks/unwrap_standard_webhook_event.rb +258 -0
  168. data/lib/orb/models.rb +2 -0
  169. data/lib/orb/resources/webhooks/standard.rb +24 -0
  170. data/lib/orb/resources/webhooks.rb +4 -0
  171. data/lib/orb/version.rb +1 -1
  172. data/lib/orb.rb +84 -0
  173. data/rbi/orb/models/backfill_reflected_webhook_event.rbi +47 -0
  174. data/rbi/orb/models/backfill_reverted_webhook_event.rbi +47 -0
  175. data/rbi/orb/models/billable_metric_edited_webhook_event.rbi +49 -0
  176. data/rbi/orb/models/credit_block_accounting_sync_failed_webhook_event.rbi +52 -0
  177. data/rbi/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbi +52 -0
  178. data/rbi/orb/models/credit_note_accounting_sync_failed_webhook_event.rbi +52 -0
  179. data/rbi/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rbi +52 -0
  180. data/rbi/orb/models/credit_note_issued_webhook_event.rbi +47 -0
  181. data/rbi/orb/models/credit_note_marked_as_void_webhook_event.rbi +49 -0
  182. data/rbi/orb/models/customer_accounting_sync_failed_webhook_event.rbi +52 -0
  183. data/rbi/orb/models/customer_accounting_sync_succeeded_webhook_event.rbi +52 -0
  184. data/rbi/orb/models/customer_balance_transaction_created_webhook_event.rbi +52 -0
  185. data/rbi/orb/models/customer_created_webhook_event.rbi +47 -0
  186. data/rbi/orb/models/customer_credit_balance_depleted_webhook_event.rbi +52 -0
  187. data/rbi/orb/models/customer_credit_balance_dropped_webhook_event.rbi +52 -0
  188. data/rbi/orb/models/customer_credit_balance_recovered_webhook_event.rbi +52 -0
  189. data/rbi/orb/models/customer_credit_ledger_incremented_webhook_event.rbi +52 -0
  190. data/rbi/orb/models/customer_edited_webhook_event.rbi +47 -0
  191. data/rbi/orb/models/data_exports_transfer_error_webhook_event.rbi +52 -0
  192. data/rbi/orb/models/data_exports_transfer_success_webhook_event.rbi +52 -0
  193. data/rbi/orb/models/event_unmatched_event_webhook_event.rbi +49 -0
  194. data/rbi/orb/models/ingestion_unmatched_customer_ids_webhook_event.rbi +52 -0
  195. data/rbi/orb/models/invoice_accounting_sync_failed_webhook_event.rbi +52 -0
  196. data/rbi/orb/models/invoice_accounting_sync_succeeded_webhook_event.rbi +52 -0
  197. data/rbi/orb/models/invoice_automation_schedule_step_executed_webhook_event.rbi +52 -0
  198. data/rbi/orb/models/invoice_cost_data_exported_webhook_event.rbi +52 -0
  199. data/rbi/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rbi +52 -0
  200. data/rbi/orb/models/invoice_due_date_recalculation_completed_webhook_event.rbi +52 -0
  201. data/rbi/orb/models/invoice_due_date_recalculation_started_webhook_event.rbi +52 -0
  202. data/rbi/orb/models/invoice_dunning_schedule_created_webhook_event.rbi +52 -0
  203. data/rbi/orb/models/invoice_dunning_schedule_ended_webhook_event.rbi +52 -0
  204. data/rbi/orb/models/invoice_dunning_schedule_reset_webhook_event.rbi +52 -0
  205. data/rbi/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rbi +52 -0
  206. data/rbi/orb/models/invoice_edited_webhook_event.rbi +44 -0
  207. data/rbi/orb/models/invoice_invoice_date_elapsed_webhook_event.rbi +52 -0
  208. data/rbi/orb/models/invoice_issue_failed_webhook_event.rbi +47 -0
  209. data/rbi/orb/models/invoice_issued_summary_webhook_event.rbi +49 -0
  210. data/rbi/orb/models/invoice_issued_webhook_event.rbi +44 -0
  211. data/rbi/orb/models/invoice_manually_marked_as_paid_webhook_event.rbi +52 -0
  212. data/rbi/orb/models/invoice_manually_marked_as_void_webhook_event.rbi +52 -0
  213. data/rbi/orb/models/invoice_payment_failed_webhook_event.rbi +49 -0
  214. data/rbi/orb/models/invoice_payment_processing_webhook_event.rbi +52 -0
  215. data/rbi/orb/models/invoice_payment_succeeded_webhook_event.rbi +52 -0
  216. data/rbi/orb/models/invoice_sync_failed_webhook_event.rbi +47 -0
  217. data/rbi/orb/models/invoice_sync_succeeded_webhook_event.rbi +49 -0
  218. data/rbi/orb/models/invoice_undo_mark_as_paid_webhook_event.rbi +49 -0
  219. data/rbi/orb/models/metric_events_dropped_by_watermark_webhook_event.rbi +52 -0
  220. data/rbi/orb/models/payment_method_created_webhook_event.rbi +49 -0
  221. data/rbi/orb/models/payment_method_deleted_webhook_event.rbi +49 -0
  222. data/rbi/orb/models/plan_created_webhook_event.rbi +42 -0
  223. data/rbi/orb/models/plan_default_version_set_webhook_event.rbi +49 -0
  224. data/rbi/orb/models/plan_edited_webhook_event.rbi +42 -0
  225. data/rbi/orb/models/plan_version_created_webhook_event.rbi +47 -0
  226. data/rbi/orb/models/price_edited_webhook_event.rbi +42 -0
  227. data/rbi/orb/models/resource_event_test_webhook_event.rbi +47 -0
  228. data/rbi/orb/models/sales_order_accounting_sync_failed_webhook_event.rbi +52 -0
  229. data/rbi/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rbi +52 -0
  230. data/rbi/orb/models/subscription_accounting_sync_failed_webhook_event.rbi +52 -0
  231. data/rbi/orb/models/subscription_accounting_sync_succeeded_webhook_event.rbi +52 -0
  232. data/rbi/orb/models/subscription_alert_disabled_webhook_event.rbi +52 -0
  233. data/rbi/orb/models/subscription_cancellation_scheduled_webhook_event.rbi +52 -0
  234. data/rbi/orb/models/subscription_cancellation_unscheduled_webhook_event.rbi +52 -0
  235. data/rbi/orb/models/subscription_cost_exceeded_webhook_event.rbi +52 -0
  236. data/rbi/orb/models/subscription_created_webhook_event.rbi +49 -0
  237. data/rbi/orb/models/subscription_edited_webhook_event.rbi +47 -0
  238. data/rbi/orb/models/subscription_ended_webhook_event.rbi +47 -0
  239. data/rbi/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rbi +52 -0
  240. data/rbi/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbi +52 -0
  241. data/rbi/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbi +52 -0
  242. data/rbi/orb/models/subscription_license_allocation_reset_webhook_event.rbi +52 -0
  243. data/rbi/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbi +52 -0
  244. data/rbi/orb/models/subscription_plan_change_scheduled_webhook_event.rbi +52 -0
  245. data/rbi/orb/models/subscription_plan_changed_webhook_event.rbi +52 -0
  246. data/rbi/orb/models/subscription_plan_version_change_scheduled_webhook_event.rbi +52 -0
  247. data/rbi/orb/models/subscription_plan_version_changed_webhook_event.rbi +52 -0
  248. data/rbi/orb/models/subscription_spend_exceeded_webhook_event.rbi +52 -0
  249. data/rbi/orb/models/subscription_started_webhook_event.rbi +49 -0
  250. data/rbi/orb/models/subscription_trial_ended_webhook_event.rbi +49 -0
  251. data/rbi/orb/models/subscription_usage_exceeded_webhook_event.rbi +52 -0
  252. data/rbi/orb/models/transaction_accounting_sync_failed_webhook_event.rbi +52 -0
  253. data/rbi/orb/models/transaction_accounting_sync_succeeded_webhook_event.rbi +52 -0
  254. data/rbi/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbi +349 -0
  255. data/rbi/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbi +347 -0
  256. data/rbi/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbi +273 -0
  257. data/rbi/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbi +1106 -0
  258. data/rbi/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbi +1095 -0
  259. data/rbi/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbi +377 -0
  260. data/rbi/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbi +366 -0
  261. data/rbi/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbi +166 -0
  262. data/rbi/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbi +166 -0
  263. data/rbi/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbi +403 -0
  264. data/rbi/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbi +392 -0
  265. data/rbi/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbi +493 -0
  266. data/rbi/orb/models/webhooks/customer_created_standard_webhook_event.rbi +198 -0
  267. data/rbi/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbi +1151 -0
  268. data/rbi/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbi +1158 -0
  269. data/rbi/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbi +1151 -0
  270. data/rbi/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbi +1044 -0
  271. data/rbi/orb/models/webhooks/customer_edited_standard_webhook_event.rbi +678 -0
  272. data/rbi/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbi +236 -0
  273. data/rbi/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbi +230 -0
  274. data/rbi/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbi +275 -0
  275. data/rbi/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbi +192 -0
  276. data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +1705 -0
  277. data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +1694 -0
  278. data/rbi/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbi +670 -0
  279. data/rbi/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbi +210 -0
  280. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbi +195 -0
  281. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbi +195 -0
  282. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbi +188 -0
  283. data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +1713 -0
  284. data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +1708 -0
  285. data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +1713 -0
  286. data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +1628 -0
  287. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +2337 -0
  288. data/rbi/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbi +324 -0
  289. data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +1529 -0
  290. data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +1529 -0
  291. data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +1534 -0
  292. data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +1549 -0
  293. data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +1494 -0
  294. data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +1554 -0
  295. data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +1547 -0
  296. data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +1563 -0
  297. data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +1542 -0
  298. data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +1544 -0
  299. data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +1494 -0
  300. data/rbi/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbi +233 -0
  301. data/rbi/orb/models/webhooks/payment_method_created_standard_webhook_event.rbi +331 -0
  302. data/rbi/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbi +331 -0
  303. data/rbi/orb/models/webhooks/plan_created_standard_webhook_event.rbi +216 -0
  304. data/rbi/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbi +277 -0
  305. data/rbi/orb/models/webhooks/plan_edited_standard_webhook_event.rbi +337 -0
  306. data/rbi/orb/models/webhooks/plan_version_created_standard_webhook_event.rbi +271 -0
  307. data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi +311 -0
  308. data/rbi/orb/models/webhooks/resource_event_test_standard_webhook_event.rbi +191 -0
  309. data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +1705 -0
  310. data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +1694 -0
  311. data/rbi/orb/models/webhooks/standard_unwrap_standard_params.rbi +32 -0
  312. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +609 -0
  313. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +598 -0
  314. data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +1302 -0
  315. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +433 -0
  316. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +435 -0
  317. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +1298 -0
  318. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +398 -0
  319. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +520 -0
  320. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +398 -0
  321. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +458 -0
  322. data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +1321 -0
  323. data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +428 -0
  324. data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +477 -0
  325. data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +1319 -0
  326. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +453 -0
  327. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +433 -0
  328. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +457 -0
  329. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +457 -0
  330. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +1299 -0
  331. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +398 -0
  332. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +398 -0
  333. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +1305 -0
  334. data/rbi/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbi +516 -0
  335. data/rbi/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbi +505 -0
  336. data/rbi/orb/models/webhooks/unwrap_standard_webhook_event.rbi +107 -0
  337. data/rbi/orb/models.rbi +2 -0
  338. data/rbi/orb/resources/webhooks/standard.rbi +107 -0
  339. data/rbi/orb/resources/webhooks.rbi +3 -0
  340. data/sig/orb/models/backfill_reflected_webhook_event.rbs +16 -0
  341. data/sig/orb/models/backfill_reverted_webhook_event.rbs +16 -0
  342. data/sig/orb/models/billable_metric_edited_webhook_event.rbs +16 -0
  343. data/sig/orb/models/credit_block_accounting_sync_failed_webhook_event.rbs +16 -0
  344. data/sig/orb/models/credit_block_accounting_sync_succeeded_webhook_event.rbs +16 -0
  345. data/sig/orb/models/credit_note_accounting_sync_failed_webhook_event.rbs +16 -0
  346. data/sig/orb/models/credit_note_accounting_sync_succeeded_webhook_event.rbs +16 -0
  347. data/sig/orb/models/credit_note_issued_webhook_event.rbs +16 -0
  348. data/sig/orb/models/credit_note_marked_as_void_webhook_event.rbs +16 -0
  349. data/sig/orb/models/customer_accounting_sync_failed_webhook_event.rbs +16 -0
  350. data/sig/orb/models/customer_accounting_sync_succeeded_webhook_event.rbs +16 -0
  351. data/sig/orb/models/customer_balance_transaction_created_webhook_event.rbs +16 -0
  352. data/sig/orb/models/customer_created_webhook_event.rbs +16 -0
  353. data/sig/orb/models/customer_credit_balance_depleted_webhook_event.rbs +16 -0
  354. data/sig/orb/models/customer_credit_balance_dropped_webhook_event.rbs +16 -0
  355. data/sig/orb/models/customer_credit_balance_recovered_webhook_event.rbs +16 -0
  356. data/sig/orb/models/customer_credit_ledger_incremented_webhook_event.rbs +16 -0
  357. data/sig/orb/models/customer_edited_webhook_event.rbs +16 -0
  358. data/sig/orb/models/data_exports_transfer_error_webhook_event.rbs +16 -0
  359. data/sig/orb/models/data_exports_transfer_success_webhook_event.rbs +16 -0
  360. data/sig/orb/models/event_unmatched_event_webhook_event.rbs +16 -0
  361. data/sig/orb/models/ingestion_unmatched_customer_ids_webhook_event.rbs +16 -0
  362. data/sig/orb/models/invoice_accounting_sync_failed_webhook_event.rbs +16 -0
  363. data/sig/orb/models/invoice_accounting_sync_succeeded_webhook_event.rbs +16 -0
  364. data/sig/orb/models/invoice_automation_schedule_step_executed_webhook_event.rbs +16 -0
  365. data/sig/orb/models/invoice_cost_data_exported_webhook_event.rbs +16 -0
  366. data/sig/orb/models/invoice_due_date_recalculation_canceled_webhook_event.rbs +16 -0
  367. data/sig/orb/models/invoice_due_date_recalculation_completed_webhook_event.rbs +16 -0
  368. data/sig/orb/models/invoice_due_date_recalculation_started_webhook_event.rbs +16 -0
  369. data/sig/orb/models/invoice_dunning_schedule_created_webhook_event.rbs +16 -0
  370. data/sig/orb/models/invoice_dunning_schedule_ended_webhook_event.rbs +16 -0
  371. data/sig/orb/models/invoice_dunning_schedule_reset_webhook_event.rbs +16 -0
  372. data/sig/orb/models/invoice_dunning_schedule_step_executed_webhook_event.rbs +16 -0
  373. data/sig/orb/models/invoice_edited_webhook_event.rbs +16 -0
  374. data/sig/orb/models/invoice_invoice_date_elapsed_webhook_event.rbs +16 -0
  375. data/sig/orb/models/invoice_issue_failed_webhook_event.rbs +16 -0
  376. data/sig/orb/models/invoice_issued_summary_webhook_event.rbs +16 -0
  377. data/sig/orb/models/invoice_issued_webhook_event.rbs +16 -0
  378. data/sig/orb/models/invoice_manually_marked_as_paid_webhook_event.rbs +16 -0
  379. data/sig/orb/models/invoice_manually_marked_as_void_webhook_event.rbs +16 -0
  380. data/sig/orb/models/invoice_payment_failed_webhook_event.rbs +16 -0
  381. data/sig/orb/models/invoice_payment_processing_webhook_event.rbs +16 -0
  382. data/sig/orb/models/invoice_payment_succeeded_webhook_event.rbs +16 -0
  383. data/sig/orb/models/invoice_sync_failed_webhook_event.rbs +16 -0
  384. data/sig/orb/models/invoice_sync_succeeded_webhook_event.rbs +16 -0
  385. data/sig/orb/models/invoice_undo_mark_as_paid_webhook_event.rbs +16 -0
  386. data/sig/orb/models/metric_events_dropped_by_watermark_webhook_event.rbs +16 -0
  387. data/sig/orb/models/payment_method_created_webhook_event.rbs +16 -0
  388. data/sig/orb/models/payment_method_deleted_webhook_event.rbs +16 -0
  389. data/sig/orb/models/plan_created_webhook_event.rbs +16 -0
  390. data/sig/orb/models/plan_default_version_set_webhook_event.rbs +16 -0
  391. data/sig/orb/models/plan_edited_webhook_event.rbs +16 -0
  392. data/sig/orb/models/plan_version_created_webhook_event.rbs +16 -0
  393. data/sig/orb/models/price_edited_webhook_event.rbs +16 -0
  394. data/sig/orb/models/resource_event_test_webhook_event.rbs +16 -0
  395. data/sig/orb/models/sales_order_accounting_sync_failed_webhook_event.rbs +16 -0
  396. data/sig/orb/models/sales_order_accounting_sync_succeeded_webhook_event.rbs +16 -0
  397. data/sig/orb/models/subscription_accounting_sync_failed_webhook_event.rbs +16 -0
  398. data/sig/orb/models/subscription_accounting_sync_succeeded_webhook_event.rbs +16 -0
  399. data/sig/orb/models/subscription_alert_disabled_webhook_event.rbs +16 -0
  400. data/sig/orb/models/subscription_cancellation_scheduled_webhook_event.rbs +16 -0
  401. data/sig/orb/models/subscription_cancellation_unscheduled_webhook_event.rbs +16 -0
  402. data/sig/orb/models/subscription_cost_exceeded_webhook_event.rbs +16 -0
  403. data/sig/orb/models/subscription_created_webhook_event.rbs +16 -0
  404. data/sig/orb/models/subscription_edited_webhook_event.rbs +16 -0
  405. data/sig/orb/models/subscription_ended_webhook_event.rbs +16 -0
  406. data/sig/orb/models/subscription_fixed_fee_quantity_updated_webhook_event.rbs +16 -0
  407. data/sig/orb/models/subscription_grouped_cost_exceeded_webhook_event.rbs +16 -0
  408. data/sig/orb/models/subscription_invoicing_threshold_exceeded_webhook_event.rbs +16 -0
  409. data/sig/orb/models/subscription_license_allocation_reset_webhook_event.rbs +16 -0
  410. data/sig/orb/models/subscription_license_balance_threshold_reached_webhook_event.rbs +16 -0
  411. data/sig/orb/models/subscription_plan_change_scheduled_webhook_event.rbs +16 -0
  412. data/sig/orb/models/subscription_plan_changed_webhook_event.rbs +16 -0
  413. data/sig/orb/models/subscription_plan_version_change_scheduled_webhook_event.rbs +16 -0
  414. data/sig/orb/models/subscription_plan_version_changed_webhook_event.rbs +16 -0
  415. data/sig/orb/models/subscription_spend_exceeded_webhook_event.rbs +16 -0
  416. data/sig/orb/models/subscription_started_webhook_event.rbs +16 -0
  417. data/sig/orb/models/subscription_trial_ended_webhook_event.rbs +16 -0
  418. data/sig/orb/models/subscription_usage_exceeded_webhook_event.rbs +16 -0
  419. data/sig/orb/models/transaction_accounting_sync_failed_webhook_event.rbs +16 -0
  420. data/sig/orb/models/transaction_accounting_sync_succeeded_webhook_event.rbs +16 -0
  421. data/sig/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbs +148 -0
  422. data/sig/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbs +148 -0
  423. data/sig/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbs +112 -0
  424. data/sig/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbs +435 -0
  425. data/sig/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbs +430 -0
  426. data/sig/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbs +165 -0
  427. data/sig/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbs +160 -0
  428. data/sig/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbs +68 -0
  429. data/sig/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbs +68 -0
  430. data/sig/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbs +160 -0
  431. data/sig/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbs +155 -0
  432. data/sig/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbs +189 -0
  433. data/sig/orb/models/webhooks/customer_created_standard_webhook_event.rbs +68 -0
  434. data/sig/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbs +396 -0
  435. data/sig/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbs +401 -0
  436. data/sig/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbs +396 -0
  437. data/sig/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbs +386 -0
  438. data/sig/orb/models/webhooks/customer_edited_standard_webhook_event.rbs +157 -0
  439. data/sig/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbs +110 -0
  440. data/sig/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbs +105 -0
  441. data/sig/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbs +122 -0
  442. data/sig/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbs +73 -0
  443. data/sig/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  444. data/sig/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  445. data/sig/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbs +331 -0
  446. data/sig/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbs +91 -0
  447. data/sig/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbs +75 -0
  448. data/sig/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbs +75 -0
  449. data/sig/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbs +73 -0
  450. data/sig/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbs +638 -0
  451. data/sig/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbs +633 -0
  452. data/sig/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbs +623 -0
  453. data/sig/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbs +586 -0
  454. data/sig/orb/models/webhooks/invoice_edited_standard_webhook_event.rbs +859 -0
  455. data/sig/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbs +129 -0
  456. data/sig/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbs +527 -0
  457. data/sig/orb/models/webhooks/invoice_issued_standard_webhook_event.rbs +527 -0
  458. data/sig/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbs +527 -0
  459. data/sig/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbs +540 -0
  460. data/sig/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbs +517 -0
  461. data/sig/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbs +544 -0
  462. data/sig/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbs +538 -0
  463. data/sig/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbs +549 -0
  464. data/sig/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbs +536 -0
  465. data/sig/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbs +536 -0
  466. data/sig/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbs +517 -0
  467. data/sig/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbs +100 -0
  468. data/sig/orb/models/webhooks/payment_method_created_standard_webhook_event.rbs +130 -0
  469. data/sig/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbs +130 -0
  470. data/sig/orb/models/webhooks/plan_created_standard_webhook_event.rbs +90 -0
  471. data/sig/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbs +112 -0
  472. data/sig/orb/models/webhooks/plan_edited_standard_webhook_event.rbs +134 -0
  473. data/sig/orb/models/webhooks/plan_version_created_standard_webhook_event.rbs +109 -0
  474. data/sig/orb/models/webhooks/price_edited_standard_webhook_event.rbs +95 -0
  475. data/sig/orb/models/webhooks/resource_event_test_standard_webhook_event.rbs +75 -0
  476. data/sig/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  477. data/sig/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  478. data/sig/orb/models/webhooks/standard_unwrap_standard_params.rbs +17 -0
  479. data/sig/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbs +256 -0
  480. data/sig/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbs +251 -0
  481. data/sig/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbs +466 -0
  482. data/sig/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbs +169 -0
  483. data/sig/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbs +169 -0
  484. data/sig/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbs +475 -0
  485. data/sig/orb/models/webhooks/subscription_created_standard_webhook_event.rbs +159 -0
  486. data/sig/orb/models/webhooks/subscription_edited_standard_webhook_event.rbs +218 -0
  487. data/sig/orb/models/webhooks/subscription_ended_standard_webhook_event.rbs +159 -0
  488. data/sig/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbs +191 -0
  489. data/sig/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbs +487 -0
  490. data/sig/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbs +176 -0
  491. data/sig/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbs +198 -0
  492. data/sig/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbs +482 -0
  493. data/sig/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbs +182 -0
  494. data/sig/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbs +169 -0
  495. data/sig/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbs +186 -0
  496. data/sig/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbs +186 -0
  497. data/sig/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbs +475 -0
  498. data/sig/orb/models/webhooks/subscription_started_standard_webhook_event.rbs +159 -0
  499. data/sig/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbs +159 -0
  500. data/sig/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbs +480 -0
  501. data/sig/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbs +223 -0
  502. data/sig/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbs +218 -0
  503. data/sig/orb/models/webhooks/unwrap_standard_webhook_event.rbs +94 -0
  504. data/sig/orb/models.rbs +2 -0
  505. data/sig/orb/resources/webhooks/standard.rbs +93 -0
  506. data/sig/orb/resources/webhooks.rbs +2 -0
  507. metadata +253 -1
@@ -0,0 +1,1694 @@
1
+ # typed: strong
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class InvoiceAccountingSyncSucceededStandardWebhookEvent < Orb::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent,
11
+ Orb::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ # The ID of this webhook event.
16
+ sig { returns(String) }
17
+ attr_accessor :id
18
+
19
+ sig do
20
+ returns(
21
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord
22
+ )
23
+ end
24
+ attr_reader :accounting_sync_record
25
+
26
+ sig do
27
+ params(
28
+ accounting_sync_record:
29
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::OrHash
30
+ ).void
31
+ end
32
+ attr_writer :accounting_sync_record
33
+
34
+ # The time at which this event was created, to the second.
35
+ sig { returns(Time) }
36
+ attr_accessor :created_at
37
+
38
+ # #InvoiceApiResourceWithoutLineItems
39
+ sig do
40
+ returns(
41
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice
42
+ )
43
+ end
44
+ attr_reader :invoice
45
+
46
+ sig do
47
+ params(
48
+ invoice:
49
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::OrHash
50
+ ).void
51
+ end
52
+ attr_writer :invoice
53
+
54
+ # The serialization style this payload was rendered in, as configured on the
55
+ # endpoint.
56
+ sig do
57
+ returns(
58
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
59
+ )
60
+ end
61
+ attr_accessor :payload_style
62
+
63
+ sig do
64
+ returns(
65
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Properties
66
+ )
67
+ end
68
+ attr_reader :properties
69
+
70
+ sig do
71
+ params(
72
+ properties:
73
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Properties::OrHash
74
+ ).void
75
+ end
76
+ attr_writer :properties
77
+
78
+ # The event this payload describes.
79
+ sig do
80
+ returns(
81
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
82
+ )
83
+ end
84
+ attr_accessor :type
85
+
86
+ # Issued when an invoice accounting sync succeeds.
87
+ sig do
88
+ params(
89
+ id: String,
90
+ accounting_sync_record:
91
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::OrHash,
92
+ created_at: Time,
93
+ invoice:
94
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::OrHash,
95
+ payload_style:
96
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::OrSymbol,
97
+ properties:
98
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Properties::OrHash,
99
+ type:
100
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Type::OrSymbol
101
+ ).returns(T.attached_class)
102
+ end
103
+ def self.new(
104
+ # The ID of this webhook event.
105
+ id:,
106
+ accounting_sync_record:,
107
+ # The time at which this event was created, to the second.
108
+ created_at:,
109
+ # #InvoiceApiResourceWithoutLineItems
110
+ invoice:,
111
+ # The serialization style this payload was rendered in, as configured on the
112
+ # endpoint.
113
+ payload_style:,
114
+ properties:,
115
+ # The event this payload describes.
116
+ type:
117
+ )
118
+ end
119
+
120
+ sig do
121
+ override.returns(
122
+ {
123
+ id: String,
124
+ accounting_sync_record:
125
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord,
126
+ created_at: Time,
127
+ invoice:
128
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice,
129
+ payload_style:
130
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol,
131
+ properties:
132
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Properties,
133
+ type:
134
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
135
+ }
136
+ )
137
+ end
138
+ def to_hash
139
+ end
140
+
141
+ class AccountingSyncRecord < Orb::Internal::Type::BaseModel
142
+ OrHash =
143
+ T.type_alias do
144
+ T.any(
145
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord,
146
+ Orb::Internal::AnyHash
147
+ )
148
+ end
149
+
150
+ sig { returns(String) }
151
+ attr_accessor :id
152
+
153
+ sig { returns(String) }
154
+ attr_accessor :customer_id
155
+
156
+ sig do
157
+ returns(
158
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
159
+ )
160
+ end
161
+ attr_accessor :record_type
162
+
163
+ sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
164
+ attr_accessor :error_details
165
+
166
+ sig { returns(T.nilable(String)) }
167
+ attr_accessor :invoice_id
168
+
169
+ sig { returns(T.nilable(String)) }
170
+ attr_accessor :provider_customer_id
171
+
172
+ sig { returns(T.nilable(String)) }
173
+ attr_accessor :status
174
+
175
+ sig { returns(T.nilable(String)) }
176
+ attr_accessor :sync_action
177
+
178
+ sig do
179
+ params(
180
+ id: String,
181
+ customer_id: String,
182
+ record_type:
183
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::OrSymbol,
184
+ error_details: T.nilable(T::Hash[Symbol, T.anything]),
185
+ invoice_id: T.nilable(String),
186
+ provider_customer_id: T.nilable(String),
187
+ status: T.nilable(String),
188
+ sync_action: T.nilable(String)
189
+ ).returns(T.attached_class)
190
+ end
191
+ def self.new(
192
+ id:,
193
+ customer_id:,
194
+ record_type:,
195
+ error_details: nil,
196
+ invoice_id: nil,
197
+ provider_customer_id: nil,
198
+ status: nil,
199
+ sync_action: nil
200
+ )
201
+ end
202
+
203
+ sig do
204
+ override.returns(
205
+ {
206
+ id: String,
207
+ customer_id: String,
208
+ record_type:
209
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol,
210
+ error_details: T.nilable(T::Hash[Symbol, T.anything]),
211
+ invoice_id: T.nilable(String),
212
+ provider_customer_id: T.nilable(String),
213
+ status: T.nilable(String),
214
+ sync_action: T.nilable(String)
215
+ }
216
+ )
217
+ end
218
+ def to_hash
219
+ end
220
+
221
+ module RecordType
222
+ extend Orb::Internal::Type::Enum
223
+
224
+ TaggedSymbol =
225
+ T.type_alias do
226
+ T.all(
227
+ Symbol,
228
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType
229
+ )
230
+ end
231
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
232
+
233
+ CUSTOMER =
234
+ T.let(
235
+ :customer,
236
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
237
+ )
238
+ INVOICE =
239
+ T.let(
240
+ :invoice,
241
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
242
+ )
243
+ TRANSACTION =
244
+ T.let(
245
+ :transaction,
246
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
247
+ )
248
+ CUSTOMER_BALANCE_TRANSACTION =
249
+ T.let(
250
+ :customer_balance_transaction,
251
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
252
+ )
253
+ CREDIT_NOTE =
254
+ T.let(
255
+ :credit_note,
256
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
257
+ )
258
+ SUBSCRIPTION =
259
+ T.let(
260
+ :subscription,
261
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
262
+ )
263
+ SALES_ORDER =
264
+ T.let(
265
+ :sales_order,
266
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
267
+ )
268
+ BLOCK =
269
+ T.let(
270
+ :block,
271
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
272
+ )
273
+
274
+ sig do
275
+ override.returns(
276
+ T::Array[
277
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::AccountingSyncRecord::RecordType::TaggedSymbol
278
+ ]
279
+ )
280
+ end
281
+ def self.values
282
+ end
283
+ end
284
+ end
285
+
286
+ class Invoice < Orb::Internal::Type::BaseModel
287
+ OrHash =
288
+ T.type_alias do
289
+ T.any(
290
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice,
291
+ Orb::Internal::AnyHash
292
+ )
293
+ end
294
+
295
+ sig { returns(String) }
296
+ attr_accessor :id
297
+
298
+ # This is the final amount required to be charged to the customer and reflects the
299
+ # application of the customer balance to the `total` of the invoice.
300
+ sig { returns(String) }
301
+ attr_accessor :amount_due
302
+
303
+ sig do
304
+ returns(
305
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::AutoCollection
306
+ )
307
+ end
308
+ attr_reader :auto_collection
309
+
310
+ sig do
311
+ params(
312
+ auto_collection:
313
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::AutoCollection::OrHash
314
+ ).void
315
+ end
316
+ attr_writer :auto_collection
317
+
318
+ sig { returns(T.nilable(Orb::Address)) }
319
+ attr_reader :billing_address
320
+
321
+ sig { params(billing_address: T.nilable(Orb::Address::OrHash)).void }
322
+ attr_writer :billing_address
323
+
324
+ # The creation time of the resource in Orb.
325
+ sig { returns(Time) }
326
+ attr_accessor :created_at
327
+
328
+ # A list of credit notes associated with the invoice
329
+ sig do
330
+ returns(
331
+ T::Array[
332
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CreditNote
333
+ ]
334
+ )
335
+ end
336
+ attr_accessor :credit_notes
337
+
338
+ # An ISO 4217 currency string or `credits`
339
+ sig { returns(String) }
340
+ attr_accessor :currency
341
+
342
+ sig { returns(Orb::CustomerMinified) }
343
+ attr_reader :customer
344
+
345
+ sig { params(customer: Orb::CustomerMinified::OrHash).void }
346
+ attr_writer :customer
347
+
348
+ sig do
349
+ returns(
350
+ T::Array[
351
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction
352
+ ]
353
+ )
354
+ end
355
+ attr_accessor :customer_balance_transactions
356
+
357
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
358
+ # added to the headers of invoices.
359
+ #
360
+ # ### Supported Tax ID Countries and Types
361
+ #
362
+ # | Country | Type | Description |
363
+ # | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
364
+ # | Albania | `al_tin` | Albania Tax Identification Number |
365
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
366
+ # | Angola | `ao_tin` | Angola Tax Identification Number |
367
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
368
+ # | Armenia | `am_tin` | Armenia Tax Identification Number |
369
+ # | Aruba | `aw_tin` | Aruba Tax Identification Number |
370
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
371
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
372
+ # | Austria | `eu_vat` | European VAT Number |
373
+ # | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
374
+ # | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
375
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
376
+ # | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
377
+ # | Barbados | `bb_tin` | Barbados Tax Identification Number |
378
+ # | Belarus | `by_tin` | Belarus TIN Number |
379
+ # | Belgium | `eu_vat` | European VAT Number |
380
+ # | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
381
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
382
+ # | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
383
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
384
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
385
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
386
+ # | Bulgaria | `eu_vat` | European VAT Number |
387
+ # | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
388
+ # | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
389
+ # | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
390
+ # | Canada | `ca_bn` | Canadian BN |
391
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
392
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
393
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
394
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
395
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
396
+ # | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
397
+ # | Chile | `cl_tin` | Chilean TIN |
398
+ # | China | `cn_tin` | Chinese Tax ID |
399
+ # | Colombia | `co_nit` | Colombian NIT Number |
400
+ # | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
401
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
402
+ # | Croatia | `eu_vat` | European VAT Number |
403
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
404
+ # | Cyprus | `eu_vat` | European VAT Number |
405
+ # | Czech Republic | `eu_vat` | European VAT Number |
406
+ # | Denmark | `eu_vat` | European VAT Number |
407
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
408
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
409
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
410
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
411
+ # | Estonia | `eu_vat` | European VAT Number |
412
+ # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
413
+ # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
414
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
415
+ # | Finland | `eu_vat` | European VAT Number |
416
+ # | France | `eu_vat` | European VAT Number |
417
+ # | Georgia | `ge_vat` | Georgian VAT |
418
+ # | Germany | `de_stn` | German Tax Number (Steuernummer) |
419
+ # | Germany | `eu_vat` | European VAT Number |
420
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
421
+ # | Greece | `eu_vat` | European VAT Number |
422
+ # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
423
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
424
+ # | Hungary | `eu_vat` | European VAT Number |
425
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
426
+ # | Iceland | `is_vat` | Icelandic VAT |
427
+ # | India | `in_gst` | Indian GST Number |
428
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
429
+ # | Ireland | `eu_vat` | European VAT Number |
430
+ # | Israel | `il_vat` | Israel VAT |
431
+ # | Italy | `eu_vat` | European VAT Number |
432
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
433
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
434
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
435
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
436
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
437
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
438
+ # | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
439
+ # | Laos | `la_tin` | Laos Tax Identification Number |
440
+ # | Latvia | `eu_vat` | European VAT Number |
441
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
442
+ # | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
443
+ # | Lithuania | `eu_vat` | European VAT Number |
444
+ # | Luxembourg | `eu_vat` | European VAT Number |
445
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
446
+ # | Malaysia | `my_itn` | Malaysian ITN |
447
+ # | Malaysia | `my_sst` | Malaysian SST Number |
448
+ # | Malta | `eu_vat` | European VAT Number |
449
+ # | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
450
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
451
+ # | Moldova | `md_vat` | Moldova VAT Number |
452
+ # | Montenegro | `me_pib` | Montenegro PIB Number |
453
+ # | Morocco | `ma_vat` | Morocco VAT Number |
454
+ # | Nepal | `np_pan` | Nepal PAN Number |
455
+ # | Netherlands | `eu_vat` | European VAT Number |
456
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
457
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
458
+ # | North Macedonia | `mk_vat` | North Macedonia VAT Number |
459
+ # | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
460
+ # | Norway | `no_vat` | Norwegian VAT Number |
461
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
462
+ # | Oman | `om_vat` | Omani VAT Number |
463
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
464
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
465
+ # | Philippines | `ph_tin` | Philippines Tax Identification Number |
466
+ # | Poland | `eu_vat` | European VAT Number |
467
+ # | Poland | `pl_nip` | Polish Tax ID Number |
468
+ # | Portugal | `eu_vat` | European VAT Number |
469
+ # | Romania | `eu_vat` | European VAT Number |
470
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
471
+ # | Russia | `ru_inn` | Russian INN |
472
+ # | Russia | `ru_kpp` | Russian KPP |
473
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
474
+ # | Senegal | `sn_ninea` | Senegal NINEA Number |
475
+ # | Serbia | `rs_pib` | Serbian PIB Number |
476
+ # | Singapore | `sg_gst` | Singaporean GST |
477
+ # | Singapore | `sg_uen` | Singaporean UEN |
478
+ # | Slovakia | `eu_vat` | European VAT Number |
479
+ # | Slovenia | `eu_vat` | European VAT Number |
480
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
481
+ # | South Africa | `za_vat` | South African VAT Number |
482
+ # | South Korea | `kr_brn` | Korean BRN |
483
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
484
+ # | Spain | `eu_vat` | European VAT Number |
485
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
486
+ # | Suriname | `sr_fin` | Suriname FIN Number |
487
+ # | Sweden | `eu_vat` | European VAT Number |
488
+ # | Switzerland | `ch_uid` | Switzerland UID Number |
489
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
490
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
491
+ # | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
492
+ # | Tanzania | `tz_vat` | Tanzania VAT Number |
493
+ # | Thailand | `th_vat` | Thai VAT |
494
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
495
+ # | Uganda | `ug_tin` | Uganda Tax Identification Number |
496
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
497
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
498
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
499
+ # | United States | `us_ein` | United States EIN |
500
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
501
+ # | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
502
+ # | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
503
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
504
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
505
+ # | Zambia | `zm_tin` | Zambia Tax Identification Number |
506
+ # | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
507
+ sig { returns(T.nilable(Orb::CustomerTaxID)) }
508
+ attr_reader :customer_tax_id
509
+
510
+ sig do
511
+ params(customer_tax_id: T.nilable(Orb::CustomerTaxID::OrHash)).void
512
+ end
513
+ attr_writer :customer_tax_id
514
+
515
+ # When the invoice payment is due. The due date is null if the invoice is not yet
516
+ # finalized.
517
+ sig { returns(T.nilable(Time)) }
518
+ attr_accessor :due_date
519
+
520
+ # If the invoice has a status of `draft`, this will be the time that the invoice
521
+ # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
522
+ # true, the invoice will automatically begin issuing at this time.
523
+ sig { returns(T.nilable(Time)) }
524
+ attr_accessor :eligible_to_issue_at
525
+
526
+ # A URL for the customer-facing invoice portal. This URL expires 60 days after the
527
+ # link is generated, or 30 days after the invoice's due date — whichever is later.
528
+ sig { returns(T.nilable(String)) }
529
+ attr_accessor :hosted_invoice_url
530
+
531
+ # The scheduled date of the invoice
532
+ sig { returns(Time) }
533
+ attr_accessor :invoice_date
534
+
535
+ # Automatically generated invoice number to help track and reconcile invoices.
536
+ # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
537
+ # account or customer.
538
+ sig { returns(String) }
539
+ attr_accessor :invoice_number
540
+
541
+ # The link to download the PDF representation of the `Invoice`.
542
+ sig { returns(T.nilable(String)) }
543
+ attr_accessor :invoice_pdf
544
+
545
+ sig do
546
+ returns(
547
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::InvoiceSource::TaggedSymbol
548
+ )
549
+ end
550
+ attr_accessor :invoice_source
551
+
552
+ # If the invoice failed to issue, this will be the last time it failed to issue
553
+ # (even if it is now in a different state.)
554
+ sig { returns(T.nilable(Time)) }
555
+ attr_accessor :issue_failed_at
556
+
557
+ # If the invoice has been issued, this will be the time it transitioned to
558
+ # `issued` (even if it is now in a different state.)
559
+ sig { returns(T.nilable(Time)) }
560
+ attr_accessor :issued_at
561
+
562
+ # Free-form text which is available on the invoice PDF and the Orb invoice portal.
563
+ sig { returns(T.nilable(String)) }
564
+ attr_accessor :memo
565
+
566
+ # User specified key-value pairs for the resource. If not present, this defaults
567
+ # to an empty dictionary. Individual keys can be removed by setting the value to
568
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
569
+ # `null`.
570
+ sig { returns(T::Hash[Symbol, String]) }
571
+ attr_accessor :metadata
572
+
573
+ # If the invoice has a status of `paid`, this gives a timestamp when the invoice
574
+ # was paid.
575
+ sig { returns(T.nilable(Time)) }
576
+ attr_accessor :paid_at
577
+
578
+ # A list of payment attempts associated with the invoice
579
+ sig do
580
+ returns(
581
+ T::Array[
582
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt
583
+ ]
584
+ )
585
+ end
586
+ attr_accessor :payment_attempts
587
+
588
+ # If payment was attempted on this invoice but failed, this will be the time of
589
+ # the most recent attempt.
590
+ sig { returns(T.nilable(Time)) }
591
+ attr_accessor :payment_failed_at
592
+
593
+ # When payment for this invoice was received. For an invoice manually marked as
594
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
595
+ # through a payment provider, this is the settlement time reported by that
596
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
597
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
598
+ # when the invoice reached the `paid` status in Orb.
599
+ sig { returns(T.nilable(Time)) }
600
+ attr_accessor :payment_received_at
601
+
602
+ # If payment was attempted on this invoice, this will be the start time of the
603
+ # most recent attempt. This field is especially useful for delayed-notification
604
+ # payment mechanisms (like bank transfers), where payment can take 3 days or more.
605
+ sig { returns(T.nilable(Time)) }
606
+ attr_accessor :payment_started_at
607
+
608
+ # If the invoice is in draft, this timestamp will reflect when the invoice is
609
+ # scheduled to be issued.
610
+ sig { returns(T.nilable(Time)) }
611
+ attr_accessor :scheduled_issue_at
612
+
613
+ sig { returns(T.nilable(Orb::Address)) }
614
+ attr_reader :shipping_address
615
+
616
+ sig { params(shipping_address: T.nilable(Orb::Address::OrHash)).void }
617
+ attr_writer :shipping_address
618
+
619
+ sig do
620
+ returns(
621
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol
622
+ )
623
+ end
624
+ attr_accessor :status
625
+
626
+ sig { returns(T.nilable(Orb::SubscriptionMinified)) }
627
+ attr_reader :subscription
628
+
629
+ sig do
630
+ params(
631
+ subscription: T.nilable(Orb::SubscriptionMinified::OrHash)
632
+ ).void
633
+ end
634
+ attr_writer :subscription
635
+
636
+ # If the invoice failed to sync, this will be the last time an external invoicing
637
+ # provider sync was attempted. This field will always be `null` for invoices using
638
+ # Orb Invoicing.
639
+ sig { returns(T.nilable(Time)) }
640
+ attr_accessor :sync_failed_at
641
+
642
+ # The total after any minimums and discounts have been applied.
643
+ sig { returns(String) }
644
+ attr_accessor :total
645
+
646
+ # If the invoice has a status of `void`, this gives a timestamp when the invoice
647
+ # was voided.
648
+ sig { returns(T.nilable(Time)) }
649
+ attr_accessor :voided_at
650
+
651
+ # This is true if the invoice will be automatically issued in the future, and
652
+ # false otherwise.
653
+ sig { returns(T::Boolean) }
654
+ attr_accessor :will_auto_issue
655
+
656
+ # #InvoiceApiResourceWithoutLineItems
657
+ sig do
658
+ params(
659
+ id: String,
660
+ amount_due: String,
661
+ auto_collection:
662
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::AutoCollection::OrHash,
663
+ billing_address: T.nilable(Orb::Address::OrHash),
664
+ created_at: Time,
665
+ credit_notes:
666
+ T::Array[
667
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CreditNote::OrHash
668
+ ],
669
+ currency: String,
670
+ customer: Orb::CustomerMinified::OrHash,
671
+ customer_balance_transactions:
672
+ T::Array[
673
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::OrHash
674
+ ],
675
+ customer_tax_id: T.nilable(Orb::CustomerTaxID::OrHash),
676
+ due_date: T.nilable(Time),
677
+ eligible_to_issue_at: T.nilable(Time),
678
+ hosted_invoice_url: T.nilable(String),
679
+ invoice_date: Time,
680
+ invoice_number: String,
681
+ invoice_pdf: T.nilable(String),
682
+ invoice_source:
683
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::InvoiceSource::OrSymbol,
684
+ issue_failed_at: T.nilable(Time),
685
+ issued_at: T.nilable(Time),
686
+ memo: T.nilable(String),
687
+ metadata: T::Hash[Symbol, String],
688
+ paid_at: T.nilable(Time),
689
+ payment_attempts:
690
+ T::Array[
691
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt::OrHash
692
+ ],
693
+ payment_failed_at: T.nilable(Time),
694
+ payment_received_at: T.nilable(Time),
695
+ payment_started_at: T.nilable(Time),
696
+ scheduled_issue_at: T.nilable(Time),
697
+ shipping_address: T.nilable(Orb::Address::OrHash),
698
+ status:
699
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::OrSymbol,
700
+ subscription: T.nilable(Orb::SubscriptionMinified::OrHash),
701
+ sync_failed_at: T.nilable(Time),
702
+ total: String,
703
+ voided_at: T.nilable(Time),
704
+ will_auto_issue: T::Boolean
705
+ ).returns(T.attached_class)
706
+ end
707
+ def self.new(
708
+ id:,
709
+ # This is the final amount required to be charged to the customer and reflects the
710
+ # application of the customer balance to the `total` of the invoice.
711
+ amount_due:,
712
+ auto_collection:,
713
+ billing_address:,
714
+ # The creation time of the resource in Orb.
715
+ created_at:,
716
+ # A list of credit notes associated with the invoice
717
+ credit_notes:,
718
+ # An ISO 4217 currency string or `credits`
719
+ currency:,
720
+ customer:,
721
+ customer_balance_transactions:,
722
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
723
+ # added to the headers of invoices.
724
+ #
725
+ # ### Supported Tax ID Countries and Types
726
+ #
727
+ # | Country | Type | Description |
728
+ # | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
729
+ # | Albania | `al_tin` | Albania Tax Identification Number |
730
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
731
+ # | Angola | `ao_tin` | Angola Tax Identification Number |
732
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
733
+ # | Armenia | `am_tin` | Armenia Tax Identification Number |
734
+ # | Aruba | `aw_tin` | Aruba Tax Identification Number |
735
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
736
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
737
+ # | Austria | `eu_vat` | European VAT Number |
738
+ # | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
739
+ # | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
740
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
741
+ # | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
742
+ # | Barbados | `bb_tin` | Barbados Tax Identification Number |
743
+ # | Belarus | `by_tin` | Belarus TIN Number |
744
+ # | Belgium | `eu_vat` | European VAT Number |
745
+ # | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
746
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
747
+ # | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
748
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
749
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
750
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
751
+ # | Bulgaria | `eu_vat` | European VAT Number |
752
+ # | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
753
+ # | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
754
+ # | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
755
+ # | Canada | `ca_bn` | Canadian BN |
756
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
757
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
758
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
759
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
760
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
761
+ # | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
762
+ # | Chile | `cl_tin` | Chilean TIN |
763
+ # | China | `cn_tin` | Chinese Tax ID |
764
+ # | Colombia | `co_nit` | Colombian NIT Number |
765
+ # | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
766
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
767
+ # | Croatia | `eu_vat` | European VAT Number |
768
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
769
+ # | Cyprus | `eu_vat` | European VAT Number |
770
+ # | Czech Republic | `eu_vat` | European VAT Number |
771
+ # | Denmark | `eu_vat` | European VAT Number |
772
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
773
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
774
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
775
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
776
+ # | Estonia | `eu_vat` | European VAT Number |
777
+ # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
778
+ # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
779
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
780
+ # | Finland | `eu_vat` | European VAT Number |
781
+ # | France | `eu_vat` | European VAT Number |
782
+ # | Georgia | `ge_vat` | Georgian VAT |
783
+ # | Germany | `de_stn` | German Tax Number (Steuernummer) |
784
+ # | Germany | `eu_vat` | European VAT Number |
785
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
786
+ # | Greece | `eu_vat` | European VAT Number |
787
+ # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
788
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
789
+ # | Hungary | `eu_vat` | European VAT Number |
790
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
791
+ # | Iceland | `is_vat` | Icelandic VAT |
792
+ # | India | `in_gst` | Indian GST Number |
793
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
794
+ # | Ireland | `eu_vat` | European VAT Number |
795
+ # | Israel | `il_vat` | Israel VAT |
796
+ # | Italy | `eu_vat` | European VAT Number |
797
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
798
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
799
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
800
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
801
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
802
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
803
+ # | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
804
+ # | Laos | `la_tin` | Laos Tax Identification Number |
805
+ # | Latvia | `eu_vat` | European VAT Number |
806
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
807
+ # | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
808
+ # | Lithuania | `eu_vat` | European VAT Number |
809
+ # | Luxembourg | `eu_vat` | European VAT Number |
810
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
811
+ # | Malaysia | `my_itn` | Malaysian ITN |
812
+ # | Malaysia | `my_sst` | Malaysian SST Number |
813
+ # | Malta | `eu_vat` | European VAT Number |
814
+ # | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
815
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
816
+ # | Moldova | `md_vat` | Moldova VAT Number |
817
+ # | Montenegro | `me_pib` | Montenegro PIB Number |
818
+ # | Morocco | `ma_vat` | Morocco VAT Number |
819
+ # | Nepal | `np_pan` | Nepal PAN Number |
820
+ # | Netherlands | `eu_vat` | European VAT Number |
821
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
822
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
823
+ # | North Macedonia | `mk_vat` | North Macedonia VAT Number |
824
+ # | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
825
+ # | Norway | `no_vat` | Norwegian VAT Number |
826
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
827
+ # | Oman | `om_vat` | Omani VAT Number |
828
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
829
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
830
+ # | Philippines | `ph_tin` | Philippines Tax Identification Number |
831
+ # | Poland | `eu_vat` | European VAT Number |
832
+ # | Poland | `pl_nip` | Polish Tax ID Number |
833
+ # | Portugal | `eu_vat` | European VAT Number |
834
+ # | Romania | `eu_vat` | European VAT Number |
835
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
836
+ # | Russia | `ru_inn` | Russian INN |
837
+ # | Russia | `ru_kpp` | Russian KPP |
838
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
839
+ # | Senegal | `sn_ninea` | Senegal NINEA Number |
840
+ # | Serbia | `rs_pib` | Serbian PIB Number |
841
+ # | Singapore | `sg_gst` | Singaporean GST |
842
+ # | Singapore | `sg_uen` | Singaporean UEN |
843
+ # | Slovakia | `eu_vat` | European VAT Number |
844
+ # | Slovenia | `eu_vat` | European VAT Number |
845
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
846
+ # | South Africa | `za_vat` | South African VAT Number |
847
+ # | South Korea | `kr_brn` | Korean BRN |
848
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
849
+ # | Spain | `eu_vat` | European VAT Number |
850
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
851
+ # | Suriname | `sr_fin` | Suriname FIN Number |
852
+ # | Sweden | `eu_vat` | European VAT Number |
853
+ # | Switzerland | `ch_uid` | Switzerland UID Number |
854
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
855
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
856
+ # | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
857
+ # | Tanzania | `tz_vat` | Tanzania VAT Number |
858
+ # | Thailand | `th_vat` | Thai VAT |
859
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
860
+ # | Uganda | `ug_tin` | Uganda Tax Identification Number |
861
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
862
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
863
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
864
+ # | United States | `us_ein` | United States EIN |
865
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
866
+ # | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
867
+ # | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
868
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
869
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
870
+ # | Zambia | `zm_tin` | Zambia Tax Identification Number |
871
+ # | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
872
+ customer_tax_id:,
873
+ # When the invoice payment is due. The due date is null if the invoice is not yet
874
+ # finalized.
875
+ due_date:,
876
+ # If the invoice has a status of `draft`, this will be the time that the invoice
877
+ # will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is
878
+ # true, the invoice will automatically begin issuing at this time.
879
+ eligible_to_issue_at:,
880
+ # A URL for the customer-facing invoice portal. This URL expires 60 days after the
881
+ # link is generated, or 30 days after the invoice's due date — whichever is later.
882
+ hosted_invoice_url:,
883
+ # The scheduled date of the invoice
884
+ invoice_date:,
885
+ # Automatically generated invoice number to help track and reconcile invoices.
886
+ # Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per
887
+ # account or customer.
888
+ invoice_number:,
889
+ # The link to download the PDF representation of the `Invoice`.
890
+ invoice_pdf:,
891
+ invoice_source:,
892
+ # If the invoice failed to issue, this will be the last time it failed to issue
893
+ # (even if it is now in a different state.)
894
+ issue_failed_at:,
895
+ # If the invoice has been issued, this will be the time it transitioned to
896
+ # `issued` (even if it is now in a different state.)
897
+ issued_at:,
898
+ # Free-form text which is available on the invoice PDF and the Orb invoice portal.
899
+ memo:,
900
+ # User specified key-value pairs for the resource. If not present, this defaults
901
+ # to an empty dictionary. Individual keys can be removed by setting the value to
902
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
903
+ # `null`.
904
+ metadata:,
905
+ # If the invoice has a status of `paid`, this gives a timestamp when the invoice
906
+ # was paid.
907
+ paid_at:,
908
+ # A list of payment attempts associated with the invoice
909
+ payment_attempts:,
910
+ # If payment was attempted on this invoice but failed, this will be the time of
911
+ # the most recent attempt.
912
+ payment_failed_at:,
913
+ # When payment for this invoice was received. For an invoice manually marked as
914
+ # paid, this is the `payment_received_date` that was supplied. For an invoice paid
915
+ # through a payment provider, this is the settlement time reported by that
916
+ # provider. It is `null` for an invoice that became `paid` without a payment, such
917
+ # as a $0 invoice or one fully covered by credit notes. By contrast, `paid_at` is
918
+ # when the invoice reached the `paid` status in Orb.
919
+ payment_received_at:,
920
+ # If payment was attempted on this invoice, this will be the start time of the
921
+ # most recent attempt. This field is especially useful for delayed-notification
922
+ # payment mechanisms (like bank transfers), where payment can take 3 days or more.
923
+ payment_started_at:,
924
+ # If the invoice is in draft, this timestamp will reflect when the invoice is
925
+ # scheduled to be issued.
926
+ scheduled_issue_at:,
927
+ shipping_address:,
928
+ status:,
929
+ subscription:,
930
+ # If the invoice failed to sync, this will be the last time an external invoicing
931
+ # provider sync was attempted. This field will always be `null` for invoices using
932
+ # Orb Invoicing.
933
+ sync_failed_at:,
934
+ # The total after any minimums and discounts have been applied.
935
+ total:,
936
+ # If the invoice has a status of `void`, this gives a timestamp when the invoice
937
+ # was voided.
938
+ voided_at:,
939
+ # This is true if the invoice will be automatically issued in the future, and
940
+ # false otherwise.
941
+ will_auto_issue:
942
+ )
943
+ end
944
+
945
+ sig do
946
+ override.returns(
947
+ {
948
+ id: String,
949
+ amount_due: String,
950
+ auto_collection:
951
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::AutoCollection,
952
+ billing_address: T.nilable(Orb::Address),
953
+ created_at: Time,
954
+ credit_notes:
955
+ T::Array[
956
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CreditNote
957
+ ],
958
+ currency: String,
959
+ customer: Orb::CustomerMinified,
960
+ customer_balance_transactions:
961
+ T::Array[
962
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction
963
+ ],
964
+ customer_tax_id: T.nilable(Orb::CustomerTaxID),
965
+ due_date: T.nilable(Time),
966
+ eligible_to_issue_at: T.nilable(Time),
967
+ hosted_invoice_url: T.nilable(String),
968
+ invoice_date: Time,
969
+ invoice_number: String,
970
+ invoice_pdf: T.nilable(String),
971
+ invoice_source:
972
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::InvoiceSource::TaggedSymbol,
973
+ issue_failed_at: T.nilable(Time),
974
+ issued_at: T.nilable(Time),
975
+ memo: T.nilable(String),
976
+ metadata: T::Hash[Symbol, String],
977
+ paid_at: T.nilable(Time),
978
+ payment_attempts:
979
+ T::Array[
980
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt
981
+ ],
982
+ payment_failed_at: T.nilable(Time),
983
+ payment_received_at: T.nilable(Time),
984
+ payment_started_at: T.nilable(Time),
985
+ scheduled_issue_at: T.nilable(Time),
986
+ shipping_address: T.nilable(Orb::Address),
987
+ status:
988
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol,
989
+ subscription: T.nilable(Orb::SubscriptionMinified),
990
+ sync_failed_at: T.nilable(Time),
991
+ total: String,
992
+ voided_at: T.nilable(Time),
993
+ will_auto_issue: T::Boolean
994
+ }
995
+ )
996
+ end
997
+ def to_hash
998
+ end
999
+
1000
+ class AutoCollection < Orb::Internal::Type::BaseModel
1001
+ OrHash =
1002
+ T.type_alias do
1003
+ T.any(
1004
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::AutoCollection,
1005
+ Orb::Internal::AnyHash
1006
+ )
1007
+ end
1008
+
1009
+ # True only if auto-collection is enabled for this invoice.
1010
+ sig { returns(T.nilable(T::Boolean)) }
1011
+ attr_accessor :enabled
1012
+
1013
+ # If the invoice is scheduled for auto-collection, this field will reflect when
1014
+ # the next attempt will occur. If dunning has been exhausted, or auto-collection
1015
+ # is not enabled for this invoice, this field will be `null`.
1016
+ sig { returns(T.nilable(Time)) }
1017
+ attr_accessor :next_attempt_at
1018
+
1019
+ # Number of auto-collection payment attempts.
1020
+ sig { returns(T.nilable(Integer)) }
1021
+ attr_accessor :num_attempts
1022
+
1023
+ # If Orb has ever attempted payment auto-collection for this invoice, this field
1024
+ # will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
1025
+ # this can be used to tell whether the invoice is currently in dunning (that is,
1026
+ # `previously_attempted_at` is non-null, and `next_attempt_at` is non-null), or if
1027
+ # dunning has been exhausted (`previously_attempted_at` is non-null, but
1028
+ # `next_attempt_at` is null).
1029
+ sig { returns(T.nilable(Time)) }
1030
+ attr_accessor :previously_attempted_at
1031
+
1032
+ sig do
1033
+ params(
1034
+ enabled: T.nilable(T::Boolean),
1035
+ next_attempt_at: T.nilable(Time),
1036
+ num_attempts: T.nilable(Integer),
1037
+ previously_attempted_at: T.nilable(Time)
1038
+ ).returns(T.attached_class)
1039
+ end
1040
+ def self.new(
1041
+ # True only if auto-collection is enabled for this invoice.
1042
+ enabled:,
1043
+ # If the invoice is scheduled for auto-collection, this field will reflect when
1044
+ # the next attempt will occur. If dunning has been exhausted, or auto-collection
1045
+ # is not enabled for this invoice, this field will be `null`.
1046
+ next_attempt_at:,
1047
+ # Number of auto-collection payment attempts.
1048
+ num_attempts:,
1049
+ # If Orb has ever attempted payment auto-collection for this invoice, this field
1050
+ # will reflect when that attempt occurred. In conjunction with `next_attempt_at`,
1051
+ # this can be used to tell whether the invoice is currently in dunning (that is,
1052
+ # `previously_attempted_at` is non-null, and `next_attempt_at` is non-null), or if
1053
+ # dunning has been exhausted (`previously_attempted_at` is non-null, but
1054
+ # `next_attempt_at` is null).
1055
+ previously_attempted_at:
1056
+ )
1057
+ end
1058
+
1059
+ sig do
1060
+ override.returns(
1061
+ {
1062
+ enabled: T.nilable(T::Boolean),
1063
+ next_attempt_at: T.nilable(Time),
1064
+ num_attempts: T.nilable(Integer),
1065
+ previously_attempted_at: T.nilable(Time)
1066
+ }
1067
+ )
1068
+ end
1069
+ def to_hash
1070
+ end
1071
+ end
1072
+
1073
+ class CreditNote < Orb::Internal::Type::BaseModel
1074
+ OrHash =
1075
+ T.type_alias do
1076
+ T.any(
1077
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CreditNote,
1078
+ Orb::Internal::AnyHash
1079
+ )
1080
+ end
1081
+
1082
+ sig { returns(String) }
1083
+ attr_accessor :id
1084
+
1085
+ sig { returns(String) }
1086
+ attr_accessor :credit_note_number
1087
+
1088
+ # An optional memo supplied on the credit note.
1089
+ sig { returns(T.nilable(String)) }
1090
+ attr_accessor :memo
1091
+
1092
+ sig { returns(String) }
1093
+ attr_accessor :reason
1094
+
1095
+ sig { returns(String) }
1096
+ attr_accessor :total
1097
+
1098
+ sig { returns(String) }
1099
+ attr_accessor :type
1100
+
1101
+ # If the credit note has a status of `void`, this gives a timestamp when the
1102
+ # credit note was voided.
1103
+ sig { returns(T.nilable(Time)) }
1104
+ attr_accessor :voided_at
1105
+
1106
+ sig do
1107
+ params(
1108
+ id: String,
1109
+ credit_note_number: String,
1110
+ memo: T.nilable(String),
1111
+ reason: String,
1112
+ total: String,
1113
+ type: String,
1114
+ voided_at: T.nilable(Time)
1115
+ ).returns(T.attached_class)
1116
+ end
1117
+ def self.new(
1118
+ id:,
1119
+ credit_note_number:,
1120
+ # An optional memo supplied on the credit note.
1121
+ memo:,
1122
+ reason:,
1123
+ total:,
1124
+ type:,
1125
+ # If the credit note has a status of `void`, this gives a timestamp when the
1126
+ # credit note was voided.
1127
+ voided_at:
1128
+ )
1129
+ end
1130
+
1131
+ sig do
1132
+ override.returns(
1133
+ {
1134
+ id: String,
1135
+ credit_note_number: String,
1136
+ memo: T.nilable(String),
1137
+ reason: String,
1138
+ total: String,
1139
+ type: String,
1140
+ voided_at: T.nilable(Time)
1141
+ }
1142
+ )
1143
+ end
1144
+ def to_hash
1145
+ end
1146
+ end
1147
+
1148
+ class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
1149
+ OrHash =
1150
+ T.type_alias do
1151
+ T.any(
1152
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction,
1153
+ Orb::Internal::AnyHash
1154
+ )
1155
+ end
1156
+
1157
+ # A unique id for this transaction.
1158
+ sig { returns(String) }
1159
+ attr_accessor :id
1160
+
1161
+ sig do
1162
+ returns(
1163
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1164
+ )
1165
+ end
1166
+ attr_accessor :action
1167
+
1168
+ # The value of the amount changed in the transaction.
1169
+ sig { returns(String) }
1170
+ attr_accessor :amount
1171
+
1172
+ # The creation time of this transaction.
1173
+ sig { returns(Time) }
1174
+ attr_accessor :created_at
1175
+
1176
+ sig { returns(T.nilable(Orb::CreditNoteTiny)) }
1177
+ attr_reader :credit_note
1178
+
1179
+ sig do
1180
+ params(credit_note: T.nilable(Orb::CreditNoteTiny::OrHash)).void
1181
+ end
1182
+ attr_writer :credit_note
1183
+
1184
+ # An optional description provided for manual customer balance adjustments.
1185
+ sig { returns(T.nilable(String)) }
1186
+ attr_accessor :description
1187
+
1188
+ # The new value of the customer's balance prior to the transaction, in the
1189
+ # customer's currency.
1190
+ sig { returns(String) }
1191
+ attr_accessor :ending_balance
1192
+
1193
+ sig { returns(T.nilable(Orb::InvoiceTiny)) }
1194
+ attr_reader :invoice
1195
+
1196
+ sig { params(invoice: T.nilable(Orb::InvoiceTiny::OrHash)).void }
1197
+ attr_writer :invoice
1198
+
1199
+ # The original value of the customer's balance prior to the transaction, in the
1200
+ # customer's currency.
1201
+ sig { returns(String) }
1202
+ attr_accessor :starting_balance
1203
+
1204
+ sig do
1205
+ returns(
1206
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
1207
+ )
1208
+ end
1209
+ attr_accessor :type
1210
+
1211
+ sig do
1212
+ params(
1213
+ id: String,
1214
+ action:
1215
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::OrSymbol,
1216
+ amount: String,
1217
+ created_at: Time,
1218
+ credit_note: T.nilable(Orb::CreditNoteTiny::OrHash),
1219
+ description: T.nilable(String),
1220
+ ending_balance: String,
1221
+ invoice: T.nilable(Orb::InvoiceTiny::OrHash),
1222
+ starting_balance: String,
1223
+ type:
1224
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type::OrSymbol
1225
+ ).returns(T.attached_class)
1226
+ end
1227
+ def self.new(
1228
+ # A unique id for this transaction.
1229
+ id:,
1230
+ action:,
1231
+ # The value of the amount changed in the transaction.
1232
+ amount:,
1233
+ # The creation time of this transaction.
1234
+ created_at:,
1235
+ credit_note:,
1236
+ # An optional description provided for manual customer balance adjustments.
1237
+ description:,
1238
+ # The new value of the customer's balance prior to the transaction, in the
1239
+ # customer's currency.
1240
+ ending_balance:,
1241
+ invoice:,
1242
+ # The original value of the customer's balance prior to the transaction, in the
1243
+ # customer's currency.
1244
+ starting_balance:,
1245
+ type:
1246
+ )
1247
+ end
1248
+
1249
+ sig do
1250
+ override.returns(
1251
+ {
1252
+ id: String,
1253
+ action:
1254
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol,
1255
+ amount: String,
1256
+ created_at: Time,
1257
+ credit_note: T.nilable(Orb::CreditNoteTiny),
1258
+ description: T.nilable(String),
1259
+ ending_balance: String,
1260
+ invoice: T.nilable(Orb::InvoiceTiny),
1261
+ starting_balance: String,
1262
+ type:
1263
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
1264
+ }
1265
+ )
1266
+ end
1267
+ def to_hash
1268
+ end
1269
+
1270
+ module Action
1271
+ extend Orb::Internal::Type::Enum
1272
+
1273
+ TaggedSymbol =
1274
+ T.type_alias do
1275
+ T.all(
1276
+ Symbol,
1277
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action
1278
+ )
1279
+ end
1280
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1281
+
1282
+ APPLIED_TO_INVOICE =
1283
+ T.let(
1284
+ :applied_to_invoice,
1285
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1286
+ )
1287
+ MANUAL_ADJUSTMENT =
1288
+ T.let(
1289
+ :manual_adjustment,
1290
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1291
+ )
1292
+ PRORATED_REFUND =
1293
+ T.let(
1294
+ :prorated_refund,
1295
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1296
+ )
1297
+ REVERT_PRORATED_REFUND =
1298
+ T.let(
1299
+ :revert_prorated_refund,
1300
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1301
+ )
1302
+ RETURN_FROM_VOIDING =
1303
+ T.let(
1304
+ :return_from_voiding,
1305
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1306
+ )
1307
+ CREDIT_NOTE_APPLIED =
1308
+ T.let(
1309
+ :credit_note_applied,
1310
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1311
+ )
1312
+ CREDIT_NOTE_VOIDED =
1313
+ T.let(
1314
+ :credit_note_voided,
1315
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1316
+ )
1317
+ OVERPAYMENT_REFUND =
1318
+ T.let(
1319
+ :overpayment_refund,
1320
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1321
+ )
1322
+ EXTERNAL_PAYMENT =
1323
+ T.let(
1324
+ :external_payment,
1325
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1326
+ )
1327
+ SMALL_INVOICE_CARRYOVER =
1328
+ T.let(
1329
+ :small_invoice_carryover,
1330
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1331
+ )
1332
+ PREPAID_COMMIT_CANCEL =
1333
+ T.let(
1334
+ :prepaid_commit_cancel,
1335
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1336
+ )
1337
+
1338
+ sig do
1339
+ override.returns(
1340
+ T::Array[
1341
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Action::TaggedSymbol
1342
+ ]
1343
+ )
1344
+ end
1345
+ def self.values
1346
+ end
1347
+ end
1348
+
1349
+ module Type
1350
+ extend Orb::Internal::Type::Enum
1351
+
1352
+ TaggedSymbol =
1353
+ T.type_alias do
1354
+ T.all(
1355
+ Symbol,
1356
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type
1357
+ )
1358
+ end
1359
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1360
+
1361
+ INCREMENT =
1362
+ T.let(
1363
+ :increment,
1364
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
1365
+ )
1366
+ DECREMENT =
1367
+ T.let(
1368
+ :decrement,
1369
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
1370
+ )
1371
+
1372
+ sig do
1373
+ override.returns(
1374
+ T::Array[
1375
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::CustomerBalanceTransaction::Type::TaggedSymbol
1376
+ ]
1377
+ )
1378
+ end
1379
+ def self.values
1380
+ end
1381
+ end
1382
+ end
1383
+
1384
+ module InvoiceSource
1385
+ extend Orb::Internal::Type::Enum
1386
+
1387
+ TaggedSymbol =
1388
+ T.type_alias do
1389
+ T.all(
1390
+ Symbol,
1391
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::InvoiceSource
1392
+ )
1393
+ end
1394
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1395
+
1396
+ SUBSCRIPTION =
1397
+ T.let(
1398
+ :subscription,
1399
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::InvoiceSource::TaggedSymbol
1400
+ )
1401
+ PARTIAL =
1402
+ T.let(
1403
+ :partial,
1404
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::InvoiceSource::TaggedSymbol
1405
+ )
1406
+ ONE_OFF =
1407
+ T.let(
1408
+ :one_off,
1409
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::InvoiceSource::TaggedSymbol
1410
+ )
1411
+
1412
+ sig do
1413
+ override.returns(
1414
+ T::Array[
1415
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::InvoiceSource::TaggedSymbol
1416
+ ]
1417
+ )
1418
+ end
1419
+ def self.values
1420
+ end
1421
+ end
1422
+
1423
+ class PaymentAttempt < Orb::Internal::Type::BaseModel
1424
+ OrHash =
1425
+ T.type_alias do
1426
+ T.any(
1427
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt,
1428
+ Orb::Internal::AnyHash
1429
+ )
1430
+ end
1431
+
1432
+ # The ID of the payment attempt.
1433
+ sig { returns(String) }
1434
+ attr_accessor :id
1435
+
1436
+ # The amount of the payment attempt.
1437
+ sig { returns(String) }
1438
+ attr_accessor :amount
1439
+
1440
+ # The time at which the payment attempt was created.
1441
+ sig { returns(Time) }
1442
+ attr_accessor :created_at
1443
+
1444
+ # The payment provider that attempted to collect the payment.
1445
+ sig do
1446
+ returns(
1447
+ T.nilable(
1448
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
1449
+ )
1450
+ )
1451
+ end
1452
+ attr_accessor :payment_provider
1453
+
1454
+ # The ID of the payment attempt in the payment provider.
1455
+ sig { returns(T.nilable(String)) }
1456
+ attr_accessor :payment_provider_id
1457
+
1458
+ # URL to the downloadable PDF version of the receipt. This field will be `null`
1459
+ # for payment attempts that did not succeed.
1460
+ sig { returns(T.nilable(String)) }
1461
+ attr_accessor :receipt_pdf
1462
+
1463
+ # Whether the payment attempt succeeded.
1464
+ sig { returns(T::Boolean) }
1465
+ attr_accessor :succeeded
1466
+
1467
+ sig do
1468
+ params(
1469
+ id: String,
1470
+ amount: String,
1471
+ created_at: Time,
1472
+ payment_provider:
1473
+ T.nilable(
1474
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider::OrSymbol
1475
+ ),
1476
+ payment_provider_id: T.nilable(String),
1477
+ receipt_pdf: T.nilable(String),
1478
+ succeeded: T::Boolean
1479
+ ).returns(T.attached_class)
1480
+ end
1481
+ def self.new(
1482
+ # The ID of the payment attempt.
1483
+ id:,
1484
+ # The amount of the payment attempt.
1485
+ amount:,
1486
+ # The time at which the payment attempt was created.
1487
+ created_at:,
1488
+ # The payment provider that attempted to collect the payment.
1489
+ payment_provider:,
1490
+ # The ID of the payment attempt in the payment provider.
1491
+ payment_provider_id:,
1492
+ # URL to the downloadable PDF version of the receipt. This field will be `null`
1493
+ # for payment attempts that did not succeed.
1494
+ receipt_pdf:,
1495
+ # Whether the payment attempt succeeded.
1496
+ succeeded:
1497
+ )
1498
+ end
1499
+
1500
+ sig do
1501
+ override.returns(
1502
+ {
1503
+ id: String,
1504
+ amount: String,
1505
+ created_at: Time,
1506
+ payment_provider:
1507
+ T.nilable(
1508
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
1509
+ ),
1510
+ payment_provider_id: T.nilable(String),
1511
+ receipt_pdf: T.nilable(String),
1512
+ succeeded: T::Boolean
1513
+ }
1514
+ )
1515
+ end
1516
+ def to_hash
1517
+ end
1518
+
1519
+ # The payment provider that attempted to collect the payment.
1520
+ module PaymentProvider
1521
+ extend Orb::Internal::Type::Enum
1522
+
1523
+ TaggedSymbol =
1524
+ T.type_alias do
1525
+ T.all(
1526
+ Symbol,
1527
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider
1528
+ )
1529
+ end
1530
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1531
+
1532
+ STRIPE =
1533
+ T.let(
1534
+ :stripe,
1535
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
1536
+ )
1537
+ ADYEN =
1538
+ T.let(
1539
+ :adyen,
1540
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
1541
+ )
1542
+
1543
+ sig do
1544
+ override.returns(
1545
+ T::Array[
1546
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::PaymentAttempt::PaymentProvider::TaggedSymbol
1547
+ ]
1548
+ )
1549
+ end
1550
+ def self.values
1551
+ end
1552
+ end
1553
+ end
1554
+
1555
+ module Status
1556
+ extend Orb::Internal::Type::Enum
1557
+
1558
+ TaggedSymbol =
1559
+ T.type_alias do
1560
+ T.all(
1561
+ Symbol,
1562
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status
1563
+ )
1564
+ end
1565
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1566
+
1567
+ ISSUED =
1568
+ T.let(
1569
+ :issued,
1570
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol
1571
+ )
1572
+ PAID =
1573
+ T.let(
1574
+ :paid,
1575
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol
1576
+ )
1577
+ SYNCED =
1578
+ T.let(
1579
+ :synced,
1580
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol
1581
+ )
1582
+ VOID =
1583
+ T.let(
1584
+ :void,
1585
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol
1586
+ )
1587
+ DRAFT =
1588
+ T.let(
1589
+ :draft,
1590
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol
1591
+ )
1592
+
1593
+ sig do
1594
+ override.returns(
1595
+ T::Array[
1596
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Invoice::Status::TaggedSymbol
1597
+ ]
1598
+ )
1599
+ end
1600
+ def self.values
1601
+ end
1602
+ end
1603
+ end
1604
+
1605
+ # The serialization style this payload was rendered in, as configured on the
1606
+ # endpoint.
1607
+ module PayloadStyle
1608
+ extend Orb::Internal::Type::Enum
1609
+
1610
+ TaggedSymbol =
1611
+ T.type_alias do
1612
+ T.all(
1613
+ Symbol,
1614
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::PayloadStyle
1615
+ )
1616
+ end
1617
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1618
+
1619
+ EXPANDED =
1620
+ T.let(
1621
+ :expanded,
1622
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
1623
+ )
1624
+ STANDARD =
1625
+ T.let(
1626
+ :standard,
1627
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
1628
+ )
1629
+
1630
+ sig do
1631
+ override.returns(
1632
+ T::Array[
1633
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::PayloadStyle::TaggedSymbol
1634
+ ]
1635
+ )
1636
+ end
1637
+ def self.values
1638
+ end
1639
+ end
1640
+
1641
+ class Properties < Orb::Internal::Type::BaseModel
1642
+ OrHash =
1643
+ T.type_alias do
1644
+ T.any(
1645
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Properties,
1646
+ Orb::Internal::AnyHash
1647
+ )
1648
+ end
1649
+
1650
+ sig { returns(String) }
1651
+ attr_accessor :connection_type
1652
+
1653
+ sig { params(connection_type: String).returns(T.attached_class) }
1654
+ def self.new(connection_type:)
1655
+ end
1656
+
1657
+ sig { override.returns({ connection_type: String }) }
1658
+ def to_hash
1659
+ end
1660
+ end
1661
+
1662
+ # The event this payload describes.
1663
+ module Type
1664
+ extend Orb::Internal::Type::Enum
1665
+
1666
+ TaggedSymbol =
1667
+ T.type_alias do
1668
+ T.all(
1669
+ Symbol,
1670
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Type
1671
+ )
1672
+ end
1673
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1674
+
1675
+ INVOICE_ACCOUNTING_SYNC_SUCCEEDED =
1676
+ T.let(
1677
+ :"invoice.accounting_sync_succeeded",
1678
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
1679
+ )
1680
+
1681
+ sig do
1682
+ override.returns(
1683
+ T::Array[
1684
+ Orb::Webhooks::InvoiceAccountingSyncSucceededStandardWebhookEvent::Type::TaggedSymbol
1685
+ ]
1686
+ )
1687
+ end
1688
+ def self.values
1689
+ end
1690
+ end
1691
+ end
1692
+ end
1693
+ end
1694
+ end