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
@@ -242,78 +242,79 @@ module Orb
242
242
  # @return [Orb::Models::Customer::ReportingConfiguration, nil]
243
243
  optional :reporting_configuration, -> { Orb::Models::Customer::ReportingConfiguration }, nil?: true
244
244
 
245
- # @!parse
246
- # # A customer is a buyer of your products, and the other party to the billing
247
- # # relationship.
248
- # #
249
- # # In Orb, customers are assigned system generated identifiers automatically, but
250
- # # it's often desirable to have these match existing identifiers in your system. To
251
- # # avoid having to denormalize Orb ID information, you can pass in an
252
- # # `external_customer_id` with your own identifier. See
253
- # # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
254
- # # information about how these aliases work in Orb.
255
- # #
256
- # # In addition to having an identifier in your system, a customer may exist in a
257
- # # payment provider solution like Stripe. Use the `payment_provider_id` and the
258
- # # `payment_provider` enum field to express this mapping.
259
- # #
260
- # # A customer also has a timezone (from the standard
261
- # # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
262
- # # your account's timezone. See [Timezone localization](/essentials/timezones) for
263
- # # information on what this timezone parameter influences within Orb.
264
- # #
265
- # # @param id [String]
266
- # # @param additional_emails [Array<String>]
267
- # # @param auto_collection [Boolean]
268
- # # @param balance [String]
269
- # # @param billing_address [Orb::Models::Customer::BillingAddress, nil]
270
- # # @param created_at [Time]
271
- # # @param currency [String, nil]
272
- # # @param email [String]
273
- # # @param email_delivery [Boolean]
274
- # # @param exempt_from_automated_tax [Boolean, nil]
275
- # # @param external_customer_id [String, nil]
276
- # # @param hierarchy [Orb::Models::Customer::Hierarchy]
277
- # # @param metadata [Hash{Symbol=>String}]
278
- # # @param name [String]
279
- # # @param payment_provider [Symbol, Orb::Models::Customer::PaymentProvider, nil]
280
- # # @param payment_provider_id [String, nil]
281
- # # @param portal_url [String, nil]
282
- # # @param shipping_address [Orb::Models::Customer::ShippingAddress, nil]
283
- # # @param tax_id [Orb::Models::Customer::TaxID, nil]
284
- # # @param timezone [String]
285
- # # @param accounting_sync_configuration [Orb::Models::Customer::AccountingSyncConfiguration, nil]
286
- # # @param reporting_configuration [Orb::Models::Customer::ReportingConfiguration, nil]
287
- # #
288
- # def initialize(
289
- # id:,
290
- # additional_emails:,
291
- # auto_collection:,
292
- # balance:,
293
- # billing_address:,
294
- # created_at:,
295
- # currency:,
296
- # email:,
297
- # email_delivery:,
298
- # exempt_from_automated_tax:,
299
- # external_customer_id:,
300
- # hierarchy:,
301
- # metadata:,
302
- # name:,
303
- # payment_provider:,
304
- # payment_provider_id:,
305
- # portal_url:,
306
- # shipping_address:,
307
- # tax_id:,
308
- # timezone:,
309
- # accounting_sync_configuration: nil,
310
- # reporting_configuration: nil,
311
- # **
312
- # )
313
- # super
314
- # end
315
-
316
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
245
+ # @!method initialize(id:, additional_emails:, auto_collection:, balance:, billing_address:, created_at:, currency:, email:, email_delivery:, exempt_from_automated_tax:, external_customer_id:, hierarchy:, metadata:, name:, payment_provider:, payment_provider_id:, portal_url:, shipping_address:, tax_id:, timezone:, accounting_sync_configuration: nil, reporting_configuration: nil)
246
+ # Some parameter documentations has been truncated, see {Orb::Models::Customer}
247
+ # for more details.
248
+ #
249
+ # A customer is a buyer of your products, and the other party to the billing
250
+ # relationship.
251
+ #
252
+ # In Orb, customers are assigned system generated identifiers automatically, but
253
+ # it's often desirable to have these match existing identifiers in your system. To
254
+ # avoid having to denormalize Orb ID information, you can pass in an
255
+ # `external_customer_id` with your own identifier. See
256
+ # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
257
+ # information about how these aliases work in Orb.
258
+ #
259
+ # In addition to having an identifier in your system, a customer may exist in a
260
+ # payment provider solution like Stripe. Use the `payment_provider_id` and the
261
+ # `payment_provider` enum field to express this mapping.
262
+ #
263
+ # A customer also has a timezone (from the standard
264
+ # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
265
+ # your account's timezone. See [Timezone localization](/essentials/timezones) for
266
+ # information on what this timezone parameter influences within Orb.
267
+ #
268
+ # @param id [String]
269
+ #
270
+ # @param additional_emails [Array<String>]
271
+ #
272
+ # @param auto_collection [Boolean]
273
+ #
274
+ # @param balance [String] The customer's current balance in their currency.
275
+ #
276
+ # @param billing_address [Orb::Models::Customer::BillingAddress, nil]
277
+ #
278
+ # @param created_at [Time]
279
+ #
280
+ # @param currency [String, nil]
281
+ #
282
+ # @param email [String] A valid customer email, to be used for notifications. When Orb triggers payment
283
+ # ...
284
+ #
285
+ # @param email_delivery [Boolean]
286
+ #
287
+ # @param exempt_from_automated_tax [Boolean, nil]
288
+ #
289
+ # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
290
+ # ...
291
+ #
292
+ # @param hierarchy [Orb::Models::Customer::Hierarchy] The hierarchical relationships for this customer.
293
+ #
294
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
295
+ # ...
296
+ #
297
+ # @param name [String] The full name of the customer
298
+ #
299
+ # @param payment_provider [Symbol, Orb::Models::Customer::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
300
+ # ...
301
+ #
302
+ # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
303
+ # ...
304
+ #
305
+ # @param portal_url [String, nil]
306
+ #
307
+ # @param shipping_address [Orb::Models::Customer::ShippingAddress, nil]
308
+ #
309
+ # @param tax_id [Orb::Models::Customer::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
310
+ # ...
311
+ #
312
+ # @param timezone [String] A timezone identifier from the IANA timezone database, such as "America/Los_Ange
313
+ # ...
314
+ #
315
+ # @param accounting_sync_configuration [Orb::Models::Customer::AccountingSyncConfiguration, nil]
316
+ #
317
+ # @param reporting_configuration [Orb::Models::Customer::ReportingConfiguration, nil]
317
318
 
318
319
  # @see Orb::Models::Customer#billing_address
319
320
  class BillingAddress < Orb::Internal::Type::BaseModel
@@ -347,17 +348,13 @@ module Orb
347
348
  # @return [String, nil]
348
349
  required :state, String, nil?: true
349
350
 
350
- # @!parse
351
- # # @param city [String, nil]
352
- # # @param country [String, nil]
353
- # # @param line1 [String, nil]
354
- # # @param line2 [String, nil]
355
- # # @param postal_code [String, nil]
356
- # # @param state [String, nil]
357
- # #
358
- # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
359
-
360
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
351
+ # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
352
+ # @param city [String, nil]
353
+ # @param country [String, nil]
354
+ # @param line1 [String, nil]
355
+ # @param line2 [String, nil]
356
+ # @param postal_code [String, nil]
357
+ # @param state [String, nil]
361
358
  end
362
359
 
363
360
  # @see Orb::Models::Customer#hierarchy
@@ -372,15 +369,11 @@ module Orb
372
369
  # @return [Orb::Models::Customer::Hierarchy::Parent, nil]
373
370
  required :parent, -> { Orb::Models::Customer::Hierarchy::Parent }, nil?: true
374
371
 
375
- # @!parse
376
- # # The hierarchical relationships for this customer.
377
- # #
378
- # # @param children [Array<Orb::Models::Customer::Hierarchy::Child>]
379
- # # @param parent [Orb::Models::Customer::Hierarchy::Parent, nil]
380
- # #
381
- # def initialize(children:, parent:, **) = super
382
-
383
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
372
+ # @!method initialize(children:, parent:)
373
+ # The hierarchical relationships for this customer.
374
+ #
375
+ # @param children [Array<Orb::Models::Customer::Hierarchy::Child>]
376
+ # @param parent [Orb::Models::Customer::Hierarchy::Parent, nil]
384
377
 
385
378
  class Child < Orb::Internal::Type::BaseModel
386
379
  # @!attribute id
@@ -393,13 +386,9 @@ module Orb
393
386
  # @return [String, nil]
394
387
  required :external_customer_id, String, nil?: true
395
388
 
396
- # @!parse
397
- # # @param id [String]
398
- # # @param external_customer_id [String, nil]
399
- # #
400
- # def initialize(id:, external_customer_id:, **) = super
401
-
402
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
389
+ # @!method initialize(id:, external_customer_id:)
390
+ # @param id [String]
391
+ # @param external_customer_id [String, nil]
403
392
  end
404
393
 
405
394
  # @see Orb::Models::Customer::Hierarchy#parent
@@ -414,13 +403,9 @@ module Orb
414
403
  # @return [String, nil]
415
404
  required :external_customer_id, String, nil?: true
416
405
 
417
- # @!parse
418
- # # @param id [String]
419
- # # @param external_customer_id [String, nil]
420
- # #
421
- # def initialize(id:, external_customer_id:, **) = super
422
-
423
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
406
+ # @!method initialize(id:, external_customer_id:)
407
+ # @param id [String]
408
+ # @param external_customer_id [String, nil]
424
409
  end
425
410
  end
426
411
 
@@ -438,11 +423,8 @@ module Orb
438
423
  STRIPE_INVOICE = :stripe_invoice
439
424
  NETSUITE = :netsuite
440
425
 
441
- finalize!
442
-
443
- # @!parse
444
- # # @return [Array<Symbol>]
445
- # def self.values; end
426
+ # @!method self.values
427
+ # @return [Array<Symbol>]
446
428
  end
447
429
 
448
430
  # @see Orb::Models::Customer#shipping_address
@@ -477,17 +459,13 @@ module Orb
477
459
  # @return [String, nil]
478
460
  required :state, String, nil?: true
479
461
 
480
- # @!parse
481
- # # @param city [String, nil]
482
- # # @param country [String, nil]
483
- # # @param line1 [String, nil]
484
- # # @param line2 [String, nil]
485
- # # @param postal_code [String, nil]
486
- # # @param state [String, nil]
487
- # #
488
- # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
489
-
490
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
462
+ # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
463
+ # @param city [String, nil]
464
+ # @param country [String, nil]
465
+ # @param line1 [String, nil]
466
+ # @param line2 [String, nil]
467
+ # @param postal_code [String, nil]
468
+ # @param state [String, nil]
491
469
  end
492
470
 
493
471
  # @see Orb::Models::Customer#tax_id
@@ -507,120 +485,116 @@ module Orb
507
485
  # @return [String]
508
486
  required :value, String
509
487
 
510
- # @!parse
511
- # # Tax IDs are commonly required to be displayed on customer invoices, which are
512
- # # added to the headers of invoices.
513
- # #
514
- # # ### Supported Tax ID Countries and Types
515
- # #
516
- # # | Country | Type | Description |
517
- # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
518
- # # | Andorra | `ad_nrt` | Andorran NRT Number |
519
- # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
520
- # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
521
- # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
522
- # # | Austria | `eu_vat` | European VAT Number |
523
- # # | Bahrain | `bh_vat` | Bahraini VAT Number |
524
- # # | Belgium | `eu_vat` | European VAT Number |
525
- # # | Bolivia | `bo_tin` | Bolivian Tax ID |
526
- # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
527
- # # | Brazil | `br_cpf` | Brazilian CPF Number |
528
- # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
529
- # # | Bulgaria | `eu_vat` | European VAT Number |
530
- # # | Canada | `ca_bn` | Canadian BN |
531
- # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
532
- # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
533
- # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
534
- # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
535
- # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
536
- # # | Chile | `cl_tin` | Chilean TIN |
537
- # # | China | `cn_tin` | Chinese Tax ID |
538
- # # | Colombia | `co_nit` | Colombian NIT Number |
539
- # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
540
- # # | Croatia | `eu_vat` | European VAT Number |
541
- # # | Cyprus | `eu_vat` | European VAT Number |
542
- # # | Czech Republic | `eu_vat` | European VAT Number |
543
- # # | Denmark | `eu_vat` | European VAT Number |
544
- # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
545
- # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
546
- # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
547
- # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
548
- # # | Estonia | `eu_vat` | European VAT Number |
549
- # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
550
- # # | Finland | `eu_vat` | European VAT Number |
551
- # # | France | `eu_vat` | European VAT Number |
552
- # # | Georgia | `ge_vat` | Georgian VAT |
553
- # # | Germany | `eu_vat` | European VAT Number |
554
- # # | Greece | `eu_vat` | European VAT Number |
555
- # # | Hong Kong | `hk_br` | Hong Kong BR Number |
556
- # # | Hungary | `eu_vat` | European VAT Number |
557
- # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
558
- # # | Iceland | `is_vat` | Icelandic VAT |
559
- # # | India | `in_gst` | Indian GST Number |
560
- # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
561
- # # | Ireland | `eu_vat` | European VAT Number |
562
- # # | Israel | `il_vat` | Israel VAT |
563
- # # | Italy | `eu_vat` | European VAT Number |
564
- # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
565
- # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
566
- # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
567
- # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
568
- # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
569
- # # | Latvia | `eu_vat` | European VAT Number |
570
- # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
571
- # # | Lithuania | `eu_vat` | European VAT Number |
572
- # # | Luxembourg | `eu_vat` | European VAT Number |
573
- # # | Malaysia | `my_frp` | Malaysian FRP Number |
574
- # # | Malaysia | `my_itn` | Malaysian ITN |
575
- # # | Malaysia | `my_sst` | Malaysian SST Number |
576
- # # | Malta | `eu_vat ` | European VAT Number |
577
- # # | Mexico | `mx_rfc` | Mexican RFC Number |
578
- # # | Netherlands | `eu_vat` | European VAT Number |
579
- # # | New Zealand | `nz_gst` | New Zealand GST Number |
580
- # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
581
- # # | Norway | `no_vat` | Norwegian VAT Number |
582
- # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
583
- # # | Oman | `om_vat` | Omani VAT Number |
584
- # # | Peru | `pe_ruc` | Peruvian RUC Number |
585
- # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
586
- # # | Poland | `eu_vat` | European VAT Number |
587
- # # | Portugal | `eu_vat` | European VAT Number |
588
- # # | Romania | `eu_vat` | European VAT Number |
589
- # # | Romania | `ro_tin` | Romanian Tax ID Number |
590
- # # | Russia | `ru_inn` | Russian INN |
591
- # # | Russia | `ru_kpp` | Russian KPP |
592
- # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
593
- # # | Serbia | `rs_pib` | Serbian PIB Number |
594
- # # | Singapore | `sg_gst` | Singaporean GST |
595
- # # | Singapore | `sg_uen` | Singaporean UEN |
596
- # # | Slovakia | `eu_vat` | European VAT Number |
597
- # # | Slovenia | `eu_vat` | European VAT Number |
598
- # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
599
- # # | South Africa | `za_vat` | South African VAT Number |
600
- # # | South Korea | `kr_brn` | Korean BRN |
601
- # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
602
- # # | Spain | `eu_vat` | European VAT Number |
603
- # # | Sweden | `eu_vat` | European VAT Number |
604
- # # | Switzerland | `ch_vat` | Switzerland VAT Number |
605
- # # | Taiwan | `tw_vat` | Taiwanese VAT |
606
- # # | Thailand | `th_vat` | Thai VAT |
607
- # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
608
- # # | Ukraine | `ua_vat` | Ukrainian VAT |
609
- # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
610
- # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
611
- # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
612
- # # | United States | `us_ein` | United States EIN |
613
- # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
614
- # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
615
- # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
616
- # #
617
- # # @param country [Symbol, Orb::Models::Customer::TaxID::Country]
618
- # # @param type [Symbol, Orb::Models::Customer::TaxID::Type]
619
- # # @param value [String]
620
- # #
621
- # def initialize(country:, type:, value:, **) = super
622
-
623
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
488
+ # @!method initialize(country:, type:, value:)
489
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
490
+ # added to the headers of invoices.
491
+ #
492
+ # ### Supported Tax ID Countries and Types
493
+ #
494
+ # | Country | Type | Description |
495
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
496
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
497
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
498
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
499
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
500
+ # | Austria | `eu_vat` | European VAT Number |
501
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
502
+ # | Belgium | `eu_vat` | European VAT Number |
503
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
504
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
505
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
506
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
507
+ # | Bulgaria | `eu_vat` | European VAT Number |
508
+ # | Canada | `ca_bn` | Canadian BN |
509
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
510
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
511
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
512
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
513
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
514
+ # | Chile | `cl_tin` | Chilean TIN |
515
+ # | China | `cn_tin` | Chinese Tax ID |
516
+ # | Colombia | `co_nit` | Colombian NIT Number |
517
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
518
+ # | Croatia | `eu_vat` | European VAT Number |
519
+ # | Cyprus | `eu_vat` | European VAT Number |
520
+ # | Czech Republic | `eu_vat` | European VAT Number |
521
+ # | Denmark | `eu_vat` | European VAT Number |
522
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
523
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
524
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
525
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
526
+ # | Estonia | `eu_vat` | European VAT Number |
527
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
528
+ # | Finland | `eu_vat` | European VAT Number |
529
+ # | France | `eu_vat` | European VAT Number |
530
+ # | Georgia | `ge_vat` | Georgian VAT |
531
+ # | Germany | `eu_vat` | European VAT Number |
532
+ # | Greece | `eu_vat` | European VAT Number |
533
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
534
+ # | Hungary | `eu_vat` | European VAT Number |
535
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
536
+ # | Iceland | `is_vat` | Icelandic VAT |
537
+ # | India | `in_gst` | Indian GST Number |
538
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
539
+ # | Ireland | `eu_vat` | European VAT Number |
540
+ # | Israel | `il_vat` | Israel VAT |
541
+ # | Italy | `eu_vat` | European VAT Number |
542
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
543
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
544
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
545
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
546
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
547
+ # | Latvia | `eu_vat` | European VAT Number |
548
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
549
+ # | Lithuania | `eu_vat` | European VAT Number |
550
+ # | Luxembourg | `eu_vat` | European VAT Number |
551
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
552
+ # | Malaysia | `my_itn` | Malaysian ITN |
553
+ # | Malaysia | `my_sst` | Malaysian SST Number |
554
+ # | Malta | `eu_vat ` | European VAT Number |
555
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
556
+ # | Netherlands | `eu_vat` | European VAT Number |
557
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
558
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
559
+ # | Norway | `no_vat` | Norwegian VAT Number |
560
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
561
+ # | Oman | `om_vat` | Omani VAT Number |
562
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
563
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
564
+ # | Poland | `eu_vat` | European VAT Number |
565
+ # | Portugal | `eu_vat` | European VAT Number |
566
+ # | Romania | `eu_vat` | European VAT Number |
567
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
568
+ # | Russia | `ru_inn` | Russian INN |
569
+ # | Russia | `ru_kpp` | Russian KPP |
570
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
571
+ # | Serbia | `rs_pib` | Serbian PIB Number |
572
+ # | Singapore | `sg_gst` | Singaporean GST |
573
+ # | Singapore | `sg_uen` | Singaporean UEN |
574
+ # | Slovakia | `eu_vat` | European VAT Number |
575
+ # | Slovenia | `eu_vat` | European VAT Number |
576
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
577
+ # | South Africa | `za_vat` | South African VAT Number |
578
+ # | South Korea | `kr_brn` | Korean BRN |
579
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
580
+ # | Spain | `eu_vat` | European VAT Number |
581
+ # | Sweden | `eu_vat` | European VAT Number |
582
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
583
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
584
+ # | Thailand | `th_vat` | Thai VAT |
585
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
586
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
587
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
588
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
589
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
590
+ # | United States | `us_ein` | United States EIN |
591
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
592
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
593
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
594
+ #
595
+ # @param country [Symbol, Orb::Models::Customer::TaxID::Country]
596
+ # @param type [Symbol, Orb::Models::Customer::TaxID::Type]
597
+ # @param value [String]
624
598
 
625
599
  # @see Orb::Models::Customer::TaxID#country
626
600
  module Country
@@ -705,11 +679,8 @@ module Orb
705
679
  VN = :VN
706
680
  ZA = :ZA
707
681
 
708
- finalize!
709
-
710
- # @!parse
711
- # # @return [Array<Symbol>]
712
- # def self.values; end
682
+ # @!method self.values
683
+ # @return [Array<Symbol>]
713
684
  end
714
685
 
715
686
  # @see Orb::Models::Customer::TaxID#type
@@ -788,11 +759,8 @@ module Orb
788
759
  VN_TIN = :vn_tin
789
760
  ZA_VAT = :za_vat
790
761
 
791
- finalize!
792
-
793
- # @!parse
794
- # # @return [Array<Symbol>]
795
- # def self.values; end
762
+ # @!method self.values
763
+ # @return [Array<Symbol>]
796
764
  end
797
765
  end
798
766
 
@@ -809,13 +777,9 @@ module Orb
809
777
  # @return [Boolean]
810
778
  required :excluded, Orb::Internal::Type::Boolean
811
779
 
812
- # @!parse
813
- # # @param accounting_providers [Array<Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider>]
814
- # # @param excluded [Boolean]
815
- # #
816
- # def initialize(accounting_providers:, excluded:, **) = super
817
-
818
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
780
+ # @!method initialize(accounting_providers:, excluded:)
781
+ # @param accounting_providers [Array<Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider>]
782
+ # @param excluded [Boolean]
819
783
 
820
784
  class AccountingProvider < Orb::Internal::Type::BaseModel
821
785
  # @!attribute external_provider_id
@@ -829,13 +793,9 @@ module Orb
829
793
  required :provider_type,
830
794
  enum: -> { Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType }
831
795
 
832
- # @!parse
833
- # # @param external_provider_id [String, nil]
834
- # # @param provider_type [Symbol, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
835
- # #
836
- # def initialize(external_provider_id:, provider_type:, **) = super
837
-
838
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
796
+ # @!method initialize(external_provider_id:, provider_type:)
797
+ # @param external_provider_id [String, nil]
798
+ # @param provider_type [Symbol, Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider::ProviderType]
839
799
 
840
800
  # @see Orb::Models::Customer::AccountingSyncConfiguration::AccountingProvider#provider_type
841
801
  module ProviderType
@@ -844,11 +804,8 @@ module Orb
844
804
  QUICKBOOKS = :quickbooks
845
805
  NETSUITE = :netsuite
846
806
 
847
- finalize!
848
-
849
- # @!parse
850
- # # @return [Array<Symbol>]
851
- # def self.values; end
807
+ # @!method self.values
808
+ # @return [Array<Symbol>]
852
809
  end
853
810
  end
854
811
  end
@@ -860,12 +817,8 @@ module Orb
860
817
  # @return [Boolean]
861
818
  required :exempt, Orb::Internal::Type::Boolean
862
819
 
863
- # @!parse
864
- # # @param exempt [Boolean]
865
- # #
866
- # def initialize(exempt:, **) = super
867
-
868
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
820
+ # @!method initialize(exempt:)
821
+ # @param exempt [Boolean]
869
822
  end
870
823
  end
871
824
  end