orb-billing 0.2.0 → 0.3.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 (374) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +34 -0
  3. data/README.md +59 -49
  4. data/lib/orb/client.rb +4 -4
  5. data/lib/orb/file_part.rb +55 -0
  6. data/lib/orb/internal/page.rb +4 -8
  7. data/lib/orb/internal/transport/base_client.rb +7 -7
  8. data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
  9. data/lib/orb/internal/type/array_of.rb +11 -0
  10. data/lib/orb/internal/type/base_model.rb +32 -14
  11. data/lib/orb/internal/type/base_page.rb +9 -1
  12. data/lib/orb/internal/type/boolean.rb +4 -0
  13. data/lib/orb/internal/type/converter.rb +4 -1
  14. data/lib/orb/internal/type/enum.rb +9 -5
  15. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
  16. data/lib/orb/internal/type/hash_of.rb +11 -0
  17. data/lib/orb/internal/type/request_parameters.rb +1 -2
  18. data/lib/orb/internal/type/union.rb +10 -1
  19. data/lib/orb/internal/type/unknown.rb +4 -0
  20. data/lib/orb/internal/util.rb +69 -61
  21. data/lib/orb/internal.rb +0 -1
  22. data/lib/orb/models/alert.rb +68 -71
  23. data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
  24. data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
  25. data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
  26. data/lib/orb/models/alert_disable_params.rb +5 -9
  27. data/lib/orb/models/alert_enable_params.rb +5 -9
  28. data/lib/orb/models/alert_list_params.rb +26 -36
  29. data/lib/orb/models/alert_retrieve_params.rb +3 -8
  30. data/lib/orb/models/alert_update_params.rb +14 -18
  31. data/lib/orb/models/amount_discount.rb +14 -14
  32. data/lib/orb/models/billable_metric.rb +23 -20
  33. data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
  34. data/lib/orb/models/coupon.rb +28 -21
  35. data/lib/orb/models/coupon_archive_params.rb +3 -8
  36. data/lib/orb/models/coupon_create_params.rb +24 -29
  37. data/lib/orb/models/coupon_fetch_params.rb +3 -8
  38. data/lib/orb/models/coupon_list_params.rb +17 -17
  39. data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
  40. data/lib/orb/models/credit_note.rb +100 -166
  41. data/lib/orb/models/credit_note_create_params.rb +15 -23
  42. data/lib/orb/models/credit_note_fetch_params.rb +3 -8
  43. data/lib/orb/models/credit_note_list_params.rb +20 -30
  44. data/lib/orb/models/customer.rb +224 -271
  45. data/lib/orb/models/customer_create_params.rb +211 -252
  46. data/lib/orb/models/customer_delete_params.rb +3 -8
  47. data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
  48. data/lib/orb/models/customer_fetch_params.rb +3 -8
  49. data/lib/orb/models/customer_list_params.rb +20 -30
  50. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
  51. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
  52. data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
  53. data/lib/orb/models/customer_update_params.rb +207 -250
  54. data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
  55. data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
  56. data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
  57. data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
  58. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
  59. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
  60. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  61. data/lib/orb/models/customers/cost_list_response.rb +22 -26
  62. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
  63. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
  64. data/lib/orb/models/customers/credit_list_params.rb +18 -22
  65. data/lib/orb/models/customers/credit_list_response.rb +10 -17
  66. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
  67. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
  68. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
  69. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
  70. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
  71. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
  72. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  73. data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
  74. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
  75. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
  76. data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
  77. data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
  78. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
  79. data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
  80. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
  81. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
  82. data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
  83. data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
  84. data/lib/orb/models/dimensional_price_group.rb +21 -15
  85. data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
  86. data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
  87. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
  88. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
  89. data/lib/orb/models/dimensional_price_groups.rb +3 -7
  90. data/lib/orb/models/discount.rb +2 -3
  91. data/lib/orb/models/evaluate_price_group.rb +8 -11
  92. data/lib/orb/models/event_deprecate_params.rb +3 -8
  93. data/lib/orb/models/event_deprecate_response.rb +2 -6
  94. data/lib/orb/models/event_ingest_params.rb +33 -27
  95. data/lib/orb/models/event_ingest_response.rb +23 -24
  96. data/lib/orb/models/event_search_params.rb +15 -11
  97. data/lib/orb/models/event_search_response.rb +27 -22
  98. data/lib/orb/models/event_update_params.rb +19 -13
  99. data/lib/orb/models/event_update_response.rb +2 -6
  100. data/lib/orb/models/events/backfill_close_params.rb +3 -8
  101. data/lib/orb/models/events/backfill_close_response.rb +34 -39
  102. data/lib/orb/models/events/backfill_create_params.rb +28 -32
  103. data/lib/orb/models/events/backfill_create_response.rb +34 -39
  104. data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
  105. data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
  106. data/lib/orb/models/events/backfill_list_params.rb +12 -15
  107. data/lib/orb/models/events/backfill_list_response.rb +34 -39
  108. data/lib/orb/models/events/backfill_revert_params.rb +3 -8
  109. data/lib/orb/models/events/backfill_revert_response.rb +34 -39
  110. data/lib/orb/models/events/event_volumes.rb +11 -17
  111. data/lib/orb/models/events/volume_list_params.rb +19 -22
  112. data/lib/orb/models/invoice.rb +589 -637
  113. data/lib/orb/models/invoice_create_params.rb +52 -61
  114. data/lib/orb/models/invoice_fetch_params.rb +3 -8
  115. data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
  116. data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
  117. data/lib/orb/models/invoice_issue_params.rb +10 -14
  118. data/lib/orb/models/invoice_level_discount.rb +2 -3
  119. data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
  120. data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
  121. data/lib/orb/models/invoice_list_params.rb +51 -66
  122. data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
  123. data/lib/orb/models/invoice_pay_params.rb +3 -8
  124. data/lib/orb/models/invoice_update_params.rb +9 -9
  125. data/lib/orb/models/invoice_void_params.rb +3 -8
  126. data/lib/orb/models/item.rb +14 -25
  127. data/lib/orb/models/item_create_params.rb +5 -9
  128. data/lib/orb/models/item_fetch_params.rb +3 -8
  129. data/lib/orb/models/item_list_params.rb +12 -15
  130. data/lib/orb/models/item_update_params.rb +10 -22
  131. data/lib/orb/models/metric_create_params.rb +17 -13
  132. data/lib/orb/models/metric_fetch_params.rb +3 -8
  133. data/lib/orb/models/metric_list_params.rb +20 -30
  134. data/lib/orb/models/metric_update_params.rb +9 -9
  135. data/lib/orb/models/pagination_metadata.rb +3 -7
  136. data/lib/orb/models/percentage_discount.rb +15 -14
  137. data/lib/orb/models/plan.rb +250 -279
  138. data/lib/orb/models/plan_create_params.rb +1623 -1984
  139. data/lib/orb/models/plan_fetch_params.rb +3 -8
  140. data/lib/orb/models/plan_list_params.rb +25 -42
  141. data/lib/orb/models/plan_update_params.rb +12 -10
  142. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
  143. data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
  144. data/lib/orb/models/price.rb +2709 -3820
  145. data/lib/orb/models/price_create_params.rb +203 -244
  146. data/lib/orb/models/price_evaluate_params.rb +21 -30
  147. data/lib/orb/models/price_evaluate_response.rb +2 -6
  148. data/lib/orb/models/price_fetch_params.rb +3 -8
  149. data/lib/orb/models/price_list_params.rb +12 -15
  150. data/lib/orb/models/price_update_params.rb +9 -9
  151. data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
  152. data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
  153. data/lib/orb/models/subscription.rb +343 -382
  154. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  155. data/lib/orb/models/subscription_cancel_response.rb +339 -377
  156. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  157. data/lib/orb/models/subscription_change_apply_response.rb +365 -398
  158. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  159. data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
  160. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  161. data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
  162. data/lib/orb/models/subscription_create_params.rb +3771 -4402
  163. data/lib/orb/models/subscription_create_response.rb +339 -377
  164. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  165. data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
  166. data/lib/orb/models/subscription_fetch_params.rb +3 -8
  167. data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
  168. data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
  169. data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
  170. data/lib/orb/models/subscription_list_params.rb +28 -41
  171. data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
  172. data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
  173. data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
  174. data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
  175. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  176. data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
  177. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  178. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
  179. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
  180. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
  181. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
  182. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
  183. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
  184. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
  185. data/lib/orb/models/subscription_update_params.rb +21 -23
  186. data/lib/orb/models/subscription_update_trial_params.rb +15 -18
  187. data/lib/orb/models/subscription_update_trial_response.rb +341 -377
  188. data/lib/orb/models/subscription_usage.rb +37 -80
  189. data/lib/orb/models/subscriptions.rb +3 -7
  190. data/lib/orb/models/top_level_ping_params.rb +3 -8
  191. data/lib/orb/models/top_level_ping_response.rb +2 -6
  192. data/lib/orb/models/trial_discount.rb +16 -24
  193. data/lib/orb/models/usage_discount.rb +15 -14
  194. data/lib/orb/request_options.rb +3 -4
  195. data/lib/orb/resources/alerts.rb +48 -17
  196. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  197. data/lib/orb/resources/coupons.rb +25 -7
  198. data/lib/orb/resources/credit_notes.rb +17 -4
  199. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  200. data/lib/orb/resources/customers/costs.rb +26 -8
  201. data/lib/orb/resources/customers/credits/ledger.rb +108 -28
  202. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  203. data/lib/orb/resources/customers/credits.rb +28 -8
  204. data/lib/orb/resources/customers.rb +135 -36
  205. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  206. data/lib/orb/resources/events/backfills.rb +32 -9
  207. data/lib/orb/resources/events/volume.rb +14 -4
  208. data/lib/orb/resources/events.rb +40 -11
  209. data/lib/orb/resources/invoice_line_items.rb +16 -6
  210. data/lib/orb/resources/invoices.rb +77 -17
  211. data/lib/orb/resources/items.rb +10 -3
  212. data/lib/orb/resources/metrics.rb +33 -8
  213. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  214. data/lib/orb/resources/plans.rb +47 -11
  215. data/lib/orb/resources/prices/external_price_id.rb +7 -1
  216. data/lib/orb/resources/prices.rb +97 -22
  217. data/lib/orb/resources/subscription_changes.rb +5 -2
  218. data/lib/orb/resources/subscriptions.rb +292 -78
  219. data/lib/orb/version.rb +1 -1
  220. data/lib/orb.rb +2 -10
  221. data/rbi/lib/orb/client.rbi +4 -4
  222. data/rbi/lib/orb/file_part.rbi +34 -0
  223. data/rbi/lib/orb/internal/transport/base_client.rbi +17 -3
  224. data/rbi/lib/orb/internal/type/array_of.rbi +3 -0
  225. data/rbi/lib/orb/internal/type/base_model.rbi +7 -1
  226. data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
  227. data/rbi/lib/orb/internal/type/enum.rbi +3 -6
  228. data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +5 -2
  229. data/rbi/lib/orb/internal/type/hash_of.rbi +3 -0
  230. data/rbi/lib/orb/internal/type/union.rbi +3 -0
  231. data/rbi/lib/orb/internal/util.rbi +24 -19
  232. data/rbi/lib/orb/internal.rbi +0 -1
  233. data/rbi/lib/orb/models/alert.rbi +28 -8
  234. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
  235. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
  236. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
  237. data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
  238. data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
  239. data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
  240. data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
  241. data/rbi/lib/orb/models/amount_discount.rbi +10 -4
  242. data/rbi/lib/orb/models/billable_metric.rbi +16 -3
  243. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
  244. data/rbi/lib/orb/models/coupon.rbi +10 -3
  245. data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
  246. data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
  247. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
  248. data/rbi/lib/orb/models/credit_note.rbi +44 -12
  249. data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
  250. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
  251. data/rbi/lib/orb/models/customer.rbi +130 -11
  252. data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
  253. data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
  254. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
  255. data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
  256. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
  257. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
  258. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
  259. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
  260. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
  261. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
  262. data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
  263. data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
  264. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
  265. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
  266. data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
  267. data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
  268. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  269. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
  270. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  271. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
  272. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  273. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
  274. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
  275. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
  276. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  277. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  278. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
  279. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
  280. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  281. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  282. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
  283. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
  284. data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
  285. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
  286. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
  287. data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
  288. data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
  289. data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
  290. data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
  291. data/rbi/lib/orb/models/event_search_params.rbi +14 -2
  292. data/rbi/lib/orb/models/event_search_response.rbi +14 -3
  293. data/rbi/lib/orb/models/event_update_params.rbi +10 -3
  294. data/rbi/lib/orb/models/event_update_response.rbi +4 -2
  295. data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
  296. data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
  297. data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
  298. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
  299. data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
  300. data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
  301. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
  302. data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
  303. data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
  304. data/rbi/lib/orb/models/invoice.rbi +375 -46
  305. data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
  306. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
  307. data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
  308. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
  309. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
  310. data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
  311. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
  312. data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
  313. data/rbi/lib/orb/models/item.rbi +1 -2
  314. data/rbi/lib/orb/models/item_create_params.rbi +5 -2
  315. data/rbi/lib/orb/models/item_list_params.rbi +8 -2
  316. data/rbi/lib/orb/models/item_update_params.rbi +1 -8
  317. data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
  318. data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
  319. data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
  320. data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
  321. data/rbi/lib/orb/models/plan.rbi +102 -15
  322. data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
  323. data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
  324. data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
  325. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
  326. data/rbi/lib/orb/models/price.rbi +717 -688
  327. data/rbi/lib/orb/models/price_create_params.rbi +137 -53
  328. data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
  329. data/rbi/lib/orb/models/price_list_params.rbi +8 -2
  330. data/rbi/lib/orb/models/price_update_params.rbi +7 -2
  331. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
  332. data/rbi/lib/orb/models/subscription.rbi +174 -11
  333. data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
  334. data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
  335. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
  336. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
  337. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
  338. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
  339. data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
  340. data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
  341. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
  342. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
  343. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
  344. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
  345. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
  346. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
  347. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
  348. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
  349. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
  350. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
  351. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
  352. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
  353. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
  354. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  355. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
  356. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
  357. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  358. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
  359. data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
  360. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
  361. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
  362. data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
  363. data/rbi/lib/orb/models/trial_discount.rbi +5 -1
  364. data/rbi/lib/orb/models/usage_discount.rbi +11 -3
  365. data/sig/orb/file_part.rbs +21 -0
  366. data/sig/orb/internal/transport/base_client.rbs +9 -3
  367. data/sig/orb/internal/type/array_of.rbs +2 -0
  368. data/sig/orb/internal/type/base_model.rbs +4 -0
  369. data/sig/orb/internal/type/enum.rbs +2 -2
  370. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  371. data/sig/orb/internal/type/hash_of.rbs +2 -0
  372. data/sig/orb/internal/type/union.rbs +2 -0
  373. data/sig/orb/internal/util.rbs +14 -12
  374. metadata +8 -5
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Customers#update_by_external_id
6
6
  class CustomerUpdateByExternalIDParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute accounting_sync_configuration
@@ -234,51 +233,53 @@ module Orb
234
233
  # @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil]
235
234
  optional :tax_id, -> { Orb::Models::CustomerUpdateByExternalIDParams::TaxID }, nil?: true
236
235
 
237
- # @!parse
238
- # # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
239
- # # @param additional_emails [Array<String>, nil]
240
- # # @param auto_collection [Boolean, nil]
241
- # # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
242
- # # @param currency [String, nil]
243
- # # @param email [String, nil]
244
- # # @param email_delivery [Boolean, nil]
245
- # # @param external_customer_id [String, nil]
246
- # # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil]
247
- # # @param metadata [Hash{Symbol=>String, nil}, nil]
248
- # # @param name [String, nil]
249
- # # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil]
250
- # # @param payment_provider_id [String, nil]
251
- # # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
252
- # # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
253
- # # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil]
254
- # # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil]
255
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
256
- # #
257
- # def initialize(
258
- # accounting_sync_configuration: nil,
259
- # additional_emails: nil,
260
- # auto_collection: nil,
261
- # billing_address: nil,
262
- # currency: nil,
263
- # email: nil,
264
- # email_delivery: nil,
265
- # external_customer_id: nil,
266
- # hierarchy: nil,
267
- # metadata: nil,
268
- # name: nil,
269
- # payment_provider: nil,
270
- # payment_provider_id: nil,
271
- # reporting_configuration: nil,
272
- # shipping_address: nil,
273
- # tax_configuration: nil,
274
- # tax_id: nil,
275
- # request_options: {},
276
- # **
277
- # )
278
- # super
279
- # end
280
-
281
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
236
+ # @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
237
+ # Some parameter documentations has been truncated, see
238
+ # {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
239
+ #
240
+ # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
241
+ #
242
+ # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
243
+ # ...
244
+ #
245
+ # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
246
+ # ...
247
+ #
248
+ # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
249
+ #
250
+ # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
251
+ # ...
252
+ #
253
+ # @param email [String, nil] A valid customer email, to be used for invoicing and notifications.
254
+ #
255
+ # @param email_delivery [Boolean, nil]
256
+ #
257
+ # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
258
+ # ...
259
+ #
260
+ # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
261
+ #
262
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
263
+ # ...
264
+ #
265
+ # @param name [String, nil] The full name of the customer
266
+ #
267
+ # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
268
+ # ...
269
+ #
270
+ # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
271
+ # ...
272
+ #
273
+ # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
274
+ #
275
+ # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
276
+ #
277
+ # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration, nil]
278
+ #
279
+ # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
280
+ # ...
281
+ #
282
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
282
283
 
283
284
  class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
284
285
  # @!attribute accounting_providers
@@ -293,13 +294,9 @@ module Orb
293
294
  # @return [Boolean, nil]
294
295
  optional :excluded, Orb::Internal::Type::Boolean, nil?: true
295
296
 
296
- # @!parse
297
- # # @param accounting_providers [Array<Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
298
- # # @param excluded [Boolean, nil]
299
- # #
300
- # def initialize(accounting_providers: nil, excluded: nil, **) = super
301
-
302
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
297
+ # @!method initialize(accounting_providers: nil, excluded: nil)
298
+ # @param accounting_providers [Array<Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
299
+ # @param excluded [Boolean, nil]
303
300
 
304
301
  class AccountingProvider < Orb::Internal::Type::BaseModel
305
302
  # @!attribute external_provider_id
@@ -312,13 +309,9 @@ module Orb
312
309
  # @return [String]
313
310
  required :provider_type, String
314
311
 
315
- # @!parse
316
- # # @param external_provider_id [String]
317
- # # @param provider_type [String]
318
- # #
319
- # def initialize(external_provider_id:, provider_type:, **) = super
320
-
321
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
312
+ # @!method initialize(external_provider_id:, provider_type:)
313
+ # @param external_provider_id [String]
314
+ # @param provider_type [String]
322
315
  end
323
316
  end
324
317
 
@@ -353,31 +346,23 @@ module Orb
353
346
  # @return [String, nil]
354
347
  optional :state, String, nil?: true
355
348
 
356
- # @!parse
357
- # # @param city [String, nil]
358
- # # @param country [String, nil]
359
- # # @param line1 [String, nil]
360
- # # @param line2 [String, nil]
361
- # # @param postal_code [String, nil]
362
- # # @param state [String, nil]
363
- # #
364
- # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
365
-
366
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
349
+ # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
350
+ # @param city [String, nil]
351
+ # @param country [String, nil]
352
+ # @param line1 [String, nil]
353
+ # @param line2 [String, nil]
354
+ # @param postal_code [String, nil]
355
+ # @param state [String, nil]
367
356
  end
368
357
 
369
358
  class Hierarchy < Orb::Internal::Type::BaseModel
370
- # @!attribute [r] child_customer_ids
359
+ # @!attribute child_customer_ids
371
360
  # A list of child customer IDs to add to the hierarchy. The desired child
372
361
  # customers must not already be part of another hierarchy.
373
362
  #
374
363
  # @return [Array<String>, nil]
375
364
  optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String]
376
365
 
377
- # @!parse
378
- # # @return [Array<String>]
379
- # attr_writer :child_customer_ids
380
-
381
366
  # @!attribute parent_customer_id
382
367
  # The ID of the parent customer in the hierarchy. The desired parent customer must
383
368
  # not be a child of another customer.
@@ -385,15 +370,17 @@ module Orb
385
370
  # @return [String, nil]
386
371
  optional :parent_customer_id, String, nil?: true
387
372
 
388
- # @!parse
389
- # # The hierarchical relationships for this customer.
390
- # #
391
- # # @param child_customer_ids [Array<String>]
392
- # # @param parent_customer_id [String, nil]
393
- # #
394
- # def initialize(child_customer_ids: nil, parent_customer_id: nil, **) = super
395
-
396
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
373
+ # @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
374
+ # Some parameter documentations has been truncated, see
375
+ # {Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy} for more details.
376
+ #
377
+ # The hierarchical relationships for this customer.
378
+ #
379
+ # @param child_customer_ids [Array<String>] A list of child customer IDs to add to the hierarchy. The desired child customer
380
+ # ...
381
+ #
382
+ # @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must
383
+ # ...
397
384
  end
398
385
 
399
386
  # This is used for creating charges or invoices in an external system via Orb.
@@ -412,11 +399,8 @@ module Orb
412
399
  STRIPE_INVOICE = :stripe_invoice
413
400
  NETSUITE = :netsuite
414
401
 
415
- finalize!
416
-
417
- # @!parse
418
- # # @return [Array<Symbol>]
419
- # def self.values; end
402
+ # @!method self.values
403
+ # @return [Array<Symbol>]
420
404
  end
421
405
 
422
406
  class ReportingConfiguration < Orb::Internal::Type::BaseModel
@@ -425,12 +409,8 @@ module Orb
425
409
  # @return [Boolean]
426
410
  required :exempt, Orb::Internal::Type::Boolean
427
411
 
428
- # @!parse
429
- # # @param exempt [Boolean]
430
- # #
431
- # def initialize(exempt:, **) = super
432
-
433
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
412
+ # @!method initialize(exempt:)
413
+ # @param exempt [Boolean]
434
414
  end
435
415
 
436
416
  class ShippingAddress < Orb::Internal::Type::BaseModel
@@ -464,17 +444,13 @@ module Orb
464
444
  # @return [String, nil]
465
445
  optional :state, String, nil?: true
466
446
 
467
- # @!parse
468
- # # @param city [String, nil]
469
- # # @param country [String, nil]
470
- # # @param line1 [String, nil]
471
- # # @param line2 [String, nil]
472
- # # @param postal_code [String, nil]
473
- # # @param state [String, nil]
474
- # #
475
- # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
476
-
477
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
447
+ # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
448
+ # @param city [String, nil]
449
+ # @param country [String, nil]
450
+ # @param line1 [String, nil]
451
+ # @param line2 [String, nil]
452
+ # @param postal_code [String, nil]
453
+ # @param state [String, nil]
478
454
  end
479
455
 
480
456
  module TaxConfiguration
@@ -504,14 +480,10 @@ module Orb
504
480
  # @return [String, nil]
505
481
  optional :tax_exemption_code, String, nil?: true
506
482
 
507
- # @!parse
508
- # # @param tax_exempt [Boolean]
509
- # # @param tax_exemption_code [String, nil]
510
- # # @param tax_provider [Symbol, :avalara]
511
- # #
512
- # def initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara, **) = super
513
-
514
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
483
+ # @!method initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara)
484
+ # @param tax_exempt [Boolean]
485
+ # @param tax_exemption_code [String, nil]
486
+ # @param tax_provider [Symbol, :avalara]
515
487
  end
516
488
 
517
489
  class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
@@ -525,18 +497,13 @@ module Orb
525
497
  # @return [Symbol, :taxjar]
526
498
  required :tax_provider, const: :taxjar
527
499
 
528
- # @!parse
529
- # # @param tax_exempt [Boolean]
530
- # # @param tax_provider [Symbol, :taxjar]
531
- # #
532
- # def initialize(tax_exempt:, tax_provider: :taxjar, **) = super
533
-
534
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
500
+ # @!method initialize(tax_exempt:, tax_provider: :taxjar)
501
+ # @param tax_exempt [Boolean]
502
+ # @param tax_provider [Symbol, :taxjar]
535
503
  end
536
504
 
537
- # @!parse
538
- # # @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration)]
539
- # def self.variants; end
505
+ # @!method self.variants
506
+ # @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::NewTaxJarConfiguration)]
540
507
  end
541
508
 
542
509
  class TaxID < Orb::Internal::Type::BaseModel
@@ -555,120 +522,116 @@ module Orb
555
522
  # @return [String]
556
523
  required :value, String
557
524
 
558
- # @!parse
559
- # # Tax IDs are commonly required to be displayed on customer invoices, which are
560
- # # added to the headers of invoices.
561
- # #
562
- # # ### Supported Tax ID Countries and Types
563
- # #
564
- # # | Country | Type | Description |
565
- # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
566
- # # | Andorra | `ad_nrt` | Andorran NRT Number |
567
- # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
568
- # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
569
- # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
570
- # # | Austria | `eu_vat` | European VAT Number |
571
- # # | Bahrain | `bh_vat` | Bahraini VAT Number |
572
- # # | Belgium | `eu_vat` | European VAT Number |
573
- # # | Bolivia | `bo_tin` | Bolivian Tax ID |
574
- # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
575
- # # | Brazil | `br_cpf` | Brazilian CPF Number |
576
- # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
577
- # # | Bulgaria | `eu_vat` | European VAT Number |
578
- # # | Canada | `ca_bn` | Canadian BN |
579
- # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
580
- # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
581
- # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
582
- # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
583
- # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
584
- # # | Chile | `cl_tin` | Chilean TIN |
585
- # # | China | `cn_tin` | Chinese Tax ID |
586
- # # | Colombia | `co_nit` | Colombian NIT Number |
587
- # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
588
- # # | Croatia | `eu_vat` | European VAT Number |
589
- # # | Cyprus | `eu_vat` | European VAT Number |
590
- # # | Czech Republic | `eu_vat` | European VAT Number |
591
- # # | Denmark | `eu_vat` | European VAT Number |
592
- # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
593
- # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
594
- # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
595
- # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
596
- # # | Estonia | `eu_vat` | European VAT Number |
597
- # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
598
- # # | Finland | `eu_vat` | European VAT Number |
599
- # # | France | `eu_vat` | European VAT Number |
600
- # # | Georgia | `ge_vat` | Georgian VAT |
601
- # # | Germany | `eu_vat` | European VAT Number |
602
- # # | Greece | `eu_vat` | European VAT Number |
603
- # # | Hong Kong | `hk_br` | Hong Kong BR Number |
604
- # # | Hungary | `eu_vat` | European VAT Number |
605
- # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
606
- # # | Iceland | `is_vat` | Icelandic VAT |
607
- # # | India | `in_gst` | Indian GST Number |
608
- # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
609
- # # | Ireland | `eu_vat` | European VAT Number |
610
- # # | Israel | `il_vat` | Israel VAT |
611
- # # | Italy | `eu_vat` | European VAT Number |
612
- # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
613
- # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
614
- # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
615
- # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
616
- # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
617
- # # | Latvia | `eu_vat` | European VAT Number |
618
- # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
619
- # # | Lithuania | `eu_vat` | European VAT Number |
620
- # # | Luxembourg | `eu_vat` | European VAT Number |
621
- # # | Malaysia | `my_frp` | Malaysian FRP Number |
622
- # # | Malaysia | `my_itn` | Malaysian ITN |
623
- # # | Malaysia | `my_sst` | Malaysian SST Number |
624
- # # | Malta | `eu_vat ` | European VAT Number |
625
- # # | Mexico | `mx_rfc` | Mexican RFC Number |
626
- # # | Netherlands | `eu_vat` | European VAT Number |
627
- # # | New Zealand | `nz_gst` | New Zealand GST Number |
628
- # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
629
- # # | Norway | `no_vat` | Norwegian VAT Number |
630
- # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
631
- # # | Oman | `om_vat` | Omani VAT Number |
632
- # # | Peru | `pe_ruc` | Peruvian RUC Number |
633
- # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
634
- # # | Poland | `eu_vat` | European VAT Number |
635
- # # | Portugal | `eu_vat` | European VAT Number |
636
- # # | Romania | `eu_vat` | European VAT Number |
637
- # # | Romania | `ro_tin` | Romanian Tax ID Number |
638
- # # | Russia | `ru_inn` | Russian INN |
639
- # # | Russia | `ru_kpp` | Russian KPP |
640
- # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
641
- # # | Serbia | `rs_pib` | Serbian PIB Number |
642
- # # | Singapore | `sg_gst` | Singaporean GST |
643
- # # | Singapore | `sg_uen` | Singaporean UEN |
644
- # # | Slovakia | `eu_vat` | European VAT Number |
645
- # # | Slovenia | `eu_vat` | European VAT Number |
646
- # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
647
- # # | South Africa | `za_vat` | South African VAT Number |
648
- # # | South Korea | `kr_brn` | Korean BRN |
649
- # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
650
- # # | Spain | `eu_vat` | European VAT Number |
651
- # # | Sweden | `eu_vat` | European VAT Number |
652
- # # | Switzerland | `ch_vat` | Switzerland VAT Number |
653
- # # | Taiwan | `tw_vat` | Taiwanese VAT |
654
- # # | Thailand | `th_vat` | Thai VAT |
655
- # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
656
- # # | Ukraine | `ua_vat` | Ukrainian VAT |
657
- # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
658
- # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
659
- # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
660
- # # | United States | `us_ein` | United States EIN |
661
- # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
662
- # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
663
- # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
664
- # #
665
- # # @param country [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country]
666
- # # @param type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type]
667
- # # @param value [String]
668
- # #
669
- # def initialize(country:, type:, value:, **) = super
670
-
671
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
525
+ # @!method initialize(country:, type:, value:)
526
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
527
+ # added to the headers of invoices.
528
+ #
529
+ # ### Supported Tax ID Countries and Types
530
+ #
531
+ # | Country | Type | Description |
532
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
533
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
534
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
535
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
536
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
537
+ # | Austria | `eu_vat` | European VAT Number |
538
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
539
+ # | Belgium | `eu_vat` | European VAT Number |
540
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
541
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
542
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
543
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
544
+ # | Bulgaria | `eu_vat` | European VAT Number |
545
+ # | Canada | `ca_bn` | Canadian BN |
546
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
547
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
548
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
549
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
550
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
551
+ # | Chile | `cl_tin` | Chilean TIN |
552
+ # | China | `cn_tin` | Chinese Tax ID |
553
+ # | Colombia | `co_nit` | Colombian NIT Number |
554
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
555
+ # | Croatia | `eu_vat` | European VAT Number |
556
+ # | Cyprus | `eu_vat` | European VAT Number |
557
+ # | Czech Republic | `eu_vat` | European VAT Number |
558
+ # | Denmark | `eu_vat` | European VAT Number |
559
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
560
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
561
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
562
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
563
+ # | Estonia | `eu_vat` | European VAT Number |
564
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
565
+ # | Finland | `eu_vat` | European VAT Number |
566
+ # | France | `eu_vat` | European VAT Number |
567
+ # | Georgia | `ge_vat` | Georgian VAT |
568
+ # | Germany | `eu_vat` | European VAT Number |
569
+ # | Greece | `eu_vat` | European VAT Number |
570
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
571
+ # | Hungary | `eu_vat` | European VAT Number |
572
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
573
+ # | Iceland | `is_vat` | Icelandic VAT |
574
+ # | India | `in_gst` | Indian GST Number |
575
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
576
+ # | Ireland | `eu_vat` | European VAT Number |
577
+ # | Israel | `il_vat` | Israel VAT |
578
+ # | Italy | `eu_vat` | European VAT Number |
579
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
580
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
581
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
582
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
583
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
584
+ # | Latvia | `eu_vat` | European VAT Number |
585
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
586
+ # | Lithuania | `eu_vat` | European VAT Number |
587
+ # | Luxembourg | `eu_vat` | European VAT Number |
588
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
589
+ # | Malaysia | `my_itn` | Malaysian ITN |
590
+ # | Malaysia | `my_sst` | Malaysian SST Number |
591
+ # | Malta | `eu_vat ` | European VAT Number |
592
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
593
+ # | Netherlands | `eu_vat` | European VAT Number |
594
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
595
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
596
+ # | Norway | `no_vat` | Norwegian VAT Number |
597
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
598
+ # | Oman | `om_vat` | Omani VAT Number |
599
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
600
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
601
+ # | Poland | `eu_vat` | European VAT Number |
602
+ # | Portugal | `eu_vat` | European VAT Number |
603
+ # | Romania | `eu_vat` | European VAT Number |
604
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
605
+ # | Russia | `ru_inn` | Russian INN |
606
+ # | Russia | `ru_kpp` | Russian KPP |
607
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
608
+ # | Serbia | `rs_pib` | Serbian PIB Number |
609
+ # | Singapore | `sg_gst` | Singaporean GST |
610
+ # | Singapore | `sg_uen` | Singaporean UEN |
611
+ # | Slovakia | `eu_vat` | European VAT Number |
612
+ # | Slovenia | `eu_vat` | European VAT Number |
613
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
614
+ # | South Africa | `za_vat` | South African VAT Number |
615
+ # | South Korea | `kr_brn` | Korean BRN |
616
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
617
+ # | Spain | `eu_vat` | European VAT Number |
618
+ # | Sweden | `eu_vat` | European VAT Number |
619
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
620
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
621
+ # | Thailand | `th_vat` | Thai VAT |
622
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
623
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
624
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
625
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
626
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
627
+ # | United States | `us_ein` | United States EIN |
628
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
629
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
630
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
631
+ #
632
+ # @param country [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country]
633
+ # @param type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type]
634
+ # @param value [String]
672
635
 
673
636
  # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#country
674
637
  module Country
@@ -753,11 +716,8 @@ module Orb
753
716
  VN = :VN
754
717
  ZA = :ZA
755
718
 
756
- finalize!
757
-
758
- # @!parse
759
- # # @return [Array<Symbol>]
760
- # def self.values; end
719
+ # @!method self.values
720
+ # @return [Array<Symbol>]
761
721
  end
762
722
 
763
723
  # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#type
@@ -836,11 +796,8 @@ module Orb
836
796
  VN_TIN = :vn_tin
837
797
  ZA_VAT = :za_vat
838
798
 
839
- finalize!
840
-
841
- # @!parse
842
- # # @return [Array<Symbol>]
843
- # def self.values; end
799
+ # @!method self.values
800
+ # @return [Array<Symbol>]
844
801
  end
845
802
  end
846
803
  end