orb-billing 0.2.0 → 0.3.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 (488) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +67 -0
  3. data/README.md +63 -53
  4. data/lib/orb/client.rb +4 -4
  5. data/lib/orb/errors.rb +9 -9
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +7 -11
  8. data/lib/orb/internal/transport/base_client.rb +10 -10
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
  10. data/lib/orb/internal/type/array_of.rb +11 -0
  11. data/lib/orb/internal/type/base_model.rb +33 -23
  12. data/lib/orb/internal/type/base_page.rb +9 -1
  13. data/lib/orb/internal/type/boolean.rb +14 -11
  14. data/lib/orb/internal/type/converter.rb +4 -1
  15. data/lib/orb/internal/type/enum.rb +19 -16
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
  17. data/lib/orb/internal/type/hash_of.rb +11 -0
  18. data/lib/orb/internal/type/request_parameters.rb +3 -10
  19. data/lib/orb/internal/type/union.rb +10 -1
  20. data/lib/orb/internal/type/unknown.rb +14 -11
  21. data/lib/orb/internal/util.rb +88 -64
  22. data/lib/orb/internal.rb +0 -1
  23. data/lib/orb/models/alert.rb +68 -71
  24. data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
  25. data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
  26. data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
  27. data/lib/orb/models/alert_disable_params.rb +5 -9
  28. data/lib/orb/models/alert_enable_params.rb +5 -9
  29. data/lib/orb/models/alert_list_params.rb +26 -36
  30. data/lib/orb/models/alert_retrieve_params.rb +3 -8
  31. data/lib/orb/models/alert_update_params.rb +14 -18
  32. data/lib/orb/models/amount_discount.rb +14 -14
  33. data/lib/orb/models/billable_metric.rb +23 -20
  34. data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
  35. data/lib/orb/models/coupon.rb +28 -21
  36. data/lib/orb/models/coupon_archive_params.rb +3 -8
  37. data/lib/orb/models/coupon_create_params.rb +29 -34
  38. data/lib/orb/models/coupon_fetch_params.rb +3 -8
  39. data/lib/orb/models/coupon_list_params.rb +17 -17
  40. data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
  41. data/lib/orb/models/credit_note.rb +100 -166
  42. data/lib/orb/models/credit_note_create_params.rb +15 -23
  43. data/lib/orb/models/credit_note_fetch_params.rb +3 -8
  44. data/lib/orb/models/credit_note_list_params.rb +20 -30
  45. data/lib/orb/models/customer.rb +224 -271
  46. data/lib/orb/models/customer_create_params.rb +216 -257
  47. data/lib/orb/models/customer_delete_params.rb +3 -8
  48. data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
  49. data/lib/orb/models/customer_fetch_params.rb +3 -8
  50. data/lib/orb/models/customer_list_params.rb +20 -30
  51. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
  52. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
  53. data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
  54. data/lib/orb/models/customer_update_params.rb +212 -255
  55. data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
  56. data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
  57. data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
  58. data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
  59. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
  60. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +23 -27
  63. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
  64. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
  65. data/lib/orb/models/customers/credit_list_params.rb +18 -22
  66. data/lib/orb/models/customers/credit_list_response.rb +10 -17
  67. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
  68. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
  69. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
  70. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
  71. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
  72. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
  75. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
  76. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
  77. data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
  78. data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
  79. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
  80. data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
  81. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
  82. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
  83. data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
  84. data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
  85. data/lib/orb/models/dimensional_price_group.rb +21 -15
  86. data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
  87. data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
  88. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
  89. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
  90. data/lib/orb/models/dimensional_price_groups.rb +3 -7
  91. data/lib/orb/models/discount.rb +2 -3
  92. data/lib/orb/models/evaluate_price_group.rb +8 -11
  93. data/lib/orb/models/event_deprecate_params.rb +3 -8
  94. data/lib/orb/models/event_deprecate_response.rb +2 -6
  95. data/lib/orb/models/event_ingest_params.rb +33 -27
  96. data/lib/orb/models/event_ingest_response.rb +23 -24
  97. data/lib/orb/models/event_search_params.rb +15 -11
  98. data/lib/orb/models/event_search_response.rb +27 -22
  99. data/lib/orb/models/event_update_params.rb +19 -13
  100. data/lib/orb/models/event_update_response.rb +2 -6
  101. data/lib/orb/models/events/backfill_close_params.rb +3 -8
  102. data/lib/orb/models/events/backfill_close_response.rb +34 -39
  103. data/lib/orb/models/events/backfill_create_params.rb +28 -32
  104. data/lib/orb/models/events/backfill_create_response.rb +34 -39
  105. data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
  106. data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
  107. data/lib/orb/models/events/backfill_list_params.rb +12 -15
  108. data/lib/orb/models/events/backfill_list_response.rb +34 -39
  109. data/lib/orb/models/events/backfill_revert_params.rb +3 -8
  110. data/lib/orb/models/events/backfill_revert_response.rb +34 -39
  111. data/lib/orb/models/events/event_volumes.rb +11 -17
  112. data/lib/orb/models/events/volume_list_params.rb +19 -22
  113. data/lib/orb/models/invoice.rb +619 -681
  114. data/lib/orb/models/invoice_create_params.rb +52 -61
  115. data/lib/orb/models/invoice_fetch_params.rb +3 -8
  116. data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
  117. data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
  118. data/lib/orb/models/invoice_issue_params.rb +10 -14
  119. data/lib/orb/models/invoice_level_discount.rb +2 -3
  120. data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
  121. data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
  122. data/lib/orb/models/invoice_list_params.rb +51 -66
  123. data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
  124. data/lib/orb/models/invoice_pay_params.rb +3 -8
  125. data/lib/orb/models/invoice_update_params.rb +9 -9
  126. data/lib/orb/models/invoice_void_params.rb +3 -8
  127. data/lib/orb/models/item.rb +14 -25
  128. data/lib/orb/models/item_create_params.rb +5 -9
  129. data/lib/orb/models/item_fetch_params.rb +3 -8
  130. data/lib/orb/models/item_list_params.rb +12 -15
  131. data/lib/orb/models/item_update_params.rb +10 -22
  132. data/lib/orb/models/metric_create_params.rb +17 -13
  133. data/lib/orb/models/metric_fetch_params.rb +3 -8
  134. data/lib/orb/models/metric_list_params.rb +20 -30
  135. data/lib/orb/models/metric_update_params.rb +9 -9
  136. data/lib/orb/models/pagination_metadata.rb +3 -7
  137. data/lib/orb/models/percentage_discount.rb +15 -14
  138. data/lib/orb/models/plan.rb +259 -291
  139. data/lib/orb/models/plan_create_params.rb +2070 -2466
  140. data/lib/orb/models/plan_fetch_params.rb +3 -8
  141. data/lib/orb/models/plan_list_params.rb +25 -42
  142. data/lib/orb/models/plan_update_params.rb +12 -10
  143. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
  144. data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
  145. data/lib/orb/models/price.rb +3842 -5005
  146. data/lib/orb/models/price_create_params.rb +203 -244
  147. data/lib/orb/models/price_evaluate_params.rb +21 -30
  148. data/lib/orb/models/price_evaluate_response.rb +2 -6
  149. data/lib/orb/models/price_fetch_params.rb +3 -8
  150. data/lib/orb/models/price_list_params.rb +12 -15
  151. data/lib/orb/models/price_update_params.rb +9 -9
  152. data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
  153. data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
  154. data/lib/orb/models/subscription.rb +360 -405
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +358 -399
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +384 -418
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
  163. data/lib/orb/models/subscription_create_params.rb +4735 -5417
  164. data/lib/orb/models/subscription_create_response.rb +358 -399
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
  167. data/lib/orb/models/subscription_fetch_params.rb +3 -8
  168. data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
  169. data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
  170. data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
  171. data/lib/orb/models/subscription_list_params.rb +28 -41
  172. data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
  173. data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
  180. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
  181. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
  182. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
  183. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
  184. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
  185. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
  186. data/lib/orb/models/subscription_update_params.rb +21 -23
  187. data/lib/orb/models/subscription_update_trial_params.rb +15 -18
  188. data/lib/orb/models/subscription_update_trial_response.rb +360 -399
  189. data/lib/orb/models/subscription_usage.rb +37 -80
  190. data/lib/orb/models/subscriptions.rb +3 -7
  191. data/lib/orb/models/top_level_ping_params.rb +3 -8
  192. data/lib/orb/models/top_level_ping_response.rb +2 -6
  193. data/lib/orb/models/trial_discount.rb +16 -24
  194. data/lib/orb/models/usage_discount.rb +15 -14
  195. data/lib/orb/models.rb +220 -0
  196. data/lib/orb/request_options.rb +4 -6
  197. data/lib/orb/resources/alerts.rb +48 -17
  198. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  199. data/lib/orb/resources/coupons.rb +26 -8
  200. data/lib/orb/resources/credit_notes.rb +17 -4
  201. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  202. data/lib/orb/resources/customers/costs.rb +26 -8
  203. data/lib/orb/resources/customers/credits/ledger.rb +112 -32
  204. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  205. data/lib/orb/resources/customers/credits.rb +28 -8
  206. data/lib/orb/resources/customers.rb +138 -39
  207. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  208. data/lib/orb/resources/events/backfills.rb +32 -9
  209. data/lib/orb/resources/events/volume.rb +14 -4
  210. data/lib/orb/resources/events.rb +40 -11
  211. data/lib/orb/resources/invoice_line_items.rb +16 -6
  212. data/lib/orb/resources/invoices.rb +77 -17
  213. data/lib/orb/resources/items.rb +10 -3
  214. data/lib/orb/resources/metrics.rb +33 -8
  215. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  216. data/lib/orb/resources/plans.rb +47 -11
  217. data/lib/orb/resources/prices/external_price_id.rb +9 -3
  218. data/lib/orb/resources/prices.rb +101 -26
  219. data/lib/orb/resources/subscription_changes.rb +5 -2
  220. data/lib/orb/resources/subscriptions.rb +292 -78
  221. data/lib/orb/version.rb +1 -1
  222. data/lib/orb.rb +2 -10
  223. data/rbi/{lib/orb → orb}/client.rbi +4 -4
  224. data/rbi/{lib/orb → orb}/errors.rbi +1 -1
  225. data/rbi/orb/file_part.rbi +34 -0
  226. data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
  227. data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
  228. data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
  229. data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
  230. data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
  231. data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
  232. data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
  233. data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
  234. data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
  235. data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
  236. data/rbi/{lib/orb → orb}/internal.rbi +0 -1
  237. data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
  238. data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
  239. data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
  240. data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
  241. data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
  242. data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
  243. data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
  244. data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
  245. data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
  246. data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
  247. data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
  248. data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
  249. data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
  250. data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
  251. data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
  252. data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
  253. data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
  254. data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
  255. data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
  256. data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
  257. data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
  258. data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
  259. data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
  260. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
  261. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
  262. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
  263. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
  264. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
  265. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
  266. data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
  267. data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
  268. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
  269. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
  270. data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
  271. data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
  272. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  273. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
  274. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  275. data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
  276. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  277. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
  278. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
  279. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
  280. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  281. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  282. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
  283. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
  284. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  285. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  286. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
  287. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
  288. data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
  289. data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
  290. data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
  291. data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
  292. data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
  293. data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
  294. data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
  295. data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
  296. data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
  297. data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
  298. data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
  299. data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
  300. data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
  301. data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
  302. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
  303. data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
  304. data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
  305. data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
  306. data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
  307. data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
  308. data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
  309. data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
  310. data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
  311. data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
  312. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
  313. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
  314. data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
  315. data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
  316. data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
  317. data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
  318. data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
  319. data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
  320. data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
  321. data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
  322. data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
  323. data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
  324. data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
  325. data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
  326. data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
  327. data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
  328. data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
  329. data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
  330. data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
  331. data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
  332. data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
  333. data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
  334. data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
  335. data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
  336. data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
  337. data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
  338. data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
  339. data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
  340. data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
  341. data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
  342. data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
  343. data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
  344. data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
  345. data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
  346. data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
  347. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
  348. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
  349. data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
  350. data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
  351. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
  352. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
  353. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
  354. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
  355. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
  356. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
  357. data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
  358. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  359. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
  360. data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
  361. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  362. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
  363. data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
  364. data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
  365. data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
  366. data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
  367. data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
  368. data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
  369. data/rbi/orb/models.rbi +220 -0
  370. data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
  371. data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
  372. data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
  373. data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
  374. data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
  375. data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
  376. data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
  377. data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
  378. data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
  379. data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
  380. data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
  381. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
  382. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
  383. data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
  384. data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
  385. data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
  386. data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
  387. data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
  388. data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
  389. data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
  390. data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
  391. data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
  392. data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
  393. data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
  394. data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
  395. data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
  396. data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
  397. data/sig/orb/file_part.rbs +21 -0
  398. data/sig/orb/internal/transport/base_client.rbs +9 -3
  399. data/sig/orb/internal/type/array_of.rbs +2 -0
  400. data/sig/orb/internal/type/base_model.rbs +4 -0
  401. data/sig/orb/internal/type/enum.rbs +2 -2
  402. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  403. data/sig/orb/internal/type/hash_of.rbs +2 -0
  404. data/sig/orb/internal/type/union.rbs +2 -0
  405. data/sig/orb/internal/util.rbs +16 -12
  406. data/sig/orb/models/coupon_create_params.rbs +9 -10
  407. data/sig/orb/models/customer_create_params.rbs +9 -10
  408. data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
  409. data/sig/orb/models/customer_update_params.rbs +9 -10
  410. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
  411. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
  412. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
  413. data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
  414. data/sig/orb/models/invoice.rbs +54 -54
  415. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
  416. data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
  417. data/sig/orb/models/plan.rbs +21 -21
  418. data/sig/orb/models/plan_create_params.rbs +653 -653
  419. data/sig/orb/models/price.rbs +1517 -1521
  420. data/sig/orb/models/subscription.rbs +34 -34
  421. data/sig/orb/models/subscription_cancel_response.rbs +34 -34
  422. data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
  423. data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
  424. data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
  425. data/sig/orb/models/subscription_create_params.rbs +1348 -1348
  426. data/sig/orb/models/subscription_create_response.rbs +34 -34
  427. data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
  428. data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
  429. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
  430. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
  431. data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
  432. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
  433. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
  434. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
  435. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
  436. data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
  437. data/sig/orb/models.rbs +215 -0
  438. metadata +230 -224
  439. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
  440. data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
  441. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
  442. data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
  443. /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
  444. /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
  445. /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
  446. /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
  447. /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
  448. /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
  449. /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
  450. /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
  451. /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
  452. /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
  453. /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
  454. /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
  455. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
  456. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
  457. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
  458. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
  459. /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
  460. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
  461. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
  462. /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
  463. /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
  464. /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
  465. /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
  466. /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
  467. /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
  468. /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
  469. /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
  470. /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
  471. /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
  472. /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
  473. /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
  474. /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
  475. /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
  476. /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
  477. /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
  478. /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
  479. /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
  480. /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
  481. /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
  482. /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
  483. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
  484. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
  485. /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
  486. /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
  487. /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
  488. /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -12,11 +12,11 @@ module Orb
12
12
  returns(
13
13
  T::Array[
14
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
15
+ Orb::Models::Plan::Adjustment::UsageDiscount,
16
+ Orb::Models::Plan::Adjustment::AmountDiscount,
17
+ Orb::Models::Plan::Adjustment::PercentageDiscount,
18
+ Orb::Models::Plan::Adjustment::Minimum,
19
+ Orb::Models::Plan::Adjustment::Maximum
20
20
  )
21
21
  ]
22
22
  )
@@ -120,34 +120,34 @@ module Orb
120
120
  returns(
121
121
  T::Array[
122
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
123
+ Orb::Models::Price::Unit,
124
+ Orb::Models::Price::Package,
125
+ Orb::Models::Price::Matrix,
126
+ Orb::Models::Price::Tiered,
127
+ Orb::Models::Price::TieredBps,
128
+ Orb::Models::Price::Bps,
129
+ Orb::Models::Price::BulkBps,
130
+ Orb::Models::Price::Bulk,
131
+ Orb::Models::Price::ThresholdTotalAmount,
132
+ Orb::Models::Price::TieredPackage,
133
+ Orb::Models::Price::GroupedTiered,
134
+ Orb::Models::Price::TieredWithMinimum,
135
+ Orb::Models::Price::TieredPackageWithMinimum,
136
+ Orb::Models::Price::PackageWithAllocation,
137
+ Orb::Models::Price::UnitWithPercent,
138
+ Orb::Models::Price::MatrixWithAllocation,
139
+ Orb::Models::Price::TieredWithProration,
140
+ Orb::Models::Price::UnitWithProration,
141
+ Orb::Models::Price::GroupedAllocation,
142
+ Orb::Models::Price::GroupedWithProratedMinimum,
143
+ Orb::Models::Price::GroupedWithMeteredMinimum,
144
+ Orb::Models::Price::MatrixWithDisplayName,
145
+ Orb::Models::Price::BulkWithProration,
146
+ Orb::Models::Price::GroupedTieredPackage,
147
+ Orb::Models::Price::MaxGroupTieredPackage,
148
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
149
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
150
+ Orb::Models::Price::CumulativeGroupedBulk
151
151
  )
152
152
  ]
153
153
  )
@@ -181,12 +181,12 @@ module Orb
181
181
  id: String,
182
182
  adjustments: T::Array[
183
183
  T.any(
184
- Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment,
184
+ Orb::Models::Plan::Adjustment::UsageDiscount,
185
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
186
+ Orb::Models::Plan::Adjustment::AmountDiscount,
187
+ Orb::Models::Plan::Adjustment::PercentageDiscount,
188
+ Orb::Models::Plan::Adjustment::Minimum,
189
+ Orb::Models::Plan::Adjustment::Maximum
190
190
  )
191
191
  ],
192
192
  base_plan: T.nilable(T.any(Orb::Models::Plan::BasePlan, Orb::Internal::AnyHash)),
@@ -216,35 +216,35 @@ module Orb
216
216
  plan_phases: T.nilable(T::Array[T.any(Orb::Models::Plan::PlanPhase, Orb::Internal::AnyHash)]),
217
217
  prices: T::Array[
218
218
  T.any(
219
- Orb::Models::Price::UnitPrice,
219
+ Orb::Models::Price::Unit,
220
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
221
+ Orb::Models::Price::Package,
222
+ Orb::Models::Price::Matrix,
223
+ Orb::Models::Price::Tiered,
224
+ Orb::Models::Price::TieredBps,
225
+ Orb::Models::Price::Bps,
226
+ Orb::Models::Price::BulkBps,
227
+ Orb::Models::Price::Bulk,
228
+ Orb::Models::Price::ThresholdTotalAmount,
229
+ Orb::Models::Price::TieredPackage,
230
+ Orb::Models::Price::GroupedTiered,
231
+ Orb::Models::Price::TieredWithMinimum,
232
+ Orb::Models::Price::TieredPackageWithMinimum,
233
+ Orb::Models::Price::PackageWithAllocation,
234
+ Orb::Models::Price::UnitWithPercent,
235
+ Orb::Models::Price::MatrixWithAllocation,
236
+ Orb::Models::Price::TieredWithProration,
237
+ Orb::Models::Price::UnitWithProration,
238
+ Orb::Models::Price::GroupedAllocation,
239
+ Orb::Models::Price::GroupedWithProratedMinimum,
240
+ Orb::Models::Price::GroupedWithMeteredMinimum,
241
+ Orb::Models::Price::MatrixWithDisplayName,
242
+ Orb::Models::Price::BulkWithProration,
243
+ Orb::Models::Price::GroupedTieredPackage,
244
+ Orb::Models::Price::MaxGroupTieredPackage,
245
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
246
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
247
+ Orb::Models::Price::CumulativeGroupedBulk
248
248
  )
249
249
  ],
250
250
  product: T.any(Orb::Models::Plan::Product, Orb::Internal::AnyHash),
@@ -256,24 +256,48 @@ module Orb
256
256
  end
257
257
  def self.new(
258
258
  id:,
259
+ # Adjustments for this plan. If the plan has phases, this includes adjustments
260
+ # across all phases of the plan.
259
261
  adjustments:,
260
262
  base_plan:,
263
+ # The parent plan id if the given plan was created by overriding one or more of
264
+ # the parent's prices
261
265
  base_plan_id:,
262
266
  created_at:,
267
+ # An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
268
+ # prices.
263
269
  currency:,
270
+ # The default memo text on the invoices corresponding to subscriptions on this
271
+ # plan. Note that each subscription may configure its own memo.
264
272
  default_invoice_memo:,
265
273
  description:,
266
274
  discount:,
275
+ # An optional user-defined ID for this plan resource, used throughout the system
276
+ # as an alias for this Plan. Use this field to identify a plan by an existing
277
+ # identifier in your system.
267
278
  external_plan_id:,
279
+ # An ISO 4217 currency string for which this plan is billed in. Matches `currency`
280
+ # unless `currency` is a custom pricing unit.
268
281
  invoicing_currency:,
269
282
  maximum:,
270
283
  maximum_amount:,
284
+ # User specified key-value pairs for the resource. If not present, this defaults
285
+ # to an empty dictionary. Individual keys can be removed by setting the value to
286
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
287
+ # `null`.
271
288
  metadata:,
272
289
  minimum:,
273
290
  minimum_amount:,
274
291
  name:,
292
+ # Determines the difference between the invoice issue date and the due date. A
293
+ # value of "0" here signifies that invoices are due on issue, whereas a value of
294
+ # "30" means that the customer has a month to pay the invoice before its overdue.
295
+ # Note that individual subscriptions or invoices may set a different net terms
296
+ # configuration.
275
297
  net_terms:,
276
298
  plan_phases:,
299
+ # Prices for this plan. If the plan has phases, this includes prices across all
300
+ # phases of the plan.
277
301
  prices:,
278
302
  product:,
279
303
  status:,
@@ -287,11 +311,11 @@ module Orb
287
311
  id: String,
288
312
  adjustments: T::Array[
289
313
  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
314
+ Orb::Models::Plan::Adjustment::UsageDiscount,
315
+ Orb::Models::Plan::Adjustment::AmountDiscount,
316
+ Orb::Models::Plan::Adjustment::PercentageDiscount,
317
+ Orb::Models::Plan::Adjustment::Minimum,
318
+ Orb::Models::Plan::Adjustment::Maximum
295
319
  )
296
320
  ],
297
321
  base_plan: T.nilable(Orb::Models::Plan::BasePlan),
@@ -320,34 +344,34 @@ module Orb
320
344
  plan_phases: T.nilable(T::Array[Orb::Models::Plan::PlanPhase]),
321
345
  prices: T::Array[
322
346
  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
347
+ Orb::Models::Price::Unit,
348
+ Orb::Models::Price::Package,
349
+ Orb::Models::Price::Matrix,
350
+ Orb::Models::Price::Tiered,
351
+ Orb::Models::Price::TieredBps,
352
+ Orb::Models::Price::Bps,
353
+ Orb::Models::Price::BulkBps,
354
+ Orb::Models::Price::Bulk,
355
+ Orb::Models::Price::ThresholdTotalAmount,
356
+ Orb::Models::Price::TieredPackage,
357
+ Orb::Models::Price::GroupedTiered,
358
+ Orb::Models::Price::TieredWithMinimum,
359
+ Orb::Models::Price::TieredPackageWithMinimum,
360
+ Orb::Models::Price::PackageWithAllocation,
361
+ Orb::Models::Price::UnitWithPercent,
362
+ Orb::Models::Price::MatrixWithAllocation,
363
+ Orb::Models::Price::TieredWithProration,
364
+ Orb::Models::Price::UnitWithProration,
365
+ Orb::Models::Price::GroupedAllocation,
366
+ Orb::Models::Price::GroupedWithProratedMinimum,
367
+ Orb::Models::Price::GroupedWithMeteredMinimum,
368
+ Orb::Models::Price::MatrixWithDisplayName,
369
+ Orb::Models::Price::BulkWithProration,
370
+ Orb::Models::Price::GroupedTieredPackage,
371
+ Orb::Models::Price::MaxGroupTieredPackage,
372
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
373
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
374
+ Orb::Models::Price::CumulativeGroupedBulk
351
375
  )
352
376
  ],
353
377
  product: Orb::Models::Plan::Product,
@@ -362,7 +386,7 @@ module Orb
362
386
  module Adjustment
363
387
  extend Orb::Internal::Type::Union
364
388
 
365
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
389
+ class UsageDiscount < Orb::Internal::Type::BaseModel
366
390
  sig { returns(String) }
367
391
  attr_accessor :id
368
392
 
@@ -405,10 +429,17 @@ module Orb
405
429
  end
406
430
  def self.new(
407
431
  id:,
432
+ # The price IDs that this adjustment applies to.
408
433
  applies_to_price_ids:,
434
+ # True for adjustments that apply to an entire invocice, false for adjustments
435
+ # that apply to only one price.
409
436
  is_invoice_level:,
437
+ # The plan phase in which this adjustment is active.
410
438
  plan_phase_order:,
439
+ # The reason for the adjustment.
411
440
  reason:,
441
+ # The number of usage units by which to discount the price this adjustment applies
442
+ # to in a given billing period.
412
443
  usage_discount:,
413
444
  adjustment_type: :usage_discount
414
445
  ); end
@@ -429,7 +460,7 @@ module Orb
429
460
  def to_hash; end
430
461
  end
431
462
 
432
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
463
+ class AmountDiscount < Orb::Internal::Type::BaseModel
433
464
  sig { returns(String) }
434
465
  attr_accessor :id
435
466
 
@@ -472,10 +503,17 @@ module Orb
472
503
  end
473
504
  def self.new(
474
505
  id:,
506
+ # The amount by which to discount the prices this adjustment applies to in a given
507
+ # billing period.
475
508
  amount_discount:,
509
+ # The price IDs that this adjustment applies to.
476
510
  applies_to_price_ids:,
511
+ # True for adjustments that apply to an entire invocice, false for adjustments
512
+ # that apply to only one price.
477
513
  is_invoice_level:,
514
+ # The plan phase in which this adjustment is active.
478
515
  plan_phase_order:,
516
+ # The reason for the adjustment.
479
517
  reason:,
480
518
  adjustment_type: :amount_discount
481
519
  ); end
@@ -496,7 +534,7 @@ module Orb
496
534
  def to_hash; end
497
535
  end
498
536
 
499
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
537
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
500
538
  sig { returns(String) }
501
539
  attr_accessor :id
502
540
 
@@ -539,10 +577,17 @@ module Orb
539
577
  end
540
578
  def self.new(
541
579
  id:,
580
+ # The price IDs that this adjustment applies to.
542
581
  applies_to_price_ids:,
582
+ # True for adjustments that apply to an entire invocice, false for adjustments
583
+ # that apply to only one price.
543
584
  is_invoice_level:,
585
+ # The percentage (as a value between 0 and 1) by which to discount the price
586
+ # intervals this adjustment applies to in a given billing period.
544
587
  percentage_discount:,
588
+ # The plan phase in which this adjustment is active.
545
589
  plan_phase_order:,
590
+ # The reason for the adjustment.
546
591
  reason:,
547
592
  adjustment_type: :percentage_discount
548
593
  ); end
@@ -563,7 +608,7 @@ module Orb
563
608
  def to_hash; end
564
609
  end
565
610
 
566
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
611
+ class Minimum < Orb::Internal::Type::BaseModel
567
612
  sig { returns(String) }
568
613
  attr_accessor :id
569
614
 
@@ -611,11 +656,19 @@ module Orb
611
656
  end
612
657
  def self.new(
613
658
  id:,
659
+ # The price IDs that this adjustment applies to.
614
660
  applies_to_price_ids:,
661
+ # True for adjustments that apply to an entire invocice, false for adjustments
662
+ # that apply to only one price.
615
663
  is_invoice_level:,
664
+ # The item ID that revenue from this minimum will be attributed to.
616
665
  item_id:,
666
+ # The minimum amount to charge in a given billing period for the prices this
667
+ # adjustment applies to.
617
668
  minimum_amount:,
669
+ # The plan phase in which this adjustment is active.
618
670
  plan_phase_order:,
671
+ # The reason for the adjustment.
619
672
  reason:,
620
673
  adjustment_type: :minimum
621
674
  ); end
@@ -637,7 +690,7 @@ module Orb
637
690
  def to_hash; end
638
691
  end
639
692
 
640
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
693
+ class Maximum < Orb::Internal::Type::BaseModel
641
694
  sig { returns(String) }
642
695
  attr_accessor :id
643
696
 
@@ -680,10 +733,17 @@ module Orb
680
733
  end
681
734
  def self.new(
682
735
  id:,
736
+ # The price IDs that this adjustment applies to.
683
737
  applies_to_price_ids:,
738
+ # True for adjustments that apply to an entire invocice, false for adjustments
739
+ # that apply to only one price.
684
740
  is_invoice_level:,
741
+ # The maximum amount to charge in a given billing period for the prices this
742
+ # adjustment applies to.
685
743
  maximum_amount:,
744
+ # The plan phase in which this adjustment is active.
686
745
  plan_phase_order:,
746
+ # The reason for the adjustment.
687
747
  reason:,
688
748
  adjustment_type: :maximum
689
749
  ); end
@@ -707,7 +767,7 @@ module Orb
707
767
  sig do
708
768
  override
709
769
  .returns(
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]
770
+ [Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum]
711
771
  )
712
772
  end
713
773
  def self.variants; end
@@ -730,8 +790,14 @@ module Orb
730
790
  params(id: T.nilable(String), external_plan_id: T.nilable(String), name: T.nilable(String))
731
791
  .returns(T.attached_class)
732
792
  end
733
- def self.new(id:, external_plan_id:, name:); end
734
-
793
+ def self.new(
794
+ id:,
795
+ # An optional user-defined ID for this plan resource, used throughout the system
796
+ # as an alias for this Plan. Use this field to identify a plan by an existing
797
+ # identifier in your system.
798
+ external_plan_id:,
799
+ name:
800
+ ); end
735
801
  sig do
736
802
  override.returns(
737
803
  {
@@ -757,8 +823,13 @@ module Orb
757
823
  sig do
758
824
  params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
759
825
  end
760
- def self.new(applies_to_price_ids:, maximum_amount:); end
761
-
826
+ def self.new(
827
+ # List of price_ids that this maximum amount applies to. For plan/plan phase
828
+ # maximums, this can be a subset of prices.
829
+ applies_to_price_ids:,
830
+ # Maximum amount applied
831
+ maximum_amount:
832
+ ); end
762
833
  sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
763
834
  def to_hash; end
764
835
  end
@@ -776,8 +847,13 @@ module Orb
776
847
  sig do
777
848
  params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
778
849
  end
779
- def self.new(applies_to_price_ids:, minimum_amount:); end
780
-
850
+ def self.new(
851
+ # List of price_ids that this minimum amount applies to. For plan/plan phase
852
+ # minimums, this can be a subset of prices.
853
+ applies_to_price_ids:,
854
+ # Minimum amount applied
855
+ minimum_amount:
856
+ ); end
781
857
  sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
782
858
  def to_hash; end
783
859
  end
@@ -864,6 +940,8 @@ module Orb
864
940
  id:,
865
941
  description:,
866
942
  discount:,
943
+ # How many terms of length `duration_unit` this phase is active for. If null, this
944
+ # phase is evergreen and active indefinitely
867
945
  duration:,
868
946
  duration_unit:,
869
947
  maximum:,
@@ -871,6 +949,7 @@ module Orb
871
949
  minimum:,
872
950
  minimum_amount:,
873
951
  name:,
952
+ # Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
874
953
  order:
875
954
  ); end
876
955
  sig do
@@ -904,8 +983,7 @@ module Orb
904
983
  extend Orb::Internal::Type::Enum
905
984
 
906
985
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::PlanPhase::DurationUnit) }
907
- OrSymbol =
908
- T.type_alias { T.any(Symbol, String, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol) }
986
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
909
987
 
910
988
  DAILY = T.let(:daily, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol)
911
989
  MONTHLY = T.let(:monthly, Orb::Models::Plan::PlanPhase::DurationUnit::TaggedSymbol)
@@ -930,8 +1008,13 @@ module Orb
930
1008
  sig do
931
1009
  params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
932
1010
  end
933
- def self.new(applies_to_price_ids:, maximum_amount:); end
934
-
1011
+ def self.new(
1012
+ # List of price_ids that this maximum amount applies to. For plan/plan phase
1013
+ # maximums, this can be a subset of prices.
1014
+ applies_to_price_ids:,
1015
+ # Maximum amount applied
1016
+ maximum_amount:
1017
+ ); end
935
1018
  sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
936
1019
  def to_hash; end
937
1020
  end
@@ -949,8 +1032,13 @@ module Orb
949
1032
  sig do
950
1033
  params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
951
1034
  end
952
- def self.new(applies_to_price_ids:, minimum_amount:); end
953
-
1035
+ def self.new(
1036
+ # List of price_ids that this minimum amount applies to. For plan/plan phase
1037
+ # minimums, this can be a subset of prices.
1038
+ applies_to_price_ids:,
1039
+ # Minimum amount applied
1040
+ minimum_amount:
1041
+ ); end
954
1042
  sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
955
1043
  def to_hash; end
956
1044
  end
@@ -977,7 +1065,7 @@ module Orb
977
1065
  extend Orb::Internal::Type::Enum
978
1066
 
979
1067
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::Status) }
980
- OrSymbol = T.type_alias { T.any(Symbol, String, Orb::Models::Plan::Status::TaggedSymbol) }
1068
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
981
1069
 
982
1070
  ACTIVE = T.let(:active, Orb::Models::Plan::Status::TaggedSymbol)
983
1071
  ARCHIVED = T.let(:archived, Orb::Models::Plan::Status::TaggedSymbol)
@@ -1018,8 +1106,7 @@ module Orb
1018
1106
  extend Orb::Internal::Type::Enum
1019
1107
 
1020
1108
  TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit) }
1021
- OrSymbol =
1022
- T.type_alias { T.any(Symbol, String, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol) }
1109
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1023
1110
 
1024
1111
  DAYS = T.let(:days, Orb::Models::Plan::TrialConfig::TrialPeriodUnit::TaggedSymbol)
1025
1112