orb-billing 0.1.0.pre.alpha.38 → 0.1.0.pre.alpha.39

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 (390) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/orb/client.rb +4 -0
  4. data/lib/orb/internal/transport/base_client.rb +1 -1
  5. data/lib/orb/internal/transport/pooled_net_requester.rb +1 -1
  6. data/lib/orb/internal/type/base_model.rb +14 -17
  7. data/lib/orb/internal/type/converter.rb +20 -22
  8. data/lib/orb/internal/type/enum.rb +8 -8
  9. data/lib/orb/internal/util.rb +1 -5
  10. data/lib/orb/models/alert.rb +9 -9
  11. data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
  12. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
  13. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
  14. data/lib/orb/models/alert_list_params.rb +5 -5
  15. data/lib/orb/models/alert_update_params.rb +3 -3
  16. data/lib/orb/models/amount_discount.rb +1 -1
  17. data/lib/orb/models/billable_metric.rb +7 -7
  18. data/lib/orb/models/coupon.rb +7 -7
  19. data/lib/orb/models/coupon_create_params.rb +2 -2
  20. data/lib/orb/models/coupon_list_params.rb +2 -2
  21. data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
  22. data/lib/orb/models/credit_note.rb +1 -1
  23. data/lib/orb/models/credit_note_list_params.rb +5 -5
  24. data/lib/orb/models/customer.rb +232 -232
  25. data/lib/orb/models/customer_create_params.rb +223 -223
  26. data/lib/orb/models/customer_list_params.rb +5 -5
  27. data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
  28. data/lib/orb/models/customer_update_params.rb +224 -224
  29. data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
  30. data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
  31. data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
  32. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
  33. data/lib/orb/models/customers/cost_list_params.rb +6 -6
  34. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
  35. data/lib/orb/models/customers/credit_list_params.rb +2 -2
  36. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
  37. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
  38. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
  39. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
  40. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
  41. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
  42. data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
  43. data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
  44. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
  45. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
  46. data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
  47. data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
  48. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
  49. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
  50. data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
  51. data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
  52. data/lib/orb/models/dimensional_price_group.rb +7 -7
  53. data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
  54. data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
  55. data/lib/orb/models/event_ingest_params.rb +7 -7
  56. data/lib/orb/models/event_ingest_response.rb +4 -4
  57. data/lib/orb/models/event_search_params.rb +5 -5
  58. data/lib/orb/models/event_search_response.rb +8 -8
  59. data/lib/orb/models/event_update_params.rb +4 -4
  60. data/lib/orb/models/events/backfill_close_response.rb +7 -7
  61. data/lib/orb/models/events/backfill_create_params.rb +11 -11
  62. data/lib/orb/models/events/backfill_create_response.rb +7 -7
  63. data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
  64. data/lib/orb/models/events/backfill_list_params.rb +1 -1
  65. data/lib/orb/models/events/backfill_list_response.rb +7 -7
  66. data/lib/orb/models/events/backfill_revert_response.rb +7 -7
  67. data/lib/orb/models/events/event_volumes.rb +1 -1
  68. data/lib/orb/models/events/volume_list_params.rb +7 -7
  69. data/lib/orb/models/invoice.rb +270 -270
  70. data/lib/orb/models/invoice_create_params.rb +12 -11
  71. data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
  72. data/lib/orb/models/invoice_issue_params.rb +4 -4
  73. data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
  74. data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
  75. data/lib/orb/models/invoice_list_params.rb +12 -12
  76. data/lib/orb/models/invoice_update_params.rb +2 -2
  77. data/lib/orb/models/item.rb +2 -2
  78. data/lib/orb/models/item_list_params.rb +1 -1
  79. data/lib/orb/models/metric_create_params.rb +2 -2
  80. data/lib/orb/models/metric_list_params.rb +5 -5
  81. data/lib/orb/models/metric_update_params.rb +2 -2
  82. data/lib/orb/models/percentage_discount.rb +2 -2
  83. data/lib/orb/models/plan.rb +35 -35
  84. data/lib/orb/models/plan_create_params.rb +267 -267
  85. data/lib/orb/models/plan_list_params.rb +5 -5
  86. data/lib/orb/models/plan_update_params.rb +4 -4
  87. data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
  88. data/lib/orb/models/price.rb +158 -158
  89. data/lib/orb/models/price_create_params.rb +20 -20
  90. data/lib/orb/models/price_evaluate_params.rb +4 -4
  91. data/lib/orb/models/price_list_params.rb +1 -1
  92. data/lib/orb/models/price_update_params.rb +2 -2
  93. data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
  94. data/lib/orb/models/subscription.rb +114 -87
  95. data/lib/orb/models/subscription_cancel_params.rb +3 -3
  96. data/lib/orb/models/subscription_cancel_response.rb +150 -72
  97. data/lib/orb/models/subscription_change_apply_params.rb +33 -0
  98. data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
  99. data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
  100. data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
  101. data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
  102. data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
  103. data/lib/orb/models/subscription_create_params.rb +641 -641
  104. data/lib/orb/models/subscription_create_response.rb +150 -72
  105. data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
  106. data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
  107. data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
  108. data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
  109. data/lib/orb/models/subscription_list_params.rb +5 -5
  110. data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
  111. data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
  112. data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
  113. data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
  114. data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
  115. data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
  116. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
  117. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
  118. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
  119. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
  120. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
  121. data/lib/orb/models/subscription_update_params.rb +10 -10
  122. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  123. data/lib/orb/models/subscription_update_trial_response.rb +152 -72
  124. data/lib/orb/models/trial_discount.rb +1 -1
  125. data/lib/orb/models/usage_discount.rb +2 -2
  126. data/lib/orb/request_options.rb +7 -7
  127. data/lib/orb/resources/alerts.rb +38 -38
  128. data/lib/orb/resources/coupons/subscriptions.rb +3 -3
  129. data/lib/orb/resources/coupons.rb +9 -9
  130. data/lib/orb/resources/credit_notes.rb +8 -8
  131. data/lib/orb/resources/customers/balance_transactions.rb +26 -26
  132. data/lib/orb/resources/customers/costs.rb +232 -232
  133. data/lib/orb/resources/customers/credits/ledger.rb +344 -344
  134. data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
  135. data/lib/orb/resources/customers/credits.rb +8 -8
  136. data/lib/orb/resources/customers.rb +59 -59
  137. data/lib/orb/resources/dimensional_price_groups.rb +6 -6
  138. data/lib/orb/resources/events/backfills.rb +49 -49
  139. data/lib/orb/resources/events/volume.rb +10 -10
  140. data/lib/orb/resources/events.rb +295 -295
  141. data/lib/orb/resources/invoice_line_items.rb +1 -1
  142. data/lib/orb/resources/invoices.rb +38 -38
  143. data/lib/orb/resources/items.rb +1 -1
  144. data/lib/orb/resources/metrics.rb +11 -11
  145. data/lib/orb/resources/plans/external_plan_id.rb +14 -14
  146. data/lib/orb/resources/plans.rb +22 -22
  147. data/lib/orb/resources/prices/external_price_id.rb +4 -4
  148. data/lib/orb/resources/prices.rb +30 -30
  149. data/lib/orb/resources/subscription_changes.rb +87 -0
  150. data/lib/orb/resources/subscriptions.rb +813 -813
  151. data/lib/orb/resources/top_level.rb +4 -4
  152. data/lib/orb/version.rb +1 -1
  153. data/lib/orb.rb +7 -0
  154. data/rbi/lib/orb/client.rbi +5 -4
  155. data/rbi/lib/orb/errors.rbi +3 -6
  156. data/rbi/lib/orb/internal/page.rbi +3 -6
  157. data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
  158. data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +7 -13
  159. data/rbi/lib/orb/internal/type/array_of.rbi +8 -16
  160. data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
  161. data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
  162. data/rbi/lib/orb/internal/type/boolean.rbi +4 -8
  163. data/rbi/lib/orb/internal/type/converter.rbi +25 -31
  164. data/rbi/lib/orb/internal/type/enum.rbi +14 -20
  165. data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
  166. data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
  167. data/rbi/lib/orb/internal/type/union.rbi +10 -20
  168. data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
  169. data/rbi/lib/orb/internal/util.rbi +34 -68
  170. data/rbi/lib/orb/internal.rbi +1 -1
  171. data/rbi/lib/orb/models/alert.rbi +21 -33
  172. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
  173. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
  174. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
  175. data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
  176. data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
  177. data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
  178. data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
  179. data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
  180. data/rbi/lib/orb/models/amount_discount.rbi +4 -7
  181. data/rbi/lib/orb/models/billable_metric.rbi +10 -13
  182. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
  183. data/rbi/lib/orb/models/coupon.rbi +9 -11
  184. data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
  185. data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
  186. data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
  187. data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
  188. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
  189. data/rbi/lib/orb/models/credit_note.rbi +22 -45
  190. data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
  191. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
  192. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
  193. data/rbi/lib/orb/models/customer.rbi +256 -281
  194. data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
  195. data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
  196. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
  197. data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
  198. data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
  199. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
  200. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
  201. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
  202. data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
  203. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
  204. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
  205. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
  206. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
  207. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
  208. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
  209. data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
  210. data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
  211. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
  212. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
  213. data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
  214. data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
  215. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
  216. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
  217. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
  218. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
  219. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
  220. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
  221. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
  222. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
  223. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
  224. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
  225. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
  226. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
  227. data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
  228. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
  229. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
  230. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
  231. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
  232. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
  233. data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
  234. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
  235. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
  236. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
  237. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
  238. data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
  239. data/rbi/lib/orb/models/discount.rbi +1 -2
  240. data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
  241. data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
  242. data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
  243. data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
  244. data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
  245. data/rbi/lib/orb/models/event_search_params.rbi +7 -9
  246. data/rbi/lib/orb/models/event_search_response.rbi +11 -14
  247. data/rbi/lib/orb/models/event_update_params.rbi +5 -6
  248. data/rbi/lib/orb/models/event_update_response.rbi +2 -4
  249. data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
  250. data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
  251. data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
  252. data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
  253. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
  254. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
  255. data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
  256. data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
  257. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
  258. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
  259. data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
  260. data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
  261. data/rbi/lib/orb/models/invoice.rbi +388 -465
  262. data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
  263. data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
  264. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
  265. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
  266. data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
  267. data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
  268. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
  269. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
  270. data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
  271. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
  272. data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
  273. data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
  274. data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
  275. data/rbi/lib/orb/models/item.rbi +7 -12
  276. data/rbi/lib/orb/models/item_create_params.rbi +2 -4
  277. data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
  278. data/rbi/lib/orb/models/item_list_params.rbi +3 -5
  279. data/rbi/lib/orb/models/item_update_params.rbi +5 -10
  280. data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
  281. data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
  282. data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
  283. data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
  284. data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
  285. data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
  286. data/rbi/lib/orb/models/plan.rbi +180 -219
  287. data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
  288. data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
  289. data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
  290. data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
  291. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
  292. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
  293. data/rbi/lib/orb/models/price.rbi +827 -1494
  294. data/rbi/lib/orb/models/price_create_params.rbi +60 -101
  295. data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
  296. data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
  297. data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
  298. data/rbi/lib/orb/models/price_list_params.rbi +3 -5
  299. data/rbi/lib/orb/models/price_update_params.rbi +4 -6
  300. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
  301. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
  302. data/rbi/lib/orb/models/subscription.rbi +167 -187
  303. data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
  304. data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
  305. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
  306. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
  307. data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
  308. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
  309. data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
  310. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
  311. data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
  312. data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
  313. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
  314. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
  315. data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
  316. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
  317. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
  318. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
  319. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
  320. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
  321. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
  322. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
  323. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
  324. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
  325. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
  326. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
  327. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
  328. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
  329. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
  330. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
  331. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
  332. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
  333. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
  334. data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
  335. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
  336. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
  337. data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
  338. data/rbi/lib/orb/models/subscriptions.rbi +2 -4
  339. data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
  340. data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
  341. data/rbi/lib/orb/models/trial_discount.rbi +4 -8
  342. data/rbi/lib/orb/models/usage_discount.rbi +5 -8
  343. data/rbi/lib/orb/request_options.rbi +9 -11
  344. data/rbi/lib/orb/resources/alerts.rbi +44 -60
  345. data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
  346. data/rbi/lib/orb/resources/coupons.rbi +18 -25
  347. data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
  348. data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
  349. data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
  350. data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
  351. data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
  352. data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
  353. data/rbi/lib/orb/resources/customers.rbi +407 -417
  354. data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
  355. data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
  356. data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
  357. data/rbi/lib/orb/resources/events/volume.rbi +19 -22
  358. data/rbi/lib/orb/resources/events.rbi +311 -319
  359. data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
  360. data/rbi/lib/orb/resources/invoices.rbi +62 -76
  361. data/rbi/lib/orb/resources/items.rbi +7 -14
  362. data/rbi/lib/orb/resources/metrics.rbi +17 -25
  363. data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
  364. data/rbi/lib/orb/resources/plans.rbi +63 -71
  365. data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
  366. data/rbi/lib/orb/resources/prices.rbi +77 -87
  367. data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
  368. data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
  369. data/rbi/lib/orb/resources/top_level.rbi +6 -8
  370. data/sig/orb/client.rbs +2 -0
  371. data/sig/orb/models/subscription.rbs +14 -0
  372. data/sig/orb/models/subscription_cancel_response.rbs +47 -2
  373. data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
  374. data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
  375. data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
  376. data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
  377. data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
  378. data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
  379. data/sig/orb/models/subscription_create_response.rbs +47 -2
  380. data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
  381. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
  382. data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
  383. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
  384. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
  385. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
  386. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
  387. data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
  388. data/sig/orb/resources/customers.rbs +2 -2
  389. data/sig/orb/resources/subscription_changes.rbs +24 -0
  390. metadata +23 -2
data/lib/orb/models/customer_update_params.rb CHANGED
@@ -17,15 +17,15 @@ module Orb
17
17
 
18
18
  # @!attribute additional_emails
19
19
  # Additional email addresses for this customer. If populated, these email
20
- # addresses will be CC'd for customer communications.
20
+ # addresses will be CC'd for customer communications.
21
21
  #
22
22
  # @return [Array<String>, nil]
23
23
  optional :additional_emails, Orb::Internal::Type::ArrayOf[String], nil?: true
24
24
 
25
25
  # @!attribute auto_collection
26
26
  # Used to determine if invoices for this customer will automatically attempt to
27
- # charge a saved payment method, if available. This parameter defaults to `True`
28
- # when a payment provider is provided on customer creation.
27
+ # charge a saved payment method, if available. This parameter defaults to `True`
28
+ # when a payment provider is provided on customer creation.
29
29
  #
30
30
  # @return [Boolean, nil]
31
31
  optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
@@ -37,7 +37,7 @@ module Orb
37
37
 
38
38
  # @!attribute currency
39
39
  # An ISO 4217 currency string used for the customer's invoices and balance. If not
40
- # set at creation time, will be set at subscription creation time.
40
+ # set at creation time, will be set at subscription creation time.
41
41
  #
42
42
  # @return [String, nil]
43
43
  optional :currency, String, nil?: true
@@ -55,7 +55,7 @@ module Orb
55
55
 
56
56
  # @!attribute external_customer_id
57
57
  # The external customer ID. This can only be set if empty and the customer has no
58
- # past or current subscriptions.
58
+ # past or current subscriptions.
59
59
  #
60
60
  # @return [String, nil]
61
61
  optional :external_customer_id, String, nil?: true
@@ -68,8 +68,8 @@ module Orb
68
68
 
69
69
  # @!attribute metadata
70
70
  # User-specified key/value pairs for the resource. Individual keys can be removed
71
- # by setting the value to `null`, and the entire metadata mapping can be cleared
72
- # by setting `metadata` to `null`.
71
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
72
+ # by setting `metadata` to `null`.
73
73
  #
74
74
  # @return [Hash{Symbol=>String, nil}, nil]
75
75
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
@@ -82,19 +82,19 @@ module Orb
82
82
 
83
83
  # @!attribute payment_provider
84
84
  # This is used for creating charges or invoices in an external system via Orb.
85
- # When not in test mode:
85
+ # When not in test mode:
86
86
  #
87
- # - the connection must first be configured in the Orb webapp.
88
- # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
89
- # `bill.com`, `netsuite`), any product mappings must first be configured with
90
- # the Orb team.
87
+ # - the connection must first be configured in the Orb webapp.
88
+ # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
89
+ # `bill.com`, `netsuite`), any product mappings must first be configured with
90
+ # the Orb team.
91
91
  #
92
92
  # @return [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil]
93
93
  optional :payment_provider, enum: -> { Orb::Models::CustomerUpdateParams::PaymentProvider }, nil?: true
94
94
 
95
95
  # @!attribute payment_provider_id
96
96
  # The ID of this customer in an external payments solution, such as Stripe. This
97
- # is used for creating charges or invoices in the external system via Orb.
97
+ # is used for creating charges or invoices in the external system via Orb.
98
98
  #
99
99
  # @return [String, nil]
100
100
  optional :payment_provider_id, String, nil?: true
@@ -118,110 +118,110 @@ module Orb
118
118
 
119
119
  # @!attribute tax_id
120
120
  # Tax IDs are commonly required to be displayed on customer invoices, which are
121
- # added to the headers of invoices.
121
+ # added to the headers of invoices.
122
122
  #
123
- # ### Supported Tax ID Countries and Types
123
+ # ### Supported Tax ID Countries and Types
124
124
  #
125
- # | Country | Type | Description |
126
- # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
127
- # | Andorra | `ad_nrt` | Andorran NRT Number |
128
- # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
129
- # | Australia | `au_abn` | Australian Business Number (AU ABN) |
130
- # | Australia | `au_arn` | Australian Taxation Office Reference Number |
131
- # | Austria | `eu_vat` | European VAT Number |
132
- # | Bahrain | `bh_vat` | Bahraini VAT Number |
133
- # | Belgium | `eu_vat` | European VAT Number |
134
- # | Bolivia | `bo_tin` | Bolivian Tax ID |
135
- # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
136
- # | Brazil | `br_cpf` | Brazilian CPF Number |
137
- # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
138
- # | Bulgaria | `eu_vat` | European VAT Number |
139
- # | Canada | `ca_bn` | Canadian BN |
140
- # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
141
- # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
142
- # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
143
- # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
144
- # | Canada | `ca_qst` | Canadian QST Number (Québec) |
145
- # | Chile | `cl_tin` | Chilean TIN |
146
- # | China | `cn_tin` | Chinese Tax ID |
147
- # | Colombia | `co_nit` | Colombian NIT Number |
148
- # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
149
- # | Croatia | `eu_vat` | European VAT Number |
150
- # | Cyprus | `eu_vat` | European VAT Number |
151
- # | Czech Republic | `eu_vat` | European VAT Number |
152
- # | Denmark | `eu_vat` | European VAT Number |
153
- # | Dominican Republic | `do_rcn` | Dominican RCN Number |
154
- # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
155
- # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
156
- # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
157
- # | Estonia | `eu_vat` | European VAT Number |
158
- # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
159
- # | Finland | `eu_vat` | European VAT Number |
160
- # | France | `eu_vat` | European VAT Number |
161
- # | Georgia | `ge_vat` | Georgian VAT |
162
- # | Germany | `eu_vat` | European VAT Number |
163
- # | Greece | `eu_vat` | European VAT Number |
164
- # | Hong Kong | `hk_br` | Hong Kong BR Number |
165
- # | Hungary | `eu_vat` | European VAT Number |
166
- # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
167
- # | Iceland | `is_vat` | Icelandic VAT |
168
- # | India | `in_gst` | Indian GST Number |
169
- # | Indonesia | `id_npwp` | Indonesian NPWP Number |
170
- # | Ireland | `eu_vat` | European VAT Number |
171
- # | Israel | `il_vat` | Israel VAT |
172
- # | Italy | `eu_vat` | European VAT Number |
173
- # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
174
- # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
175
- # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
176
- # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
177
- # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
178
- # | Latvia | `eu_vat` | European VAT Number |
179
- # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
180
- # | Lithuania | `eu_vat` | European VAT Number |
181
- # | Luxembourg | `eu_vat` | European VAT Number |
182
- # | Malaysia | `my_frp` | Malaysian FRP Number |
183
- # | Malaysia | `my_itn` | Malaysian ITN |
184
- # | Malaysia | `my_sst` | Malaysian SST Number |
185
- # | Malta | `eu_vat ` | European VAT Number |
186
- # | Mexico | `mx_rfc` | Mexican RFC Number |
187
- # | Netherlands | `eu_vat` | European VAT Number |
188
- # | New Zealand | `nz_gst` | New Zealand GST Number |
189
- # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
190
- # | Norway | `no_vat` | Norwegian VAT Number |
191
- # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
192
- # | Oman | `om_vat` | Omani VAT Number |
193
- # | Peru | `pe_ruc` | Peruvian RUC Number |
194
- # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
195
- # | Poland | `eu_vat` | European VAT Number |
196
- # | Portugal | `eu_vat` | European VAT Number |
197
- # | Romania | `eu_vat` | European VAT Number |
198
- # | Romania | `ro_tin` | Romanian Tax ID Number |
199
- # | Russia | `ru_inn` | Russian INN |
200
- # | Russia | `ru_kpp` | Russian KPP |
201
- # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
202
- # | Serbia | `rs_pib` | Serbian PIB Number |
203
- # | Singapore | `sg_gst` | Singaporean GST |
204
- # | Singapore | `sg_uen` | Singaporean UEN |
205
- # | Slovakia | `eu_vat` | European VAT Number |
206
- # | Slovenia | `eu_vat` | European VAT Number |
207
- # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
208
- # | South Africa | `za_vat` | South African VAT Number |
209
- # | South Korea | `kr_brn` | Korean BRN |
210
- # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
211
- # | Spain | `eu_vat` | European VAT Number |
212
- # | Sweden | `eu_vat` | European VAT Number |
213
- # | Switzerland | `ch_vat` | Switzerland VAT Number |
214
- # | Taiwan | `tw_vat` | Taiwanese VAT |
215
- # | Thailand | `th_vat` | Thai VAT |
216
- # | Turkey | `tr_tin` | Turkish Tax Identification Number |
217
- # | Ukraine | `ua_vat` | Ukrainian VAT |
218
- # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
219
- # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
220
- # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
221
- # | United States | `us_ein` | United States EIN |
222
- # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
223
- # | Venezuela | `ve_rif` | Venezuelan RIF Number |
224
- # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
125
+ # | Country | Type | Description |
126
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
127
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
128
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
129
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
130
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
131
+ # | Austria | `eu_vat` | European VAT Number |
132
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
133
+ # | Belgium | `eu_vat` | European VAT Number |
134
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
135
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
136
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
137
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
138
+ # | Bulgaria | `eu_vat` | European VAT Number |
139
+ # | Canada | `ca_bn` | Canadian BN |
140
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
141
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
142
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
143
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
144
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
145
+ # | Chile | `cl_tin` | Chilean TIN |
146
+ # | China | `cn_tin` | Chinese Tax ID |
147
+ # | Colombia | `co_nit` | Colombian NIT Number |
148
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
149
+ # | Croatia | `eu_vat` | European VAT Number |
150
+ # | Cyprus | `eu_vat` | European VAT Number |
151
+ # | Czech Republic | `eu_vat` | European VAT Number |
152
+ # | Denmark | `eu_vat` | European VAT Number |
153
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
154
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
155
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
156
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
157
+ # | Estonia | `eu_vat` | European VAT Number |
158
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
159
+ # | Finland | `eu_vat` | European VAT Number |
160
+ # | France | `eu_vat` | European VAT Number |
161
+ # | Georgia | `ge_vat` | Georgian VAT |
162
+ # | Germany | `eu_vat` | European VAT Number |
163
+ # | Greece | `eu_vat` | European VAT Number |
164
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
165
+ # | Hungary | `eu_vat` | European VAT Number |
166
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
167
+ # | Iceland | `is_vat` | Icelandic VAT |
168
+ # | India | `in_gst` | Indian GST Number |
169
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
170
+ # | Ireland | `eu_vat` | European VAT Number |
171
+ # | Israel | `il_vat` | Israel VAT |
172
+ # | Italy | `eu_vat` | European VAT Number |
173
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
174
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
175
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
176
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
177
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
178
+ # | Latvia | `eu_vat` | European VAT Number |
179
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
180
+ # | Lithuania | `eu_vat` | European VAT Number |
181
+ # | Luxembourg | `eu_vat` | European VAT Number |
182
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
183
+ # | Malaysia | `my_itn` | Malaysian ITN |
184
+ # | Malaysia | `my_sst` | Malaysian SST Number |
185
+ # | Malta | `eu_vat ` | European VAT Number |
186
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
187
+ # | Netherlands | `eu_vat` | European VAT Number |
188
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
189
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
190
+ # | Norway | `no_vat` | Norwegian VAT Number |
191
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
192
+ # | Oman | `om_vat` | Omani VAT Number |
193
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
194
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
195
+ # | Poland | `eu_vat` | European VAT Number |
196
+ # | Portugal | `eu_vat` | European VAT Number |
197
+ # | Romania | `eu_vat` | European VAT Number |
198
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
199
+ # | Russia | `ru_inn` | Russian INN |
200
+ # | Russia | `ru_kpp` | Russian KPP |
201
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
202
+ # | Serbia | `rs_pib` | Serbian PIB Number |
203
+ # | Singapore | `sg_gst` | Singaporean GST |
204
+ # | Singapore | `sg_uen` | Singaporean UEN |
205
+ # | Slovakia | `eu_vat` | European VAT Number |
206
+ # | Slovenia | `eu_vat` | European VAT Number |
207
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
208
+ # | South Africa | `za_vat` | South African VAT Number |
209
+ # | South Korea | `kr_brn` | Korean BRN |
210
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
211
+ # | Spain | `eu_vat` | European VAT Number |
212
+ # | Sweden | `eu_vat` | European VAT Number |
213
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
214
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
215
+ # | Thailand | `th_vat` | Thai VAT |
216
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
217
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
218
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
219
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
220
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
221
+ # | United States | `us_ein` | United States EIN |
222
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
223
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
224
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
225
225
  #
226
226
  # @return [Orb::Models::CustomerUpdateParams::TaxID, nil]
227
227
  optional :tax_id, -> { Orb::Models::CustomerUpdateParams::TaxID }, nil?: true
@@ -361,7 +361,7 @@ module Orb
361
361
  class Hierarchy < Orb::Internal::Type::BaseModel
362
362
  # @!attribute [r] child_customer_ids
363
363
  # A list of child customer IDs to add to the hierarchy. The desired child
364
- # customers must not already be part of another hierarchy.
364
+ # customers must not already be part of another hierarchy.
365
365
  #
366
366
  # @return [Array<String>, nil]
367
367
  optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String]
@@ -372,7 +372,7 @@ module Orb
372
372
 
373
373
  # @!attribute parent_customer_id
374
374
  # The ID of the parent customer in the hierarchy. The desired parent customer must
375
- # not be a child of another customer.
375
+ # not be a child of another customer.
376
376
  #
377
377
  # @return [String, nil]
378
378
  optional :parent_customer_id, String, nil?: true
@@ -389,12 +389,12 @@ module Orb
389
389
  end
390
390
 
391
391
  # This is used for creating charges or invoices in an external system via Orb.
392
- # When not in test mode:
392
+ # When not in test mode:
393
393
  #
394
- # - the connection must first be configured in the Orb webapp.
395
- # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
396
- # `bill.com`, `netsuite`), any product mappings must first be configured with
397
- # the Orb team.
394
+ # - the connection must first be configured in the Orb webapp.
395
+ # - if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`,
396
+ # `bill.com`, `netsuite`), any product mappings must first be configured with
397
+ # the Orb team.
398
398
  module PaymentProvider
399
399
  extend Orb::Internal::Type::Enum
400
400
 
@@ -547,110 +547,110 @@ module Orb
547
547
 
548
548
  # @!parse
549
549
  # # Tax IDs are commonly required to be displayed on customer invoices, which are
550
- # # added to the headers of invoices.
550
+ # # added to the headers of invoices.
551
551
  # #
552
- # # ### Supported Tax ID Countries and Types
552
+ # # ### Supported Tax ID Countries and Types
553
553
  # #
554
- # # | Country | Type | Description |
555
- # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
556
- # # | Andorra | `ad_nrt` | Andorran NRT Number |
557
- # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
558
- # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
559
- # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
560
- # # | Austria | `eu_vat` | European VAT Number |
561
- # # | Bahrain | `bh_vat` | Bahraini VAT Number |
562
- # # | Belgium | `eu_vat` | European VAT Number |
563
- # # | Bolivia | `bo_tin` | Bolivian Tax ID |
564
- # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
565
- # # | Brazil | `br_cpf` | Brazilian CPF Number |
566
- # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
567
- # # | Bulgaria | `eu_vat` | European VAT Number |
568
- # # | Canada | `ca_bn` | Canadian BN |
569
- # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
570
- # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
571
- # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
572
- # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
573
- # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
574
- # # | Chile | `cl_tin` | Chilean TIN |
575
- # # | China | `cn_tin` | Chinese Tax ID |
576
- # # | Colombia | `co_nit` | Colombian NIT Number |
577
- # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
578
- # # | Croatia | `eu_vat` | European VAT Number |
579
- # # | Cyprus | `eu_vat` | European VAT Number |
580
- # # | Czech Republic | `eu_vat` | European VAT Number |
581
- # # | Denmark | `eu_vat` | European VAT Number |
582
- # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
583
- # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
584
- # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
585
- # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
586
- # # | Estonia | `eu_vat` | European VAT Number |
587
- # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
588
- # # | Finland | `eu_vat` | European VAT Number |
589
- # # | France | `eu_vat` | European VAT Number |
590
- # # | Georgia | `ge_vat` | Georgian VAT |
591
- # # | Germany | `eu_vat` | European VAT Number |
592
- # # | Greece | `eu_vat` | European VAT Number |
593
- # # | Hong Kong | `hk_br` | Hong Kong BR Number |
594
- # # | Hungary | `eu_vat` | European VAT Number |
595
- # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
596
- # # | Iceland | `is_vat` | Icelandic VAT |
597
- # # | India | `in_gst` | Indian GST Number |
598
- # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
599
- # # | Ireland | `eu_vat` | European VAT Number |
600
- # # | Israel | `il_vat` | Israel VAT |
601
- # # | Italy | `eu_vat` | European VAT Number |
602
- # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
603
- # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
604
- # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
605
- # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
606
- # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
607
- # # | Latvia | `eu_vat` | European VAT Number |
608
- # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
609
- # # | Lithuania | `eu_vat` | European VAT Number |
610
- # # | Luxembourg | `eu_vat` | European VAT Number |
611
- # # | Malaysia | `my_frp` | Malaysian FRP Number |
612
- # # | Malaysia | `my_itn` | Malaysian ITN |
613
- # # | Malaysia | `my_sst` | Malaysian SST Number |
614
- # # | Malta | `eu_vat ` | European VAT Number |
615
- # # | Mexico | `mx_rfc` | Mexican RFC Number |
616
- # # | Netherlands | `eu_vat` | European VAT Number |
617
- # # | New Zealand | `nz_gst` | New Zealand GST Number |
618
- # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
619
- # # | Norway | `no_vat` | Norwegian VAT Number |
620
- # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
621
- # # | Oman | `om_vat` | Omani VAT Number |
622
- # # | Peru | `pe_ruc` | Peruvian RUC Number |
623
- # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
624
- # # | Poland | `eu_vat` | European VAT Number |
625
- # # | Portugal | `eu_vat` | European VAT Number |
626
- # # | Romania | `eu_vat` | European VAT Number |
627
- # # | Romania | `ro_tin` | Romanian Tax ID Number |
628
- # # | Russia | `ru_inn` | Russian INN |
629
- # # | Russia | `ru_kpp` | Russian KPP |
630
- # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
631
- # # | Serbia | `rs_pib` | Serbian PIB Number |
632
- # # | Singapore | `sg_gst` | Singaporean GST |
633
- # # | Singapore | `sg_uen` | Singaporean UEN |
634
- # # | Slovakia | `eu_vat` | European VAT Number |
635
- # # | Slovenia | `eu_vat` | European VAT Number |
636
- # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
637
- # # | South Africa | `za_vat` | South African VAT Number |
638
- # # | South Korea | `kr_brn` | Korean BRN |
639
- # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
640
- # # | Spain | `eu_vat` | European VAT Number |
641
- # # | Sweden | `eu_vat` | European VAT Number |
642
- # # | Switzerland | `ch_vat` | Switzerland VAT Number |
643
- # # | Taiwan | `tw_vat` | Taiwanese VAT |
644
- # # | Thailand | `th_vat` | Thai VAT |
645
- # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
646
- # # | Ukraine | `ua_vat` | Ukrainian VAT |
647
- # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
648
- # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
649
- # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
650
- # # | United States | `us_ein` | United States EIN |
651
- # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
652
- # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
653
- # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
554
+ # # | Country | Type | Description |
555
+ # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
556
+ # # | Andorra | `ad_nrt` | Andorran NRT Number |
557
+ # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
558
+ # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
559
+ # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
560
+ # # | Austria | `eu_vat` | European VAT Number |
561
+ # # | Bahrain | `bh_vat` | Bahraini VAT Number |
562
+ # # | Belgium | `eu_vat` | European VAT Number |
563
+ # # | Bolivia | `bo_tin` | Bolivian Tax ID |
564
+ # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
565
+ # # | Brazil | `br_cpf` | Brazilian CPF Number |
566
+ # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
567
+ # # | Bulgaria | `eu_vat` | European VAT Number |
568
+ # # | Canada | `ca_bn` | Canadian BN |
569
+ # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
570
+ # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
571
+ # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
572
+ # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
573
+ # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
574
+ # # | Chile | `cl_tin` | Chilean TIN |
575
+ # # | China | `cn_tin` | Chinese Tax ID |
576
+ # # | Colombia | `co_nit` | Colombian NIT Number |
577
+ # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
578
+ # # | Croatia | `eu_vat` | European VAT Number |
579
+ # # | Cyprus | `eu_vat` | European VAT Number |
580
+ # # | Czech Republic | `eu_vat` | European VAT Number |
581
+ # # | Denmark | `eu_vat` | European VAT Number |
582
+ # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
583
+ # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
584
+ # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
585
+ # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
586
+ # # | Estonia | `eu_vat` | European VAT Number |
587
+ # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
588
+ # # | Finland | `eu_vat` | European VAT Number |
589
+ # # | France | `eu_vat` | European VAT Number |
590
+ # # | Georgia | `ge_vat` | Georgian VAT |
591
+ # # | Germany | `eu_vat` | European VAT Number |
592
+ # # | Greece | `eu_vat` | European VAT Number |
593
+ # # | Hong Kong | `hk_br` | Hong Kong BR Number |
594
+ # # | Hungary | `eu_vat` | European VAT Number |
595
+ # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
596
+ # # | Iceland | `is_vat` | Icelandic VAT |
597
+ # # | India | `in_gst` | Indian GST Number |
598
+ # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
599
+ # # | Ireland | `eu_vat` | European VAT Number |
600
+ # # | Israel | `il_vat` | Israel VAT |
601
+ # # | Italy | `eu_vat` | European VAT Number |
602
+ # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
603
+ # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
604
+ # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
605
+ # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
606
+ # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
607
+ # # | Latvia | `eu_vat` | European VAT Number |
608
+ # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
609
+ # # | Lithuania | `eu_vat` | European VAT Number |
610
+ # # | Luxembourg | `eu_vat` | European VAT Number |
611
+ # # | Malaysia | `my_frp` | Malaysian FRP Number |
612
+ # # | Malaysia | `my_itn` | Malaysian ITN |
613
+ # # | Malaysia | `my_sst` | Malaysian SST Number |
614
+ # # | Malta | `eu_vat ` | European VAT Number |
615
+ # # | Mexico | `mx_rfc` | Mexican RFC Number |
616
+ # # | Netherlands | `eu_vat` | European VAT Number |
617
+ # # | New Zealand | `nz_gst` | New Zealand GST Number |
618
+ # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
619
+ # # | Norway | `no_vat` | Norwegian VAT Number |
620
+ # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
621
+ # # | Oman | `om_vat` | Omani VAT Number |
622
+ # # | Peru | `pe_ruc` | Peruvian RUC Number |
623
+ # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
624
+ # # | Poland | `eu_vat` | European VAT Number |
625
+ # # | Portugal | `eu_vat` | European VAT Number |
626
+ # # | Romania | `eu_vat` | European VAT Number |
627
+ # # | Romania | `ro_tin` | Romanian Tax ID Number |
628
+ # # | Russia | `ru_inn` | Russian INN |
629
+ # # | Russia | `ru_kpp` | Russian KPP |
630
+ # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
631
+ # # | Serbia | `rs_pib` | Serbian PIB Number |
632
+ # # | Singapore | `sg_gst` | Singaporean GST |
633
+ # # | Singapore | `sg_uen` | Singaporean UEN |
634
+ # # | Slovakia | `eu_vat` | European VAT Number |
635
+ # # | Slovenia | `eu_vat` | European VAT Number |
636
+ # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
637
+ # # | South Africa | `za_vat` | South African VAT Number |
638
+ # # | South Korea | `kr_brn` | Korean BRN |
639
+ # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
640
+ # # | Spain | `eu_vat` | European VAT Number |
641
+ # # | Sweden | `eu_vat` | European VAT Number |
642
+ # # | Switzerland | `ch_vat` | Switzerland VAT Number |
643
+ # # | Taiwan | `tw_vat` | Taiwanese VAT |
644
+ # # | Thailand | `th_vat` | Thai VAT |
645
+ # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
646
+ # # | Ukraine | `ua_vat` | Ukrainian VAT |
647
+ # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
648
+ # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
649
+ # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
650
+ # # | United States | `us_ein` | United States EIN |
651
+ # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
652
+ # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
653
+ # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
654
654
  # #
655
655
  # # @param country [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country]
656
656
  # # @param type [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type]