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
@@ -282,21 +282,150 @@ module Orb
282
282
  end
283
283
  def self.new(
284
284
  accounting_sync_configuration: nil,
285
+ # Additional email addresses for this customer. If populated, these email
286
+ # addresses will be CC'd for customer communications.
285
287
  additional_emails: nil,
288
+ # Used to determine if invoices for this customer will automatically attempt to
289
+ # charge a saved payment method, if available. This parameter defaults to `True`
290
+ # when a payment provider is provided on customer creation.
286
291
  auto_collection: nil,
287
292
  billing_address: nil,
293
+ # An ISO 4217 currency string used for the customer's invoices and balance. If not
294
+ # set at creation time, will be set at subscription creation time.
288
295
  currency: nil,
296
+ # A valid customer email, to be used for invoicing and notifications.
289
297
  email: nil,
290
298
  email_delivery: nil,
299
+ # The external customer ID. This can only be set if empty and the customer has no
300
+ # past or current subscriptions.
291
301
  external_customer_id: nil,
302
+ # The hierarchical relationships for this customer.
292
303
  hierarchy: nil,
304
+ # User-specified key/value pairs for the resource. Individual keys can be removed
305
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
306
+ # by setting `metadata` to `null`.
293
307
  metadata: nil,
308
+ # The full name of the customer
294
309
  name: nil,
310
+ # This is used for creating charges or invoices in an external system via Orb.
311
+ # When not in test mode:
312
+ #
313
+ # - the connection must first be configured in the Orb webapp.
314
+ # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
315
+ # `bill.com`, `netsuite`), any product mappings must first be configured with
316
+ # the Orb team.
295
317
  payment_provider: nil,
318
+ # The ID of this customer in an external payments solution, such as Stripe. This
319
+ # is used for creating charges or invoices in the external system via Orb.
296
320
  payment_provider_id: nil,
297
321
  reporting_configuration: nil,
298
322
  shipping_address: nil,
299
323
  tax_configuration: nil,
324
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
325
+ # added to the headers of invoices.
326
+ #
327
+ # ### Supported Tax ID Countries and Types
328
+ #
329
+ # | Country | Type | Description |
330
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
331
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
332
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
333
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
334
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
335
+ # | Austria | `eu_vat` | European VAT Number |
336
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
337
+ # | Belgium | `eu_vat` | European VAT Number |
338
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
339
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
340
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
341
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
342
+ # | Bulgaria | `eu_vat` | European VAT Number |
343
+ # | Canada | `ca_bn` | Canadian BN |
344
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
345
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
346
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
347
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
348
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
349
+ # | Chile | `cl_tin` | Chilean TIN |
350
+ # | China | `cn_tin` | Chinese Tax ID |
351
+ # | Colombia | `co_nit` | Colombian NIT Number |
352
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
353
+ # | Croatia | `eu_vat` | European VAT Number |
354
+ # | Cyprus | `eu_vat` | European VAT Number |
355
+ # | Czech Republic | `eu_vat` | European VAT Number |
356
+ # | Denmark | `eu_vat` | European VAT Number |
357
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
358
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
359
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
360
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
361
+ # | Estonia | `eu_vat` | European VAT Number |
362
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
363
+ # | Finland | `eu_vat` | European VAT Number |
364
+ # | France | `eu_vat` | European VAT Number |
365
+ # | Georgia | `ge_vat` | Georgian VAT |
366
+ # | Germany | `eu_vat` | European VAT Number |
367
+ # | Greece | `eu_vat` | European VAT Number |
368
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
369
+ # | Hungary | `eu_vat` | European VAT Number |
370
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
371
+ # | Iceland | `is_vat` | Icelandic VAT |
372
+ # | India | `in_gst` | Indian GST Number |
373
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
374
+ # | Ireland | `eu_vat` | European VAT Number |
375
+ # | Israel | `il_vat` | Israel VAT |
376
+ # | Italy | `eu_vat` | European VAT Number |
377
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
378
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
379
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
380
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
381
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
382
+ # | Latvia | `eu_vat` | European VAT Number |
383
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
384
+ # | Lithuania | `eu_vat` | European VAT Number |
385
+ # | Luxembourg | `eu_vat` | European VAT Number |
386
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
387
+ # | Malaysia | `my_itn` | Malaysian ITN |
388
+ # | Malaysia | `my_sst` | Malaysian SST Number |
389
+ # | Malta | `eu_vat ` | European VAT Number |
390
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
391
+ # | Netherlands | `eu_vat` | European VAT Number |
392
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
393
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
394
+ # | Norway | `no_vat` | Norwegian VAT Number |
395
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
396
+ # | Oman | `om_vat` | Omani VAT Number |
397
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
398
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
399
+ # | Poland | `eu_vat` | European VAT Number |
400
+ # | Portugal | `eu_vat` | European VAT Number |
401
+ # | Romania | `eu_vat` | European VAT Number |
402
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
403
+ # | Russia | `ru_inn` | Russian INN |
404
+ # | Russia | `ru_kpp` | Russian KPP |
405
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
406
+ # | Serbia | `rs_pib` | Serbian PIB Number |
407
+ # | Singapore | `sg_gst` | Singaporean GST |
408
+ # | Singapore | `sg_uen` | Singaporean UEN |
409
+ # | Slovakia | `eu_vat` | European VAT Number |
410
+ # | Slovenia | `eu_vat` | European VAT Number |
411
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
412
+ # | South Africa | `za_vat` | South African VAT Number |
413
+ # | South Korea | `kr_brn` | Korean BRN |
414
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
415
+ # | Spain | `eu_vat` | European VAT Number |
416
+ # | Sweden | `eu_vat` | European VAT Number |
417
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
418
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
419
+ # | Thailand | `th_vat` | Thai VAT |
420
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
421
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
422
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
423
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
424
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
425
+ # | United States | `us_ein` | United States EIN |
426
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
427
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
428
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
300
429
  tax_id: nil,
301
430
  request_options: {}
302
431
  ); end
@@ -456,8 +585,14 @@ module Orb
456
585
  params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String))
457
586
  .returns(T.attached_class)
458
587
  end
459
- def self.new(child_customer_ids: nil, parent_customer_id: nil); end
460
-
588
+ def self.new(
589
+ # A list of child customer IDs to add to the hierarchy. The desired child
590
+ # customers must not already be part of another hierarchy.
591
+ child_customer_ids: nil,
592
+ # The ID of the parent customer in the hierarchy. The desired parent customer must
593
+ # not be a child of another customer.
594
+ parent_customer_id: nil
595
+ ); end
461
596
  sig do
462
597
  override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)})
463
598
  end
@@ -476,8 +611,7 @@ module Orb
476
611
 
477
612
  TaggedSymbol =
478
613
  T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider) }
479
- OrSymbol =
480
- T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol) }
614
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
481
615
 
482
616
  QUICKBOOKS =
483
617
  T.let(:quickbooks, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider::TaggedSymbol)
@@ -748,8 +882,7 @@ module Orb
748
882
 
749
883
  TaggedSymbol =
750
884
  T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country) }
751
- OrSymbol =
752
- T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol) }
885
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
753
886
 
754
887
  AD = T.let(:AD, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol)
755
888
  AE = T.let(:AE, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country::TaggedSymbol)
@@ -838,8 +971,7 @@ module Orb
838
971
  extend Orb::Internal::Type::Enum
839
972
 
840
973
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type) }
841
- OrSymbol =
842
- T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol) }
974
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
843
975
 
844
976
  AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol)
845
977
  AE_TRN = T.let(:ae_trn, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type::TaggedSymbol)
@@ -267,21 +267,150 @@ module Orb
267
267
  end
268
268
  def self.new(
269
269
  accounting_sync_configuration: nil,
270
+ # Additional email addresses for this customer. If populated, these email
271
+ # addresses will be CC'd for customer communications.
270
272
  additional_emails: nil,
273
+ # Used to determine if invoices for this customer will automatically attempt to
274
+ # charge a saved payment method, if available. This parameter defaults to `True`
275
+ # when a payment provider is provided on customer creation.
271
276
  auto_collection: nil,
272
277
  billing_address: nil,
278
+ # An ISO 4217 currency string used for the customer's invoices and balance. If not
279
+ # set at creation time, will be set at subscription creation time.
273
280
  currency: nil,
281
+ # A valid customer email, to be used for invoicing and notifications.
274
282
  email: nil,
275
283
  email_delivery: nil,
284
+ # The external customer ID. This can only be set if empty and the customer has no
285
+ # past or current subscriptions.
276
286
  external_customer_id: nil,
287
+ # The hierarchical relationships for this customer.
277
288
  hierarchy: nil,
289
+ # User-specified key/value pairs for the resource. Individual keys can be removed
290
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
291
+ # by setting `metadata` to `null`.
278
292
  metadata: nil,
293
+ # The full name of the customer
279
294
  name: nil,
295
+ # This is used for creating charges or invoices in an external system via Orb.
296
+ # When not in test mode:
297
+ #
298
+ # - the connection must first be configured in the Orb webapp.
299
+ # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
300
+ # `bill.com`, `netsuite`), any product mappings must first be configured with
301
+ # the Orb team.
280
302
  payment_provider: nil,
303
+ # The ID of this customer in an external payments solution, such as Stripe. This
304
+ # is used for creating charges or invoices in the external system via Orb.
281
305
  payment_provider_id: nil,
282
306
  reporting_configuration: nil,
283
307
  shipping_address: nil,
284
308
  tax_configuration: nil,
309
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
310
+ # added to the headers of invoices.
311
+ #
312
+ # ### Supported Tax ID Countries and Types
313
+ #
314
+ # | Country | Type | Description |
315
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
316
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
317
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
318
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
319
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
320
+ # | Austria | `eu_vat` | European VAT Number |
321
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
322
+ # | Belgium | `eu_vat` | European VAT Number |
323
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
324
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
325
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
326
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
327
+ # | Bulgaria | `eu_vat` | European VAT Number |
328
+ # | Canada | `ca_bn` | Canadian BN |
329
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
330
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
331
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
332
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
333
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
334
+ # | Chile | `cl_tin` | Chilean TIN |
335
+ # | China | `cn_tin` | Chinese Tax ID |
336
+ # | Colombia | `co_nit` | Colombian NIT Number |
337
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
338
+ # | Croatia | `eu_vat` | European VAT Number |
339
+ # | Cyprus | `eu_vat` | European VAT Number |
340
+ # | Czech Republic | `eu_vat` | European VAT Number |
341
+ # | Denmark | `eu_vat` | European VAT Number |
342
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
343
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
344
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
345
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
346
+ # | Estonia | `eu_vat` | European VAT Number |
347
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
348
+ # | Finland | `eu_vat` | European VAT Number |
349
+ # | France | `eu_vat` | European VAT Number |
350
+ # | Georgia | `ge_vat` | Georgian VAT |
351
+ # | Germany | `eu_vat` | European VAT Number |
352
+ # | Greece | `eu_vat` | European VAT Number |
353
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
354
+ # | Hungary | `eu_vat` | European VAT Number |
355
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
356
+ # | Iceland | `is_vat` | Icelandic VAT |
357
+ # | India | `in_gst` | Indian GST Number |
358
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
359
+ # | Ireland | `eu_vat` | European VAT Number |
360
+ # | Israel | `il_vat` | Israel VAT |
361
+ # | Italy | `eu_vat` | European VAT Number |
362
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
363
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
364
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
365
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
366
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
367
+ # | Latvia | `eu_vat` | European VAT Number |
368
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
369
+ # | Lithuania | `eu_vat` | European VAT Number |
370
+ # | Luxembourg | `eu_vat` | European VAT Number |
371
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
372
+ # | Malaysia | `my_itn` | Malaysian ITN |
373
+ # | Malaysia | `my_sst` | Malaysian SST Number |
374
+ # | Malta | `eu_vat ` | European VAT Number |
375
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
376
+ # | Netherlands | `eu_vat` | European VAT Number |
377
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
378
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
379
+ # | Norway | `no_vat` | Norwegian VAT Number |
380
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
381
+ # | Oman | `om_vat` | Omani VAT Number |
382
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
383
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
384
+ # | Poland | `eu_vat` | European VAT Number |
385
+ # | Portugal | `eu_vat` | European VAT Number |
386
+ # | Romania | `eu_vat` | European VAT Number |
387
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
388
+ # | Russia | `ru_inn` | Russian INN |
389
+ # | Russia | `ru_kpp` | Russian KPP |
390
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
391
+ # | Serbia | `rs_pib` | Serbian PIB Number |
392
+ # | Singapore | `sg_gst` | Singaporean GST |
393
+ # | Singapore | `sg_uen` | Singaporean UEN |
394
+ # | Slovakia | `eu_vat` | European VAT Number |
395
+ # | Slovenia | `eu_vat` | European VAT Number |
396
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
397
+ # | South Africa | `za_vat` | South African VAT Number |
398
+ # | South Korea | `kr_brn` | Korean BRN |
399
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
400
+ # | Spain | `eu_vat` | European VAT Number |
401
+ # | Sweden | `eu_vat` | European VAT Number |
402
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
403
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
404
+ # | Thailand | `th_vat` | Thai VAT |
405
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
406
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
407
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
408
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
409
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
410
+ # | United States | `us_ein` | United States EIN |
411
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
412
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
413
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
285
414
  tax_id: nil,
286
415
  request_options: {}
287
416
  ); end
@@ -437,8 +566,14 @@ module Orb
437
566
  params(child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String))
438
567
  .returns(T.attached_class)
439
568
  end
440
- def self.new(child_customer_ids: nil, parent_customer_id: nil); end
441
-
569
+ def self.new(
570
+ # A list of child customer IDs to add to the hierarchy. The desired child
571
+ # customers must not already be part of another hierarchy.
572
+ child_customer_ids: nil,
573
+ # The ID of the parent customer in the hierarchy. The desired parent customer must
574
+ # not be a child of another customer.
575
+ parent_customer_id: nil
576
+ ); end
442
577
  sig do
443
578
  override.returns({child_customer_ids: T::Array[String], parent_customer_id: T.nilable(String)})
444
579
  end
@@ -456,8 +591,7 @@ module Orb
456
591
  extend Orb::Internal::Type::Enum
457
592
 
458
593
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider) }
459
- OrSymbol =
460
- T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol) }
594
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
461
595
 
462
596
  QUICKBOOKS = T.let(:quickbooks, Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol)
463
597
  BILL_COM = T.let(:"bill.com", Orb::Models::CustomerUpdateParams::PaymentProvider::TaggedSymbol)
@@ -723,8 +857,7 @@ module Orb
723
857
  extend Orb::Internal::Type::Enum
724
858
 
725
859
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country) }
726
- OrSymbol =
727
- T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol) }
860
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
728
861
 
729
862
  AD = T.let(:AD, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol)
730
863
  AE = T.let(:AE, Orb::Models::CustomerUpdateParams::TaxID::Country::TaggedSymbol)
@@ -813,8 +946,7 @@ module Orb
813
946
  extend Orb::Internal::Type::Enum
814
947
 
815
948
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type) }
816
- OrSymbol =
817
- T.type_alias { T.any(Symbol, String, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol) }
949
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
818
950
 
819
951
  AD_NRT = T.let(:ad_nrt, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol)
820
952
  AE_TRN = T.let(:ae_trn, Orb::Models::CustomerUpdateParams::TaxID::Type::TaggedSymbol)
@@ -26,8 +26,13 @@ module Orb
26
26
  )
27
27
  .returns(T.attached_class)
28
28
  end
29
- def self.new(amount:, type:, description: nil, request_options: {}); end
30
-
29
+ def self.new(
30
+ amount:,
31
+ type:,
32
+ # An optional description that can be specified around this entry.
33
+ description: nil,
34
+ request_options: {}
35
+ ); end
31
36
  sig do
32
37
  override
33
38
  .returns(
@@ -46,8 +51,7 @@ module Orb
46
51
 
47
52
  TaggedSymbol =
48
53
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type) }
49
- OrSymbol =
50
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol) }
54
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
51
55
 
52
56
  INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol)
53
57
  DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionCreateParams::Type::TaggedSymbol)
@@ -82,14 +82,22 @@ module Orb
82
82
  .returns(T.attached_class)
83
83
  end
84
84
  def self.new(
85
+ # A unique id for this transaction.
85
86
  id:,
86
87
  action:,
88
+ # The value of the amount changed in the transaction.
87
89
  amount:,
90
+ # The creation time of this transaction.
88
91
  created_at:,
89
92
  credit_note:,
93
+ # An optional description provided for manual customer balance adjustments.
90
94
  description:,
95
+ # The new value of the customer's balance prior to the transaction, in the
96
+ # customer's currency.
91
97
  ending_balance:,
92
98
  invoice:,
99
+ # The original value of the customer's balance prior to the transaction, in the
100
+ # customer's currency.
93
101
  starting_balance:,
94
102
  type:
95
103
  ); end
@@ -117,8 +125,7 @@ module Orb
117
125
 
118
126
  TaggedSymbol =
119
127
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Action) }
120
- OrSymbol =
121
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol) }
128
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
122
129
 
123
130
  APPLIED_TO_INVOICE =
124
131
  T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionCreateResponse::Action::TaggedSymbol)
@@ -158,8 +165,10 @@ module Orb
158
165
  attr_accessor :id
159
166
 
160
167
  sig { params(id: String).returns(T.attached_class) }
161
- def self.new(id:); end
162
-
168
+ def self.new(
169
+ # The id of the Credit note
170
+ id:
171
+ ); end
163
172
  sig { override.returns({id: String}) }
164
173
  def to_hash; end
165
174
  end
@@ -170,8 +179,10 @@ module Orb
170
179
  attr_accessor :id
171
180
 
172
181
  sig { params(id: String).returns(T.attached_class) }
173
- def self.new(id:); end
174
-
182
+ def self.new(
183
+ # The Invoice id
184
+ id:
185
+ ); end
175
186
  sig { override.returns({id: String}) }
176
187
  def to_hash; end
177
188
  end
@@ -181,8 +192,7 @@ module Orb
181
192
 
182
193
  TaggedSymbol =
183
194
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionCreateResponse::Type) }
184
- OrSymbol =
185
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol) }
195
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
186
196
 
187
197
  INCREMENT =
188
198
  T.let(:increment, Orb::Models::Customers::BalanceTransactionCreateResponse::Type::TaggedSymbol)
@@ -44,7 +44,10 @@ module Orb
44
44
  .returns(T.attached_class)
45
45
  end
46
46
  def self.new(
47
+ # Cursor for pagination. This can be populated by the `next_cursor` value returned
48
+ # from the initial request.
47
49
  cursor: nil,
50
+ # The number of items to fetch. Defaults to 20.
48
51
  limit: nil,
49
52
  operation_time_gt: nil,
50
53
  operation_time_gte: nil,
@@ -78,14 +78,22 @@ module Orb
78
78
  .returns(T.attached_class)
79
79
  end
80
80
  def self.new(
81
+ # A unique id for this transaction.
81
82
  id:,
82
83
  action:,
84
+ # The value of the amount changed in the transaction.
83
85
  amount:,
86
+ # The creation time of this transaction.
84
87
  created_at:,
85
88
  credit_note:,
89
+ # An optional description provided for manual customer balance adjustments.
86
90
  description:,
91
+ # The new value of the customer's balance prior to the transaction, in the
92
+ # customer's currency.
87
93
  ending_balance:,
88
94
  invoice:,
95
+ # The original value of the customer's balance prior to the transaction, in the
96
+ # customer's currency.
89
97
  starting_balance:,
90
98
  type:
91
99
  ); end
@@ -113,8 +121,7 @@ module Orb
113
121
 
114
122
  TaggedSymbol =
115
123
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Action) }
116
- OrSymbol =
117
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol) }
124
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
118
125
 
119
126
  APPLIED_TO_INVOICE =
120
127
  T.let(:applied_to_invoice, Orb::Models::Customers::BalanceTransactionListResponse::Action::TaggedSymbol)
@@ -148,8 +155,10 @@ module Orb
148
155
  attr_accessor :id
149
156
 
150
157
  sig { params(id: String).returns(T.attached_class) }
151
- def self.new(id:); end
152
-
158
+ def self.new(
159
+ # The id of the Credit note
160
+ id:
161
+ ); end
153
162
  sig { override.returns({id: String}) }
154
163
  def to_hash; end
155
164
  end
@@ -160,8 +169,10 @@ module Orb
160
169
  attr_accessor :id
161
170
 
162
171
  sig { params(id: String).returns(T.attached_class) }
163
- def self.new(id:); end
164
-
172
+ def self.new(
173
+ # The Invoice id
174
+ id:
175
+ ); end
165
176
  sig { override.returns({id: String}) }
166
177
  def to_hash; end
167
178
  end
@@ -171,8 +182,7 @@ module Orb
171
182
 
172
183
  TaggedSymbol =
173
184
  T.type_alias { T.all(Symbol, Orb::Models::Customers::BalanceTransactionListResponse::Type) }
174
- OrSymbol =
175
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol) }
185
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
176
186
 
177
187
  INCREMENT = T.let(:increment, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol)
178
188
  DECREMENT = T.let(:decrement, Orb::Models::Customers::BalanceTransactionListResponse::Type::TaggedSymbol)
@@ -37,14 +37,19 @@ module Orb
37
37
  .returns(T.attached_class)
38
38
  end
39
39
  def self.new(
40
+ # The currency or custom pricing unit to use.
40
41
  currency: nil,
42
+ # Costs returned are exclusive of `timeframe_end`.
41
43
  timeframe_end: nil,
44
+ # Costs returned are inclusive of `timeframe_start`.
42
45
  timeframe_start: nil,
46
+ # Controls whether Orb returns cumulative costs since the start of the billing
47
+ # period, or incremental day-by-day costs. If your customer has minimums or
48
+ # discounts, it's strongly recommended that you use the default cumulative
49
+ # behavior.
43
50
  view_mode: nil,
44
51
  request_options: {}
45
- )
46
- end
47
-
52
+ ); end
48
53
  sig do
49
54
  override
50
55
  .returns(
@@ -68,8 +73,7 @@ module Orb
68
73
 
69
74
  TaggedSymbol =
70
75
  T.type_alias { T.all(Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode) }
71
- OrSymbol =
72
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol) }
76
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
73
77
 
74
78
  PERIODIC = T.let(:periodic, Orb::Models::Customers::CostListByExternalIDParams::ViewMode::TaggedSymbol)
75
79
  CUMULATIVE =