orb-billing 1.45.0 → 1.47.0

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