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.rb CHANGED
@@ -42,8 +42,8 @@ module Orb
42
42
 
43
43
  # @!attribute email
44
44
  # A valid customer email, to be used for notifications. When Orb triggers payment
45
- # through a payment gateway, this email will be used for any automatically issued
46
- # receipts.
45
+ # through a payment gateway, this email will be used for any automatically issued
46
+ # receipts.
47
47
  #
48
48
  # @return [String]
49
49
  required :email, String
@@ -60,8 +60,8 @@ module Orb
60
60
 
61
61
  # @!attribute external_customer_id
62
62
  # An optional user-defined ID for this customer resource, used throughout the
63
- # system as an alias for this Customer. Use this field to identify a customer by
64
- # an existing identifier in your system.
63
+ # system as an alias for this Customer. Use this field to identify a customer by
64
+ # an existing identifier in your system.
65
65
  #
66
66
  # @return [String, nil]
67
67
  required :external_customer_id, String, nil?: true
@@ -74,9 +74,9 @@ module Orb
74
74
 
75
75
  # @!attribute metadata
76
76
  # User specified key-value pairs for the resource. If not present, this defaults
77
- # to an empty dictionary. Individual keys can be removed by setting the value to
78
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
79
- # `null`.
77
+ # to an empty dictionary. Individual keys can be removed by setting the value to
78
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
79
+ # `null`.
80
80
  #
81
81
  # @return [Hash{Symbol=>String}]
82
82
  required :metadata, Orb::Internal::Type::HashOf[String]
@@ -89,15 +89,15 @@ module Orb
89
89
 
90
90
  # @!attribute payment_provider
91
91
  # This is used for creating charges or invoices in an external system via Orb.
92
- # When not in test mode, the connection must first be configured in the Orb
93
- # webapp.
92
+ # When not in test mode, the connection must first be configured in the Orb
93
+ # webapp.
94
94
  #
95
95
  # @return [Symbol, Orb::Models::Customer::PaymentProvider, nil]
96
96
  required :payment_provider, enum: -> { Orb::Models::Customer::PaymentProvider }, nil?: true
97
97
 
98
98
  # @!attribute payment_provider_id
99
99
  # The ID of this customer in an external payments solution, such as Stripe. This
100
- # is used for creating charges or invoices in the external system via Orb.
100
+ # is used for creating charges or invoices in the external system via Orb.
101
101
  #
102
102
  # @return [String, nil]
103
103
  required :payment_provider_id, String, nil?: true
@@ -114,118 +114,118 @@ module Orb
114
114
 
115
115
  # @!attribute tax_id
116
116
  # Tax IDs are commonly required to be displayed on customer invoices, which are
117
- # added to the headers of invoices.
117
+ # added to the headers of invoices.
118
118
  #
119
- # ### Supported Tax ID Countries and Types
119
+ # ### Supported Tax ID Countries and Types
120
120
  #
121
- # | Country | Type | Description |
122
- # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
123
- # | Andorra | `ad_nrt` | Andorran NRT Number |
124
- # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
125
- # | Australia | `au_abn` | Australian Business Number (AU ABN) |
126
- # | Australia | `au_arn` | Australian Taxation Office Reference Number |
127
- # | Austria | `eu_vat` | European VAT Number |
128
- # | Bahrain | `bh_vat` | Bahraini VAT Number |
129
- # | Belgium | `eu_vat` | European VAT Number |
130
- # | Bolivia | `bo_tin` | Bolivian Tax ID |
131
- # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
132
- # | Brazil | `br_cpf` | Brazilian CPF Number |
133
- # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
134
- # | Bulgaria | `eu_vat` | European VAT Number |
135
- # | Canada | `ca_bn` | Canadian BN |
136
- # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
137
- # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
138
- # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
139
- # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
140
- # | Canada | `ca_qst` | Canadian QST Number (Québec) |
141
- # | Chile | `cl_tin` | Chilean TIN |
142
- # | China | `cn_tin` | Chinese Tax ID |
143
- # | Colombia | `co_nit` | Colombian NIT Number |
144
- # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
145
- # | Croatia | `eu_vat` | European VAT Number |
146
- # | Cyprus | `eu_vat` | European VAT Number |
147
- # | Czech Republic | `eu_vat` | European VAT Number |
148
- # | Denmark | `eu_vat` | European VAT Number |
149
- # | Dominican Republic | `do_rcn` | Dominican RCN Number |
150
- # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
151
- # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
152
- # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
153
- # | Estonia | `eu_vat` | European VAT Number |
154
- # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
155
- # | Finland | `eu_vat` | European VAT Number |
156
- # | France | `eu_vat` | European VAT Number |
157
- # | Georgia | `ge_vat` | Georgian VAT |
158
- # | Germany | `eu_vat` | European VAT Number |
159
- # | Greece | `eu_vat` | European VAT Number |
160
- # | Hong Kong | `hk_br` | Hong Kong BR Number |
161
- # | Hungary | `eu_vat` | European VAT Number |
162
- # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
163
- # | Iceland | `is_vat` | Icelandic VAT |
164
- # | India | `in_gst` | Indian GST Number |
165
- # | Indonesia | `id_npwp` | Indonesian NPWP Number |
166
- # | Ireland | `eu_vat` | European VAT Number |
167
- # | Israel | `il_vat` | Israel VAT |
168
- # | Italy | `eu_vat` | European VAT Number |
169
- # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
170
- # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
171
- # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
172
- # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
173
- # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
174
- # | Latvia | `eu_vat` | European VAT Number |
175
- # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
176
- # | Lithuania | `eu_vat` | European VAT Number |
177
- # | Luxembourg | `eu_vat` | European VAT Number |
178
- # | Malaysia | `my_frp` | Malaysian FRP Number |
179
- # | Malaysia | `my_itn` | Malaysian ITN |
180
- # | Malaysia | `my_sst` | Malaysian SST Number |
181
- # | Malta | `eu_vat ` | European VAT Number |
182
- # | Mexico | `mx_rfc` | Mexican RFC Number |
183
- # | Netherlands | `eu_vat` | European VAT Number |
184
- # | New Zealand | `nz_gst` | New Zealand GST Number |
185
- # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
186
- # | Norway | `no_vat` | Norwegian VAT Number |
187
- # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
188
- # | Oman | `om_vat` | Omani VAT Number |
189
- # | Peru | `pe_ruc` | Peruvian RUC Number |
190
- # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
191
- # | Poland | `eu_vat` | European VAT Number |
192
- # | Portugal | `eu_vat` | European VAT Number |
193
- # | Romania | `eu_vat` | European VAT Number |
194
- # | Romania | `ro_tin` | Romanian Tax ID Number |
195
- # | Russia | `ru_inn` | Russian INN |
196
- # | Russia | `ru_kpp` | Russian KPP |
197
- # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
198
- # | Serbia | `rs_pib` | Serbian PIB Number |
199
- # | Singapore | `sg_gst` | Singaporean GST |
200
- # | Singapore | `sg_uen` | Singaporean UEN |
201
- # | Slovakia | `eu_vat` | European VAT Number |
202
- # | Slovenia | `eu_vat` | European VAT Number |
203
- # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
204
- # | South Africa | `za_vat` | South African VAT Number |
205
- # | South Korea | `kr_brn` | Korean BRN |
206
- # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
207
- # | Spain | `eu_vat` | European VAT Number |
208
- # | Sweden | `eu_vat` | European VAT Number |
209
- # | Switzerland | `ch_vat` | Switzerland VAT Number |
210
- # | Taiwan | `tw_vat` | Taiwanese VAT |
211
- # | Thailand | `th_vat` | Thai VAT |
212
- # | Turkey | `tr_tin` | Turkish Tax Identification Number |
213
- # | Ukraine | `ua_vat` | Ukrainian VAT |
214
- # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
215
- # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
216
- # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
217
- # | United States | `us_ein` | United States EIN |
218
- # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
219
- # | Venezuela | `ve_rif` | Venezuelan RIF Number |
220
- # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
121
+ # | Country | Type | Description |
122
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
123
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
124
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
125
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
126
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
127
+ # | Austria | `eu_vat` | European VAT Number |
128
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
129
+ # | Belgium | `eu_vat` | European VAT Number |
130
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
131
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
132
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
133
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
134
+ # | Bulgaria | `eu_vat` | European VAT Number |
135
+ # | Canada | `ca_bn` | Canadian BN |
136
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
137
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
138
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
139
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
140
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
141
+ # | Chile | `cl_tin` | Chilean TIN |
142
+ # | China | `cn_tin` | Chinese Tax ID |
143
+ # | Colombia | `co_nit` | Colombian NIT Number |
144
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
145
+ # | Croatia | `eu_vat` | European VAT Number |
146
+ # | Cyprus | `eu_vat` | European VAT Number |
147
+ # | Czech Republic | `eu_vat` | European VAT Number |
148
+ # | Denmark | `eu_vat` | European VAT Number |
149
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
150
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
151
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
152
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
153
+ # | Estonia | `eu_vat` | European VAT Number |
154
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
155
+ # | Finland | `eu_vat` | European VAT Number |
156
+ # | France | `eu_vat` | European VAT Number |
157
+ # | Georgia | `ge_vat` | Georgian VAT |
158
+ # | Germany | `eu_vat` | European VAT Number |
159
+ # | Greece | `eu_vat` | European VAT Number |
160
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
161
+ # | Hungary | `eu_vat` | European VAT Number |
162
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
163
+ # | Iceland | `is_vat` | Icelandic VAT |
164
+ # | India | `in_gst` | Indian GST Number |
165
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
166
+ # | Ireland | `eu_vat` | European VAT Number |
167
+ # | Israel | `il_vat` | Israel VAT |
168
+ # | Italy | `eu_vat` | European VAT Number |
169
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
170
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
171
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
172
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
173
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
174
+ # | Latvia | `eu_vat` | European VAT Number |
175
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
176
+ # | Lithuania | `eu_vat` | European VAT Number |
177
+ # | Luxembourg | `eu_vat` | European VAT Number |
178
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
179
+ # | Malaysia | `my_itn` | Malaysian ITN |
180
+ # | Malaysia | `my_sst` | Malaysian SST Number |
181
+ # | Malta | `eu_vat ` | European VAT Number |
182
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
183
+ # | Netherlands | `eu_vat` | European VAT Number |
184
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
185
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
186
+ # | Norway | `no_vat` | Norwegian VAT Number |
187
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
188
+ # | Oman | `om_vat` | Omani VAT Number |
189
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
190
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
191
+ # | Poland | `eu_vat` | European VAT Number |
192
+ # | Portugal | `eu_vat` | European VAT Number |
193
+ # | Romania | `eu_vat` | European VAT Number |
194
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
195
+ # | Russia | `ru_inn` | Russian INN |
196
+ # | Russia | `ru_kpp` | Russian KPP |
197
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
198
+ # | Serbia | `rs_pib` | Serbian PIB Number |
199
+ # | Singapore | `sg_gst` | Singaporean GST |
200
+ # | Singapore | `sg_uen` | Singaporean UEN |
201
+ # | Slovakia | `eu_vat` | European VAT Number |
202
+ # | Slovenia | `eu_vat` | European VAT Number |
203
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
204
+ # | South Africa | `za_vat` | South African VAT Number |
205
+ # | South Korea | `kr_brn` | Korean BRN |
206
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
207
+ # | Spain | `eu_vat` | European VAT Number |
208
+ # | Sweden | `eu_vat` | European VAT Number |
209
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
210
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
211
+ # | Thailand | `th_vat` | Thai VAT |
212
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
213
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
214
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
215
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
216
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
217
+ # | United States | `us_ein` | United States EIN |
218
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
219
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
220
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
221
221
  #
222
222
  # @return [Orb::Models::Customer::TaxID, nil]
223
223
  required :tax_id, -> { Orb::Models::Customer::TaxID }, nil?: true
224
224
 
225
225
  # @!attribute timezone
226
226
  # A timezone identifier from the IANA timezone database, such as
227
- # "America/Los_Angeles". This "defaults to your account's timezone if not set.
228
- # This cannot be changed after customer creation.
227
+ # "America/Los_Angeles". This "defaults to your account's timezone if not set.
228
+ # This cannot be changed after customer creation.
229
229
  #
230
230
  # @return [String]
231
231
  required :timezone, String
@@ -244,23 +244,23 @@ module Orb
244
244
 
245
245
  # @!parse
246
246
  # # A customer is a buyer of your products, and the other party to the billing
247
- # # relationship.
247
+ # # relationship.
248
248
  # #
249
- # # In Orb, customers are assigned system generated identifiers automatically, but
250
- # # it's often desirable to have these match existing identifiers in your system. To
251
- # # avoid having to denormalize Orb ID information, you can pass in an
252
- # # `external_customer_id` with your own identifier. See
253
- # # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
254
- # # information about how these aliases work in Orb.
249
+ # # In Orb, customers are assigned system generated identifiers automatically, but
250
+ # # it's often desirable to have these match existing identifiers in your system. To
251
+ # # avoid having to denormalize Orb ID information, you can pass in an
252
+ # # `external_customer_id` with your own identifier. See
253
+ # # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
254
+ # # information about how these aliases work in Orb.
255
255
  # #
256
- # # In addition to having an identifier in your system, a customer may exist in a
257
- # # payment provider solution like Stripe. Use the `payment_provider_id` and the
258
- # # `payment_provider` enum field to express this mapping.
256
+ # # In addition to having an identifier in your system, a customer may exist in a
257
+ # # payment provider solution like Stripe. Use the `payment_provider_id` and the
258
+ # # `payment_provider` enum field to express this mapping.
259
259
  # #
260
- # # A customer also has a timezone (from the standard
261
- # # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
262
- # # your account's timezone. See [Timezone localization](/essentials/timezones) for
263
- # # information on what this timezone parameter influences within Orb.
260
+ # # A customer also has a timezone (from the standard
261
+ # # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
262
+ # # your account's timezone. See [Timezone localization](/essentials/timezones) for
263
+ # # information on what this timezone parameter influences within Orb.
264
264
  # #
265
265
  # # @param id [String]
266
266
  # # @param additional_emails [Array<String>]
@@ -425,8 +425,8 @@ module Orb
425
425
  end
426
426
 
427
427
  # This is used for creating charges or invoices in an external system via Orb.
428
- # When not in test mode, the connection must first be configured in the Orb
429
- # webapp.
428
+ # When not in test mode, the connection must first be configured in the Orb
429
+ # webapp.
430
430
  #
431
431
  # @see Orb::Models::Customer#payment_provider
432
432
  module PaymentProvider
@@ -509,110 +509,110 @@ module Orb
509
509
 
510
510
  # @!parse
511
511
  # # Tax IDs are commonly required to be displayed on customer invoices, which are
512
- # # added to the headers of invoices.
512
+ # # added to the headers of invoices.
513
513
  # #
514
- # # ### Supported Tax ID Countries and Types
514
+ # # ### Supported Tax ID Countries and Types
515
515
  # #
516
- # # | Country | Type | Description |
517
- # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
518
- # # | Andorra | `ad_nrt` | Andorran NRT Number |
519
- # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
520
- # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
521
- # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
522
- # # | Austria | `eu_vat` | European VAT Number |
523
- # # | Bahrain | `bh_vat` | Bahraini VAT Number |
524
- # # | Belgium | `eu_vat` | European VAT Number |
525
- # # | Bolivia | `bo_tin` | Bolivian Tax ID |
526
- # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
527
- # # | Brazil | `br_cpf` | Brazilian CPF Number |
528
- # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
529
- # # | Bulgaria | `eu_vat` | European VAT Number |
530
- # # | Canada | `ca_bn` | Canadian BN |
531
- # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
532
- # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
533
- # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
534
- # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
535
- # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
536
- # # | Chile | `cl_tin` | Chilean TIN |
537
- # # | China | `cn_tin` | Chinese Tax ID |
538
- # # | Colombia | `co_nit` | Colombian NIT Number |
539
- # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
540
- # # | Croatia | `eu_vat` | European VAT Number |
541
- # # | Cyprus | `eu_vat` | European VAT Number |
542
- # # | Czech Republic | `eu_vat` | European VAT Number |
543
- # # | Denmark | `eu_vat` | European VAT Number |
544
- # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
545
- # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
546
- # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
547
- # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
548
- # # | Estonia | `eu_vat` | European VAT Number |
549
- # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
550
- # # | Finland | `eu_vat` | European VAT Number |
551
- # # | France | `eu_vat` | European VAT Number |
552
- # # | Georgia | `ge_vat` | Georgian VAT |
553
- # # | Germany | `eu_vat` | European VAT Number |
554
- # # | Greece | `eu_vat` | European VAT Number |
555
- # # | Hong Kong | `hk_br` | Hong Kong BR Number |
556
- # # | Hungary | `eu_vat` | European VAT Number |
557
- # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
558
- # # | Iceland | `is_vat` | Icelandic VAT |
559
- # # | India | `in_gst` | Indian GST Number |
560
- # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
561
- # # | Ireland | `eu_vat` | European VAT Number |
562
- # # | Israel | `il_vat` | Israel VAT |
563
- # # | Italy | `eu_vat` | European VAT Number |
564
- # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
565
- # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
566
- # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
567
- # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
568
- # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
569
- # # | Latvia | `eu_vat` | European VAT Number |
570
- # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
571
- # # | Lithuania | `eu_vat` | European VAT Number |
572
- # # | Luxembourg | `eu_vat` | European VAT Number |
573
- # # | Malaysia | `my_frp` | Malaysian FRP Number |
574
- # # | Malaysia | `my_itn` | Malaysian ITN |
575
- # # | Malaysia | `my_sst` | Malaysian SST Number |
576
- # # | Malta | `eu_vat ` | European VAT Number |
577
- # # | Mexico | `mx_rfc` | Mexican RFC Number |
578
- # # | Netherlands | `eu_vat` | European VAT Number |
579
- # # | New Zealand | `nz_gst` | New Zealand GST Number |
580
- # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
581
- # # | Norway | `no_vat` | Norwegian VAT Number |
582
- # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
583
- # # | Oman | `om_vat` | Omani VAT Number |
584
- # # | Peru | `pe_ruc` | Peruvian RUC Number |
585
- # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
586
- # # | Poland | `eu_vat` | European VAT Number |
587
- # # | Portugal | `eu_vat` | European VAT Number |
588
- # # | Romania | `eu_vat` | European VAT Number |
589
- # # | Romania | `ro_tin` | Romanian Tax ID Number |
590
- # # | Russia | `ru_inn` | Russian INN |
591
- # # | Russia | `ru_kpp` | Russian KPP |
592
- # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
593
- # # | Serbia | `rs_pib` | Serbian PIB Number |
594
- # # | Singapore | `sg_gst` | Singaporean GST |
595
- # # | Singapore | `sg_uen` | Singaporean UEN |
596
- # # | Slovakia | `eu_vat` | European VAT Number |
597
- # # | Slovenia | `eu_vat` | European VAT Number |
598
- # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
599
- # # | South Africa | `za_vat` | South African VAT Number |
600
- # # | South Korea | `kr_brn` | Korean BRN |
601
- # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
602
- # # | Spain | `eu_vat` | European VAT Number |
603
- # # | Sweden | `eu_vat` | European VAT Number |
604
- # # | Switzerland | `ch_vat` | Switzerland VAT Number |
605
- # # | Taiwan | `tw_vat` | Taiwanese VAT |
606
- # # | Thailand | `th_vat` | Thai VAT |
607
- # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
608
- # # | Ukraine | `ua_vat` | Ukrainian VAT |
609
- # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
610
- # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
611
- # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
612
- # # | United States | `us_ein` | United States EIN |
613
- # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
614
- # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
615
- # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
516
+ # # | Country | Type | Description |
517
+ # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
518
+ # # | Andorra | `ad_nrt` | Andorran NRT Number |
519
+ # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
520
+ # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
521
+ # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
522
+ # # | Austria | `eu_vat` | European VAT Number |
523
+ # # | Bahrain | `bh_vat` | Bahraini VAT Number |
524
+ # # | Belgium | `eu_vat` | European VAT Number |
525
+ # # | Bolivia | `bo_tin` | Bolivian Tax ID |
526
+ # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
527
+ # # | Brazil | `br_cpf` | Brazilian CPF Number |
528
+ # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
529
+ # # | Bulgaria | `eu_vat` | European VAT Number |
530
+ # # | Canada | `ca_bn` | Canadian BN |
531
+ # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
532
+ # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
533
+ # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
534
+ # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
535
+ # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
536
+ # # | Chile | `cl_tin` | Chilean TIN |
537
+ # # | China | `cn_tin` | Chinese Tax ID |
538
+ # # | Colombia | `co_nit` | Colombian NIT Number |
539
+ # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
540
+ # # | Croatia | `eu_vat` | European VAT Number |
541
+ # # | Cyprus | `eu_vat` | European VAT Number |
542
+ # # | Czech Republic | `eu_vat` | European VAT Number |
543
+ # # | Denmark | `eu_vat` | European VAT Number |
544
+ # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
545
+ # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
546
+ # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
547
+ # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
548
+ # # | Estonia | `eu_vat` | European VAT Number |
549
+ # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
550
+ # # | Finland | `eu_vat` | European VAT Number |
551
+ # # | France | `eu_vat` | European VAT Number |
552
+ # # | Georgia | `ge_vat` | Georgian VAT |
553
+ # # | Germany | `eu_vat` | European VAT Number |
554
+ # # | Greece | `eu_vat` | European VAT Number |
555
+ # # | Hong Kong | `hk_br` | Hong Kong BR Number |
556
+ # # | Hungary | `eu_vat` | European VAT Number |
557
+ # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
558
+ # # | Iceland | `is_vat` | Icelandic VAT |
559
+ # # | India | `in_gst` | Indian GST Number |
560
+ # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
561
+ # # | Ireland | `eu_vat` | European VAT Number |
562
+ # # | Israel | `il_vat` | Israel VAT |
563
+ # # | Italy | `eu_vat` | European VAT Number |
564
+ # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
565
+ # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
566
+ # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
567
+ # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
568
+ # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
569
+ # # | Latvia | `eu_vat` | European VAT Number |
570
+ # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
571
+ # # | Lithuania | `eu_vat` | European VAT Number |
572
+ # # | Luxembourg | `eu_vat` | European VAT Number |
573
+ # # | Malaysia | `my_frp` | Malaysian FRP Number |
574
+ # # | Malaysia | `my_itn` | Malaysian ITN |
575
+ # # | Malaysia | `my_sst` | Malaysian SST Number |
576
+ # # | Malta | `eu_vat ` | European VAT Number |
577
+ # # | Mexico | `mx_rfc` | Mexican RFC Number |
578
+ # # | Netherlands | `eu_vat` | European VAT Number |
579
+ # # | New Zealand | `nz_gst` | New Zealand GST Number |
580
+ # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
581
+ # # | Norway | `no_vat` | Norwegian VAT Number |
582
+ # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
583
+ # # | Oman | `om_vat` | Omani VAT Number |
584
+ # # | Peru | `pe_ruc` | Peruvian RUC Number |
585
+ # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
586
+ # # | Poland | `eu_vat` | European VAT Number |
587
+ # # | Portugal | `eu_vat` | European VAT Number |
588
+ # # | Romania | `eu_vat` | European VAT Number |
589
+ # # | Romania | `ro_tin` | Romanian Tax ID Number |
590
+ # # | Russia | `ru_inn` | Russian INN |
591
+ # # | Russia | `ru_kpp` | Russian KPP |
592
+ # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
593
+ # # | Serbia | `rs_pib` | Serbian PIB Number |
594
+ # # | Singapore | `sg_gst` | Singaporean GST |
595
+ # # | Singapore | `sg_uen` | Singaporean UEN |
596
+ # # | Slovakia | `eu_vat` | European VAT Number |
597
+ # # | Slovenia | `eu_vat` | European VAT Number |
598
+ # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
599
+ # # | South Africa | `za_vat` | South African VAT Number |
600
+ # # | South Korea | `kr_brn` | Korean BRN |
601
+ # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
602
+ # # | Spain | `eu_vat` | European VAT Number |
603
+ # # | Sweden | `eu_vat` | European VAT Number |
604
+ # # | Switzerland | `ch_vat` | Switzerland VAT Number |
605
+ # # | Taiwan | `tw_vat` | Taiwanese VAT |
606
+ # # | Thailand | `th_vat` | Thai VAT |
607
+ # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
608
+ # # | Ukraine | `ua_vat` | Ukrainian VAT |
609
+ # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
610
+ # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
611
+ # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
612
+ # # | United States | `us_ein` | United States EIN |
613
+ # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
614
+ # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
615
+ # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
616
616
  # #
617
617
  # # @param country [Symbol, Orb::Models::Customer::TaxID::Country]
618
618
  # # @param type [Symbol, Orb::Models::Customer::TaxID::Type]