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_create_params.rb CHANGED
@@ -10,8 +10,8 @@ module Orb
10
10
 
11
11
  # @!attribute email
12
12
  # A valid customer email, to be used for notifications. When Orb triggers payment
13
- # through a payment gateway, this email will be used for any automatically issued
14
- # receipts.
13
+ # through a payment gateway, this email will be used for any automatically issued
14
+ # receipts.
15
15
  #
16
16
  # @return [String]
17
17
  required :email, String
@@ -31,15 +31,15 @@ module Orb
31
31
 
32
32
  # @!attribute additional_emails
33
33
  # Additional email addresses for this customer. If populated, these email
34
- # addresses will be CC'd for customer communications.
34
+ # addresses will be CC'd for customer communications.
35
35
  #
36
36
  # @return [Array<String>, nil]
37
37
  optional :additional_emails, Orb::Internal::Type::ArrayOf[String], nil?: true
38
38
 
39
39
  # @!attribute auto_collection
40
40
  # Used to determine if invoices for this customer will automatically attempt to
41
- # charge a saved payment method, if available. This parameter defaults to `True`
42
- # when a payment provider is provided on customer creation.
41
+ # charge a saved payment method, if available. This parameter defaults to `True`
42
+ # when a payment provider is provided on customer creation.
43
43
  #
44
44
  # @return [Boolean, nil]
45
45
  optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
@@ -51,7 +51,7 @@ module Orb
51
51
 
52
52
  # @!attribute currency
53
53
  # An ISO 4217 currency string used for the customer's invoices and balance. If not
54
- # set at creation time, will be set at subscription creation time.
54
+ # set at creation time, will be set at subscription creation time.
55
55
  #
56
56
  # @return [String, nil]
57
57
  optional :currency, String, nil?: true
@@ -63,8 +63,8 @@ module Orb
63
63
 
64
64
  # @!attribute external_customer_id
65
65
  # An optional user-defined ID for this customer resource, used throughout the
66
- # system as an alias for this Customer. Use this field to identify a customer by
67
- # an existing identifier in your system.
66
+ # system as an alias for this Customer. Use this field to identify a customer by
67
+ # an existing identifier in your system.
68
68
  #
69
69
  # @return [String, nil]
70
70
  optional :external_customer_id, String, nil?: true
@@ -77,23 +77,23 @@ module Orb
77
77
 
78
78
  # @!attribute metadata
79
79
  # User-specified key/value pairs for the resource. Individual keys can be removed
80
- # by setting the value to `null`, and the entire metadata mapping can be cleared
81
- # by setting `metadata` to `null`.
80
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
81
+ # by setting `metadata` to `null`.
82
82
  #
83
83
  # @return [Hash{Symbol=>String, nil}, nil]
84
84
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
85
85
 
86
86
  # @!attribute payment_provider
87
87
  # This is used for creating charges or invoices in an external system via Orb.
88
- # When not in test mode, the connection must first be configured in the Orb
89
- # webapp.
88
+ # When not in test mode, the connection must first be configured in the Orb
89
+ # webapp.
90
90
  #
91
91
  # @return [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil]
92
92
  optional :payment_provider, enum: -> { Orb::Models::CustomerCreateParams::PaymentProvider }, nil?: true
93
93
 
94
94
  # @!attribute payment_provider_id
95
95
  # The ID of this customer in an external payments solution, such as Stripe. This
96
- # is used for creating charges or invoices in the external system via Orb.
96
+ # is used for creating charges or invoices in the external system via Orb.
97
97
  #
98
98
  # @return [String, nil]
99
99
  optional :payment_provider_id, String, nil?: true
@@ -117,118 +117,118 @@ module Orb
117
117
 
118
118
  # @!attribute tax_id
119
119
  # Tax IDs are commonly required to be displayed on customer invoices, which are
120
- # added to the headers of invoices.
120
+ # added to the headers of invoices.
121
121
  #
122
- # ### Supported Tax ID Countries and Types
122
+ # ### Supported Tax ID Countries and Types
123
123
  #
124
- # | Country | Type | Description |
125
- # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
126
- # | Andorra | `ad_nrt` | Andorran NRT Number |
127
- # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
128
- # | Australia | `au_abn` | Australian Business Number (AU ABN) |
129
- # | Australia | `au_arn` | Australian Taxation Office Reference Number |
130
- # | Austria | `eu_vat` | European VAT Number |
131
- # | Bahrain | `bh_vat` | Bahraini VAT Number |
132
- # | Belgium | `eu_vat` | European VAT Number |
133
- # | Bolivia | `bo_tin` | Bolivian Tax ID |
134
- # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
135
- # | Brazil | `br_cpf` | Brazilian CPF Number |
136
- # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
137
- # | Bulgaria | `eu_vat` | European VAT Number |
138
- # | Canada | `ca_bn` | Canadian BN |
139
- # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
140
- # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
141
- # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
142
- # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
143
- # | Canada | `ca_qst` | Canadian QST Number (Québec) |
144
- # | Chile | `cl_tin` | Chilean TIN |
145
- # | China | `cn_tin` | Chinese Tax ID |
146
- # | Colombia | `co_nit` | Colombian NIT Number |
147
- # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
148
- # | Croatia | `eu_vat` | European VAT Number |
149
- # | Cyprus | `eu_vat` | European VAT Number |
150
- # | Czech Republic | `eu_vat` | European VAT Number |
151
- # | Denmark | `eu_vat` | European VAT Number |
152
- # | Dominican Republic | `do_rcn` | Dominican RCN Number |
153
- # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
154
- # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
155
- # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
156
- # | Estonia | `eu_vat` | European VAT Number |
157
- # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
158
- # | Finland | `eu_vat` | European VAT Number |
159
- # | France | `eu_vat` | European VAT Number |
160
- # | Georgia | `ge_vat` | Georgian VAT |
161
- # | Germany | `eu_vat` | European VAT Number |
162
- # | Greece | `eu_vat` | European VAT Number |
163
- # | Hong Kong | `hk_br` | Hong Kong BR Number |
164
- # | Hungary | `eu_vat` | European VAT Number |
165
- # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
166
- # | Iceland | `is_vat` | Icelandic VAT |
167
- # | India | `in_gst` | Indian GST Number |
168
- # | Indonesia | `id_npwp` | Indonesian NPWP Number |
169
- # | Ireland | `eu_vat` | European VAT Number |
170
- # | Israel | `il_vat` | Israel VAT |
171
- # | Italy | `eu_vat` | European VAT Number |
172
- # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
173
- # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
174
- # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
175
- # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
176
- # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
177
- # | Latvia | `eu_vat` | European VAT Number |
178
- # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
179
- # | Lithuania | `eu_vat` | European VAT Number |
180
- # | Luxembourg | `eu_vat` | European VAT Number |
181
- # | Malaysia | `my_frp` | Malaysian FRP Number |
182
- # | Malaysia | `my_itn` | Malaysian ITN |
183
- # | Malaysia | `my_sst` | Malaysian SST Number |
184
- # | Malta | `eu_vat ` | European VAT Number |
185
- # | Mexico | `mx_rfc` | Mexican RFC Number |
186
- # | Netherlands | `eu_vat` | European VAT Number |
187
- # | New Zealand | `nz_gst` | New Zealand GST Number |
188
- # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
189
- # | Norway | `no_vat` | Norwegian VAT Number |
190
- # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
191
- # | Oman | `om_vat` | Omani VAT Number |
192
- # | Peru | `pe_ruc` | Peruvian RUC Number |
193
- # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
194
- # | Poland | `eu_vat` | European VAT Number |
195
- # | Portugal | `eu_vat` | European VAT Number |
196
- # | Romania | `eu_vat` | European VAT Number |
197
- # | Romania | `ro_tin` | Romanian Tax ID Number |
198
- # | Russia | `ru_inn` | Russian INN |
199
- # | Russia | `ru_kpp` | Russian KPP |
200
- # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
201
- # | Serbia | `rs_pib` | Serbian PIB Number |
202
- # | Singapore | `sg_gst` | Singaporean GST |
203
- # | Singapore | `sg_uen` | Singaporean UEN |
204
- # | Slovakia | `eu_vat` | European VAT Number |
205
- # | Slovenia | `eu_vat` | European VAT Number |
206
- # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
207
- # | South Africa | `za_vat` | South African VAT Number |
208
- # | South Korea | `kr_brn` | Korean BRN |
209
- # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
210
- # | Spain | `eu_vat` | European VAT Number |
211
- # | Sweden | `eu_vat` | European VAT Number |
212
- # | Switzerland | `ch_vat` | Switzerland VAT Number |
213
- # | Taiwan | `tw_vat` | Taiwanese VAT |
214
- # | Thailand | `th_vat` | Thai VAT |
215
- # | Turkey | `tr_tin` | Turkish Tax Identification Number |
216
- # | Ukraine | `ua_vat` | Ukrainian VAT |
217
- # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
218
- # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
219
- # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
220
- # | United States | `us_ein` | United States EIN |
221
- # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
222
- # | Venezuela | `ve_rif` | Venezuelan RIF Number |
223
- # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
124
+ # | Country | Type | Description |
125
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
126
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
127
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
128
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
129
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
130
+ # | Austria | `eu_vat` | European VAT Number |
131
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
132
+ # | Belgium | `eu_vat` | European VAT Number |
133
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
134
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
135
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
136
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
137
+ # | Bulgaria | `eu_vat` | European VAT Number |
138
+ # | Canada | `ca_bn` | Canadian BN |
139
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
140
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
141
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
142
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
143
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
144
+ # | Chile | `cl_tin` | Chilean TIN |
145
+ # | China | `cn_tin` | Chinese Tax ID |
146
+ # | Colombia | `co_nit` | Colombian NIT Number |
147
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
148
+ # | Croatia | `eu_vat` | European VAT Number |
149
+ # | Cyprus | `eu_vat` | European VAT Number |
150
+ # | Czech Republic | `eu_vat` | European VAT Number |
151
+ # | Denmark | `eu_vat` | European VAT Number |
152
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
153
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
154
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
155
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
156
+ # | Estonia | `eu_vat` | European VAT Number |
157
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
158
+ # | Finland | `eu_vat` | European VAT Number |
159
+ # | France | `eu_vat` | European VAT Number |
160
+ # | Georgia | `ge_vat` | Georgian VAT |
161
+ # | Germany | `eu_vat` | European VAT Number |
162
+ # | Greece | `eu_vat` | European VAT Number |
163
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
164
+ # | Hungary | `eu_vat` | European VAT Number |
165
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
166
+ # | Iceland | `is_vat` | Icelandic VAT |
167
+ # | India | `in_gst` | Indian GST Number |
168
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
169
+ # | Ireland | `eu_vat` | European VAT Number |
170
+ # | Israel | `il_vat` | Israel VAT |
171
+ # | Italy | `eu_vat` | European VAT Number |
172
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
173
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
174
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
175
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
176
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
177
+ # | Latvia | `eu_vat` | European VAT Number |
178
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
179
+ # | Lithuania | `eu_vat` | European VAT Number |
180
+ # | Luxembourg | `eu_vat` | European VAT Number |
181
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
182
+ # | Malaysia | `my_itn` | Malaysian ITN |
183
+ # | Malaysia | `my_sst` | Malaysian SST Number |
184
+ # | Malta | `eu_vat ` | European VAT Number |
185
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
186
+ # | Netherlands | `eu_vat` | European VAT Number |
187
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
188
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
189
+ # | Norway | `no_vat` | Norwegian VAT Number |
190
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
191
+ # | Oman | `om_vat` | Omani VAT Number |
192
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
193
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
194
+ # | Poland | `eu_vat` | European VAT Number |
195
+ # | Portugal | `eu_vat` | European VAT Number |
196
+ # | Romania | `eu_vat` | European VAT Number |
197
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
198
+ # | Russia | `ru_inn` | Russian INN |
199
+ # | Russia | `ru_kpp` | Russian KPP |
200
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
201
+ # | Serbia | `rs_pib` | Serbian PIB Number |
202
+ # | Singapore | `sg_gst` | Singaporean GST |
203
+ # | Singapore | `sg_uen` | Singaporean UEN |
204
+ # | Slovakia | `eu_vat` | European VAT Number |
205
+ # | Slovenia | `eu_vat` | European VAT Number |
206
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
207
+ # | South Africa | `za_vat` | South African VAT Number |
208
+ # | South Korea | `kr_brn` | Korean BRN |
209
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
210
+ # | Spain | `eu_vat` | European VAT Number |
211
+ # | Sweden | `eu_vat` | European VAT Number |
212
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
213
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
214
+ # | Thailand | `th_vat` | Thai VAT |
215
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
216
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
217
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
218
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
219
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
220
+ # | United States | `us_ein` | United States EIN |
221
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
222
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
223
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
224
224
  #
225
225
  # @return [Orb::Models::CustomerCreateParams::TaxID, nil]
226
226
  optional :tax_id, -> { Orb::Models::CustomerCreateParams::TaxID }, nil?: true
227
227
 
228
228
  # @!attribute timezone
229
229
  # A timezone identifier from the IANA timezone database, such as
230
- # `"America/Los_Angeles"`. This defaults to your account's timezone if not set.
231
- # This cannot be changed after customer creation.
230
+ # `"America/Los_Angeles"`. This defaults to your account's timezone if not set.
231
+ # This cannot be changed after customer creation.
232
232
  #
233
233
  # @return [String, nil]
234
234
  optional :timezone, String, nil?: true
@@ -370,7 +370,7 @@ module Orb
370
370
  class Hierarchy < Orb::Internal::Type::BaseModel
371
371
  # @!attribute [r] child_customer_ids
372
372
  # A list of child customer IDs to add to the hierarchy. The desired child
373
- # customers must not already be part of another hierarchy.
373
+ # customers must not already be part of another hierarchy.
374
374
  #
375
375
  # @return [Array<String>, nil]
376
376
  optional :child_customer_ids, Orb::Internal::Type::ArrayOf[String]
@@ -381,7 +381,7 @@ module Orb
381
381
 
382
382
  # @!attribute parent_customer_id
383
383
  # The ID of the parent customer in the hierarchy. The desired parent customer must
384
- # not be a child of another customer.
384
+ # not be a child of another customer.
385
385
  #
386
386
  # @return [String, nil]
387
387
  optional :parent_customer_id, String, nil?: true
@@ -398,8 +398,8 @@ module Orb
398
398
  end
399
399
 
400
400
  # This is used for creating charges or invoices in an external system via Orb.
401
- # When not in test mode, the connection must first be configured in the Orb
402
- # webapp.
401
+ # When not in test mode, the connection must first be configured in the Orb
402
+ # webapp.
403
403
  module PaymentProvider
404
404
  extend Orb::Internal::Type::Enum
405
405
 
@@ -552,110 +552,110 @@ module Orb
552
552
 
553
553
  # @!parse
554
554
  # # Tax IDs are commonly required to be displayed on customer invoices, which are
555
- # # added to the headers of invoices.
555
+ # # added to the headers of invoices.
556
556
  # #
557
- # # ### Supported Tax ID Countries and Types
557
+ # # ### Supported Tax ID Countries and Types
558
558
  # #
559
- # # | Country | Type | Description |
560
- # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
561
- # # | Andorra | `ad_nrt` | Andorran NRT Number |
562
- # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
563
- # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
564
- # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
565
- # # | Austria | `eu_vat` | European VAT Number |
566
- # # | Bahrain | `bh_vat` | Bahraini VAT Number |
567
- # # | Belgium | `eu_vat` | European VAT Number |
568
- # # | Bolivia | `bo_tin` | Bolivian Tax ID |
569
- # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
570
- # # | Brazil | `br_cpf` | Brazilian CPF Number |
571
- # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
572
- # # | Bulgaria | `eu_vat` | European VAT Number |
573
- # # | Canada | `ca_bn` | Canadian BN |
574
- # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
575
- # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
576
- # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
577
- # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
578
- # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
579
- # # | Chile | `cl_tin` | Chilean TIN |
580
- # # | China | `cn_tin` | Chinese Tax ID |
581
- # # | Colombia | `co_nit` | Colombian NIT Number |
582
- # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
583
- # # | Croatia | `eu_vat` | European VAT Number |
584
- # # | Cyprus | `eu_vat` | European VAT Number |
585
- # # | Czech Republic | `eu_vat` | European VAT Number |
586
- # # | Denmark | `eu_vat` | European VAT Number |
587
- # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
588
- # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
589
- # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
590
- # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
591
- # # | Estonia | `eu_vat` | European VAT Number |
592
- # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
593
- # # | Finland | `eu_vat` | European VAT Number |
594
- # # | France | `eu_vat` | European VAT Number |
595
- # # | Georgia | `ge_vat` | Georgian VAT |
596
- # # | Germany | `eu_vat` | European VAT Number |
597
- # # | Greece | `eu_vat` | European VAT Number |
598
- # # | Hong Kong | `hk_br` | Hong Kong BR Number |
599
- # # | Hungary | `eu_vat` | European VAT Number |
600
- # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
601
- # # | Iceland | `is_vat` | Icelandic VAT |
602
- # # | India | `in_gst` | Indian GST Number |
603
- # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
604
- # # | Ireland | `eu_vat` | European VAT Number |
605
- # # | Israel | `il_vat` | Israel VAT |
606
- # # | Italy | `eu_vat` | European VAT Number |
607
- # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
608
- # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
609
- # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
610
- # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
611
- # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
612
- # # | Latvia | `eu_vat` | European VAT Number |
613
- # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
614
- # # | Lithuania | `eu_vat` | European VAT Number |
615
- # # | Luxembourg | `eu_vat` | European VAT Number |
616
- # # | Malaysia | `my_frp` | Malaysian FRP Number |
617
- # # | Malaysia | `my_itn` | Malaysian ITN |
618
- # # | Malaysia | `my_sst` | Malaysian SST Number |
619
- # # | Malta | `eu_vat ` | European VAT Number |
620
- # # | Mexico | `mx_rfc` | Mexican RFC Number |
621
- # # | Netherlands | `eu_vat` | European VAT Number |
622
- # # | New Zealand | `nz_gst` | New Zealand GST Number |
623
- # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
624
- # # | Norway | `no_vat` | Norwegian VAT Number |
625
- # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
626
- # # | Oman | `om_vat` | Omani VAT Number |
627
- # # | Peru | `pe_ruc` | Peruvian RUC Number |
628
- # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
629
- # # | Poland | `eu_vat` | European VAT Number |
630
- # # | Portugal | `eu_vat` | European VAT Number |
631
- # # | Romania | `eu_vat` | European VAT Number |
632
- # # | Romania | `ro_tin` | Romanian Tax ID Number |
633
- # # | Russia | `ru_inn` | Russian INN |
634
- # # | Russia | `ru_kpp` | Russian KPP |
635
- # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
636
- # # | Serbia | `rs_pib` | Serbian PIB Number |
637
- # # | Singapore | `sg_gst` | Singaporean GST |
638
- # # | Singapore | `sg_uen` | Singaporean UEN |
639
- # # | Slovakia | `eu_vat` | European VAT Number |
640
- # # | Slovenia | `eu_vat` | European VAT Number |
641
- # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
642
- # # | South Africa | `za_vat` | South African VAT Number |
643
- # # | South Korea | `kr_brn` | Korean BRN |
644
- # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
645
- # # | Spain | `eu_vat` | European VAT Number |
646
- # # | Sweden | `eu_vat` | European VAT Number |
647
- # # | Switzerland | `ch_vat` | Switzerland VAT Number |
648
- # # | Taiwan | `tw_vat` | Taiwanese VAT |
649
- # # | Thailand | `th_vat` | Thai VAT |
650
- # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
651
- # # | Ukraine | `ua_vat` | Ukrainian VAT |
652
- # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
653
- # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
654
- # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
655
- # # | United States | `us_ein` | United States EIN |
656
- # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
657
- # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
658
- # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
559
+ # # | Country | Type | Description |
560
+ # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
561
+ # # | Andorra | `ad_nrt` | Andorran NRT Number |
562
+ # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
563
+ # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
564
+ # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
565
+ # # | Austria | `eu_vat` | European VAT Number |
566
+ # # | Bahrain | `bh_vat` | Bahraini VAT Number |
567
+ # # | Belgium | `eu_vat` | European VAT Number |
568
+ # # | Bolivia | `bo_tin` | Bolivian Tax ID |
569
+ # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
570
+ # # | Brazil | `br_cpf` | Brazilian CPF Number |
571
+ # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
572
+ # # | Bulgaria | `eu_vat` | European VAT Number |
573
+ # # | Canada | `ca_bn` | Canadian BN |
574
+ # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
575
+ # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
576
+ # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
577
+ # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
578
+ # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
579
+ # # | Chile | `cl_tin` | Chilean TIN |
580
+ # # | China | `cn_tin` | Chinese Tax ID |
581
+ # # | Colombia | `co_nit` | Colombian NIT Number |
582
+ # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
583
+ # # | Croatia | `eu_vat` | European VAT Number |
584
+ # # | Cyprus | `eu_vat` | European VAT Number |
585
+ # # | Czech Republic | `eu_vat` | European VAT Number |
586
+ # # | Denmark | `eu_vat` | European VAT Number |
587
+ # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
588
+ # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
589
+ # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
590
+ # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
591
+ # # | Estonia | `eu_vat` | European VAT Number |
592
+ # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
593
+ # # | Finland | `eu_vat` | European VAT Number |
594
+ # # | France | `eu_vat` | European VAT Number |
595
+ # # | Georgia | `ge_vat` | Georgian VAT |
596
+ # # | Germany | `eu_vat` | European VAT Number |
597
+ # # | Greece | `eu_vat` | European VAT Number |
598
+ # # | Hong Kong | `hk_br` | Hong Kong BR Number |
599
+ # # | Hungary | `eu_vat` | European VAT Number |
600
+ # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
601
+ # # | Iceland | `is_vat` | Icelandic VAT |
602
+ # # | India | `in_gst` | Indian GST Number |
603
+ # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
604
+ # # | Ireland | `eu_vat` | European VAT Number |
605
+ # # | Israel | `il_vat` | Israel VAT |
606
+ # # | Italy | `eu_vat` | European VAT Number |
607
+ # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
608
+ # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
609
+ # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
610
+ # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
611
+ # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
612
+ # # | Latvia | `eu_vat` | European VAT Number |
613
+ # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
614
+ # # | Lithuania | `eu_vat` | European VAT Number |
615
+ # # | Luxembourg | `eu_vat` | European VAT Number |
616
+ # # | Malaysia | `my_frp` | Malaysian FRP Number |
617
+ # # | Malaysia | `my_itn` | Malaysian ITN |
618
+ # # | Malaysia | `my_sst` | Malaysian SST Number |
619
+ # # | Malta | `eu_vat ` | European VAT Number |
620
+ # # | Mexico | `mx_rfc` | Mexican RFC Number |
621
+ # # | Netherlands | `eu_vat` | European VAT Number |
622
+ # # | New Zealand | `nz_gst` | New Zealand GST Number |
623
+ # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
624
+ # # | Norway | `no_vat` | Norwegian VAT Number |
625
+ # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
626
+ # # | Oman | `om_vat` | Omani VAT Number |
627
+ # # | Peru | `pe_ruc` | Peruvian RUC Number |
628
+ # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
629
+ # # | Poland | `eu_vat` | European VAT Number |
630
+ # # | Portugal | `eu_vat` | European VAT Number |
631
+ # # | Romania | `eu_vat` | European VAT Number |
632
+ # # | Romania | `ro_tin` | Romanian Tax ID Number |
633
+ # # | Russia | `ru_inn` | Russian INN |
634
+ # # | Russia | `ru_kpp` | Russian KPP |
635
+ # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
636
+ # # | Serbia | `rs_pib` | Serbian PIB Number |
637
+ # # | Singapore | `sg_gst` | Singaporean GST |
638
+ # # | Singapore | `sg_uen` | Singaporean UEN |
639
+ # # | Slovakia | `eu_vat` | European VAT Number |
640
+ # # | Slovenia | `eu_vat` | European VAT Number |
641
+ # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
642
+ # # | South Africa | `za_vat` | South African VAT Number |
643
+ # # | South Korea | `kr_brn` | Korean BRN |
644
+ # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
645
+ # # | Spain | `eu_vat` | European VAT Number |
646
+ # # | Sweden | `eu_vat` | European VAT Number |
647
+ # # | Switzerland | `ch_vat` | Switzerland VAT Number |
648
+ # # | Taiwan | `tw_vat` | Taiwanese VAT |
649
+ # # | Thailand | `th_vat` | Thai VAT |
650
+ # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
651
+ # # | Ukraine | `ua_vat` | Ukrainian VAT |
652
+ # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
653
+ # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
654
+ # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
655
+ # # | United States | `us_ein` | United States EIN |
656
+ # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
657
+ # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
658
+ # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
659
659
  # #
660
660
  # # @param country [Symbol, Orb::Models::CustomerCreateParams::TaxID::Country]
661
661
  # # @param type [Symbol, Orb::Models::CustomerCreateParams::TaxID::Type]