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