orb-billing 1.45.0 → 1.46.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (264) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -1
  3. data/README.md +1 -1
  4. data/lib/orb/models/webhooks/backfill_reflected_standard_webhook_event.rb +206 -0
  5. data/lib/orb/models/webhooks/backfill_reverted_standard_webhook_event.rb +206 -0
  6. data/lib/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rb +131 -0
  7. data/lib/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rb +537 -0
  8. data/lib/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rb +531 -0
  9. data/lib/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rb +188 -0
  10. data/lib/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rb +183 -0
  11. data/lib/orb/models/webhooks/credit_note_issued_standard_webhook_event.rb +90 -0
  12. data/lib/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rb +92 -0
  13. data/lib/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rb +198 -0
  14. data/lib/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rb +193 -0
  15. data/lib/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rb +240 -0
  16. data/lib/orb/models/webhooks/customer_created_standard_webhook_event.rb +106 -0
  17. data/lib/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rb +597 -0
  18. data/lib/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rb +603 -0
  19. data/lib/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rb +597 -0
  20. data/lib/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rb +509 -0
  21. data/lib/orb/models/webhooks/customer_edited_standard_webhook_event.rb +371 -0
  22. data/lib/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rb +130 -0
  23. data/lib/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rb +124 -0
  24. data/lib/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rb +134 -0
  25. data/lib/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rb +94 -0
  26. data/lib/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rb +972 -0
  27. data/lib/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rb +966 -0
  28. data/lib/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rb +367 -0
  29. data/lib/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rb +113 -0
  30. data/lib/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rb +101 -0
  31. data/lib/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rb +101 -0
  32. data/lib/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rb +95 -0
  33. data/lib/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rb +994 -0
  34. data/lib/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rb +988 -0
  35. data/lib/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rb +992 -0
  36. data/lib/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rb +942 -0
  37. data/lib/orb/models/webhooks/invoice_edited_standard_webhook_event.rb +1365 -0
  38. data/lib/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rb +151 -0
  39. data/lib/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rb +885 -0
  40. data/lib/orb/models/webhooks/invoice_issued_standard_webhook_event.rb +884 -0
  41. data/lib/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rb +887 -0
  42. data/lib/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rb +899 -0
  43. data/lib/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rb +876 -0
  44. data/lib/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rb +899 -0
  45. data/lib/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rb +893 -0
  46. data/lib/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rb +908 -0
  47. data/lib/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rb +890 -0
  48. data/lib/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rb +892 -0
  49. data/lib/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rb +875 -0
  50. data/lib/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rb +125 -0
  51. data/lib/orb/models/webhooks/payment_method_created_standard_webhook_event.rb +184 -0
  52. data/lib/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rb +184 -0
  53. data/lib/orb/models/webhooks/plan_created_standard_webhook_event.rb +119 -0
  54. data/lib/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rb +139 -0
  55. data/lib/orb/models/webhooks/plan_edited_standard_webhook_event.rb +159 -0
  56. data/lib/orb/models/webhooks/plan_version_created_standard_webhook_event.rb +138 -0
  57. data/lib/orb/models/webhooks/price_edited_standard_webhook_event.rb +132 -0
  58. data/lib/orb/models/webhooks/resource_event_test_standard_webhook_event.rb +92 -0
  59. data/lib/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rb +972 -0
  60. data/lib/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rb +967 -0
  61. data/lib/orb/models/webhooks/standard_unwrap_standard_params.rb +16 -0
  62. data/lib/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rb +322 -0
  63. data/lib/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rb +316 -0
  64. data/lib/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rb +667 -0
  65. data/lib/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rb +237 -0
  66. data/lib/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rb +237 -0
  67. data/lib/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rb +692 -0
  68. data/lib/orb/models/webhooks/subscription_created_standard_webhook_event.rb +221 -0
  69. data/lib/orb/models/webhooks/subscription_edited_standard_webhook_event.rb +273 -0
  70. data/lib/orb/models/webhooks/subscription_ended_standard_webhook_event.rb +219 -0
  71. data/lib/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rb +255 -0
  72. data/lib/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rb +693 -0
  73. data/lib/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rb +222 -0
  74. data/lib/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rb +244 -0
  75. data/lib/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rb +687 -0
  76. data/lib/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rb +249 -0
  77. data/lib/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rb +233 -0
  78. data/lib/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rb +250 -0
  79. data/lib/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rb +248 -0
  80. data/lib/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rb +693 -0
  81. data/lib/orb/models/webhooks/subscription_started_standard_webhook_event.rb +221 -0
  82. data/lib/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rb +222 -0
  83. data/lib/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rb +700 -0
  84. data/lib/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rb +270 -0
  85. data/lib/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rb +264 -0
  86. data/lib/orb/models/webhooks/unwrap_standard_webhook_event.rb +258 -0
  87. data/lib/orb/models.rb +2 -0
  88. data/lib/orb/resources/webhooks/standard.rb +24 -0
  89. data/lib/orb/resources/webhooks.rb +4 -0
  90. data/lib/orb/version.rb +1 -1
  91. data/lib/orb.rb +84 -0
  92. data/rbi/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbi +349 -0
  93. data/rbi/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbi +347 -0
  94. data/rbi/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbi +273 -0
  95. data/rbi/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbi +1106 -0
  96. data/rbi/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbi +1095 -0
  97. data/rbi/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbi +377 -0
  98. data/rbi/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbi +366 -0
  99. data/rbi/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbi +166 -0
  100. data/rbi/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbi +166 -0
  101. data/rbi/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbi +403 -0
  102. data/rbi/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbi +392 -0
  103. data/rbi/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbi +493 -0
  104. data/rbi/orb/models/webhooks/customer_created_standard_webhook_event.rbi +198 -0
  105. data/rbi/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbi +1151 -0
  106. data/rbi/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbi +1158 -0
  107. data/rbi/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbi +1151 -0
  108. data/rbi/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbi +1044 -0
  109. data/rbi/orb/models/webhooks/customer_edited_standard_webhook_event.rbi +678 -0
  110. data/rbi/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbi +236 -0
  111. data/rbi/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbi +230 -0
  112. data/rbi/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbi +275 -0
  113. data/rbi/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbi +192 -0
  114. data/rbi/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbi +1705 -0
  115. data/rbi/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbi +1694 -0
  116. data/rbi/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbi +670 -0
  117. data/rbi/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbi +210 -0
  118. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbi +195 -0
  119. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbi +195 -0
  120. data/rbi/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbi +188 -0
  121. data/rbi/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbi +1713 -0
  122. data/rbi/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbi +1708 -0
  123. data/rbi/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbi +1713 -0
  124. data/rbi/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbi +1628 -0
  125. data/rbi/orb/models/webhooks/invoice_edited_standard_webhook_event.rbi +2337 -0
  126. data/rbi/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbi +324 -0
  127. data/rbi/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbi +1529 -0
  128. data/rbi/orb/models/webhooks/invoice_issued_standard_webhook_event.rbi +1529 -0
  129. data/rbi/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbi +1534 -0
  130. data/rbi/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbi +1549 -0
  131. data/rbi/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbi +1494 -0
  132. data/rbi/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbi +1554 -0
  133. data/rbi/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbi +1547 -0
  134. data/rbi/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbi +1563 -0
  135. data/rbi/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbi +1542 -0
  136. data/rbi/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbi +1544 -0
  137. data/rbi/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbi +1494 -0
  138. data/rbi/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbi +233 -0
  139. data/rbi/orb/models/webhooks/payment_method_created_standard_webhook_event.rbi +331 -0
  140. data/rbi/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbi +331 -0
  141. data/rbi/orb/models/webhooks/plan_created_standard_webhook_event.rbi +216 -0
  142. data/rbi/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbi +277 -0
  143. data/rbi/orb/models/webhooks/plan_edited_standard_webhook_event.rbi +337 -0
  144. data/rbi/orb/models/webhooks/plan_version_created_standard_webhook_event.rbi +271 -0
  145. data/rbi/orb/models/webhooks/price_edited_standard_webhook_event.rbi +311 -0
  146. data/rbi/orb/models/webhooks/resource_event_test_standard_webhook_event.rbi +191 -0
  147. data/rbi/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbi +1705 -0
  148. data/rbi/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbi +1694 -0
  149. data/rbi/orb/models/webhooks/standard_unwrap_standard_params.rbi +32 -0
  150. data/rbi/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbi +609 -0
  151. data/rbi/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbi +598 -0
  152. data/rbi/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbi +1302 -0
  153. data/rbi/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbi +433 -0
  154. data/rbi/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbi +435 -0
  155. data/rbi/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbi +1298 -0
  156. data/rbi/orb/models/webhooks/subscription_created_standard_webhook_event.rbi +398 -0
  157. data/rbi/orb/models/webhooks/subscription_edited_standard_webhook_event.rbi +520 -0
  158. data/rbi/orb/models/webhooks/subscription_ended_standard_webhook_event.rbi +398 -0
  159. data/rbi/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbi +458 -0
  160. data/rbi/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbi +1321 -0
  161. data/rbi/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbi +428 -0
  162. data/rbi/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbi +477 -0
  163. data/rbi/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbi +1319 -0
  164. data/rbi/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbi +453 -0
  165. data/rbi/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbi +433 -0
  166. data/rbi/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbi +457 -0
  167. data/rbi/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbi +457 -0
  168. data/rbi/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbi +1299 -0
  169. data/rbi/orb/models/webhooks/subscription_started_standard_webhook_event.rbi +398 -0
  170. data/rbi/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbi +398 -0
  171. data/rbi/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbi +1305 -0
  172. data/rbi/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbi +516 -0
  173. data/rbi/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbi +505 -0
  174. data/rbi/orb/models/webhooks/unwrap_standard_webhook_event.rbi +107 -0
  175. data/rbi/orb/models.rbi +2 -0
  176. data/rbi/orb/resources/webhooks/standard.rbi +107 -0
  177. data/rbi/orb/resources/webhooks.rbi +3 -0
  178. data/sig/orb/models/webhooks/backfill_reflected_standard_webhook_event.rbs +148 -0
  179. data/sig/orb/models/webhooks/backfill_reverted_standard_webhook_event.rbs +148 -0
  180. data/sig/orb/models/webhooks/billable_metric_edited_standard_webhook_event.rbs +112 -0
  181. data/sig/orb/models/webhooks/credit_block_accounting_sync_failed_standard_webhook_event.rbs +435 -0
  182. data/sig/orb/models/webhooks/credit_block_accounting_sync_succeeded_standard_webhook_event.rbs +430 -0
  183. data/sig/orb/models/webhooks/credit_note_accounting_sync_failed_standard_webhook_event.rbs +165 -0
  184. data/sig/orb/models/webhooks/credit_note_accounting_sync_succeeded_standard_webhook_event.rbs +160 -0
  185. data/sig/orb/models/webhooks/credit_note_issued_standard_webhook_event.rbs +68 -0
  186. data/sig/orb/models/webhooks/credit_note_marked_as_void_standard_webhook_event.rbs +68 -0
  187. data/sig/orb/models/webhooks/customer_accounting_sync_failed_standard_webhook_event.rbs +160 -0
  188. data/sig/orb/models/webhooks/customer_accounting_sync_succeeded_standard_webhook_event.rbs +155 -0
  189. data/sig/orb/models/webhooks/customer_balance_transaction_created_standard_webhook_event.rbs +189 -0
  190. data/sig/orb/models/webhooks/customer_created_standard_webhook_event.rbs +68 -0
  191. data/sig/orb/models/webhooks/customer_credit_balance_depleted_standard_webhook_event.rbs +396 -0
  192. data/sig/orb/models/webhooks/customer_credit_balance_dropped_standard_webhook_event.rbs +401 -0
  193. data/sig/orb/models/webhooks/customer_credit_balance_recovered_standard_webhook_event.rbs +396 -0
  194. data/sig/orb/models/webhooks/customer_credit_ledger_incremented_standard_webhook_event.rbs +386 -0
  195. data/sig/orb/models/webhooks/customer_edited_standard_webhook_event.rbs +157 -0
  196. data/sig/orb/models/webhooks/data_exports_transfer_error_standard_webhook_event.rbs +110 -0
  197. data/sig/orb/models/webhooks/data_exports_transfer_success_standard_webhook_event.rbs +105 -0
  198. data/sig/orb/models/webhooks/event_unmatched_event_standard_webhook_event.rbs +122 -0
  199. data/sig/orb/models/webhooks/ingestion_unmatched_customer_ids_standard_webhook_event.rbs +73 -0
  200. data/sig/orb/models/webhooks/invoice_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  201. data/sig/orb/models/webhooks/invoice_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  202. data/sig/orb/models/webhooks/invoice_automation_schedule_step_executed_standard_webhook_event.rbs +331 -0
  203. data/sig/orb/models/webhooks/invoice_cost_data_exported_standard_webhook_event.rbs +91 -0
  204. data/sig/orb/models/webhooks/invoice_due_date_recalculation_canceled_standard_webhook_event.rbs +75 -0
  205. data/sig/orb/models/webhooks/invoice_due_date_recalculation_completed_standard_webhook_event.rbs +75 -0
  206. data/sig/orb/models/webhooks/invoice_due_date_recalculation_started_standard_webhook_event.rbs +73 -0
  207. data/sig/orb/models/webhooks/invoice_dunning_schedule_created_standard_webhook_event.rbs +638 -0
  208. data/sig/orb/models/webhooks/invoice_dunning_schedule_ended_standard_webhook_event.rbs +633 -0
  209. data/sig/orb/models/webhooks/invoice_dunning_schedule_reset_standard_webhook_event.rbs +623 -0
  210. data/sig/orb/models/webhooks/invoice_dunning_schedule_step_executed_standard_webhook_event.rbs +586 -0
  211. data/sig/orb/models/webhooks/invoice_edited_standard_webhook_event.rbs +859 -0
  212. data/sig/orb/models/webhooks/invoice_invoice_date_elapsed_standard_webhook_event.rbs +129 -0
  213. data/sig/orb/models/webhooks/invoice_issue_failed_standard_webhook_event.rbs +527 -0
  214. data/sig/orb/models/webhooks/invoice_issued_standard_webhook_event.rbs +527 -0
  215. data/sig/orb/models/webhooks/invoice_issued_summary_standard_webhook_event.rbs +527 -0
  216. data/sig/orb/models/webhooks/invoice_manually_marked_as_paid_standard_webhook_event.rbs +540 -0
  217. data/sig/orb/models/webhooks/invoice_manually_marked_as_void_standard_webhook_event.rbs +517 -0
  218. data/sig/orb/models/webhooks/invoice_payment_failed_standard_webhook_event.rbs +544 -0
  219. data/sig/orb/models/webhooks/invoice_payment_processing_standard_webhook_event.rbs +538 -0
  220. data/sig/orb/models/webhooks/invoice_payment_succeeded_standard_webhook_event.rbs +549 -0
  221. data/sig/orb/models/webhooks/invoice_sync_failed_standard_webhook_event.rbs +536 -0
  222. data/sig/orb/models/webhooks/invoice_sync_succeeded_standard_webhook_event.rbs +536 -0
  223. data/sig/orb/models/webhooks/invoice_undo_mark_as_paid_standard_webhook_event.rbs +517 -0
  224. data/sig/orb/models/webhooks/metric_events_dropped_by_watermark_standard_webhook_event.rbs +100 -0
  225. data/sig/orb/models/webhooks/payment_method_created_standard_webhook_event.rbs +130 -0
  226. data/sig/orb/models/webhooks/payment_method_deleted_standard_webhook_event.rbs +130 -0
  227. data/sig/orb/models/webhooks/plan_created_standard_webhook_event.rbs +90 -0
  228. data/sig/orb/models/webhooks/plan_default_version_set_standard_webhook_event.rbs +112 -0
  229. data/sig/orb/models/webhooks/plan_edited_standard_webhook_event.rbs +134 -0
  230. data/sig/orb/models/webhooks/plan_version_created_standard_webhook_event.rbs +109 -0
  231. data/sig/orb/models/webhooks/price_edited_standard_webhook_event.rbs +95 -0
  232. data/sig/orb/models/webhooks/resource_event_test_standard_webhook_event.rbs +75 -0
  233. data/sig/orb/models/webhooks/sales_order_accounting_sync_failed_standard_webhook_event.rbs +614 -0
  234. data/sig/orb/models/webhooks/sales_order_accounting_sync_succeeded_standard_webhook_event.rbs +609 -0
  235. data/sig/orb/models/webhooks/standard_unwrap_standard_params.rbs +17 -0
  236. data/sig/orb/models/webhooks/subscription_accounting_sync_failed_standard_webhook_event.rbs +256 -0
  237. data/sig/orb/models/webhooks/subscription_accounting_sync_succeeded_standard_webhook_event.rbs +251 -0
  238. data/sig/orb/models/webhooks/subscription_alert_disabled_standard_webhook_event.rbs +466 -0
  239. data/sig/orb/models/webhooks/subscription_cancellation_scheduled_standard_webhook_event.rbs +169 -0
  240. data/sig/orb/models/webhooks/subscription_cancellation_unscheduled_standard_webhook_event.rbs +169 -0
  241. data/sig/orb/models/webhooks/subscription_cost_exceeded_standard_webhook_event.rbs +475 -0
  242. data/sig/orb/models/webhooks/subscription_created_standard_webhook_event.rbs +159 -0
  243. data/sig/orb/models/webhooks/subscription_edited_standard_webhook_event.rbs +218 -0
  244. data/sig/orb/models/webhooks/subscription_ended_standard_webhook_event.rbs +159 -0
  245. data/sig/orb/models/webhooks/subscription_fixed_fee_quantity_updated_standard_webhook_event.rbs +191 -0
  246. data/sig/orb/models/webhooks/subscription_grouped_cost_exceeded_standard_webhook_event.rbs +487 -0
  247. data/sig/orb/models/webhooks/subscription_invoicing_threshold_exceeded_standard_webhook_event.rbs +176 -0
  248. data/sig/orb/models/webhooks/subscription_license_allocation_reset_standard_webhook_event.rbs +198 -0
  249. data/sig/orb/models/webhooks/subscription_license_balance_threshold_reached_standard_webhook_event.rbs +482 -0
  250. data/sig/orb/models/webhooks/subscription_plan_change_scheduled_standard_webhook_event.rbs +182 -0
  251. data/sig/orb/models/webhooks/subscription_plan_changed_standard_webhook_event.rbs +169 -0
  252. data/sig/orb/models/webhooks/subscription_plan_version_change_scheduled_standard_webhook_event.rbs +186 -0
  253. data/sig/orb/models/webhooks/subscription_plan_version_changed_standard_webhook_event.rbs +186 -0
  254. data/sig/orb/models/webhooks/subscription_spend_exceeded_standard_webhook_event.rbs +475 -0
  255. data/sig/orb/models/webhooks/subscription_started_standard_webhook_event.rbs +159 -0
  256. data/sig/orb/models/webhooks/subscription_trial_ended_standard_webhook_event.rbs +159 -0
  257. data/sig/orb/models/webhooks/subscription_usage_exceeded_standard_webhook_event.rbs +480 -0
  258. data/sig/orb/models/webhooks/transaction_accounting_sync_failed_standard_webhook_event.rbs +223 -0
  259. data/sig/orb/models/webhooks/transaction_accounting_sync_succeeded_standard_webhook_event.rbs +218 -0
  260. data/sig/orb/models/webhooks/unwrap_standard_webhook_event.rbs +94 -0
  261. data/sig/orb/models.rbs +2 -0
  262. data/sig/orb/resources/webhooks/standard.rbs +93 -0
  263. data/sig/orb/resources/webhooks.rbs +2 -0
  264. metadata +253 -1
@@ -0,0 +1,678 @@
1
+ # typed: strong
2
+
3
+ module Orb
4
+ module Models
5
+ module Webhooks
6
+ class CustomerEditedStandardWebhookEvent < Orb::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent,
11
+ Orb::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ # The ID of this webhook event.
16
+ sig { returns(String) }
17
+ attr_accessor :id
18
+
19
+ # The time at which this event was created, to the second.
20
+ sig { returns(Time) }
21
+ attr_accessor :created_at
22
+
23
+ # A customer is a buyer of your products, and the other party to the billing
24
+ # relationship.
25
+ #
26
+ # In Orb, customers are assigned system generated identifiers automatically, but
27
+ # it's often desirable to have these match existing identifiers in your system. To
28
+ # avoid having to denormalize Orb ID information, you can pass in an
29
+ # `external_customer_id` with your own identifier. See
30
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
31
+ # information about how these aliases work in Orb.
32
+ #
33
+ # In addition to having an identifier in your system, a customer may exist in a
34
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
35
+ # `payment_provider` enum field to express this mapping.
36
+ #
37
+ # A customer also has a timezone (from the standard
38
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
39
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
40
+ # information on what this timezone parameter influences within Orb.
41
+ sig { returns(Orb::Customer) }
42
+ attr_reader :customer
43
+
44
+ sig { params(customer: Orb::Customer::OrHash).void }
45
+ attr_writer :customer
46
+
47
+ # The serialization style this payload was rendered in, as configured on the
48
+ # endpoint.
49
+ sig do
50
+ returns(
51
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
52
+ )
53
+ end
54
+ attr_accessor :payload_style
55
+
56
+ sig do
57
+ returns(Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties)
58
+ end
59
+ attr_reader :properties
60
+
61
+ sig do
62
+ params(
63
+ properties:
64
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties::OrHash
65
+ ).void
66
+ end
67
+ attr_writer :properties
68
+
69
+ # The event this payload describes.
70
+ sig do
71
+ returns(
72
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Type::TaggedSymbol
73
+ )
74
+ end
75
+ attr_accessor :type
76
+
77
+ # Issued when a customer is updated.
78
+ sig do
79
+ params(
80
+ id: String,
81
+ created_at: Time,
82
+ customer: Orb::Customer::OrHash,
83
+ payload_style:
84
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::PayloadStyle::OrSymbol,
85
+ properties:
86
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties::OrHash,
87
+ type:
88
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Type::OrSymbol
89
+ ).returns(T.attached_class)
90
+ end
91
+ def self.new(
92
+ # The ID of this webhook event.
93
+ id:,
94
+ # The time at which this event was created, to the second.
95
+ created_at:,
96
+ # A customer is a buyer of your products, and the other party to the billing
97
+ # relationship.
98
+ #
99
+ # In Orb, customers are assigned system generated identifiers automatically, but
100
+ # it's often desirable to have these match existing identifiers in your system. To
101
+ # avoid having to denormalize Orb ID information, you can pass in an
102
+ # `external_customer_id` with your own identifier. See
103
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
104
+ # information about how these aliases work in Orb.
105
+ #
106
+ # In addition to having an identifier in your system, a customer may exist in a
107
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
108
+ # `payment_provider` enum field to express this mapping.
109
+ #
110
+ # A customer also has a timezone (from the standard
111
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
112
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
113
+ # information on what this timezone parameter influences within Orb.
114
+ customer:,
115
+ # The serialization style this payload was rendered in, as configured on the
116
+ # endpoint.
117
+ payload_style:,
118
+ properties:,
119
+ # The event this payload describes.
120
+ type:
121
+ )
122
+ end
123
+
124
+ sig do
125
+ override.returns(
126
+ {
127
+ id: String,
128
+ created_at: Time,
129
+ customer: Orb::Customer,
130
+ payload_style:
131
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol,
132
+ properties:
133
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties,
134
+ type:
135
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Type::TaggedSymbol
136
+ }
137
+ )
138
+ end
139
+ def to_hash
140
+ end
141
+
142
+ # The serialization style this payload was rendered in, as configured on the
143
+ # endpoint.
144
+ module PayloadStyle
145
+ extend Orb::Internal::Type::Enum
146
+
147
+ TaggedSymbol =
148
+ T.type_alias do
149
+ T.all(
150
+ Symbol,
151
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::PayloadStyle
152
+ )
153
+ end
154
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
155
+
156
+ EXPANDED =
157
+ T.let(
158
+ :expanded,
159
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
160
+ )
161
+ STANDARD =
162
+ T.let(
163
+ :standard,
164
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
165
+ )
166
+
167
+ sig do
168
+ override.returns(
169
+ T::Array[
170
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::PayloadStyle::TaggedSymbol
171
+ ]
172
+ )
173
+ end
174
+ def self.values
175
+ end
176
+ end
177
+
178
+ class Properties < Orb::Internal::Type::BaseModel
179
+ OrHash =
180
+ T.type_alias do
181
+ T.any(
182
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties,
183
+ Orb::Internal::AnyHash
184
+ )
185
+ end
186
+
187
+ # metadata values are non-null on the wire (deleting a key removes it from
188
+ # storage); the Optional[str] values only exist on the new half of a metadata
189
+ # FieldChange.
190
+ sig do
191
+ returns(
192
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties::PreviousAttributes
193
+ )
194
+ end
195
+ attr_reader :previous_attributes
196
+
197
+ sig do
198
+ params(
199
+ previous_attributes:
200
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties::PreviousAttributes::OrHash
201
+ ).void
202
+ end
203
+ attr_writer :previous_attributes
204
+
205
+ sig do
206
+ params(
207
+ previous_attributes:
208
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties::PreviousAttributes::OrHash
209
+ ).returns(T.attached_class)
210
+ end
211
+ def self.new(
212
+ # metadata values are non-null on the wire (deleting a key removes it from
213
+ # storage); the Optional[str] values only exist on the new half of a metadata
214
+ # FieldChange.
215
+ previous_attributes:
216
+ )
217
+ end
218
+
219
+ sig do
220
+ override.returns(
221
+ {
222
+ previous_attributes:
223
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties::PreviousAttributes
224
+ }
225
+ )
226
+ end
227
+ def to_hash
228
+ end
229
+
230
+ class PreviousAttributes < Orb::Internal::Type::BaseModel
231
+ OrHash =
232
+ T.type_alias do
233
+ T.any(
234
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Properties::PreviousAttributes,
235
+ Orb::Internal::AnyHash
236
+ )
237
+ end
238
+
239
+ sig { returns(T.nilable(T::Boolean)) }
240
+ attr_accessor :auto_collection
241
+
242
+ sig { returns(T.nilable(Orb::Address)) }
243
+ attr_reader :billing_address
244
+
245
+ sig do
246
+ params(billing_address: T.nilable(Orb::Address::OrHash)).void
247
+ end
248
+ attr_writer :billing_address
249
+
250
+ sig { returns(T.nilable(String)) }
251
+ attr_accessor :default_payment_method_id
252
+
253
+ sig { returns(T.nilable(String)) }
254
+ attr_accessor :email
255
+
256
+ sig { returns(T.nilable(T::Boolean)) }
257
+ attr_accessor :email_delivery
258
+
259
+ sig { returns(T.nilable(String)) }
260
+ attr_accessor :external_customer_id
261
+
262
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
263
+ attr_accessor :metadata
264
+
265
+ sig { returns(T.nilable(String)) }
266
+ attr_accessor :name
267
+
268
+ sig { returns(T.nilable(String)) }
269
+ attr_accessor :payment_provider
270
+
271
+ sig { returns(T.nilable(String)) }
272
+ attr_accessor :payment_provider_id
273
+
274
+ sig { returns(T.nilable(Orb::Address)) }
275
+ attr_reader :shipping_address
276
+
277
+ sig do
278
+ params(shipping_address: T.nilable(Orb::Address::OrHash)).void
279
+ end
280
+ attr_writer :shipping_address
281
+
282
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
283
+ # added to the headers of invoices.
284
+ #
285
+ # ### Supported Tax ID Countries and Types
286
+ #
287
+ # | Country | Type | Description |
288
+ # | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
289
+ # | Albania | `al_tin` | Albania Tax Identification Number |
290
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
291
+ # | Angola | `ao_tin` | Angola Tax Identification Number |
292
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
293
+ # | Armenia | `am_tin` | Armenia Tax Identification Number |
294
+ # | Aruba | `aw_tin` | Aruba Tax Identification Number |
295
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
296
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
297
+ # | Austria | `eu_vat` | European VAT Number |
298
+ # | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
299
+ # | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
300
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
301
+ # | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
302
+ # | Barbados | `bb_tin` | Barbados Tax Identification Number |
303
+ # | Belarus | `by_tin` | Belarus TIN Number |
304
+ # | Belgium | `eu_vat` | European VAT Number |
305
+ # | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
306
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
307
+ # | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
308
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
309
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
310
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
311
+ # | Bulgaria | `eu_vat` | European VAT Number |
312
+ # | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
313
+ # | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
314
+ # | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
315
+ # | Canada | `ca_bn` | Canadian BN |
316
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
317
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
318
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
319
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
320
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
321
+ # | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
322
+ # | Chile | `cl_tin` | Chilean TIN |
323
+ # | China | `cn_tin` | Chinese Tax ID |
324
+ # | Colombia | `co_nit` | Colombian NIT Number |
325
+ # | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
326
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
327
+ # | Croatia | `eu_vat` | European VAT Number |
328
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
329
+ # | Cyprus | `eu_vat` | European VAT Number |
330
+ # | Czech Republic | `eu_vat` | European VAT Number |
331
+ # | Denmark | `eu_vat` | European VAT Number |
332
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
333
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
334
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
335
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
336
+ # | Estonia | `eu_vat` | European VAT Number |
337
+ # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
338
+ # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
339
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
340
+ # | Finland | `eu_vat` | European VAT Number |
341
+ # | France | `eu_vat` | European VAT Number |
342
+ # | Georgia | `ge_vat` | Georgian VAT |
343
+ # | Germany | `de_stn` | German Tax Number (Steuernummer) |
344
+ # | Germany | `eu_vat` | European VAT Number |
345
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
346
+ # | Greece | `eu_vat` | European VAT Number |
347
+ # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
348
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
349
+ # | Hungary | `eu_vat` | European VAT Number |
350
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
351
+ # | Iceland | `is_vat` | Icelandic VAT |
352
+ # | India | `in_gst` | Indian GST Number |
353
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
354
+ # | Ireland | `eu_vat` | European VAT Number |
355
+ # | Israel | `il_vat` | Israel VAT |
356
+ # | Italy | `eu_vat` | European VAT Number |
357
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
358
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
359
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
360
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
361
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
362
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
363
+ # | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
364
+ # | Laos | `la_tin` | Laos Tax Identification Number |
365
+ # | Latvia | `eu_vat` | European VAT Number |
366
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
367
+ # | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
368
+ # | Lithuania | `eu_vat` | European VAT Number |
369
+ # | Luxembourg | `eu_vat` | European VAT Number |
370
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
371
+ # | Malaysia | `my_itn` | Malaysian ITN |
372
+ # | Malaysia | `my_sst` | Malaysian SST Number |
373
+ # | Malta | `eu_vat` | European VAT Number |
374
+ # | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
375
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
376
+ # | Moldova | `md_vat` | Moldova VAT Number |
377
+ # | Montenegro | `me_pib` | Montenegro PIB Number |
378
+ # | Morocco | `ma_vat` | Morocco VAT Number |
379
+ # | Nepal | `np_pan` | Nepal PAN Number |
380
+ # | Netherlands | `eu_vat` | European VAT Number |
381
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
382
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
383
+ # | North Macedonia | `mk_vat` | North Macedonia VAT Number |
384
+ # | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
385
+ # | Norway | `no_vat` | Norwegian VAT Number |
386
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
387
+ # | Oman | `om_vat` | Omani VAT Number |
388
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
389
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
390
+ # | Philippines | `ph_tin` | Philippines Tax Identification Number |
391
+ # | Poland | `eu_vat` | European VAT Number |
392
+ # | Poland | `pl_nip` | Polish Tax ID Number |
393
+ # | Portugal | `eu_vat` | European VAT Number |
394
+ # | Romania | `eu_vat` | European VAT Number |
395
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
396
+ # | Russia | `ru_inn` | Russian INN |
397
+ # | Russia | `ru_kpp` | Russian KPP |
398
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
399
+ # | Senegal | `sn_ninea` | Senegal NINEA Number |
400
+ # | Serbia | `rs_pib` | Serbian PIB Number |
401
+ # | Singapore | `sg_gst` | Singaporean GST |
402
+ # | Singapore | `sg_uen` | Singaporean UEN |
403
+ # | Slovakia | `eu_vat` | European VAT Number |
404
+ # | Slovenia | `eu_vat` | European VAT Number |
405
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
406
+ # | South Africa | `za_vat` | South African VAT Number |
407
+ # | South Korea | `kr_brn` | Korean BRN |
408
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
409
+ # | Spain | `eu_vat` | European VAT Number |
410
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
411
+ # | Suriname | `sr_fin` | Suriname FIN Number |
412
+ # | Sweden | `eu_vat` | European VAT Number |
413
+ # | Switzerland | `ch_uid` | Switzerland UID Number |
414
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
415
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
416
+ # | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
417
+ # | Tanzania | `tz_vat` | Tanzania VAT Number |
418
+ # | Thailand | `th_vat` | Thai VAT |
419
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
420
+ # | Uganda | `ug_tin` | Uganda Tax Identification Number |
421
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
422
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
423
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
424
+ # | United States | `us_ein` | United States EIN |
425
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
426
+ # | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
427
+ # | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
428
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
429
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
430
+ # | Zambia | `zm_tin` | Zambia Tax Identification Number |
431
+ # | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
432
+ sig { returns(T.nilable(Orb::CustomerTaxID)) }
433
+ attr_reader :tax_id
434
+
435
+ sig { params(tax_id: T.nilable(Orb::CustomerTaxID::OrHash)).void }
436
+ attr_writer :tax_id
437
+
438
+ # metadata values are non-null on the wire (deleting a key removes it from
439
+ # storage); the Optional[str] values only exist on the new half of a metadata
440
+ # FieldChange.
441
+ sig do
442
+ params(
443
+ auto_collection: T.nilable(T::Boolean),
444
+ billing_address: T.nilable(Orb::Address::OrHash),
445
+ default_payment_method_id: T.nilable(String),
446
+ email: T.nilable(String),
447
+ email_delivery: T.nilable(T::Boolean),
448
+ external_customer_id: T.nilable(String),
449
+ metadata: T.nilable(T::Hash[Symbol, String]),
450
+ name: T.nilable(String),
451
+ payment_provider: T.nilable(String),
452
+ payment_provider_id: T.nilable(String),
453
+ shipping_address: T.nilable(Orb::Address::OrHash),
454
+ tax_id: T.nilable(Orb::CustomerTaxID::OrHash)
455
+ ).returns(T.attached_class)
456
+ end
457
+ def self.new(
458
+ auto_collection: nil,
459
+ billing_address: nil,
460
+ default_payment_method_id: nil,
461
+ email: nil,
462
+ email_delivery: nil,
463
+ external_customer_id: nil,
464
+ metadata: nil,
465
+ name: nil,
466
+ payment_provider: nil,
467
+ payment_provider_id: nil,
468
+ shipping_address: nil,
469
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
470
+ # added to the headers of invoices.
471
+ #
472
+ # ### Supported Tax ID Countries and Types
473
+ #
474
+ # | Country | Type | Description |
475
+ # | ---------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
476
+ # | Albania | `al_tin` | Albania Tax Identification Number |
477
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
478
+ # | Angola | `ao_tin` | Angola Tax Identification Number |
479
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
480
+ # | Armenia | `am_tin` | Armenia Tax Identification Number |
481
+ # | Aruba | `aw_tin` | Aruba Tax Identification Number |
482
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
483
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
484
+ # | Austria | `eu_vat` | European VAT Number |
485
+ # | Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |
486
+ # | Bahamas | `bs_tin` | Bahamas Tax Identification Number |
487
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
488
+ # | Bangladesh | `bd_bin` | Bangladesh Business Identification Number |
489
+ # | Barbados | `bb_tin` | Barbados Tax Identification Number |
490
+ # | Belarus | `by_tin` | Belarus TIN Number |
491
+ # | Belgium | `eu_vat` | European VAT Number |
492
+ # | Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |
493
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
494
+ # | Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |
495
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
496
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
497
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
498
+ # | Bulgaria | `eu_vat` | European VAT Number |
499
+ # | Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Numéro d'Identifiant Fiscal Unique) |
500
+ # | Cambodia | `kh_tin` | Cambodia Tax Identification Number |
501
+ # | Cameroon | `cm_niu` | Cameroon Tax Identification Number (Numéro d'Identifiant fiscal Unique) |
502
+ # | Canada | `ca_bn` | Canadian BN |
503
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
504
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
505
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
506
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
507
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
508
+ # | Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (Número de Identificação Fiscal) |
509
+ # | Chile | `cl_tin` | Chilean TIN |
510
+ # | China | `cn_tin` | Chinese Tax ID |
511
+ # | Colombia | `co_nit` | Colombian NIT Number |
512
+ # | Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (Número de Identificação Fiscal) |
513
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
514
+ # | Croatia | `eu_vat` | European VAT Number |
515
+ # | Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |
516
+ # | Cyprus | `eu_vat` | European VAT Number |
517
+ # | Czech Republic | `eu_vat` | European VAT Number |
518
+ # | Denmark | `eu_vat` | European VAT Number |
519
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
520
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
521
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
522
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
523
+ # | Estonia | `eu_vat` | European VAT Number |
524
+ # | Ethiopia | `et_tin` | Ethiopia Tax Identification Number |
525
+ # | European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
526
+ # | Faroe Islands | `fo_vat` | Faroe Islands VAT Number |
527
+ # | Finland | `eu_vat` | European VAT Number |
528
+ # | France | `eu_vat` | European VAT Number |
529
+ # | Georgia | `ge_vat` | Georgian VAT |
530
+ # | Germany | `de_stn` | German Tax Number (Steuernummer) |
531
+ # | Germany | `eu_vat` | European VAT Number |
532
+ # | Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |
533
+ # | Greece | `eu_vat` | European VAT Number |
534
+ # | Guinea | `gn_nif` | Guinea Tax Identification Number (Número de Identificação Fiscal) |
535
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
536
+ # | Hungary | `eu_vat` | European VAT Number |
537
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
538
+ # | Iceland | `is_vat` | Icelandic VAT |
539
+ # | India | `in_gst` | Indian GST Number |
540
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
541
+ # | Ireland | `eu_vat` | European VAT Number |
542
+ # | Israel | `il_vat` | Israel VAT |
543
+ # | Italy | `eu_vat` | European VAT Number |
544
+ # | Italy | `it_cf` | Italian Codice Fiscale Number |
545
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
546
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
547
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
548
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
549
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
550
+ # | Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |
551
+ # | Laos | `la_tin` | Laos Tax Identification Number |
552
+ # | Latvia | `eu_vat` | European VAT Number |
553
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
554
+ # | Liechtenstein | `li_vat` | Liechtenstein VAT Number |
555
+ # | Lithuania | `eu_vat` | European VAT Number |
556
+ # | Luxembourg | `eu_vat` | European VAT Number |
557
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
558
+ # | Malaysia | `my_itn` | Malaysian ITN |
559
+ # | Malaysia | `my_sst` | Malaysian SST Number |
560
+ # | Malta | `eu_vat` | European VAT Number |
561
+ # | Mauritania | `mr_nif` | Mauritania Tax Identification Number (Número de Identificação Fiscal) |
562
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
563
+ # | Moldova | `md_vat` | Moldova VAT Number |
564
+ # | Montenegro | `me_pib` | Montenegro PIB Number |
565
+ # | Morocco | `ma_vat` | Morocco VAT Number |
566
+ # | Nepal | `np_pan` | Nepal PAN Number |
567
+ # | Netherlands | `eu_vat` | European VAT Number |
568
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
569
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
570
+ # | North Macedonia | `mk_vat` | North Macedonia VAT Number |
571
+ # | Northern Ireland | `eu_vat` | Northern Ireland VAT Number |
572
+ # | Norway | `no_vat` | Norwegian VAT Number |
573
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
574
+ # | Oman | `om_vat` | Omani VAT Number |
575
+ # | Paraguay | `py_ruc` | Paraguayan RUC Number |
576
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
577
+ # | Philippines | `ph_tin` | Philippines Tax Identification Number |
578
+ # | Poland | `eu_vat` | European VAT Number |
579
+ # | Poland | `pl_nip` | Polish Tax ID Number |
580
+ # | Portugal | `eu_vat` | European VAT Number |
581
+ # | Romania | `eu_vat` | European VAT Number |
582
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
583
+ # | Russia | `ru_inn` | Russian INN |
584
+ # | Russia | `ru_kpp` | Russian KPP |
585
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
586
+ # | Senegal | `sn_ninea` | Senegal NINEA Number |
587
+ # | Serbia | `rs_pib` | Serbian PIB Number |
588
+ # | Singapore | `sg_gst` | Singaporean GST |
589
+ # | Singapore | `sg_uen` | Singaporean UEN |
590
+ # | Slovakia | `eu_vat` | European VAT Number |
591
+ # | Slovenia | `eu_vat` | European VAT Number |
592
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
593
+ # | South Africa | `za_vat` | South African VAT Number |
594
+ # | South Korea | `kr_brn` | Korean BRN |
595
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
596
+ # | Spain | `eu_vat` | European VAT Number |
597
+ # | Sri Lanka | `lk_vat` | Sri Lanka VAT Number |
598
+ # | Suriname | `sr_fin` | Suriname FIN Number |
599
+ # | Sweden | `eu_vat` | European VAT Number |
600
+ # | Switzerland | `ch_uid` | Switzerland UID Number |
601
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
602
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
603
+ # | Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |
604
+ # | Tanzania | `tz_vat` | Tanzania VAT Number |
605
+ # | Thailand | `th_vat` | Thai VAT |
606
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
607
+ # | Uganda | `ug_tin` | Uganda Tax Identification Number |
608
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
609
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
610
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
611
+ # | United States | `us_ein` | United States EIN |
612
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
613
+ # | Uzbekistan | `uz_tin` | Uzbekistan TIN Number |
614
+ # | Uzbekistan | `uz_vat` | Uzbekistan VAT Number |
615
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
616
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
617
+ # | Zambia | `zm_tin` | Zambia Tax Identification Number |
618
+ # | Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |
619
+ tax_id: nil
620
+ )
621
+ end
622
+
623
+ sig do
624
+ override.returns(
625
+ {
626
+ auto_collection: T.nilable(T::Boolean),
627
+ billing_address: T.nilable(Orb::Address),
628
+ default_payment_method_id: T.nilable(String),
629
+ email: T.nilable(String),
630
+ email_delivery: T.nilable(T::Boolean),
631
+ external_customer_id: T.nilable(String),
632
+ metadata: T.nilable(T::Hash[Symbol, String]),
633
+ name: T.nilable(String),
634
+ payment_provider: T.nilable(String),
635
+ payment_provider_id: T.nilable(String),
636
+ shipping_address: T.nilable(Orb::Address),
637
+ tax_id: T.nilable(Orb::CustomerTaxID)
638
+ }
639
+ )
640
+ end
641
+ def to_hash
642
+ end
643
+ end
644
+ end
645
+
646
+ # The event this payload describes.
647
+ module Type
648
+ extend Orb::Internal::Type::Enum
649
+
650
+ TaggedSymbol =
651
+ T.type_alias do
652
+ T.all(
653
+ Symbol,
654
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Type
655
+ )
656
+ end
657
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
658
+
659
+ CUSTOMER_EDITED =
660
+ T.let(
661
+ :"customer.edited",
662
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Type::TaggedSymbol
663
+ )
664
+
665
+ sig do
666
+ override.returns(
667
+ T::Array[
668
+ Orb::Webhooks::CustomerEditedStandardWebhookEvent::Type::TaggedSymbol
669
+ ]
670
+ )
671
+ end
672
+ def self.values
673
+ end
674
+ end
675
+ end
676
+ end
677
+ end
678
+ end