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

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 (409) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +10 -2
  3. data/lib/orb/client.rb +4 -0
  4. data/lib/orb/internal/transport/base_client.rb +2 -2
  5. data/lib/orb/internal/transport/pooled_net_requester.rb +15 -6
  6. data/lib/orb/internal/type/array_of.rb +12 -2
  7. data/lib/orb/internal/type/base_model.rb +23 -22
  8. data/lib/orb/internal/type/boolean.rb +5 -1
  9. data/lib/orb/internal/type/converter.rb +62 -39
  10. data/lib/orb/internal/type/enum.rb +13 -9
  11. data/lib/orb/internal/type/hash_of.rb +6 -2
  12. data/lib/orb/internal/type/io_like.rb +75 -0
  13. data/lib/orb/internal/type/request_parameters.rb +11 -2
  14. data/lib/orb/internal/type/union.rb +7 -3
  15. data/lib/orb/internal/type/unknown.rb +5 -1
  16. data/lib/orb/internal/util.rb +81 -26
  17. data/lib/orb/models/alert.rb +9 -9
  18. data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
  19. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
  20. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
  21. data/lib/orb/models/alert_list_params.rb +5 -5
  22. data/lib/orb/models/alert_update_params.rb +3 -3
  23. data/lib/orb/models/amount_discount.rb +1 -1
  24. data/lib/orb/models/billable_metric.rb +7 -7
  25. data/lib/orb/models/coupon.rb +7 -7
  26. data/lib/orb/models/coupon_create_params.rb +2 -2
  27. data/lib/orb/models/coupon_list_params.rb +2 -2
  28. data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
  29. data/lib/orb/models/credit_note.rb +1 -1
  30. data/lib/orb/models/credit_note_list_params.rb +5 -5
  31. data/lib/orb/models/customer.rb +232 -232
  32. data/lib/orb/models/customer_create_params.rb +223 -223
  33. data/lib/orb/models/customer_list_params.rb +5 -5
  34. data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
  35. data/lib/orb/models/customer_update_params.rb +224 -224
  36. data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
  37. data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
  38. data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
  39. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
  40. data/lib/orb/models/customers/cost_list_params.rb +6 -6
  41. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
  42. data/lib/orb/models/customers/credit_list_params.rb +2 -2
  43. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
  44. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
  45. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
  46. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
  47. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
  48. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
  49. data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
  50. data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
  51. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
  52. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
  53. data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
  54. data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
  55. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
  56. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
  57. data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
  58. data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
  59. data/lib/orb/models/dimensional_price_group.rb +7 -7
  60. data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
  61. data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
  62. data/lib/orb/models/event_ingest_params.rb +7 -7
  63. data/lib/orb/models/event_ingest_response.rb +4 -4
  64. data/lib/orb/models/event_search_params.rb +5 -5
  65. data/lib/orb/models/event_search_response.rb +8 -8
  66. data/lib/orb/models/event_update_params.rb +4 -4
  67. data/lib/orb/models/events/backfill_close_response.rb +7 -7
  68. data/lib/orb/models/events/backfill_create_params.rb +11 -11
  69. data/lib/orb/models/events/backfill_create_response.rb +7 -7
  70. data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
  71. data/lib/orb/models/events/backfill_list_params.rb +1 -1
  72. data/lib/orb/models/events/backfill_list_response.rb +7 -7
  73. data/lib/orb/models/events/backfill_revert_response.rb +7 -7
  74. data/lib/orb/models/events/event_volumes.rb +1 -1
  75. data/lib/orb/models/events/volume_list_params.rb +7 -7
  76. data/lib/orb/models/invoice.rb +270 -270
  77. data/lib/orb/models/invoice_create_params.rb +12 -11
  78. data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
  79. data/lib/orb/models/invoice_issue_params.rb +4 -4
  80. data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
  81. data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
  82. data/lib/orb/models/invoice_list_params.rb +12 -12
  83. data/lib/orb/models/invoice_update_params.rb +2 -2
  84. data/lib/orb/models/item.rb +2 -2
  85. data/lib/orb/models/item_list_params.rb +1 -1
  86. data/lib/orb/models/metric_create_params.rb +2 -2
  87. data/lib/orb/models/metric_list_params.rb +5 -5
  88. data/lib/orb/models/metric_update_params.rb +2 -2
  89. data/lib/orb/models/percentage_discount.rb +2 -2
  90. data/lib/orb/models/plan.rb +35 -35
  91. data/lib/orb/models/plan_create_params.rb +267 -267
  92. data/lib/orb/models/plan_list_params.rb +5 -5
  93. data/lib/orb/models/plan_update_params.rb +4 -4
  94. data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
  95. data/lib/orb/models/price.rb +158 -158
  96. data/lib/orb/models/price_create_params.rb +20 -20
  97. data/lib/orb/models/price_evaluate_params.rb +4 -4
  98. data/lib/orb/models/price_list_params.rb +1 -1
  99. data/lib/orb/models/price_update_params.rb +2 -2
  100. data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
  101. data/lib/orb/models/subscription.rb +114 -87
  102. data/lib/orb/models/subscription_cancel_params.rb +3 -3
  103. data/lib/orb/models/subscription_cancel_response.rb +150 -72
  104. data/lib/orb/models/subscription_change_apply_params.rb +33 -0
  105. data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
  106. data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
  107. data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
  108. data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
  109. data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
  110. data/lib/orb/models/subscription_create_params.rb +641 -641
  111. data/lib/orb/models/subscription_create_response.rb +150 -72
  112. data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
  113. data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
  114. data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
  115. data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
  116. data/lib/orb/models/subscription_list_params.rb +5 -5
  117. data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
  118. data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
  119. data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
  120. data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
  121. data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
  122. data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
  123. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
  124. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
  125. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
  126. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
  127. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
  128. data/lib/orb/models/subscription_update_params.rb +10 -10
  129. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  130. data/lib/orb/models/subscription_update_trial_response.rb +152 -72
  131. data/lib/orb/models/trial_discount.rb +1 -1
  132. data/lib/orb/models/usage_discount.rb +2 -2
  133. data/lib/orb/request_options.rb +7 -7
  134. data/lib/orb/resources/alerts.rb +38 -38
  135. data/lib/orb/resources/coupons/subscriptions.rb +3 -3
  136. data/lib/orb/resources/coupons.rb +9 -9
  137. data/lib/orb/resources/credit_notes.rb +8 -8
  138. data/lib/orb/resources/customers/balance_transactions.rb +26 -26
  139. data/lib/orb/resources/customers/costs.rb +232 -232
  140. data/lib/orb/resources/customers/credits/ledger.rb +344 -344
  141. data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
  142. data/lib/orb/resources/customers/credits.rb +8 -8
  143. data/lib/orb/resources/customers.rb +59 -59
  144. data/lib/orb/resources/dimensional_price_groups.rb +6 -6
  145. data/lib/orb/resources/events/backfills.rb +49 -49
  146. data/lib/orb/resources/events/volume.rb +10 -10
  147. data/lib/orb/resources/events.rb +295 -295
  148. data/lib/orb/resources/invoice_line_items.rb +1 -1
  149. data/lib/orb/resources/invoices.rb +38 -38
  150. data/lib/orb/resources/items.rb +1 -1
  151. data/lib/orb/resources/metrics.rb +11 -11
  152. data/lib/orb/resources/plans/external_plan_id.rb +14 -14
  153. data/lib/orb/resources/plans.rb +22 -22
  154. data/lib/orb/resources/prices/external_price_id.rb +4 -4
  155. data/lib/orb/resources/prices.rb +30 -30
  156. data/lib/orb/resources/subscription_changes.rb +87 -0
  157. data/lib/orb/resources/subscriptions.rb +813 -813
  158. data/lib/orb/resources/top_level.rb +4 -4
  159. data/lib/orb/version.rb +1 -1
  160. data/lib/orb.rb +8 -0
  161. data/rbi/lib/orb/client.rbi +5 -4
  162. data/rbi/lib/orb/errors.rbi +3 -6
  163. data/rbi/lib/orb/internal/page.rbi +3 -6
  164. data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
  165. data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +8 -14
  166. data/rbi/lib/orb/internal/type/array_of.rbi +14 -18
  167. data/rbi/lib/orb/internal/type/base_model.rbi +51 -66
  168. data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
  169. data/rbi/lib/orb/internal/type/boolean.rbi +12 -10
  170. data/rbi/lib/orb/internal/type/converter.rbi +44 -37
  171. data/rbi/lib/orb/internal/type/enum.rbi +24 -21
  172. data/rbi/lib/orb/internal/type/hash_of.rbi +13 -18
  173. data/rbi/lib/orb/internal/type/io_like.rbi +49 -0
  174. data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
  175. data/rbi/lib/orb/internal/type/union.rbi +19 -21
  176. data/rbi/lib/orb/internal/type/unknown.rbi +10 -9
  177. data/rbi/lib/orb/internal/util.rbi +67 -70
  178. data/rbi/lib/orb/internal.rbi +1 -1
  179. data/rbi/lib/orb/models/alert.rbi +21 -33
  180. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
  181. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
  182. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
  183. data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
  184. data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
  185. data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
  186. data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
  187. data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
  188. data/rbi/lib/orb/models/amount_discount.rbi +4 -7
  189. data/rbi/lib/orb/models/billable_metric.rbi +10 -13
  190. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
  191. data/rbi/lib/orb/models/coupon.rbi +9 -11
  192. data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
  193. data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
  194. data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
  195. data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
  196. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
  197. data/rbi/lib/orb/models/credit_note.rbi +22 -45
  198. data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
  199. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
  200. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
  201. data/rbi/lib/orb/models/customer.rbi +256 -281
  202. data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
  203. data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
  204. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
  205. data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
  206. data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
  207. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
  208. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
  209. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
  210. data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
  211. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
  212. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
  213. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
  214. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
  215. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
  216. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
  217. data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
  218. data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
  219. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
  220. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
  221. data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
  222. data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
  223. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
  224. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
  225. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
  226. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
  227. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
  228. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
  229. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
  230. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
  231. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
  232. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
  233. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
  234. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
  235. data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
  236. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
  237. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
  238. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
  239. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
  240. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
  241. data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
  242. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
  243. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
  244. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
  245. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
  246. data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
  247. data/rbi/lib/orb/models/discount.rbi +1 -2
  248. data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
  249. data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
  250. data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
  251. data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
  252. data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
  253. data/rbi/lib/orb/models/event_search_params.rbi +7 -9
  254. data/rbi/lib/orb/models/event_search_response.rbi +11 -14
  255. data/rbi/lib/orb/models/event_update_params.rbi +5 -6
  256. data/rbi/lib/orb/models/event_update_response.rbi +2 -4
  257. data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
  258. data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
  259. data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
  260. data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
  261. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
  262. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
  263. data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
  264. data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
  265. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
  266. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
  267. data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
  268. data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
  269. data/rbi/lib/orb/models/invoice.rbi +388 -465
  270. data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
  271. data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
  272. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
  273. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
  274. data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
  275. data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
  276. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
  277. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
  278. data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
  279. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
  280. data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
  281. data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
  282. data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
  283. data/rbi/lib/orb/models/item.rbi +7 -12
  284. data/rbi/lib/orb/models/item_create_params.rbi +2 -4
  285. data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
  286. data/rbi/lib/orb/models/item_list_params.rbi +3 -5
  287. data/rbi/lib/orb/models/item_update_params.rbi +5 -10
  288. data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
  289. data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
  290. data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
  291. data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
  292. data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
  293. data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
  294. data/rbi/lib/orb/models/plan.rbi +180 -219
  295. data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
  296. data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
  297. data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
  298. data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
  299. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
  300. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
  301. data/rbi/lib/orb/models/price.rbi +827 -1494
  302. data/rbi/lib/orb/models/price_create_params.rbi +60 -101
  303. data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
  304. data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
  305. data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
  306. data/rbi/lib/orb/models/price_list_params.rbi +3 -5
  307. data/rbi/lib/orb/models/price_update_params.rbi +4 -6
  308. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
  309. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
  310. data/rbi/lib/orb/models/subscription.rbi +167 -187
  311. data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
  312. data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
  313. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
  314. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
  315. data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
  316. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
  317. data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
  318. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
  319. data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
  320. data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
  321. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
  322. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
  323. data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
  324. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
  325. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
  326. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
  327. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
  328. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
  329. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
  330. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
  331. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
  332. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
  333. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
  334. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
  335. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
  336. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
  337. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
  338. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
  339. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
  340. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
  341. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
  342. data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
  343. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
  344. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
  345. data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
  346. data/rbi/lib/orb/models/subscriptions.rbi +2 -4
  347. data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
  348. data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
  349. data/rbi/lib/orb/models/trial_discount.rbi +4 -8
  350. data/rbi/lib/orb/models/usage_discount.rbi +5 -8
  351. data/rbi/lib/orb/request_options.rbi +9 -11
  352. data/rbi/lib/orb/resources/alerts.rbi +44 -60
  353. data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
  354. data/rbi/lib/orb/resources/coupons.rbi +18 -25
  355. data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
  356. data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
  357. data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
  358. data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
  359. data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
  360. data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
  361. data/rbi/lib/orb/resources/customers.rbi +407 -417
  362. data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
  363. data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
  364. data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
  365. data/rbi/lib/orb/resources/events/volume.rbi +19 -22
  366. data/rbi/lib/orb/resources/events.rbi +311 -319
  367. data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
  368. data/rbi/lib/orb/resources/invoices.rbi +62 -76
  369. data/rbi/lib/orb/resources/items.rbi +7 -14
  370. data/rbi/lib/orb/resources/metrics.rbi +17 -25
  371. data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
  372. data/rbi/lib/orb/resources/plans.rbi +63 -71
  373. data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
  374. data/rbi/lib/orb/resources/prices.rbi +77 -87
  375. data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
  376. data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
  377. data/rbi/lib/orb/resources/top_level.rbi +6 -8
  378. data/sig/orb/client.rbs +2 -0
  379. data/sig/orb/internal/transport/pooled_net_requester.rbs +1 -1
  380. data/sig/orb/internal/type/array_of.rbs +5 -2
  381. data/sig/orb/internal/type/base_model.rbs +5 -2
  382. data/sig/orb/internal/type/boolean.rbs +5 -2
  383. data/sig/orb/internal/type/converter.rbs +11 -5
  384. data/sig/orb/internal/type/enum.rbs +5 -2
  385. data/sig/orb/internal/type/hash_of.rbs +5 -2
  386. data/sig/orb/internal/type/io_like.rbs +23 -0
  387. data/sig/orb/internal/type/union.rbs +5 -2
  388. data/sig/orb/internal/type/unknown.rbs +5 -2
  389. data/sig/orb/internal/util.rbs +17 -2
  390. data/sig/orb/models/subscription.rbs +14 -0
  391. data/sig/orb/models/subscription_cancel_response.rbs +47 -2
  392. data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
  393. data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
  394. data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
  395. data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
  396. data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
  397. data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
  398. data/sig/orb/models/subscription_create_response.rbs +47 -2
  399. data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
  400. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
  401. data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
  402. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
  403. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
  404. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
  405. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
  406. data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
  407. data/sig/orb/resources/customers.rbs +2 -2
  408. data/sig/orb/resources/subscription_changes.rbs +24 -0
  409. metadata +28 -4
@@ -7,17 +7,17 @@ module Orb
7
7
  attr_accessor :id
8
8
 
9
9
  # Adjustments for this plan. If the plan has phases, this includes adjustments
10
- # across all phases of the plan.
10
+ # across all phases of the plan.
11
11
  sig do
12
12
  returns(
13
13
  T::Array[
14
- T.any(
15
- Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment,
16
- Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment,
17
- Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment,
18
- Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment,
19
- Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment
20
- )
14
+ T.any(
15
+ Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment,
16
+ Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment,
17
+ Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment,
18
+ Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment,
19
+ Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment
20
+ )
21
21
  ]
22
22
  )
23
23
  end
@@ -30,7 +30,7 @@ module Orb
30
30
  attr_writer :base_plan
31
31
 
32
32
  # The parent plan id if the given plan was created by overriding one or more of
33
- # the parent's prices
33
+ # the parent's prices
34
34
  sig { returns(T.nilable(String)) }
35
35
  attr_accessor :base_plan_id
36
36
 
@@ -38,12 +38,12 @@ module Orb
38
38
  attr_accessor :created_at
39
39
 
40
40
  # An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
41
- # prices.
41
+ # prices.
42
42
  sig { returns(String) }
43
43
  attr_accessor :currency
44
44
 
45
45
  # The default memo text on the invoices corresponding to subscriptions on this
46
- # plan. Note that each subscription may configure its own memo.
46
+ # plan. Note that each subscription may configure its own memo.
47
47
  sig { returns(T.nilable(String)) }
48
48
  attr_accessor :default_invoice_memo
49
49
 
@@ -65,13 +65,13 @@ module Orb
65
65
  attr_accessor :discount
66
66
 
67
67
  # An optional user-defined ID for this plan resource, used throughout the system
68
- # as an alias for this Plan. Use this field to identify a plan by an existing
69
- # identifier in your system.
68
+ # as an alias for this Plan. Use this field to identify a plan by an existing
69
+ # identifier in your system.
70
70
  sig { returns(T.nilable(String)) }
71
71
  attr_accessor :external_plan_id
72
72
 
73
73
  # An ISO 4217 currency string for which this plan is billed in. Matches `currency`
74
- # unless `currency` is a custom pricing unit.
74
+ # unless `currency` is a custom pricing unit.
75
75
  sig { returns(String) }
76
76
  attr_accessor :invoicing_currency
77
77
 
@@ -85,9 +85,9 @@ module Orb
85
85
  attr_accessor :maximum_amount
86
86
 
87
87
  # User specified key-value pairs for the resource. If not present, this defaults
88
- # to an empty dictionary. Individual keys can be removed by setting the value to
89
- # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
90
- # `null`.
88
+ # to an empty dictionary. Individual keys can be removed by setting the value to
89
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
90
+ # `null`.
91
91
  sig { returns(T::Hash[Symbol, String]) }
92
92
  attr_accessor :metadata
93
93
 
@@ -104,10 +104,10 @@ module Orb
104
104
  attr_accessor :name
105
105
 
106
106
  # Determines the difference between the invoice issue date and the due date. A
107
- # value of "0" here signifies that invoices are due on issue, whereas a value of
108
- # "30" means that the customer has a month to pay the invoice before its overdue.
109
- # Note that individual subscriptions or invoices may set a different net terms
110
- # configuration.
107
+ # value of "0" here signifies that invoices are due on issue, whereas a value of
108
+ # "30" means that the customer has a month to pay the invoice before its overdue.
109
+ # Note that individual subscriptions or invoices may set a different net terms
110
+ # configuration.
111
111
  sig { returns(T.nilable(Integer)) }
112
112
  attr_accessor :net_terms
113
113
 
@@ -115,40 +115,40 @@ module Orb
115
115
  attr_accessor :plan_phases
116
116
 
117
117
  # Prices for this plan. If the plan has phases, this includes prices across all
118
- # phases of the plan.
118
+ # phases of the plan.
119
119
  sig do
120
120
  returns(
121
121
  T::Array[
122
- T.any(
123
- Orb::Models::Price::UnitPrice,
124
- Orb::Models::Price::PackagePrice,
125
- Orb::Models::Price::MatrixPrice,
126
- Orb::Models::Price::TieredPrice,
127
- Orb::Models::Price::TieredBpsPrice,
128
- Orb::Models::Price::BpsPrice,
129
- Orb::Models::Price::BulkBpsPrice,
130
- Orb::Models::Price::BulkPrice,
131
- Orb::Models::Price::ThresholdTotalAmountPrice,
132
- Orb::Models::Price::TieredPackagePrice,
133
- Orb::Models::Price::GroupedTieredPrice,
134
- Orb::Models::Price::TieredWithMinimumPrice,
135
- Orb::Models::Price::TieredPackageWithMinimumPrice,
136
- Orb::Models::Price::PackageWithAllocationPrice,
137
- Orb::Models::Price::UnitWithPercentPrice,
138
- Orb::Models::Price::MatrixWithAllocationPrice,
139
- Orb::Models::Price::TieredWithProrationPrice,
140
- Orb::Models::Price::UnitWithProrationPrice,
141
- Orb::Models::Price::GroupedAllocationPrice,
142
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
143
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
144
- Orb::Models::Price::MatrixWithDisplayNamePrice,
145
- Orb::Models::Price::BulkWithProrationPrice,
146
- Orb::Models::Price::GroupedTieredPackagePrice,
147
- Orb::Models::Price::MaxGroupTieredPackagePrice,
148
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
149
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
150
- Orb::Models::Price::CumulativeGroupedBulkPrice
151
- )
122
+ T.any(
123
+ Orb::Models::Price::UnitPrice,
124
+ Orb::Models::Price::PackagePrice,
125
+ Orb::Models::Price::MatrixPrice,
126
+ Orb::Models::Price::TieredPrice,
127
+ Orb::Models::Price::TieredBpsPrice,
128
+ Orb::Models::Price::BpsPrice,
129
+ Orb::Models::Price::BulkBpsPrice,
130
+ Orb::Models::Price::BulkPrice,
131
+ Orb::Models::Price::ThresholdTotalAmountPrice,
132
+ Orb::Models::Price::TieredPackagePrice,
133
+ Orb::Models::Price::GroupedTieredPrice,
134
+ Orb::Models::Price::TieredWithMinimumPrice,
135
+ Orb::Models::Price::TieredPackageWithMinimumPrice,
136
+ Orb::Models::Price::PackageWithAllocationPrice,
137
+ Orb::Models::Price::UnitWithPercentPrice,
138
+ Orb::Models::Price::MatrixWithAllocationPrice,
139
+ Orb::Models::Price::TieredWithProrationPrice,
140
+ Orb::Models::Price::UnitWithProrationPrice,
141
+ Orb::Models::Price::GroupedAllocationPrice,
142
+ Orb::Models::Price::GroupedWithProratedMinimumPrice,
143
+ Orb::Models::Price::GroupedWithMeteredMinimumPrice,
144
+ Orb::Models::Price::MatrixWithDisplayNamePrice,
145
+ Orb::Models::Price::BulkWithProrationPrice,
146
+ Orb::Models::Price::GroupedTieredPackagePrice,
147
+ Orb::Models::Price::MaxGroupTieredPackagePrice,
148
+ Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
149
+ Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
150
+ Orb::Models::Price::CumulativeGroupedBulkPrice
151
+ )
152
152
  ]
153
153
  )
154
154
  end
@@ -173,21 +173,21 @@ module Orb
173
173
  attr_accessor :version
174
174
 
175
175
  # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
176
- # subscribed to by a customer. Plans define the billing behavior of the
177
- # subscription. You can see more about how to configure prices in the
178
- # [Price resource](/reference/price).
176
+ # subscribed to by a customer. Plans define the billing behavior of the
177
+ # subscription. You can see more about how to configure prices in the
178
+ # [Price resource](/reference/price).
179
179
  sig do
180
180
  params(
181
181
  id: String,
182
182
  adjustments: T::Array[
183
- T.any(
184
- Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment,
185
- Orb::Internal::AnyHash,
186
- Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment,
187
- Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment,
188
- Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment,
189
- Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment
190
- )
183
+ T.any(
184
+ Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment,
185
+ Orb::Internal::AnyHash,
186
+ Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment,
187
+ Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment,
188
+ Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment,
189
+ Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment
190
+ )
191
191
  ],
192
192
  base_plan: T.nilable(T.any(Orb::Models::Plan::BasePlan, Orb::Internal::AnyHash)),
193
193
  base_plan_id: T.nilable(String),
@@ -215,37 +215,37 @@ module Orb
215
215
  net_terms: T.nilable(Integer),
216
216
  plan_phases: T.nilable(T::Array[T.any(Orb::Models::Plan::PlanPhase, Orb::Internal::AnyHash)]),
217
217
  prices: T::Array[
218
- T.any(
219
- Orb::Models::Price::UnitPrice,
220
- Orb::Internal::AnyHash,
221
- Orb::Models::Price::PackagePrice,
222
- Orb::Models::Price::MatrixPrice,
223
- Orb::Models::Price::TieredPrice,
224
- Orb::Models::Price::TieredBpsPrice,
225
- Orb::Models::Price::BpsPrice,
226
- Orb::Models::Price::BulkBpsPrice,
227
- Orb::Models::Price::BulkPrice,
228
- Orb::Models::Price::ThresholdTotalAmountPrice,
229
- Orb::Models::Price::TieredPackagePrice,
230
- Orb::Models::Price::GroupedTieredPrice,
231
- Orb::Models::Price::TieredWithMinimumPrice,
232
- Orb::Models::Price::TieredPackageWithMinimumPrice,
233
- Orb::Models::Price::PackageWithAllocationPrice,
234
- Orb::Models::Price::UnitWithPercentPrice,
235
- Orb::Models::Price::MatrixWithAllocationPrice,
236
- Orb::Models::Price::TieredWithProrationPrice,
237
- Orb::Models::Price::UnitWithProrationPrice,
238
- Orb::Models::Price::GroupedAllocationPrice,
239
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
240
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
241
- Orb::Models::Price::MatrixWithDisplayNamePrice,
242
- Orb::Models::Price::BulkWithProrationPrice,
243
- Orb::Models::Price::GroupedTieredPackagePrice,
244
- Orb::Models::Price::MaxGroupTieredPackagePrice,
245
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
246
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
247
- Orb::Models::Price::CumulativeGroupedBulkPrice
248
- )
218
+ T.any(
219
+ Orb::Models::Price::UnitPrice,
220
+ Orb::Internal::AnyHash,
221
+ Orb::Models::Price::PackagePrice,
222
+ Orb::Models::Price::MatrixPrice,
223
+ Orb::Models::Price::TieredPrice,
224
+ Orb::Models::Price::TieredBpsPrice,
225
+ Orb::Models::Price::BpsPrice,
226
+ Orb::Models::Price::BulkBpsPrice,
227
+ Orb::Models::Price::BulkPrice,
228
+ Orb::Models::Price::ThresholdTotalAmountPrice,
229
+ Orb::Models::Price::TieredPackagePrice,
230
+ Orb::Models::Price::GroupedTieredPrice,
231
+ Orb::Models::Price::TieredWithMinimumPrice,
232
+ Orb::Models::Price::TieredPackageWithMinimumPrice,
233
+ Orb::Models::Price::PackageWithAllocationPrice,
234
+ Orb::Models::Price::UnitWithPercentPrice,
235
+ Orb::Models::Price::MatrixWithAllocationPrice,
236
+ Orb::Models::Price::TieredWithProrationPrice,
237
+ Orb::Models::Price::UnitWithProrationPrice,
238
+ Orb::Models::Price::GroupedAllocationPrice,
239
+ Orb::Models::Price::GroupedWithProratedMinimumPrice,
240
+ Orb::Models::Price::GroupedWithMeteredMinimumPrice,
241
+ Orb::Models::Price::MatrixWithDisplayNamePrice,
242
+ Orb::Models::Price::BulkWithProrationPrice,
243
+ Orb::Models::Price::GroupedTieredPackagePrice,
244
+ Orb::Models::Price::MaxGroupTieredPackagePrice,
245
+ Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
246
+ Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
247
+ Orb::Models::Price::CumulativeGroupedBulkPrice
248
+ )
249
249
  ],
250
250
  product: T.any(Orb::Models::Plan::Product, Orb::Internal::AnyHash),
251
251
  status: Orb::Models::Plan::Status::OrSymbol,
@@ -279,22 +279,20 @@ module Orb
279
279
  status:,
280
280
  trial_config:,
281
281
  version:
282
- )
283
- end
284
-
282
+ ); end
285
283
  sig do
286
284
  override
287
285
  .returns(
288
286
  {
289
287
  id: String,
290
288
  adjustments: T::Array[
291
- T.any(
292
- Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment,
293
- Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment,
294
- Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment,
295
- Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment,
296
- Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment
297
- )
289
+ T.any(
290
+ Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment,
291
+ Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment,
292
+ Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment,
293
+ Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment,
294
+ Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment
295
+ )
298
296
  ],
299
297
  base_plan: T.nilable(Orb::Models::Plan::BasePlan),
300
298
  base_plan_id: T.nilable(String),
@@ -321,36 +319,36 @@ module Orb
321
319
  net_terms: T.nilable(Integer),
322
320
  plan_phases: T.nilable(T::Array[Orb::Models::Plan::PlanPhase]),
323
321
  prices: T::Array[
324
- T.any(
325
- Orb::Models::Price::UnitPrice,
326
- Orb::Models::Price::PackagePrice,
327
- Orb::Models::Price::MatrixPrice,
328
- Orb::Models::Price::TieredPrice,
329
- Orb::Models::Price::TieredBpsPrice,
330
- Orb::Models::Price::BpsPrice,
331
- Orb::Models::Price::BulkBpsPrice,
332
- Orb::Models::Price::BulkPrice,
333
- Orb::Models::Price::ThresholdTotalAmountPrice,
334
- Orb::Models::Price::TieredPackagePrice,
335
- Orb::Models::Price::GroupedTieredPrice,
336
- Orb::Models::Price::TieredWithMinimumPrice,
337
- Orb::Models::Price::TieredPackageWithMinimumPrice,
338
- Orb::Models::Price::PackageWithAllocationPrice,
339
- Orb::Models::Price::UnitWithPercentPrice,
340
- Orb::Models::Price::MatrixWithAllocationPrice,
341
- Orb::Models::Price::TieredWithProrationPrice,
342
- Orb::Models::Price::UnitWithProrationPrice,
343
- Orb::Models::Price::GroupedAllocationPrice,
344
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
345
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
346
- Orb::Models::Price::MatrixWithDisplayNamePrice,
347
- Orb::Models::Price::BulkWithProrationPrice,
348
- Orb::Models::Price::GroupedTieredPackagePrice,
349
- Orb::Models::Price::MaxGroupTieredPackagePrice,
350
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
351
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
352
- Orb::Models::Price::CumulativeGroupedBulkPrice
353
- )
322
+ T.any(
323
+ Orb::Models::Price::UnitPrice,
324
+ Orb::Models::Price::PackagePrice,
325
+ Orb::Models::Price::MatrixPrice,
326
+ Orb::Models::Price::TieredPrice,
327
+ Orb::Models::Price::TieredBpsPrice,
328
+ Orb::Models::Price::BpsPrice,
329
+ Orb::Models::Price::BulkBpsPrice,
330
+ Orb::Models::Price::BulkPrice,
331
+ Orb::Models::Price::ThresholdTotalAmountPrice,
332
+ Orb::Models::Price::TieredPackagePrice,
333
+ Orb::Models::Price::GroupedTieredPrice,
334
+ Orb::Models::Price::TieredWithMinimumPrice,
335
+ Orb::Models::Price::TieredPackageWithMinimumPrice,
336
+ Orb::Models::Price::PackageWithAllocationPrice,
337
+ Orb::Models::Price::UnitWithPercentPrice,
338
+ Orb::Models::Price::MatrixWithAllocationPrice,
339
+ Orb::Models::Price::TieredWithProrationPrice,
340
+ Orb::Models::Price::UnitWithProrationPrice,
341
+ Orb::Models::Price::GroupedAllocationPrice,
342
+ Orb::Models::Price::GroupedWithProratedMinimumPrice,
343
+ Orb::Models::Price::GroupedWithMeteredMinimumPrice,
344
+ Orb::Models::Price::MatrixWithDisplayNamePrice,
345
+ Orb::Models::Price::BulkWithProrationPrice,
346
+ Orb::Models::Price::GroupedTieredPackagePrice,
347
+ Orb::Models::Price::MaxGroupTieredPackagePrice,
348
+ Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
349
+ Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
350
+ Orb::Models::Price::CumulativeGroupedBulkPrice
351
+ )
354
352
  ],
355
353
  product: Orb::Models::Plan::Product,
356
354
  status: Orb::Models::Plan::Status::TaggedSymbol,
@@ -359,8 +357,7 @@ module Orb
359
357
  }
360
358
  )
361
359
  end
362
- def to_hash
363
- end
360
+ def to_hash; end
364
361
 
365
362
  module Adjustment
366
363
  extend Orb::Internal::Type::Union
@@ -377,7 +374,7 @@ module Orb
377
374
  attr_accessor :applies_to_price_ids
378
375
 
379
376
  # True for adjustments that apply to an entire invocice, false for adjustments
380
- # that apply to only one price.
377
+ # that apply to only one price.
381
378
  sig { returns(T::Boolean) }
382
379
  attr_accessor :is_invoice_level
383
380
 
@@ -390,7 +387,7 @@ module Orb
390
387
  attr_accessor :reason
391
388
 
392
389
  # The number of usage units by which to discount the price this adjustment applies
393
- # to in a given billing period.
390
+ # to in a given billing period.
394
391
  sig { returns(Float) }
395
392
  attr_accessor :usage_discount
396
393
 
@@ -414,9 +411,7 @@ module Orb
414
411
  reason:,
415
412
  usage_discount:,
416
413
  adjustment_type: :usage_discount
417
- )
418
- end
419
-
414
+ ); end
420
415
  sig do
421
416
  override
422
417
  .returns(
@@ -431,8 +426,7 @@ module Orb
431
426
  }
432
427
  )
433
428
  end
434
- def to_hash
435
- end
429
+ def to_hash; end
436
430
  end
437
431
 
438
432
  class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
@@ -443,7 +437,7 @@ module Orb
443
437
  attr_accessor :adjustment_type
444
438
 
445
439
  # The amount by which to discount the prices this adjustment applies to in a given
446
- # billing period.
440
+ # billing period.
447
441
  sig { returns(String) }
448
442
  attr_accessor :amount_discount
449
443
 
@@ -452,7 +446,7 @@ module Orb
452
446
  attr_accessor :applies_to_price_ids
453
447
 
454
448
  # True for adjustments that apply to an entire invocice, false for adjustments
455
- # that apply to only one price.
449
+ # that apply to only one price.
456
450
  sig { returns(T::Boolean) }
457
451
  attr_accessor :is_invoice_level
458
452
 
@@ -484,9 +478,7 @@ module Orb
484
478
  plan_phase_order:,
485
479
  reason:,
486
480
  adjustment_type: :amount_discount
487
- )
488
- end
489
-
481
+ ); end
490
482
  sig do
491
483
  override
492
484
  .returns(
@@ -501,8 +493,7 @@ module Orb
501
493
  }
502
494
  )
503
495
  end
504
- def to_hash
505
- end
496
+ def to_hash; end
506
497
  end
507
498
 
508
499
  class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
@@ -517,12 +508,12 @@ module Orb
517
508
  attr_accessor :applies_to_price_ids
518
509
 
519
510
  # True for adjustments that apply to an entire invocice, false for adjustments
520
- # that apply to only one price.
511
+ # that apply to only one price.
521
512
  sig { returns(T::Boolean) }
522
513
  attr_accessor :is_invoice_level
523
514
 
524
515
  # The percentage (as a value between 0 and 1) by which to discount the price
525
- # intervals this adjustment applies to in a given billing period.
516
+ # intervals this adjustment applies to in a given billing period.
526
517
  sig { returns(Float) }
527
518
  attr_accessor :percentage_discount
528
519
 
@@ -554,9 +545,7 @@ module Orb
554
545
  plan_phase_order:,
555
546
  reason:,
556
547
  adjustment_type: :percentage_discount
557
- )
558
- end
559
-
548
+ ); end
560
549
  sig do
561
550
  override
562
551
  .returns(
@@ -571,8 +560,7 @@ module Orb
571
560
  }
572
561
  )
573
562
  end
574
- def to_hash
575
- end
563
+ def to_hash; end
576
564
  end
577
565
 
578
566
  class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
@@ -587,7 +575,7 @@ module Orb
587
575
  attr_accessor :applies_to_price_ids
588
576
 
589
577
  # True for adjustments that apply to an entire invocice, false for adjustments
590
- # that apply to only one price.
578
+ # that apply to only one price.
591
579
  sig { returns(T::Boolean) }
592
580
  attr_accessor :is_invoice_level
593
581
 
@@ -596,7 +584,7 @@ module Orb
596
584
  attr_accessor :item_id
597
585
 
598
586
  # The minimum amount to charge in a given billing period for the prices this
599
- # adjustment applies to.
587
+ # adjustment applies to.
600
588
  sig { returns(String) }
601
589
  attr_accessor :minimum_amount
602
590
 
@@ -630,9 +618,7 @@ module Orb
630
618
  plan_phase_order:,
631
619
  reason:,
632
620
  adjustment_type: :minimum
633
- )
634
- end
635
-
621
+ ); end
636
622
  sig do
637
623
  override
638
624
  .returns(
@@ -648,8 +634,7 @@ module Orb
648
634
  }
649
635
  )
650
636
  end
651
- def to_hash
652
- end
637
+ def to_hash; end
653
638
  end
654
639
 
655
640
  class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
@@ -664,12 +649,12 @@ module Orb
664
649
  attr_accessor :applies_to_price_ids
665
650
 
666
651
  # True for adjustments that apply to an entire invocice, false for adjustments
667
- # that apply to only one price.
652
+ # that apply to only one price.
668
653
  sig { returns(T::Boolean) }
669
654
  attr_accessor :is_invoice_level
670
655
 
671
656
  # The maximum amount to charge in a given billing period for the prices this
672
- # adjustment applies to.
657
+ # adjustment applies to.
673
658
  sig { returns(String) }
674
659
  attr_accessor :maximum_amount
675
660
 
@@ -701,9 +686,7 @@ module Orb
701
686
  plan_phase_order:,
702
687
  reason:,
703
688
  adjustment_type: :maximum
704
- )
705
- end
706
-
689
+ ); end
707
690
  sig do
708
691
  override
709
692
  .returns(
@@ -718,8 +701,7 @@ module Orb
718
701
  }
719
702
  )
720
703
  end
721
- def to_hash
722
- end
704
+ def to_hash; end
723
705
  end
724
706
 
725
707
  sig do
@@ -728,8 +710,7 @@ module Orb
728
710
  [Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment]
729
711
  )
730
712
  end
731
- def self.variants
732
- end
713
+ def self.variants; end
733
714
  end
734
715
 
735
716
  class BasePlan < Orb::Internal::Type::BaseModel
@@ -737,8 +718,8 @@ module Orb
737
718
  attr_accessor :id
738
719
 
739
720
  # An optional user-defined ID for this plan resource, used throughout the system
740
- # as an alias for this Plan. Use this field to identify a plan by an existing
741
- # identifier in your system.
721
+ # as an alias for this Plan. Use this field to identify a plan by an existing
722
+ # identifier in your system.
742
723
  sig { returns(T.nilable(String)) }
743
724
  attr_accessor :external_plan_id
744
725
 
@@ -749,8 +730,7 @@ module Orb
749
730
  params(id: T.nilable(String), external_plan_id: T.nilable(String), name: T.nilable(String))
750
731
  .returns(T.attached_class)
751
732
  end
752
- def self.new(id:, external_plan_id:, name:)
753
- end
733
+ def self.new(id:, external_plan_id:, name:); end
754
734
 
755
735
  sig do
756
736
  override.returns(
@@ -761,13 +741,12 @@ module Orb
761
741
  }
762
742
  )
763
743
  end
764
- def to_hash
765
- end
744
+ def to_hash; end
766
745
  end
767
746
 
768
747
  class Maximum < Orb::Internal::Type::BaseModel
769
748
  # List of price_ids that this maximum amount applies to. For plan/plan phase
770
- # maximums, this can be a subset of prices.
749
+ # maximums, this can be a subset of prices.
771
750
  sig { returns(T::Array[String]) }
772
751
  attr_accessor :applies_to_price_ids
773
752
 
@@ -778,17 +757,15 @@ module Orb
778
757
  sig do
779
758
  params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
780
759
  end
781
- def self.new(applies_to_price_ids:, maximum_amount:)
782
- end
760
+ def self.new(applies_to_price_ids:, maximum_amount:); end
783
761
 
784
762
  sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
785
- def to_hash
786
- end
763
+ def to_hash; end
787
764
  end
788
765
 
789
766
  class Minimum < Orb::Internal::Type::BaseModel
790
767
  # List of price_ids that this minimum amount applies to. For plan/plan phase
791
- # minimums, this can be a subset of prices.
768
+ # minimums, this can be a subset of prices.
792
769
  sig { returns(T::Array[String]) }
793
770
  attr_accessor :applies_to_price_ids
794
771
 
@@ -799,12 +776,10 @@ module Orb
799
776
  sig do
800
777
  params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
801
778
  end
802
- def self.new(applies_to_price_ids:, minimum_amount:)
803
- end
779
+ def self.new(applies_to_price_ids:, minimum_amount:); end
804
780
 
805
781
  sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
806
- def to_hash
807
- end
782
+ def to_hash; end
808
783
  end
809
784
 
810
785
  class PlanPhase < Orb::Internal::Type::BaseModel
@@ -829,7 +804,7 @@ module Orb
829
804
  attr_accessor :discount
830
805
 
831
806
  # How many terms of length `duration_unit` this phase is active for. If null, this
832
- # phase is evergreen and active indefinitely
807
+ # phase is evergreen and active indefinitely
833
808
  sig { returns(T.nilable(Integer)) }
834
809
  attr_accessor :duration
835
810
 
@@ -897,9 +872,7 @@ module Orb
897
872
  minimum_amount:,
898
873
  name:,
899
874
  order:
900
- )
901
- end
902
-
875
+ ); end
903
876
  sig do
904
877
  override
905
878
  .returns(
@@ -925,8 +898,7 @@ module Orb
925
898
  }
926
899
  )
927
900
  end
928
- def to_hash
929
- end
901
+ def to_hash; end
930
902
 
931
903
  module DurationUnit
932
904
  extend Orb::Internal::Type::Enum
@@ -942,13 +914,12 @@ module Orb
942
914
  ANNUAL = T.let(:annual, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol)
943
915
 
944
916
  sig { override.returns(T::Array[Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol]) }
945
- def self.values
946
- end
917
+ def self.values; end
947
918
  end
948
919
 
949
920
  class Maximum < Orb::Internal::Type::BaseModel
950
921
  # List of price_ids that this maximum amount applies to. For plan/plan phase
951
- # maximums, this can be a subset of prices.
922
+ # maximums, this can be a subset of prices.
952
923
  sig { returns(T::Array[String]) }
953
924
  attr_accessor :applies_to_price_ids
954
925
 
@@ -959,17 +930,15 @@ module Orb
959
930
  sig do
960
931
  params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
961
932
  end
962
- def self.new(applies_to_price_ids:, maximum_amount:)
963
- end
933
+ def self.new(applies_to_price_ids:, maximum_amount:); end
964
934
 
965
935
  sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
966
- def to_hash
967
- end
936
+ def to_hash; end
968
937
  end
969
938
 
970
939
  class Minimum < Orb::Internal::Type::BaseModel
971
940
  # List of price_ids that this minimum amount applies to. For plan/plan phase
972
- # minimums, this can be a subset of prices.
941
+ # minimums, this can be a subset of prices.
973
942
  sig { returns(T::Array[String]) }
974
943
  attr_accessor :applies_to_price_ids
975
944
 
@@ -980,12 +949,10 @@ module Orb
980
949
  sig do
981
950
  params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
982
951
  end
983
- def self.new(applies_to_price_ids:, minimum_amount:)
984
- end
952
+ def self.new(applies_to_price_ids:, minimum_amount:); end
985
953
 
986
954
  sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
987
- def to_hash
988
- end
955
+ def to_hash; end
989
956
  end
990
957
  end
991
958
 
@@ -1000,12 +967,10 @@ module Orb
1000
967
  attr_accessor :name
1001
968
 
1002
969
  sig { params(id: String, created_at: Time, name: String).returns(T.attached_class) }
1003
- def self.new(id:, created_at:, name:)
1004
- end
970
+ def self.new(id:, created_at:, name:); end
1005
971
 
1006
972
  sig { override.returns({id: String, created_at: Time, name: String}) }
1007
- def to_hash
1008
- end
973
+ def to_hash; end
1009
974
  end
1010
975
 
1011
976
  module Status
@@ -1019,8 +984,7 @@ module Orb
1019
984
  DRAFT = T.let(:draft, Orb::Models::Plan::Status::TaggedSymbol)
1020
985
 
1021
986
  sig { override.returns(T::Array[Orb::Models::Plan::Status::TaggedSymbol]) }
1022
- def self.values
1023
- end
987
+ def self.values; end
1024
988
  end
1025
989
 
1026
990
  class TrialConfig < Orb::Internal::Type::BaseModel
@@ -1037,8 +1001,7 @@ module Orb
1037
1001
  )
1038
1002
  .returns(T.attached_class)
1039
1003
  end
1040
- def self.new(trial_period:, trial_period_unit:)
1041
- end
1004
+ def self.new(trial_period:, trial_period_unit:); end
1042
1005
 
1043
1006
  sig do
1044
1007
  override
@@ -1049,8 +1012,7 @@ module Orb
1049
1012
  }
1050
1013
  )
1051
1014
  end
1052
- def to_hash
1053
- end
1015
+ def to_hash; end
1054
1016
 
1055
1017
  module TrialPeriodUnit
1056
1018
  extend Orb::Internal::Type::Enum
@@ -1062,8 +1024,7 @@ module Orb
1062
1024
  DAYS = T.let(:days, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol)
1063
1025
 
1064
1026
  sig { override.returns(T::Array[Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol]) }
1065
- def self.values
1066
- end
1027
+ def self.values; end
1067
1028
  end
1068
1029
  end
1069
1030
  end