orb-billing 0.5.1 → 0.5.3

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 (337) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +4 -4
  4. data/SECURITY.md +2 -2
  5. data/lib/orb/internal/type/array_of.rb +8 -0
  6. data/lib/orb/internal/type/base_model.rb +7 -0
  7. data/lib/orb/internal/type/boolean.rb +8 -0
  8. data/lib/orb/internal/type/enum.rb +12 -0
  9. data/lib/orb/internal/type/file_input.rb +7 -0
  10. data/lib/orb/internal/type/hash_of.rb +8 -0
  11. data/lib/orb/internal/type/union.rb +12 -0
  12. data/lib/orb/internal/type/unknown.rb +8 -0
  13. data/lib/orb/internal/util.rb +45 -0
  14. data/lib/orb/internal.rb +3 -0
  15. data/lib/orb/models/alert.rb +23 -23
  16. data/lib/orb/models/alert_create_for_customer_params.rb +5 -5
  17. data/lib/orb/models/alert_create_for_external_customer_params.rb +5 -5
  18. data/lib/orb/models/alert_create_for_subscription_params.rb +5 -5
  19. data/lib/orb/models/alert_update_params.rb +3 -3
  20. data/lib/orb/models/amount_discount.rb +5 -5
  21. data/lib/orb/models/billable_metric.rb +7 -7
  22. data/lib/orb/models/coupon.rb +6 -10
  23. data/lib/orb/models/coupon_create_params.rb +3 -9
  24. data/lib/orb/models/credit_note.rb +33 -33
  25. data/lib/orb/models/credit_note_create_params.rb +4 -4
  26. data/lib/orb/models/customer.rb +39 -39
  27. data/lib/orb/models/customer_create_params.rb +26 -35
  28. data/lib/orb/models/customer_update_by_external_id_params.rb +26 -35
  29. data/lib/orb/models/customer_update_params.rb +26 -35
  30. data/lib/orb/models/customers/balance_transaction_create_params.rb +2 -2
  31. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +2 -2
  32. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +2 -2
  33. data/lib/orb/models/customers/cost_list_params.rb +2 -2
  34. data/lib/orb/models/customers/cost_list_response.rb +2 -2
  35. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +7 -7
  36. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -14
  37. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +8 -8
  38. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -14
  39. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +4 -4
  40. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -14
  41. data/lib/orb/models/customers/credits/ledger_list_params.rb +4 -4
  42. data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -14
  43. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +6 -6
  44. data/lib/orb/models/customers/credits/top_up_create_params.rb +6 -5
  45. data/lib/orb/models/dimensional_price_group.rb +1 -1
  46. data/lib/orb/models/dimensional_price_groups.rb +4 -4
  47. data/lib/orb/models/discount.rb +1 -7
  48. data/lib/orb/models/evaluate_price_group.rb +0 -4
  49. data/lib/orb/models/event_ingest_params.rb +3 -3
  50. data/lib/orb/models/events/event_volumes.rb +2 -2
  51. data/lib/orb/models/invoice.rb +114 -135
  52. data/lib/orb/models/invoice_create_params.rb +10 -10
  53. data/lib/orb/models/invoice_fetch_upcoming_response.rb +6 -28
  54. data/lib/orb/models/invoice_level_discount.rb +1 -5
  55. data/lib/orb/models/invoice_line_item_create_response.rb +4 -26
  56. data/lib/orb/models/invoice_list_params.rb +4 -4
  57. data/lib/orb/models/item.rb +5 -5
  58. data/lib/orb/models/item_update_params.rb +5 -5
  59. data/lib/orb/models/percentage_discount.rb +5 -5
  60. data/lib/orb/models/plan.rb +58 -70
  61. data/lib/orb/models/plan_create_params.rb +448 -476
  62. data/lib/orb/models/plan_list_params.rb +2 -2
  63. data/lib/orb/models/price.rb +1204 -1239
  64. data/lib/orb/models/price_create_params.rb +50 -50
  65. data/lib/orb/models/price_evaluate_response.rb +2 -2
  66. data/lib/orb/models/subscription.rb +58 -78
  67. data/lib/orb/models/subscription_cancel_params.rb +2 -2
  68. data/lib/orb/models/subscription_cancel_response.rb +14 -36
  69. data/lib/orb/models/subscription_change_apply_response.rb +14 -36
  70. data/lib/orb/models/subscription_change_cancel_response.rb +14 -36
  71. data/lib/orb/models/subscription_change_retrieve_response.rb +14 -36
  72. data/lib/orb/models/subscription_create_params.rb +1002 -1075
  73. data/lib/orb/models/subscription_create_response.rb +14 -36
  74. data/lib/orb/models/subscription_fetch_costs_params.rb +2 -2
  75. data/lib/orb/models/subscription_fetch_costs_response.rb +2 -2
  76. data/lib/orb/models/subscription_fetch_usage_params.rb +4 -4
  77. data/lib/orb/models/subscription_list_params.rb +2 -2
  78. data/lib/orb/models/subscription_price_intervals_params.rb +596 -674
  79. data/lib/orb/models/subscription_price_intervals_response.rb +14 -36
  80. data/lib/orb/models/subscription_schedule_plan_change_params.rb +973 -1059
  81. data/lib/orb/models/subscription_schedule_plan_change_response.rb +14 -36
  82. data/lib/orb/models/subscription_trigger_phase_response.rb +14 -36
  83. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +14 -36
  84. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +14 -36
  85. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +14 -36
  86. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +2 -2
  87. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +14 -36
  88. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  89. data/lib/orb/models/subscription_update_trial_response.rb +14 -36
  90. data/lib/orb/models/subscription_usage.rb +26 -35
  91. data/lib/orb/models/subscriptions.rb +4 -4
  92. data/lib/orb/models/trial_discount.rb +5 -5
  93. data/lib/orb/models/usage_discount.rb +5 -5
  94. data/lib/orb/models.rb +30 -16
  95. data/lib/orb/resources/alerts.rb +15 -15
  96. data/lib/orb/resources/coupons/subscriptions.rb +1 -1
  97. data/lib/orb/resources/coupons.rb +5 -5
  98. data/lib/orb/resources/credit_notes.rb +5 -5
  99. data/lib/orb/resources/customers/balance_transactions.rb +1 -1
  100. data/lib/orb/resources/customers/costs.rb +2 -2
  101. data/lib/orb/resources/customers/credits/ledger.rb +10 -10
  102. data/lib/orb/resources/customers/credits/top_ups.rb +4 -4
  103. data/lib/orb/resources/customers.rb +30 -30
  104. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +1 -1
  105. data/lib/orb/resources/dimensional_price_groups.rb +3 -3
  106. data/lib/orb/resources/events/volume.rb +1 -1
  107. data/lib/orb/resources/events.rb +1 -1
  108. data/lib/orb/resources/invoices.rb +12 -12
  109. data/lib/orb/resources/items.rb +5 -5
  110. data/lib/orb/resources/metrics.rb +4 -4
  111. data/lib/orb/resources/plans/external_plan_id.rb +2 -2
  112. data/lib/orb/resources/plans.rb +7 -7
  113. data/lib/orb/resources/prices/external_price_id.rb +2 -2
  114. data/lib/orb/resources/prices.rb +17 -17
  115. data/lib/orb/resources/subscriptions.rb +32 -32
  116. data/lib/orb/version.rb +1 -1
  117. data/rbi/orb/internal/type/array_of.rbi +6 -0
  118. data/rbi/orb/internal/type/base_model.rbi +5 -0
  119. data/rbi/orb/internal/type/boolean.rbi +6 -0
  120. data/rbi/orb/internal/type/enum.rbi +5 -0
  121. data/rbi/orb/internal/type/file_input.rbi +5 -0
  122. data/rbi/orb/internal/type/hash_of.rbi +6 -0
  123. data/rbi/orb/internal/type/union.rbi +5 -0
  124. data/rbi/orb/internal/type/unknown.rbi +6 -0
  125. data/rbi/orb/internal/util.rbi +30 -0
  126. data/rbi/orb/internal.rbi +3 -0
  127. data/rbi/orb/models/coupon.rbi +2 -2
  128. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +2 -65
  129. data/rbi/orb/models/customers/cost_list_response.rbi +2 -65
  130. data/rbi/orb/models/evaluate_price_group.rbi +7 -3
  131. data/rbi/orb/models/invoice.rbi +10 -149
  132. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +10 -133
  133. data/rbi/orb/models/invoice_line_item_create_response.rbi +8 -114
  134. data/rbi/orb/models/plan.rbi +8 -134
  135. data/rbi/orb/models/price.rbi +56 -588
  136. data/rbi/orb/models/subscription.rbi +6 -99
  137. data/rbi/orb/models/subscription_cancel_response.rbi +6 -89
  138. data/rbi/orb/models/subscription_change_apply_response.rbi +6 -89
  139. data/rbi/orb/models/subscription_change_cancel_response.rbi +6 -89
  140. data/rbi/orb/models/subscription_change_retrieve_response.rbi +6 -89
  141. data/rbi/orb/models/subscription_create_response.rbi +6 -89
  142. data/rbi/orb/models/subscription_fetch_costs_response.rbi +2 -65
  143. data/rbi/orb/models/subscription_price_intervals_response.rbi +6 -89
  144. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +6 -89
  145. data/rbi/orb/models/subscription_trigger_phase_response.rbi +6 -89
  146. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +6 -89
  147. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +6 -89
  148. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +6 -89
  149. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +6 -89
  150. data/rbi/orb/models/subscription_update_trial_response.rbi +6 -89
  151. data/rbi/orb/resources/customers/credits/ledger.rbi +4 -36
  152. data/rbi/orb/resources/prices/external_price_id.rbi +2 -64
  153. data/rbi/orb/resources/prices.rbi +4 -130
  154. data/rbi/orb/resources/subscriptions.rbi +1 -6
  155. data/sig/orb/internal/page.rbs +2 -0
  156. data/sig/orb/internal/type/array_of.rbs +3 -0
  157. data/sig/orb/internal/type/base_model.rbs +2 -0
  158. data/sig/orb/internal/type/boolean.rbs +3 -0
  159. data/sig/orb/internal/type/enum.rbs +2 -0
  160. data/sig/orb/internal/type/file_input.rbs +2 -0
  161. data/sig/orb/internal/type/hash_of.rbs +3 -0
  162. data/sig/orb/internal/type/union.rbs +2 -0
  163. data/sig/orb/internal/type/unknown.rbs +3 -0
  164. data/sig/orb/internal/util.rbs +12 -0
  165. data/sig/orb/internal.rbs +2 -0
  166. data/sig/orb/models/alert.rbs +32 -4
  167. data/sig/orb/models/alert_create_for_customer_params.rbs +9 -0
  168. data/sig/orb/models/alert_create_for_external_customer_params.rbs +9 -0
  169. data/sig/orb/models/alert_create_for_subscription_params.rbs +9 -0
  170. data/sig/orb/models/alert_disable_params.rbs +5 -0
  171. data/sig/orb/models/alert_enable_params.rbs +5 -0
  172. data/sig/orb/models/alert_list_params.rbs +13 -0
  173. data/sig/orb/models/alert_retrieve_params.rbs +2 -0
  174. data/sig/orb/models/alert_update_params.rbs +7 -0
  175. data/sig/orb/models/amount_discount.rbs +11 -4
  176. data/sig/orb/models/billable_metric.rbs +13 -4
  177. data/sig/orb/models/coupon.rbs +14 -4
  178. data/sig/orb/models/coupon_archive_params.rbs +2 -0
  179. data/sig/orb/models/coupon_create_params.rbs +15 -0
  180. data/sig/orb/models/coupon_fetch_params.rbs +2 -0
  181. data/sig/orb/models/coupon_list_params.rbs +8 -0
  182. data/sig/orb/models/coupons/subscription_list_params.rbs +6 -0
  183. data/sig/orb/models/credit_note.rbs +88 -20
  184. data/sig/orb/models/credit_note_create_params.rbs +9 -0
  185. data/sig/orb/models/credit_note_fetch_params.rbs +2 -0
  186. data/sig/orb/models/credit_note_list_params.rbs +10 -0
  187. data/sig/orb/models/customer.rbs +86 -16
  188. data/sig/orb/models/customer_create_params.rbs +79 -8
  189. data/sig/orb/models/customer_delete_params.rbs +2 -0
  190. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +2 -0
  191. data/sig/orb/models/customer_fetch_params.rbs +2 -0
  192. data/sig/orb/models/customer_list_params.rbs +10 -0
  193. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +2 -0
  194. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +2 -0
  195. data/sig/orb/models/customer_update_by_external_id_params.rbs +78 -8
  196. data/sig/orb/models/customer_update_params.rbs +78 -8
  197. data/sig/orb/models/customers/balance_transaction_create_params.rbs +7 -0
  198. data/sig/orb/models/customers/balance_transaction_create_response.rbs +17 -0
  199. data/sig/orb/models/customers/balance_transaction_list_params.rbs +10 -0
  200. data/sig/orb/models/customers/balance_transaction_list_response.rbs +17 -0
  201. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +8 -0
  202. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +20 -0
  203. data/sig/orb/models/customers/cost_list_params.rbs +8 -0
  204. data/sig/orb/models/customers/cost_list_response.rbs +20 -0
  205. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +8 -0
  206. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +10 -0
  207. data/sig/orb/models/customers/credit_list_params.rbs +8 -0
  208. data/sig/orb/models/customers/credit_list_response.rbs +10 -0
  209. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +23 -0
  210. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +177 -0
  211. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +23 -0
  212. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +177 -0
  213. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +14 -0
  214. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +177 -0
  215. data/sig/orb/models/customers/credits/ledger_list_params.rbs +14 -0
  216. data/sig/orb/models/customers/credits/ledger_list_response.rbs +177 -0
  217. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +19 -0
  218. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +18 -0
  219. data/sig/orb/models/customers/credits/top_up_create_params.rbs +19 -0
  220. data/sig/orb/models/customers/credits/top_up_create_response.rbs +18 -0
  221. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +5 -0
  222. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +5 -0
  223. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +6 -0
  224. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +18 -0
  225. data/sig/orb/models/customers/credits/top_up_list_params.rbs +6 -0
  226. data/sig/orb/models/customers/credits/top_up_list_response.rbs +18 -0
  227. data/sig/orb/models/dimensional_price_group.rbs +9 -0
  228. data/sig/orb/models/dimensional_price_group_create_params.rbs +9 -0
  229. data/sig/orb/models/dimensional_price_group_list_params.rbs +6 -0
  230. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +2 -0
  231. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +2 -0
  232. data/sig/orb/models/dimensional_price_groups.rbs +5 -0
  233. data/sig/orb/models/evaluate_price_group.rbs +10 -4
  234. data/sig/orb/models/event_deprecate_params.rbs +2 -0
  235. data/sig/orb/models/event_deprecate_response.rbs +2 -0
  236. data/sig/orb/models/event_ingest_params.rbs +16 -0
  237. data/sig/orb/models/event_ingest_response.rbs +15 -0
  238. data/sig/orb/models/event_search_params.rbs +7 -0
  239. data/sig/orb/models/event_search_response.rbs +12 -0
  240. data/sig/orb/models/event_update_params.rbs +9 -0
  241. data/sig/orb/models/event_update_response.rbs +2 -0
  242. data/sig/orb/models/events/backfill_close_params.rbs +2 -0
  243. data/sig/orb/models/events/backfill_close_response.rbs +14 -0
  244. data/sig/orb/models/events/backfill_create_params.rbs +11 -0
  245. data/sig/orb/models/events/backfill_create_response.rbs +14 -0
  246. data/sig/orb/models/events/backfill_fetch_params.rbs +2 -0
  247. data/sig/orb/models/events/backfill_fetch_response.rbs +14 -0
  248. data/sig/orb/models/events/backfill_list_params.rbs +6 -0
  249. data/sig/orb/models/events/backfill_list_response.rbs +14 -0
  250. data/sig/orb/models/events/backfill_revert_params.rbs +2 -0
  251. data/sig/orb/models/events/backfill_revert_response.rbs +14 -0
  252. data/sig/orb/models/events/event_volumes.rbs +8 -0
  253. data/sig/orb/models/events/volume_list_params.rbs +8 -0
  254. data/sig/orb/models/invoice.rbs +293 -36
  255. data/sig/orb/models/invoice_create_params.rbs +30 -4
  256. data/sig/orb/models/invoice_fetch_params.rbs +2 -0
  257. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +5 -0
  258. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +257 -0
  259. data/sig/orb/models/invoice_issue_params.rbs +5 -0
  260. data/sig/orb/models/invoice_line_item_create_params.rbs +10 -0
  261. data/sig/orb/models/invoice_line_item_create_response.rbs +132 -0
  262. data/sig/orb/models/invoice_list_params.rbs +27 -4
  263. data/sig/orb/models/invoice_mark_paid_params.rbs +7 -0
  264. data/sig/orb/models/invoice_pay_params.rbs +2 -0
  265. data/sig/orb/models/invoice_update_params.rbs +5 -0
  266. data/sig/orb/models/invoice_void_params.rbs +2 -0
  267. data/sig/orb/models/item.rbs +16 -4
  268. data/sig/orb/models/item_create_params.rbs +2 -0
  269. data/sig/orb/models/item_fetch_params.rbs +2 -0
  270. data/sig/orb/models/item_list_params.rbs +6 -0
  271. data/sig/orb/models/item_update_params.rbs +15 -4
  272. data/sig/orb/models/metric_create_params.rbs +9 -0
  273. data/sig/orb/models/metric_fetch_params.rbs +2 -0
  274. data/sig/orb/models/metric_list_params.rbs +10 -0
  275. data/sig/orb/models/metric_update_params.rbs +5 -0
  276. data/sig/orb/models/pagination_metadata.rbs +2 -0
  277. data/sig/orb/models/percentage_discount.rbs +11 -4
  278. data/sig/orb/models/plan.rbs +141 -16
  279. data/sig/orb/models/plan_create_params.rbs +1070 -304
  280. data/sig/orb/models/plan_fetch_params.rbs +2 -0
  281. data/sig/orb/models/plan_list_params.rbs +11 -0
  282. data/sig/orb/models/plan_update_params.rbs +6 -0
  283. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +2 -0
  284. data/sig/orb/models/plans/external_plan_id_update_params.rbs +6 -0
  285. data/sig/orb/models/price.rbs +2148 -460
  286. data/sig/orb/models/price_create_params.rbs +130 -8
  287. data/sig/orb/models/price_evaluate_params.rbs +10 -0
  288. data/sig/orb/models/price_evaluate_response.rbs +2 -0
  289. data/sig/orb/models/price_fetch_params.rbs +2 -0
  290. data/sig/orb/models/price_list_params.rbs +6 -0
  291. data/sig/orb/models/price_update_params.rbs +5 -0
  292. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +2 -0
  293. data/sig/orb/models/prices/external_price_id_update_params.rbs +5 -0
  294. data/sig/orb/models/subscription.rbs +177 -12
  295. data/sig/orb/models/subscription_cancel_params.rbs +7 -0
  296. data/sig/orb/models/subscription_cancel_response.rbs +173 -0
  297. data/sig/orb/models/subscription_change_apply_params.rbs +6 -0
  298. data/sig/orb/models/subscription_change_apply_response.rbs +186 -0
  299. data/sig/orb/models/subscription_change_cancel_params.rbs +2 -0
  300. data/sig/orb/models/subscription_change_cancel_response.rbs +186 -0
  301. data/sig/orb/models/subscription_change_retrieve_params.rbs +2 -0
  302. data/sig/orb/models/subscription_change_retrieve_response.rbs +186 -0
  303. data/sig/orb/models/subscription_create_params.rbs +2368 -632
  304. data/sig/orb/models/subscription_create_response.rbs +173 -0
  305. data/sig/orb/models/subscription_fetch_costs_params.rbs +8 -0
  306. data/sig/orb/models/subscription_fetch_costs_response.rbs +20 -0
  307. data/sig/orb/models/subscription_fetch_params.rbs +2 -0
  308. data/sig/orb/models/subscription_fetch_schedule_params.rbs +10 -0
  309. data/sig/orb/models/subscription_fetch_schedule_response.rbs +13 -0
  310. data/sig/orb/models/subscription_fetch_usage_params.rbs +14 -0
  311. data/sig/orb/models/subscription_list_params.rbs +13 -0
  312. data/sig/orb/models/subscription_price_intervals_params.rbs +1348 -396
  313. data/sig/orb/models/subscription_price_intervals_response.rbs +173 -0
  314. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +2363 -632
  315. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +173 -0
  316. data/sig/orb/models/subscription_trigger_phase_params.rbs +6 -0
  317. data/sig/orb/models/subscription_trigger_phase_response.rbs +173 -0
  318. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +2 -0
  319. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +173 -0
  320. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +2 -0
  321. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +173 -0
  322. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +2 -0
  323. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +173 -0
  324. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +9 -0
  325. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +173 -0
  326. data/sig/orb/models/subscription_update_params.rbs +9 -0
  327. data/sig/orb/models/subscription_update_trial_params.rbs +6 -0
  328. data/sig/orb/models/subscription_update_trial_response.rbs +173 -0
  329. data/sig/orb/models/subscription_usage.rbs +48 -8
  330. data/sig/orb/models/subscriptions.rbs +5 -0
  331. data/sig/orb/models/top_level_ping_params.rbs +2 -0
  332. data/sig/orb/models/top_level_ping_response.rbs +2 -0
  333. data/sig/orb/models/trial_discount.rbs +12 -4
  334. data/sig/orb/models/usage_discount.rbs +11 -4
  335. data/sig/orb/resources/invoices.rbs +1 -1
  336. data/sig/orb/resources/plans.rbs +1 -1
  337. metadata +2 -2
@@ -23,7 +23,7 @@ module Orb
23
23
 
24
24
  # @!attribute accounting_sync_configuration
25
25
  #
26
- # @return [Orb::CustomerCreateParams::AccountingSyncConfiguration, nil]
26
+ # @return [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil]
27
27
  optional :accounting_sync_configuration,
28
28
  -> { Orb::CustomerCreateParams::AccountingSyncConfiguration },
29
29
  nil?: true
@@ -45,7 +45,7 @@ module Orb
45
45
 
46
46
  # @!attribute billing_address
47
47
  #
48
- # @return [Orb::CustomerCreateParams::BillingAddress, nil]
48
+ # @return [Orb::Models::CustomerCreateParams::BillingAddress, nil]
49
49
  optional :billing_address, -> { Orb::CustomerCreateParams::BillingAddress }, nil?: true
50
50
 
51
51
  # @!attribute currency
@@ -71,7 +71,7 @@ module Orb
71
71
  # @!attribute hierarchy
72
72
  # The hierarchical relationships for this customer.
73
73
  #
74
- # @return [Orb::CustomerCreateParams::Hierarchy, nil]
74
+ # @return [Orb::Models::CustomerCreateParams::Hierarchy, nil]
75
75
  optional :hierarchy, -> { Orb::CustomerCreateParams::Hierarchy }, nil?: true
76
76
 
77
77
  # @!attribute metadata
@@ -87,7 +87,7 @@ module Orb
87
87
  # When not in test mode, the connection must first be configured in the Orb
88
88
  # webapp.
89
89
  #
90
- # @return [Symbol, Orb::CustomerCreateParams::PaymentProvider, nil]
90
+ # @return [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil]
91
91
  optional :payment_provider, enum: -> { Orb::CustomerCreateParams::PaymentProvider }, nil?: true
92
92
 
93
93
  # @!attribute payment_provider_id
@@ -99,17 +99,17 @@ module Orb
99
99
 
100
100
  # @!attribute reporting_configuration
101
101
  #
102
- # @return [Orb::CustomerCreateParams::ReportingConfiguration, nil]
102
+ # @return [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil]
103
103
  optional :reporting_configuration, -> { Orb::CustomerCreateParams::ReportingConfiguration }, nil?: true
104
104
 
105
105
  # @!attribute shipping_address
106
106
  #
107
- # @return [Orb::CustomerCreateParams::ShippingAddress, nil]
107
+ # @return [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
108
108
  optional :shipping_address, -> { Orb::CustomerCreateParams::ShippingAddress }, nil?: true
109
109
 
110
110
  # @!attribute tax_configuration
111
111
  #
112
- # @return [Orb::CustomerCreateParams::TaxConfiguration::Avalara, Orb::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
112
+ # @return [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
113
113
  optional :tax_configuration, union: -> { Orb::CustomerCreateParams::TaxConfiguration }, nil?: true
114
114
 
115
115
  # @!attribute tax_id
@@ -219,7 +219,7 @@ module Orb
219
219
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
220
220
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
221
221
  #
222
- # @return [Orb::CustomerCreateParams::TaxID, nil]
222
+ # @return [Orb::Models::CustomerCreateParams::TaxID, nil]
223
223
  optional :tax_id, -> { Orb::CustomerCreateParams::TaxID }, nil?: true
224
224
 
225
225
  # @!attribute timezone
@@ -238,13 +238,13 @@ module Orb
238
238
  #
239
239
  # @param name [String] The full name of the customer
240
240
  #
241
- # @param accounting_sync_configuration [Orb::CustomerCreateParams::AccountingSyncConfiguration, nil]
241
+ # @param accounting_sync_configuration [Orb::Models::CustomerCreateParams::AccountingSyncConfiguration, nil]
242
242
  #
243
243
  # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
244
244
  #
245
245
  # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
246
246
  #
247
- # @param billing_address [Orb::CustomerCreateParams::BillingAddress, nil]
247
+ # @param billing_address [Orb::Models::CustomerCreateParams::BillingAddress, nil]
248
248
  #
249
249
  # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
250
250
  #
@@ -252,21 +252,21 @@ module Orb
252
252
  #
253
253
  # @param external_customer_id [String, nil] An optional user-defined ID for this customer resource, used throughout the syst
254
254
  #
255
- # @param hierarchy [Orb::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
255
+ # @param hierarchy [Orb::Models::CustomerCreateParams::Hierarchy, nil] The hierarchical relationships for this customer.
256
256
  #
257
257
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
258
258
  #
259
- # @param payment_provider [Symbol, Orb::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
259
+ # @param payment_provider [Symbol, Orb::Models::CustomerCreateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
260
260
  #
261
261
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
262
262
  #
263
- # @param reporting_configuration [Orb::CustomerCreateParams::ReportingConfiguration, nil]
263
+ # @param reporting_configuration [Orb::Models::CustomerCreateParams::ReportingConfiguration, nil]
264
264
  #
265
- # @param shipping_address [Orb::CustomerCreateParams::ShippingAddress, nil]
265
+ # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
266
266
  #
267
- # @param tax_configuration [Orb::CustomerCreateParams::TaxConfiguration::Avalara, Orb::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
267
+ # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
268
268
  #
269
- # @param tax_id [Orb::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
269
+ # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
270
270
  #
271
271
  # @param timezone [String, nil] A timezone identifier from the IANA timezone database, such as `"America/Los_Ang
272
272
  #
@@ -275,7 +275,7 @@ module Orb
275
275
  class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
276
276
  # @!attribute accounting_providers
277
277
  #
278
- # @return [Array<Orb::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
278
+ # @return [Array<Orb::Models::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
279
279
  optional :accounting_providers,
280
280
  -> {
281
281
  Orb::Internal::Type::ArrayOf[Orb::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider]
@@ -288,7 +288,7 @@ module Orb
288
288
  optional :excluded, Orb::Internal::Type::Boolean, nil?: true
289
289
 
290
290
  # @!method initialize(accounting_providers: nil, excluded: nil)
291
- # @param accounting_providers [Array<Orb::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
291
+ # @param accounting_providers [Array<Orb::Models::CustomerCreateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
292
292
  # @param excluded [Boolean, nil]
293
293
 
294
294
  class AccountingProvider < Orb::Internal::Type::BaseModel
@@ -365,7 +365,7 @@ module Orb
365
365
 
366
366
  # @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
367
367
  # Some parameter documentations has been truncated, see
368
- # {Orb::CustomerCreateParams::Hierarchy} for more details.
368
+ # {Orb::Models::CustomerCreateParams::Hierarchy} for more details.
369
369
  #
370
370
  # The hierarchical relationships for this customer.
371
371
  #
@@ -488,27 +488,18 @@ module Orb
488
488
  end
489
489
 
490
490
  # @!method self.variants
491
- # @return [Array(Orb::CustomerCreateParams::TaxConfiguration::Avalara, Orb::CustomerCreateParams::TaxConfiguration::Taxjar)]
492
-
493
- define_sorbet_constant!(:Variants) do
494
- T.type_alias do
495
- T.any(
496
- Orb::CustomerCreateParams::TaxConfiguration::Avalara,
497
- Orb::CustomerCreateParams::TaxConfiguration::Taxjar
498
- )
499
- end
500
- end
491
+ # @return [Array(Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar)]
501
492
  end
502
493
 
503
494
  class TaxID < Orb::Internal::Type::BaseModel
504
495
  # @!attribute country
505
496
  #
506
- # @return [Symbol, Orb::CustomerCreateParams::TaxID::Country]
497
+ # @return [Symbol, Orb::Models::CustomerCreateParams::TaxID::Country]
507
498
  required :country, enum: -> { Orb::CustomerCreateParams::TaxID::Country }
508
499
 
509
500
  # @!attribute type
510
501
  #
511
- # @return [Symbol, Orb::CustomerCreateParams::TaxID::Type]
502
+ # @return [Symbol, Orb::Models::CustomerCreateParams::TaxID::Type]
512
503
  required :type, enum: -> { Orb::CustomerCreateParams::TaxID::Type }
513
504
 
514
505
  # @!attribute value
@@ -623,11 +614,11 @@ module Orb
623
614
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
624
615
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
625
616
  #
626
- # @param country [Symbol, Orb::CustomerCreateParams::TaxID::Country]
627
- # @param type [Symbol, Orb::CustomerCreateParams::TaxID::Type]
617
+ # @param country [Symbol, Orb::Models::CustomerCreateParams::TaxID::Country]
618
+ # @param type [Symbol, Orb::Models::CustomerCreateParams::TaxID::Type]
628
619
  # @param value [String]
629
620
 
630
- # @see Orb::CustomerCreateParams::TaxID#country
621
+ # @see Orb::Models::CustomerCreateParams::TaxID#country
631
622
  module Country
632
623
  extend Orb::Internal::Type::Enum
633
624
 
@@ -714,7 +705,7 @@ module Orb
714
705
  # @return [Array<Symbol>]
715
706
  end
716
707
 
717
- # @see Orb::CustomerCreateParams::TaxID#type
708
+ # @see Orb::Models::CustomerCreateParams::TaxID#type
718
709
  module Type
719
710
  extend Orb::Internal::Type::Enum
720
711
 
@@ -9,7 +9,7 @@ module Orb
9
9
 
10
10
  # @!attribute accounting_sync_configuration
11
11
  #
12
- # @return [Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
12
+ # @return [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
13
13
  optional :accounting_sync_configuration,
14
14
  -> { Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration },
15
15
  nil?: true
@@ -31,7 +31,7 @@ module Orb
31
31
 
32
32
  # @!attribute billing_address
33
33
  #
34
- # @return [Orb::CustomerUpdateByExternalIDParams::BillingAddress, nil]
34
+ # @return [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
35
35
  optional :billing_address, -> { Orb::CustomerUpdateByExternalIDParams::BillingAddress }, nil?: true
36
36
 
37
37
  # @!attribute currency
@@ -62,7 +62,7 @@ module Orb
62
62
  # @!attribute hierarchy
63
63
  # The hierarchical relationships for this customer.
64
64
  #
65
- # @return [Orb::CustomerUpdateByExternalIDParams::Hierarchy, nil]
65
+ # @return [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil]
66
66
  optional :hierarchy, -> { Orb::CustomerUpdateByExternalIDParams::Hierarchy }, nil?: true
67
67
 
68
68
  # @!attribute metadata
@@ -88,7 +88,7 @@ module Orb
88
88
  # `bill.com`, `netsuite`), any product mappings must first be configured with
89
89
  # the Orb team.
90
90
  #
91
- # @return [Symbol, Orb::CustomerUpdateByExternalIDParams::PaymentProvider, nil]
91
+ # @return [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil]
92
92
  optional :payment_provider,
93
93
  enum: -> { Orb::CustomerUpdateByExternalIDParams::PaymentProvider },
94
94
  nil?: true
@@ -102,19 +102,19 @@ module Orb
102
102
 
103
103
  # @!attribute reporting_configuration
104
104
  #
105
- # @return [Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
105
+ # @return [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
106
106
  optional :reporting_configuration,
107
107
  -> { Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration },
108
108
  nil?: true
109
109
 
110
110
  # @!attribute shipping_address
111
111
  #
112
- # @return [Orb::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
112
+ # @return [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
113
113
  optional :shipping_address, -> { Orb::CustomerUpdateByExternalIDParams::ShippingAddress }, nil?: true
114
114
 
115
115
  # @!attribute tax_configuration
116
116
  #
117
- # @return [Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
117
+ # @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
118
118
  optional :tax_configuration,
119
119
  union: -> { Orb::CustomerUpdateByExternalIDParams::TaxConfiguration },
120
120
  nil?: true
@@ -226,20 +226,20 @@ module Orb
226
226
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
227
227
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
228
228
  #
229
- # @return [Orb::CustomerUpdateByExternalIDParams::TaxID, nil]
229
+ # @return [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil]
230
230
  optional :tax_id, -> { Orb::CustomerUpdateByExternalIDParams::TaxID }, nil?: true
231
231
 
232
232
  # @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
233
233
  # Some parameter documentations has been truncated, see
234
234
  # {Orb::Models::CustomerUpdateByExternalIDParams} for more details.
235
235
  #
236
- # @param accounting_sync_configuration [Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
236
+ # @param accounting_sync_configuration [Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration, nil]
237
237
  #
238
238
  # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
239
239
  #
240
240
  # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
241
241
  #
242
- # @param billing_address [Orb::CustomerUpdateByExternalIDParams::BillingAddress, nil]
242
+ # @param billing_address [Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress, nil]
243
243
  #
244
244
  # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
245
245
  #
@@ -249,30 +249,30 @@ module Orb
249
249
  #
250
250
  # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
251
251
  #
252
- # @param hierarchy [Orb::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
252
+ # @param hierarchy [Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy, nil] The hierarchical relationships for this customer.
253
253
  #
254
254
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
255
255
  #
256
256
  # @param name [String, nil] The full name of the customer
257
257
  #
258
- # @param payment_provider [Symbol, Orb::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
258
+ # @param payment_provider [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
259
259
  #
260
260
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
261
261
  #
262
- # @param reporting_configuration [Orb::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
262
+ # @param reporting_configuration [Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration, nil]
263
263
  #
264
- # @param shipping_address [Orb::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
264
+ # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
265
265
  #
266
- # @param tax_configuration [Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
266
+ # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
267
267
  #
268
- # @param tax_id [Orb::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
268
+ # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
269
269
  #
270
270
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
271
271
 
272
272
  class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
273
273
  # @!attribute accounting_providers
274
274
  #
275
- # @return [Array<Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
275
+ # @return [Array<Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
276
276
  optional :accounting_providers,
277
277
  -> {
278
278
  Orb::Internal::Type::ArrayOf[Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider]
@@ -285,7 +285,7 @@ module Orb
285
285
  optional :excluded, Orb::Internal::Type::Boolean, nil?: true
286
286
 
287
287
  # @!method initialize(accounting_providers: nil, excluded: nil)
288
- # @param accounting_providers [Array<Orb::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
288
+ # @param accounting_providers [Array<Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration::AccountingProvider>, nil]
289
289
  # @param excluded [Boolean, nil]
290
290
 
291
291
  class AccountingProvider < Orb::Internal::Type::BaseModel
@@ -362,7 +362,7 @@ module Orb
362
362
 
363
363
  # @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
364
364
  # Some parameter documentations has been truncated, see
365
- # {Orb::CustomerUpdateByExternalIDParams::Hierarchy} for more details.
365
+ # {Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy} for more details.
366
366
  #
367
367
  # The hierarchical relationships for this customer.
368
368
  #
@@ -489,27 +489,18 @@ module Orb
489
489
  end
490
490
 
491
491
  # @!method self.variants
492
- # @return [Array(Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar)]
493
-
494
- define_sorbet_constant!(:Variants) do
495
- T.type_alias do
496
- T.any(
497
- Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara,
498
- Orb::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar
499
- )
500
- end
501
- end
492
+ # @return [Array(Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar)]
502
493
  end
503
494
 
504
495
  class TaxID < Orb::Internal::Type::BaseModel
505
496
  # @!attribute country
506
497
  #
507
- # @return [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Country]
498
+ # @return [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country]
508
499
  required :country, enum: -> { Orb::CustomerUpdateByExternalIDParams::TaxID::Country }
509
500
 
510
501
  # @!attribute type
511
502
  #
512
- # @return [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Type]
503
+ # @return [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type]
513
504
  required :type, enum: -> { Orb::CustomerUpdateByExternalIDParams::TaxID::Type }
514
505
 
515
506
  # @!attribute value
@@ -624,11 +615,11 @@ module Orb
624
615
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
625
616
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
626
617
  #
627
- # @param country [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Country]
628
- # @param type [Symbol, Orb::CustomerUpdateByExternalIDParams::TaxID::Type]
618
+ # @param country [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Country]
619
+ # @param type [Symbol, Orb::Models::CustomerUpdateByExternalIDParams::TaxID::Type]
629
620
  # @param value [String]
630
621
 
631
- # @see Orb::CustomerUpdateByExternalIDParams::TaxID#country
622
+ # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#country
632
623
  module Country
633
624
  extend Orb::Internal::Type::Enum
634
625
 
@@ -715,7 +706,7 @@ module Orb
715
706
  # @return [Array<Symbol>]
716
707
  end
717
708
 
718
- # @see Orb::CustomerUpdateByExternalIDParams::TaxID#type
709
+ # @see Orb::Models::CustomerUpdateByExternalIDParams::TaxID#type
719
710
  module Type
720
711
  extend Orb::Internal::Type::Enum
721
712
 
@@ -9,7 +9,7 @@ module Orb
9
9
 
10
10
  # @!attribute accounting_sync_configuration
11
11
  #
12
- # @return [Orb::CustomerUpdateParams::AccountingSyncConfiguration, nil]
12
+ # @return [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
13
13
  optional :accounting_sync_configuration,
14
14
  -> { Orb::CustomerUpdateParams::AccountingSyncConfiguration },
15
15
  nil?: true
@@ -31,7 +31,7 @@ module Orb
31
31
 
32
32
  # @!attribute billing_address
33
33
  #
34
- # @return [Orb::CustomerUpdateParams::BillingAddress, nil]
34
+ # @return [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
35
35
  optional :billing_address, -> { Orb::CustomerUpdateParams::BillingAddress }, nil?: true
36
36
 
37
37
  # @!attribute currency
@@ -62,7 +62,7 @@ module Orb
62
62
  # @!attribute hierarchy
63
63
  # The hierarchical relationships for this customer.
64
64
  #
65
- # @return [Orb::CustomerUpdateParams::Hierarchy, nil]
65
+ # @return [Orb::Models::CustomerUpdateParams::Hierarchy, nil]
66
66
  optional :hierarchy, -> { Orb::CustomerUpdateParams::Hierarchy }, nil?: true
67
67
 
68
68
  # @!attribute metadata
@@ -88,7 +88,7 @@ module Orb
88
88
  # `bill.com`, `netsuite`), any product mappings must first be configured with
89
89
  # the Orb team.
90
90
  #
91
- # @return [Symbol, Orb::CustomerUpdateParams::PaymentProvider, nil]
91
+ # @return [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil]
92
92
  optional :payment_provider, enum: -> { Orb::CustomerUpdateParams::PaymentProvider }, nil?: true
93
93
 
94
94
  # @!attribute payment_provider_id
@@ -100,17 +100,17 @@ module Orb
100
100
 
101
101
  # @!attribute reporting_configuration
102
102
  #
103
- # @return [Orb::CustomerUpdateParams::ReportingConfiguration, nil]
103
+ # @return [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
104
104
  optional :reporting_configuration, -> { Orb::CustomerUpdateParams::ReportingConfiguration }, nil?: true
105
105
 
106
106
  # @!attribute shipping_address
107
107
  #
108
- # @return [Orb::CustomerUpdateParams::ShippingAddress, nil]
108
+ # @return [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
109
109
  optional :shipping_address, -> { Orb::CustomerUpdateParams::ShippingAddress }, nil?: true
110
110
 
111
111
  # @!attribute tax_configuration
112
112
  #
113
- # @return [Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
113
+ # @return [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
114
114
  optional :tax_configuration, union: -> { Orb::CustomerUpdateParams::TaxConfiguration }, nil?: true
115
115
 
116
116
  # @!attribute tax_id
@@ -220,20 +220,20 @@ module Orb
220
220
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
221
221
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
222
222
  #
223
- # @return [Orb::CustomerUpdateParams::TaxID, nil]
223
+ # @return [Orb::Models::CustomerUpdateParams::TaxID, nil]
224
224
  optional :tax_id, -> { Orb::CustomerUpdateParams::TaxID }, nil?: true
225
225
 
226
226
  # @!method initialize(accounting_sync_configuration: nil, additional_emails: nil, auto_collection: nil, billing_address: nil, currency: nil, email: nil, email_delivery: nil, external_customer_id: nil, hierarchy: nil, metadata: nil, name: nil, payment_provider: nil, payment_provider_id: nil, reporting_configuration: nil, shipping_address: nil, tax_configuration: nil, tax_id: nil, request_options: {})
227
227
  # Some parameter documentations has been truncated, see
228
228
  # {Orb::Models::CustomerUpdateParams} for more details.
229
229
  #
230
- # @param accounting_sync_configuration [Orb::CustomerUpdateParams::AccountingSyncConfiguration, nil]
230
+ # @param accounting_sync_configuration [Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration, nil]
231
231
  #
232
232
  # @param additional_emails [Array<String>, nil] Additional email addresses for this customer. If populated, these email addresse
233
233
  #
234
234
  # @param auto_collection [Boolean, nil] Used to determine if invoices for this customer will automatically attempt to ch
235
235
  #
236
- # @param billing_address [Orb::CustomerUpdateParams::BillingAddress, nil]
236
+ # @param billing_address [Orb::Models::CustomerUpdateParams::BillingAddress, nil]
237
237
  #
238
238
  # @param currency [String, nil] An ISO 4217 currency string used for the customer's invoices and balance. If not
239
239
  #
@@ -243,30 +243,30 @@ module Orb
243
243
  #
244
244
  # @param external_customer_id [String, nil] The external customer ID. This can only be set if empty and the customer has no
245
245
  #
246
- # @param hierarchy [Orb::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
246
+ # @param hierarchy [Orb::Models::CustomerUpdateParams::Hierarchy, nil] The hierarchical relationships for this customer.
247
247
  #
248
248
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
249
249
  #
250
250
  # @param name [String, nil] The full name of the customer
251
251
  #
252
- # @param payment_provider [Symbol, Orb::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
252
+ # @param payment_provider [Symbol, Orb::Models::CustomerUpdateParams::PaymentProvider, nil] This is used for creating charges or invoices in an external system via Orb. Whe
253
253
  #
254
254
  # @param payment_provider_id [String, nil] The ID of this customer in an external payments solution, such as Stripe. This i
255
255
  #
256
- # @param reporting_configuration [Orb::CustomerUpdateParams::ReportingConfiguration, nil]
256
+ # @param reporting_configuration [Orb::Models::CustomerUpdateParams::ReportingConfiguration, nil]
257
257
  #
258
- # @param shipping_address [Orb::CustomerUpdateParams::ShippingAddress, nil]
258
+ # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
259
259
  #
260
- # @param tax_configuration [Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
260
+ # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
261
261
  #
262
- # @param tax_id [Orb::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
262
+ # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
263
263
  #
264
264
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
265
265
 
266
266
  class AccountingSyncConfiguration < Orb::Internal::Type::BaseModel
267
267
  # @!attribute accounting_providers
268
268
  #
269
- # @return [Array<Orb::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
269
+ # @return [Array<Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
270
270
  optional :accounting_providers,
271
271
  -> {
272
272
  Orb::Internal::Type::ArrayOf[Orb::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider]
@@ -279,7 +279,7 @@ module Orb
279
279
  optional :excluded, Orb::Internal::Type::Boolean, nil?: true
280
280
 
281
281
  # @!method initialize(accounting_providers: nil, excluded: nil)
282
- # @param accounting_providers [Array<Orb::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
282
+ # @param accounting_providers [Array<Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration::AccountingProvider>, nil]
283
283
  # @param excluded [Boolean, nil]
284
284
 
285
285
  class AccountingProvider < Orb::Internal::Type::BaseModel
@@ -356,7 +356,7 @@ module Orb
356
356
 
357
357
  # @!method initialize(child_customer_ids: nil, parent_customer_id: nil)
358
358
  # Some parameter documentations has been truncated, see
359
- # {Orb::CustomerUpdateParams::Hierarchy} for more details.
359
+ # {Orb::Models::CustomerUpdateParams::Hierarchy} for more details.
360
360
  #
361
361
  # The hierarchical relationships for this customer.
362
362
  #
@@ -483,27 +483,18 @@ module Orb
483
483
  end
484
484
 
485
485
  # @!method self.variants
486
- # @return [Array(Orb::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::CustomerUpdateParams::TaxConfiguration::Taxjar)]
487
-
488
- define_sorbet_constant!(:Variants) do
489
- T.type_alias do
490
- T.any(
491
- Orb::CustomerUpdateParams::TaxConfiguration::Avalara,
492
- Orb::CustomerUpdateParams::TaxConfiguration::Taxjar
493
- )
494
- end
495
- end
486
+ # @return [Array(Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar)]
496
487
  end
497
488
 
498
489
  class TaxID < Orb::Internal::Type::BaseModel
499
490
  # @!attribute country
500
491
  #
501
- # @return [Symbol, Orb::CustomerUpdateParams::TaxID::Country]
492
+ # @return [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country]
502
493
  required :country, enum: -> { Orb::CustomerUpdateParams::TaxID::Country }
503
494
 
504
495
  # @!attribute type
505
496
  #
506
- # @return [Symbol, Orb::CustomerUpdateParams::TaxID::Type]
497
+ # @return [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type]
507
498
  required :type, enum: -> { Orb::CustomerUpdateParams::TaxID::Type }
508
499
 
509
500
  # @!attribute value
@@ -618,11 +609,11 @@ module Orb
618
609
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
619
610
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
620
611
  #
621
- # @param country [Symbol, Orb::CustomerUpdateParams::TaxID::Country]
622
- # @param type [Symbol, Orb::CustomerUpdateParams::TaxID::Type]
612
+ # @param country [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Country]
613
+ # @param type [Symbol, Orb::Models::CustomerUpdateParams::TaxID::Type]
623
614
  # @param value [String]
624
615
 
625
- # @see Orb::CustomerUpdateParams::TaxID#country
616
+ # @see Orb::Models::CustomerUpdateParams::TaxID#country
626
617
  module Country
627
618
  extend Orb::Internal::Type::Enum
628
619
 
@@ -709,7 +700,7 @@ module Orb
709
700
  # @return [Array<Symbol>]
710
701
  end
711
702
 
712
- # @see Orb::CustomerUpdateParams::TaxID#type
703
+ # @see Orb::Models::CustomerUpdateParams::TaxID#type
713
704
  module Type
714
705
  extend Orb::Internal::Type::Enum
715
706
 
@@ -15,7 +15,7 @@ module Orb
15
15
 
16
16
  # @!attribute type
17
17
  #
18
- # @return [Symbol, Orb::Customers::BalanceTransactionCreateParams::Type]
18
+ # @return [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
19
19
  required :type, enum: -> { Orb::Customers::BalanceTransactionCreateParams::Type }
20
20
 
21
21
  # @!attribute description
@@ -27,7 +27,7 @@ module Orb
27
27
  # @!method initialize(amount:, type:, description: nil, request_options: {})
28
28
  # @param amount [String]
29
29
  #
30
- # @param type [Symbol, Orb::Customers::BalanceTransactionCreateParams::Type]
30
+ # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
31
31
  #
32
32
  # @param description [String, nil] An optional description that can be specified around this entry.
33
33
  #
@@ -32,7 +32,7 @@ module Orb
32
32
  # discounts, it's strongly recommended that you use the default cumulative
33
33
  # behavior.
34
34
  #
35
- # @return [Symbol, Orb::Customers::CostListByExternalIDParams::ViewMode, nil]
35
+ # @return [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
36
36
  optional :view_mode, enum: -> { Orb::Customers::CostListByExternalIDParams::ViewMode }, nil?: true
37
37
 
38
38
  # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
@@ -45,7 +45,7 @@ module Orb
45
45
  #
46
46
  # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
47
47
  #
48
- # @param view_mode [Symbol, Orb::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
48
+ # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
49
49
  #
50
50
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
51
51
 
@@ -58,7 +58,7 @@ module Orb
58
58
  # @!attribute price
59
59
  # The price object
60
60
  #
61
- # @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
61
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
62
62
  required :price, union: -> { Orb::Price }
63
63
 
64
64
  # @!attribute price_id
@@ -86,7 +86,7 @@ module Orb
86
86
  optional :quantity, Float, nil?: true
87
87
 
88
88
  # @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
89
- # @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The price object
89
+ # @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The price object
90
90
  #
91
91
  # @param price_id [String] The price the cost is associated with
92
92
  #
@@ -32,7 +32,7 @@ module Orb
32
32
  # discounts, it's strongly recommended that you use the default cumulative
33
33
  # behavior.
34
34
  #
35
- # @return [Symbol, Orb::Customers::CostListParams::ViewMode, nil]
35
+ # @return [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
36
36
  optional :view_mode, enum: -> { Orb::Customers::CostListParams::ViewMode }, nil?: true
37
37
 
38
38
  # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
@@ -45,7 +45,7 @@ module Orb
45
45
  #
46
46
  # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
47
47
  #
48
- # @param view_mode [Symbol, Orb::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
48
+ # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
49
49
  #
50
50
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
51
51