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#create
6
6
  class CustomerCreateParams < 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 email
@@ -233,53 +232,57 @@ module Orb
233
232
  # @return [String, nil]
234
233
  optional :timezone, String, nil?: true
235
234
 
236
- # @!parse
237
- # # @param email [String]
238
- # # @param name [String]
239
- # # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil]
240
- # # @param additional_emails [Array<String>, nil]
241
- # # @param auto_collection [Boolean, nil]
242
- # # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil]
243
- # # @param currency [String, nil]
244
- # # @param email_delivery [Boolean, nil]
245
- # # @param external_customer_id [String, nil]
246
- # # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil]
247
- # # @param metadata [Hash{Symbol=>String, nil}, nil]
248
- # # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil]
249
- # # @param payment_provider_id [String, nil]
250
- # # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil]
251
- # # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
252
- # # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
253
- # # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil]
254
- # # @param timezone [String, nil]
255
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
256
- # #
257
- # def initialize(
258
- # email:,
259
- # name:,
260
- # accounting_sync_configuration: nil,
261
- # additional_emails: nil,
262
- # auto_collection: nil,
263
- # billing_address: nil,
264
- # currency: nil,
265
- # email_delivery: nil,
266
- # external_customer_id: nil,
267
- # hierarchy: nil,
268
- # metadata: 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
- # timezone: nil,
276
- # request_options: {},
277
- # **
278
- # )
279
- # super
280
- # end
281
-
282
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
235
+ # @!method initialize(email:, name:, accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, timezone: nil, request_options: {})
236
+ # Some parameter documentations has been truncated, see
237
+ # {Orb::Models::CustomerCreateParams} for more details.
238
+ #
239
+ # @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
240
+ # ...
241
+ #
242
+ # @param name [String] The full name of the customer
243
+ #
244
+ # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil]
245
+ #
246
+ # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
247
+ # ...
248
+ #
249
+ # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
250
+ # ...
251
+ #
252
+ # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil]
253
+ #
254
+ # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
255
+ # ...
256
+ #
257
+ # @param email_delivery [Boolean, nil]
258
+ #
259
+ # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
260
+ # ...
261
+ #
262
+ # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
263
+ #
264
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
265
+ # ...
266
+ #
267
+ # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::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::CustomerCreateParams::ReportingConfiguration, nil]
274
+ #
275
+ # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
276
+ #
277
+ # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration, nil]
278
+ #
279
+ # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
280
+ # ...
281
+ #
282
+ # @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang
283
+ # ...
284
+ #
285
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
283
286
 
284
287
  class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
285
288
  # @!attribute accounting_providers
@@ -294,13 +297,9 @@ module Orb
294
297
  # @return [Boolean, nil]
295
298
  optional :excluded, Orb::Internal::Type::Boolean, nil?: true
296
299
 
297
- # @!parse
298
- # # @param accounting_providers [Array<Orb::Models::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
299
- # # @param excluded [Boolean, nil]
300
- # #
301
- # def initialize(accounting_providers: nil, excluded: nil, **) = super
302
-
303
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
300
+ # @!method initialize(accounting_providers: nil, excluded: nil)
301
+ # @param accounting_providers [Array<Orb::Models::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
302
+ # @param excluded [Boolean, nil]
304
303
 
305
304
  class AccountingProvider < Orb::Internal::Type::BaseModel
306
305
  # @!attribute external_provider_id
@@ -313,13 +312,9 @@ module Orb
313
312
  # @return [String]
314
313
  required :provider_type, String
315
314
 
316
- # @!parse
317
- # # @param external_provider_id [String]
318
- # # @param provider_type [String]
319
- # #
320
- # def initialize(external_provider_id:, provider_type:, **) = super
321
-
322
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
315
+ # @!method initialize(external_provider_id:, provider_type:)
316
+ # @param external_provider_id [String]
317
+ # @param provider_type [String]
323
318
  end
324
319
  end
325
320
 
@@ -354,31 +349,23 @@ module Orb
354
349
  # @return [String, nil]
355
350
  optional :state, String, nil?: true
356
351
 
357
- # @!parse
358
- # # @param city [String, nil]
359
- # # @param country [String, nil]
360
- # # @param line1 [String, nil]
361
- # # @param line2 [String, nil]
362
- # # @param postal_code [String, nil]
363
- # # @param state [String, nil]
364
- # #
365
- # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
366
-
367
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
352
+ # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
353
+ # @param city [String, nil]
354
+ # @param country [String, nil]
355
+ # @param line1 [String, nil]
356
+ # @param line2 [String, nil]
357
+ # @param postal_code [String, nil]
358
+ # @param state [String, nil]
368
359
  end
369
360
 
370
361
  class Hierarchy < Orb::Internal::Type::BaseModel
371
- # @!attribute [r] child_customer_ids
362
+ # @!attribute child_customer_ids
372
363
  # A list of child customer IDs to add to the hierarchy. The desired child
373
364
  # customers must not already be part of another hierarchy.
374
365
  #
375
366
  # @return [Array<String>, nil]
376
367
  optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String]
377
368
 
378
- # @!parse
379
- # # @return [Array<String>]
380
- # attr_writer :child_customer_ids
381
-
382
369
  # @!attribute parent_customer_id
383
370
  # The ID of the parent customer in the hierarchy. The desired parent customer must
384
371
  # not be a child of another customer.
@@ -386,15 +373,17 @@ module Orb
386
373
  # @return [String, nil]
387
374
  optional :parent_customer_id, String, nil?: true
388
375
 
389
- # @!parse
390
- # # The hierarchical relationships for this customer.
391
- # #
392
- # # @param child_customer_ids [Array<String>]
393
- # # @param parent_customer_id [String, nil]
394
- # #
395
- # def initialize(child_customer_ids: nil, parent_customer_id: nil, **) = super
396
-
397
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
376
+ # @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
377
+ # Some parameter documentations has been truncated, see
378
+ # {Orb::Models::CustomerCreateParams::Hierarchy} for more details.
379
+ #
380
+ # The hierarchical relationships for this customer.
381
+ #
382
+ # @param child_customer_ids [Array<String>] A list of child customer IDs to add to the hierarchy. The desired child customer
383
+ # ...
384
+ #
385
+ # @param parent_customer_id [String, nil] The ID of the parent customer in the hierarchy. The desired parent customer must
386
+ # ...
398
387
  end
399
388
 
400
389
  # This is used for creating charges or invoices in an external system via Orb.
@@ -409,11 +398,8 @@ module Orb
409
398
  STRIPE_INVOICE = :stripe_invoice
410
399
  NETSUITE = :netsuite
411
400
 
412
- finalize!
413
-
414
- # @!parse
415
- # # @return [Array<Symbol>]
416
- # def self.values; end
401
+ # @!method self.values
402
+ # @return [Array<Symbol>]
417
403
  end
418
404
 
419
405
  class ReportingConfiguration < Orb::Internal::Type::BaseModel
@@ -422,12 +408,8 @@ module Orb
422
408
  # @return [Boolean]
423
409
  required :exempt, Orb::Internal::Type::Boolean
424
410
 
425
- # @!parse
426
- # # @param exempt [Boolean]
427
- # #
428
- # def initialize(exempt:, **) = super
429
-
430
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
411
+ # @!method initialize(exempt:)
412
+ # @param exempt [Boolean]
431
413
  end
432
414
 
433
415
  class ShippingAddress < Orb::Internal::Type::BaseModel
@@ -461,17 +443,13 @@ module Orb
461
443
  # @return [String, nil]
462
444
  optional :state, String, nil?: true
463
445
 
464
- # @!parse
465
- # # @param city [String, nil]
466
- # # @param country [String, nil]
467
- # # @param line1 [String, nil]
468
- # # @param line2 [String, nil]
469
- # # @param postal_code [String, nil]
470
- # # @param state [String, nil]
471
- # #
472
- # def initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil, **) = super
473
-
474
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
446
+ # @!method initialize(city: nil, country: nil, line1: nil, line2: nil, postal_code: nil, state: nil)
447
+ # @param city [String, nil]
448
+ # @param country [String, nil]
449
+ # @param line1 [String, nil]
450
+ # @param line2 [String, nil]
451
+ # @param postal_code [String, nil]
452
+ # @param state [String, nil]
475
453
  end
476
454
 
477
455
  module TaxConfiguration
@@ -499,14 +477,10 @@ module Orb
499
477
  # @return [String, nil]
500
478
  optional :tax_exemption_code, String, nil?: true
501
479
 
502
- # @!parse
503
- # # @param tax_exempt [Boolean]
504
- # # @param tax_exemption_code [String, nil]
505
- # # @param tax_provider [Symbol, :avalara]
506
- # #
507
- # def initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara, **) = super
508
-
509
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
480
+ # @!method initialize(tax_exempt:, tax_exemption_code: nil, tax_provider: :avalara)
481
+ # @param tax_exempt [Boolean]
482
+ # @param tax_exemption_code [String, nil]
483
+ # @param tax_provider [Symbol, :avalara]
510
484
  end
511
485
 
512
486
  class NewTaxJarConfiguration < Orb::Internal::Type::BaseModel
@@ -520,18 +494,13 @@ module Orb
520
494
  # @return [Symbol, :taxjar]
521
495
  required :tax_provider, const: :taxjar
522
496
 
523
- # @!parse
524
- # # @param tax_exempt [Boolean]
525
- # # @param tax_provider [Symbol, :taxjar]
526
- # #
527
- # def initialize(tax_exempt:, tax_provider: :taxjar, **) = super
528
-
529
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
497
+ # @!method initialize(tax_exempt:, tax_provider: :taxjar)
498
+ # @param tax_exempt [Boolean]
499
+ # @param tax_provider [Symbol, :taxjar]
530
500
  end
531
501
 
532
- # @!parse
533
- # # @return [Array(Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration)]
534
- # def self.variants; end
502
+ # @!method self.variants
503
+ # @return [Array(Orb::Models::CustomerCreateParams::TaxConfiguration::NewAvalaraTaxConfiguration, Orb::Models::CustomerCreateParams::TaxConfiguration::NewTaxJarConfiguration)]
535
504
  end
536
505
 
537
506
  class TaxID < Orb::Internal::Type::BaseModel
@@ -550,120 +519,116 @@ module Orb
550
519
  # @return [String]
551
520
  required :value, String
552
521
 
553
- # @!parse
554
- # # Tax IDs are commonly required to be displayed on customer invoices, which are
555
- # # added to the headers of invoices.
556
- # #
557
- # # ### Supported Tax ID Countries and Types
558
- # #
559
- # # | Country | Type | Description |
560
- # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
561
- # # | Andorra | `ad_nrt` | Andorran NRT Number |
562
- # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
563
- # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
564
- # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
565
- # # | Austria | `eu_vat` | European VAT Number |
566
- # # | Bahrain | `bh_vat` | Bahraini VAT Number |
567
- # # | Belgium | `eu_vat` | European VAT Number |
568
- # # | Bolivia | `bo_tin` | Bolivian Tax ID |
569
- # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
570
- # # | Brazil | `br_cpf` | Brazilian CPF Number |
571
- # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
572
- # # | Bulgaria | `eu_vat` | European VAT Number |
573
- # # | Canada | `ca_bn` | Canadian BN |
574
- # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
575
- # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
576
- # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
577
- # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
578
- # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
579
- # # | Chile | `cl_tin` | Chilean TIN |
580
- # # | China | `cn_tin` | Chinese Tax ID |
581
- # # | Colombia | `co_nit` | Colombian NIT Number |
582
- # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
583
- # # | Croatia | `eu_vat` | European VAT Number |
584
- # # | Cyprus | `eu_vat` | European VAT Number |
585
- # # | Czech Republic | `eu_vat` | European VAT Number |
586
- # # | Denmark | `eu_vat` | European VAT Number |
587
- # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
588
- # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
589
- # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
590
- # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
591
- # # | Estonia | `eu_vat` | European VAT Number |
592
- # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
593
- # # | Finland | `eu_vat` | European VAT Number |
594
- # # | France | `eu_vat` | European VAT Number |
595
- # # | Georgia | `ge_vat` | Georgian VAT |
596
- # # | Germany | `eu_vat` | European VAT Number |
597
- # # | Greece | `eu_vat` | European VAT Number |
598
- # # | Hong Kong | `hk_br` | Hong Kong BR Number |
599
- # # | Hungary | `eu_vat` | European VAT Number |
600
- # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
601
- # # | Iceland | `is_vat` | Icelandic VAT |
602
- # # | India | `in_gst` | Indian GST Number |
603
- # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
604
- # # | Ireland | `eu_vat` | European VAT Number |
605
- # # | Israel | `il_vat` | Israel VAT |
606
- # # | Italy | `eu_vat` | European VAT Number |
607
- # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
608
- # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
609
- # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
610
- # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
611
- # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
612
- # # | Latvia | `eu_vat` | European VAT Number |
613
- # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
614
- # # | Lithuania | `eu_vat` | European VAT Number |
615
- # # | Luxembourg | `eu_vat` | European VAT Number |
616
- # # | Malaysia | `my_frp` | Malaysian FRP Number |
617
- # # | Malaysia | `my_itn` | Malaysian ITN |
618
- # # | Malaysia | `my_sst` | Malaysian SST Number |
619
- # # | Malta | `eu_vat ` | European VAT Number |
620
- # # | Mexico | `mx_rfc` | Mexican RFC Number |
621
- # # | Netherlands | `eu_vat` | European VAT Number |
622
- # # | New Zealand | `nz_gst` | New Zealand GST Number |
623
- # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
624
- # # | Norway | `no_vat` | Norwegian VAT Number |
625
- # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
626
- # # | Oman | `om_vat` | Omani VAT Number |
627
- # # | Peru | `pe_ruc` | Peruvian RUC Number |
628
- # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
629
- # # | Poland | `eu_vat` | European VAT Number |
630
- # # | Portugal | `eu_vat` | European VAT Number |
631
- # # | Romania | `eu_vat` | European VAT Number |
632
- # # | Romania | `ro_tin` | Romanian Tax ID Number |
633
- # # | Russia | `ru_inn` | Russian INN |
634
- # # | Russia | `ru_kpp` | Russian KPP |
635
- # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
636
- # # | Serbia | `rs_pib` | Serbian PIB Number |
637
- # # | Singapore | `sg_gst` | Singaporean GST |
638
- # # | Singapore | `sg_uen` | Singaporean UEN |
639
- # # | Slovakia | `eu_vat` | European VAT Number |
640
- # # | Slovenia | `eu_vat` | European VAT Number |
641
- # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
642
- # # | South Africa | `za_vat` | South African VAT Number |
643
- # # | South Korea | `kr_brn` | Korean BRN |
644
- # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
645
- # # | Spain | `eu_vat` | European VAT Number |
646
- # # | Sweden | `eu_vat` | European VAT Number |
647
- # # | Switzerland | `ch_vat` | Switzerland VAT Number |
648
- # # | Taiwan | `tw_vat` | Taiwanese VAT |
649
- # # | Thailand | `th_vat` | Thai VAT |
650
- # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
651
- # # | Ukraine | `ua_vat` | Ukrainian VAT |
652
- # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
653
- # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
654
- # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
655
- # # | United States | `us_ein` | United States EIN |
656
- # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
657
- # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
658
- # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
659
- # #
660
- # # @param country [Symbol, Orb::Models::CustomerCreateParams::TaxID::Country]
661
- # # @param type [Symbol, Orb::Models::CustomerCreateParams::TaxID::Type]
662
- # # @param value [String]
663
- # #
664
- # def initialize(country:, type:, value:, **) = super
665
-
666
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
522
+ # @!method initialize(country:, type:, value:)
523
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
524
+ # added to the headers of invoices.
525
+ #
526
+ # ### Supported Tax ID Countries and Types
527
+ #
528
+ # | Country | Type | Description |
529
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
530
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
531
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
532
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
533
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
534
+ # | Austria | `eu_vat` | European VAT Number |
535
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
536
+ # | Belgium | `eu_vat` | European VAT Number |
537
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
538
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
539
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
540
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
541
+ # | Bulgaria | `eu_vat` | European VAT Number |
542
+ # | Canada | `ca_bn` | Canadian BN |
543
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
544
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
545
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
546
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
547
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
548
+ # | Chile | `cl_tin` | Chilean TIN |
549
+ # | China | `cn_tin` | Chinese Tax ID |
550
+ # | Colombia | `co_nit` | Colombian NIT Number |
551
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
552
+ # | Croatia | `eu_vat` | European VAT Number |
553
+ # | Cyprus | `eu_vat` | European VAT Number |
554
+ # | Czech Republic | `eu_vat` | European VAT Number |
555
+ # | Denmark | `eu_vat` | European VAT Number |
556
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
557
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
558
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
559
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
560
+ # | Estonia | `eu_vat` | European VAT Number |
561
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
562
+ # | Finland | `eu_vat` | European VAT Number |
563
+ # | France | `eu_vat` | European VAT Number |
564
+ # | Georgia | `ge_vat` | Georgian VAT |
565
+ # | Germany | `eu_vat` | European VAT Number |
566
+ # | Greece | `eu_vat` | European VAT Number |
567
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
568
+ # | Hungary | `eu_vat` | European VAT Number |
569
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
570
+ # | Iceland | `is_vat` | Icelandic VAT |
571
+ # | India | `in_gst` | Indian GST Number |
572
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
573
+ # | Ireland | `eu_vat` | European VAT Number |
574
+ # | Israel | `il_vat` | Israel VAT |
575
+ # | Italy | `eu_vat` | European VAT Number |
576
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
577
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
578
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
579
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
580
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
581
+ # | Latvia | `eu_vat` | European VAT Number |
582
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
583
+ # | Lithuania | `eu_vat` | European VAT Number |
584
+ # | Luxembourg | `eu_vat` | European VAT Number |
585
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
586
+ # | Malaysia | `my_itn` | Malaysian ITN |
587
+ # | Malaysia | `my_sst` | Malaysian SST Number |
588
+ # | Malta | `eu_vat ` | European VAT Number |
589
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
590
+ # | Netherlands | `eu_vat` | European VAT Number |
591
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
592
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
593
+ # | Norway | `no_vat` | Norwegian VAT Number |
594
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
595
+ # | Oman | `om_vat` | Omani VAT Number |
596
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
597
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
598
+ # | Poland | `eu_vat` | European VAT Number |
599
+ # | Portugal | `eu_vat` | European VAT Number |
600
+ # | Romania | `eu_vat` | European VAT Number |
601
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
602
+ # | Russia | `ru_inn` | Russian INN |
603
+ # | Russia | `ru_kpp` | Russian KPP |
604
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
605
+ # | Serbia | `rs_pib` | Serbian PIB Number |
606
+ # | Singapore | `sg_gst` | Singaporean GST |
607
+ # | Singapore | `sg_uen` | Singaporean UEN |
608
+ # | Slovakia | `eu_vat` | European VAT Number |
609
+ # | Slovenia | `eu_vat` | European VAT Number |
610
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
611
+ # | South Africa | `za_vat` | South African VAT Number |
612
+ # | South Korea | `kr_brn` | Korean BRN |
613
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
614
+ # | Spain | `eu_vat` | European VAT Number |
615
+ # | Sweden | `eu_vat` | European VAT Number |
616
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
617
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
618
+ # | Thailand | `th_vat` | Thai VAT |
619
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
620
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
621
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
622
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
623
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
624
+ # | United States | `us_ein` | United States EIN |
625
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
626
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
627
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
628
+ #
629
+ # @param country [Symbol, Orb::Models::CustomerCreateParams::TaxID::Country]
630
+ # @param type [Symbol, Orb::Models::CustomerCreateParams::TaxID::Type]
631
+ # @param value [String]
667
632
 
668
633
  # @see Orb::Models::CustomerCreateParams::TaxID#country
669
634
  module Country
@@ -748,11 +713,8 @@ module Orb
748
713
  VN = :VN
749
714
  ZA = :ZA
750
715
 
751
- finalize!
752
-
753
- # @!parse
754
- # # @return [Array<Symbol>]
755
- # def self.values; end
716
+ # @!method self.values
717
+ # @return [Array<Symbol>]
756
718
  end
757
719
 
758
720
  # @see Orb::Models::CustomerCreateParams::TaxID#type
@@ -831,11 +793,8 @@ module Orb
831
793
  VN_TIN = :vn_tin
832
794
  ZA_VAT = :za_vat
833
795
 
834
- finalize!
835
-
836
- # @!parse
837
- # # @return [Array<Symbol>]
838
- # def self.values; end
796
+ # @!method self.values
797
+ # @return [Array<Symbol>]
839
798
  end
840
799
  end
841
800
  end
@@ -4,16 +4,11 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Customers#delete
6
6
  class CustomerDeleteParams < 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
- # @!parse
12
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
13
- # #
14
- # def initialize(request_options: {}, **) = super
15
-
16
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
17
12
  end
18
13
  end
19
14
  end