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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (390) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/orb/client.rb +4 -0
  4. data/lib/orb/internal/transport/base_client.rb +1 -1
  5. data/lib/orb/internal/transport/pooled_net_requester.rb +1 -1
  6. data/lib/orb/internal/type/base_model.rb +14 -17
  7. data/lib/orb/internal/type/converter.rb +20 -22
  8. data/lib/orb/internal/type/enum.rb +8 -8
  9. data/lib/orb/internal/util.rb +1 -5
  10. data/lib/orb/models/alert.rb +9 -9
  11. data/lib/orb/models/alert_create_for_customer_params.rb +3 -3
  12. data/lib/orb/models/alert_create_for_external_customer_params.rb +3 -3
  13. data/lib/orb/models/alert_create_for_subscription_params.rb +3 -3
  14. data/lib/orb/models/alert_list_params.rb +5 -5
  15. data/lib/orb/models/alert_update_params.rb +3 -3
  16. data/lib/orb/models/amount_discount.rb +1 -1
  17. data/lib/orb/models/billable_metric.rb +7 -7
  18. data/lib/orb/models/coupon.rb +7 -7
  19. data/lib/orb/models/coupon_create_params.rb +2 -2
  20. data/lib/orb/models/coupon_list_params.rb +2 -2
  21. data/lib/orb/models/coupons/subscription_list_params.rb +1 -1
  22. data/lib/orb/models/credit_note.rb +1 -1
  23. data/lib/orb/models/credit_note_list_params.rb +5 -5
  24. data/lib/orb/models/customer.rb +232 -232
  25. data/lib/orb/models/customer_create_params.rb +223 -223
  26. data/lib/orb/models/customer_list_params.rb +5 -5
  27. data/lib/orb/models/customer_update_by_external_id_params.rb +224 -224
  28. data/lib/orb/models/customer_update_params.rb +224 -224
  29. data/lib/orb/models/customers/balance_transaction_create_response.rb +2 -2
  30. data/lib/orb/models/customers/balance_transaction_list_params.rb +5 -5
  31. data/lib/orb/models/customers/balance_transaction_list_response.rb +2 -2
  32. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +6 -6
  33. data/lib/orb/models/customers/cost_list_params.rb +6 -6
  34. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +2 -2
  35. data/lib/orb/models/customers/credit_list_params.rb +2 -2
  36. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +20 -20
  37. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +22 -22
  38. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +20 -20
  39. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +22 -22
  40. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +5 -5
  41. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +22 -22
  42. data/lib/orb/models/customers/credits/ledger_list_params.rb +5 -5
  43. data/lib/orb/models/customers/credits/ledger_list_response.rb +22 -22
  44. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +8 -8
  45. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +7 -7
  46. data/lib/orb/models/customers/credits/top_up_create_params.rb +8 -8
  47. data/lib/orb/models/customers/credits/top_up_create_response.rb +7 -7
  48. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +1 -1
  49. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +7 -7
  50. data/lib/orb/models/customers/credits/top_up_list_params.rb +1 -1
  51. data/lib/orb/models/customers/credits/top_up_list_response.rb +7 -7
  52. data/lib/orb/models/dimensional_price_group.rb +7 -7
  53. data/lib/orb/models/dimensional_price_group_create_params.rb +2 -2
  54. data/lib/orb/models/dimensional_price_group_list_params.rb +1 -1
  55. data/lib/orb/models/event_ingest_params.rb +7 -7
  56. data/lib/orb/models/event_ingest_response.rb +4 -4
  57. data/lib/orb/models/event_search_params.rb +5 -5
  58. data/lib/orb/models/event_search_response.rb +8 -8
  59. data/lib/orb/models/event_update_params.rb +4 -4
  60. data/lib/orb/models/events/backfill_close_response.rb +7 -7
  61. data/lib/orb/models/events/backfill_create_params.rb +11 -11
  62. data/lib/orb/models/events/backfill_create_response.rb +7 -7
  63. data/lib/orb/models/events/backfill_fetch_response.rb +7 -7
  64. data/lib/orb/models/events/backfill_list_params.rb +1 -1
  65. data/lib/orb/models/events/backfill_list_response.rb +7 -7
  66. data/lib/orb/models/events/backfill_revert_response.rb +7 -7
  67. data/lib/orb/models/events/event_volumes.rb +1 -1
  68. data/lib/orb/models/events/volume_list_params.rb +7 -7
  69. data/lib/orb/models/invoice.rb +270 -270
  70. data/lib/orb/models/invoice_create_params.rb +12 -11
  71. data/lib/orb/models/invoice_fetch_upcoming_response.rb +266 -266
  72. data/lib/orb/models/invoice_issue_params.rb +4 -4
  73. data/lib/orb/models/invoice_line_item_create_params.rb +1 -1
  74. data/lib/orb/models/invoice_line_item_create_response.rb +27 -27
  75. data/lib/orb/models/invoice_list_params.rb +12 -12
  76. data/lib/orb/models/invoice_update_params.rb +2 -2
  77. data/lib/orb/models/item.rb +2 -2
  78. data/lib/orb/models/item_list_params.rb +1 -1
  79. data/lib/orb/models/metric_create_params.rb +2 -2
  80. data/lib/orb/models/metric_list_params.rb +5 -5
  81. data/lib/orb/models/metric_update_params.rb +2 -2
  82. data/lib/orb/models/percentage_discount.rb +2 -2
  83. data/lib/orb/models/plan.rb +35 -35
  84. data/lib/orb/models/plan_create_params.rb +267 -267
  85. data/lib/orb/models/plan_list_params.rb +5 -5
  86. data/lib/orb/models/plan_update_params.rb +4 -4
  87. data/lib/orb/models/plans/external_plan_id_update_params.rb +4 -4
  88. data/lib/orb/models/price.rb +158 -158
  89. data/lib/orb/models/price_create_params.rb +20 -20
  90. data/lib/orb/models/price_evaluate_params.rb +4 -4
  91. data/lib/orb/models/price_list_params.rb +1 -1
  92. data/lib/orb/models/price_update_params.rb +2 -2
  93. data/lib/orb/models/prices/external_price_id_update_params.rb +2 -2
  94. data/lib/orb/models/subscription.rb +114 -87
  95. data/lib/orb/models/subscription_cancel_params.rb +3 -3
  96. data/lib/orb/models/subscription_cancel_response.rb +150 -72
  97. data/lib/orb/models/subscription_change_apply_params.rb +33 -0
  98. data/lib/orb/models/subscription_change_apply_response.rb +1372 -0
  99. data/lib/orb/models/subscription_change_cancel_params.rb +19 -0
  100. data/lib/orb/models/subscription_change_cancel_response.rb +1372 -0
  101. data/lib/orb/models/subscription_change_retrieve_params.rb +19 -0
  102. data/lib/orb/models/subscription_change_retrieve_response.rb +1372 -0
  103. data/lib/orb/models/subscription_create_params.rb +641 -641
  104. data/lib/orb/models/subscription_create_response.rb +150 -72
  105. data/lib/orb/models/subscription_fetch_costs_params.rb +6 -6
  106. data/lib/orb/models/subscription_fetch_schedule_params.rb +5 -5
  107. data/lib/orb/models/subscription_fetch_schedule_response.rb +2 -2
  108. data/lib/orb/models/subscription_fetch_usage_params.rb +8 -8
  109. data/lib/orb/models/subscription_list_params.rb +5 -5
  110. data/lib/orb/models/subscription_price_intervals_params.rb +323 -323
  111. data/lib/orb/models/subscription_price_intervals_response.rb +152 -72
  112. data/lib/orb/models/subscription_schedule_plan_change_params.rb +651 -651
  113. data/lib/orb/models/subscription_schedule_plan_change_response.rb +152 -72
  114. data/lib/orb/models/subscription_trigger_phase_params.rb +3 -3
  115. data/lib/orb/models/subscription_trigger_phase_response.rb +152 -72
  116. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +152 -72
  117. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +153 -73
  118. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +152 -72
  119. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +8 -8
  120. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +152 -72
  121. data/lib/orb/models/subscription_update_params.rb +10 -10
  122. data/lib/orb/models/subscription_update_trial_params.rb +3 -3
  123. data/lib/orb/models/subscription_update_trial_response.rb +152 -72
  124. data/lib/orb/models/trial_discount.rb +1 -1
  125. data/lib/orb/models/usage_discount.rb +2 -2
  126. data/lib/orb/request_options.rb +7 -7
  127. data/lib/orb/resources/alerts.rb +38 -38
  128. data/lib/orb/resources/coupons/subscriptions.rb +3 -3
  129. data/lib/orb/resources/coupons.rb +9 -9
  130. data/lib/orb/resources/credit_notes.rb +8 -8
  131. data/lib/orb/resources/customers/balance_transactions.rb +26 -26
  132. data/lib/orb/resources/customers/costs.rb +232 -232
  133. data/lib/orb/resources/customers/credits/ledger.rb +344 -344
  134. data/lib/orb/resources/customers/credits/top_ups.rb +12 -12
  135. data/lib/orb/resources/customers/credits.rb +8 -8
  136. data/lib/orb/resources/customers.rb +59 -59
  137. data/lib/orb/resources/dimensional_price_groups.rb +6 -6
  138. data/lib/orb/resources/events/backfills.rb +49 -49
  139. data/lib/orb/resources/events/volume.rb +10 -10
  140. data/lib/orb/resources/events.rb +295 -295
  141. data/lib/orb/resources/invoice_line_items.rb +1 -1
  142. data/lib/orb/resources/invoices.rb +38 -38
  143. data/lib/orb/resources/items.rb +1 -1
  144. data/lib/orb/resources/metrics.rb +11 -11
  145. data/lib/orb/resources/plans/external_plan_id.rb +14 -14
  146. data/lib/orb/resources/plans.rb +22 -22
  147. data/lib/orb/resources/prices/external_price_id.rb +4 -4
  148. data/lib/orb/resources/prices.rb +30 -30
  149. data/lib/orb/resources/subscription_changes.rb +87 -0
  150. data/lib/orb/resources/subscriptions.rb +813 -813
  151. data/lib/orb/resources/top_level.rb +4 -4
  152. data/lib/orb/version.rb +1 -1
  153. data/lib/orb.rb +7 -0
  154. data/rbi/lib/orb/client.rbi +5 -4
  155. data/rbi/lib/orb/errors.rbi +3 -6
  156. data/rbi/lib/orb/internal/page.rbi +3 -6
  157. data/rbi/lib/orb/internal/transport/base_client.rbi +13 -27
  158. data/rbi/lib/orb/internal/transport/pooled_net_requester.rbi +7 -13
  159. data/rbi/lib/orb/internal/type/array_of.rbi +8 -16
  160. data/rbi/lib/orb/internal/type/base_model.rbi +45 -64
  161. data/rbi/lib/orb/internal/type/base_page.rbi +5 -10
  162. data/rbi/lib/orb/internal/type/boolean.rbi +4 -8
  163. data/rbi/lib/orb/internal/type/converter.rbi +25 -31
  164. data/rbi/lib/orb/internal/type/enum.rbi +14 -20
  165. data/rbi/lib/orb/internal/type/hash_of.rbi +8 -16
  166. data/rbi/lib/orb/internal/type/request_parameters.rbi +1 -2
  167. data/rbi/lib/orb/internal/type/union.rbi +10 -20
  168. data/rbi/lib/orb/internal/type/unknown.rbi +4 -8
  169. data/rbi/lib/orb/internal/util.rbi +34 -68
  170. data/rbi/lib/orb/internal.rbi +1 -1
  171. data/rbi/lib/orb/models/alert.rbi +21 -33
  172. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +8 -13
  173. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +8 -13
  174. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +8 -13
  175. data/rbi/lib/orb/models/alert_disable_params.rbi +2 -4
  176. data/rbi/lib/orb/models/alert_enable_params.rbi +2 -4
  177. data/rbi/lib/orb/models/alert_list_params.rbi +3 -6
  178. data/rbi/lib/orb/models/alert_retrieve_params.rbi +2 -4
  179. data/rbi/lib/orb/models/alert_update_params.rbi +7 -11
  180. data/rbi/lib/orb/models/amount_discount.rbi +4 -7
  181. data/rbi/lib/orb/models/billable_metric.rbi +10 -13
  182. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -2
  183. data/rbi/lib/orb/models/coupon.rbi +9 -11
  184. data/rbi/lib/orb/models/coupon_archive_params.rbi +2 -4
  185. data/rbi/lib/orb/models/coupon_create_params.rbi +8 -14
  186. data/rbi/lib/orb/models/coupon_fetch_params.rbi +2 -4
  187. data/rbi/lib/orb/models/coupon_list_params.rbi +3 -4
  188. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +3 -5
  189. data/rbi/lib/orb/models/credit_note.rbi +22 -45
  190. data/rbi/lib/orb/models/credit_note_create_params.rbi +5 -10
  191. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +2 -4
  192. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -6
  193. data/rbi/lib/orb/models/customer.rbi +256 -281
  194. data/rbi/lib/orb/models/customer_create_params.rbi +251 -276
  195. data/rbi/lib/orb/models/customer_delete_params.rbi +2 -4
  196. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +2 -4
  197. data/rbi/lib/orb/models/customer_fetch_params.rbi +2 -4
  198. data/rbi/lib/orb/models/customer_list_params.rbi +3 -6
  199. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +2 -4
  200. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +2 -4
  201. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +252 -277
  202. data/rbi/lib/orb/models/customer_update_params.rbi +252 -277
  203. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +3 -6
  204. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +10 -19
  205. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -6
  206. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +10 -19
  207. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +8 -10
  208. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +6 -12
  209. data/rbi/lib/orb/models/customers/cost_list_params.rbi +8 -10
  210. data/rbi/lib/orb/models/customers/cost_list_response.rbi +6 -12
  211. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +3 -4
  212. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +2 -4
  213. data/rbi/lib/orb/models/customers/credit_list_params.rbi +3 -4
  214. data/rbi/lib/orb/models/customers/credit_list_response.rbi +2 -4
  215. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +26 -33
  216. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +79 -136
  217. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +26 -33
  218. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +78 -135
  219. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +5 -10
  220. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +79 -136
  221. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +5 -10
  222. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +74 -131
  223. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +13 -19
  224. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +12 -18
  225. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +13 -19
  226. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +12 -18
  227. data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +2 -4
  228. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +2 -4
  229. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +3 -5
  230. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +12 -18
  231. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +3 -5
  232. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +12 -18
  233. data/rbi/lib/orb/models/dimensional_price_group.rbi +8 -9
  234. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -7
  235. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +3 -5
  236. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +2 -4
  237. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +2 -4
  238. data/rbi/lib/orb/models/dimensional_price_groups.rbi +2 -4
  239. data/rbi/lib/orb/models/discount.rbi +1 -2
  240. data/rbi/lib/orb/models/evaluate_price_group.rbi +3 -6
  241. data/rbi/lib/orb/models/event_deprecate_params.rbi +2 -4
  242. data/rbi/lib/orb/models/event_deprecate_response.rbi +2 -4
  243. data/rbi/lib/orb/models/event_ingest_params.rbi +10 -13
  244. data/rbi/lib/orb/models/event_ingest_response.rbi +10 -16
  245. data/rbi/lib/orb/models/event_search_params.rbi +7 -9
  246. data/rbi/lib/orb/models/event_search_response.rbi +11 -14
  247. data/rbi/lib/orb/models/event_update_params.rbi +5 -6
  248. data/rbi/lib/orb/models/event_update_response.rbi +2 -4
  249. data/rbi/lib/orb/models/events/backfill_close_params.rbi +2 -4
  250. data/rbi/lib/orb/models/events/backfill_close_response.rbi +10 -14
  251. data/rbi/lib/orb/models/events/backfill_create_params.rbi +13 -16
  252. data/rbi/lib/orb/models/events/backfill_create_response.rbi +10 -14
  253. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +2 -4
  254. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +10 -14
  255. data/rbi/lib/orb/models/events/backfill_list_params.rbi +3 -5
  256. data/rbi/lib/orb/models/events/backfill_list_response.rbi +10 -14
  257. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +2 -4
  258. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +10 -14
  259. data/rbi/lib/orb/models/events/event_volumes.rbi +5 -9
  260. data/rbi/lib/orb/models/events/volume_list_params.rbi +9 -11
  261. data/rbi/lib/orb/models/invoice.rbi +388 -465
  262. data/rbi/lib/orb/models/invoice_create_params.rbi +19 -26
  263. data/rbi/lib/orb/models/invoice_fetch_params.rbi +2 -4
  264. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +2 -4
  265. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +381 -460
  266. data/rbi/lib/orb/models/invoice_issue_params.rbi +6 -8
  267. data/rbi/lib/orb/models/invoice_level_discount.rbi +1 -2
  268. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +3 -5
  269. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +101 -143
  270. data/rbi/lib/orb/models/invoice_list_params.rbi +8 -13
  271. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +2 -4
  272. data/rbi/lib/orb/models/invoice_pay_params.rbi +2 -4
  273. data/rbi/lib/orb/models/invoice_update_params.rbi +4 -6
  274. data/rbi/lib/orb/models/invoice_void_params.rbi +2 -4
  275. data/rbi/lib/orb/models/item.rbi +7 -12
  276. data/rbi/lib/orb/models/item_create_params.rbi +2 -4
  277. data/rbi/lib/orb/models/item_fetch_params.rbi +2 -4
  278. data/rbi/lib/orb/models/item_list_params.rbi +3 -5
  279. data/rbi/lib/orb/models/item_update_params.rbi +5 -10
  280. data/rbi/lib/orb/models/metric_create_params.rbi +4 -6
  281. data/rbi/lib/orb/models/metric_fetch_params.rbi +2 -4
  282. data/rbi/lib/orb/models/metric_list_params.rbi +3 -6
  283. data/rbi/lib/orb/models/metric_update_params.rbi +4 -6
  284. data/rbi/lib/orb/models/pagination_metadata.rbi +2 -4
  285. data/rbi/lib/orb/models/percentage_discount.rbi +5 -8
  286. data/rbi/lib/orb/models/plan.rbi +180 -219
  287. data/rbi/lib/orb/models/plan_create_params.rbi +670 -951
  288. data/rbi/lib/orb/models/plan_fetch_params.rbi +2 -4
  289. data/rbi/lib/orb/models/plan_list_params.rbi +4 -8
  290. data/rbi/lib/orb/models/plan_update_params.rbi +6 -8
  291. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +2 -4
  292. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +6 -8
  293. data/rbi/lib/orb/models/price.rbi +827 -1494
  294. data/rbi/lib/orb/models/price_create_params.rbi +60 -101
  295. data/rbi/lib/orb/models/price_evaluate_params.rbi +6 -9
  296. data/rbi/lib/orb/models/price_evaluate_response.rbi +2 -4
  297. data/rbi/lib/orb/models/price_fetch_params.rbi +2 -4
  298. data/rbi/lib/orb/models/price_list_params.rbi +3 -5
  299. data/rbi/lib/orb/models/price_update_params.rbi +4 -6
  300. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +2 -4
  301. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +4 -6
  302. data/rbi/lib/orb/models/subscription.rbi +167 -187
  303. data/rbi/lib/orb/models/subscription_cancel_params.rbi +5 -7
  304. data/rbi/lib/orb/models/subscription_cancel_response.rbi +224 -178
  305. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +40 -0
  306. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +1554 -0
  307. data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +18 -0
  308. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +1565 -0
  309. data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +18 -0
  310. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +1581 -0
  311. data/rbi/lib/orb/models/subscription_create_params.rbi +1372 -1968
  312. data/rbi/lib/orb/models/subscription_create_response.rbi +224 -178
  313. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +8 -10
  314. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +6 -12
  315. data/rbi/lib/orb/models/subscription_fetch_params.rbi +2 -4
  316. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -6
  317. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +6 -10
  318. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +12 -17
  319. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -8
  320. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +772 -1124
  321. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +228 -178
  322. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +1396 -1993
  323. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +238 -182
  324. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +5 -7
  325. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +224 -178
  326. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +2 -4
  327. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +238 -182
  328. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +2 -4
  329. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +265 -199
  330. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +2 -4
  331. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +264 -198
  332. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -15
  333. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +238 -182
  334. data/rbi/lib/orb/models/subscription_update_params.rbi +12 -15
  335. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +6 -9
  336. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +224 -178
  337. data/rbi/lib/orb/models/subscription_usage.rbi +24 -43
  338. data/rbi/lib/orb/models/subscriptions.rbi +2 -4
  339. data/rbi/lib/orb/models/top_level_ping_params.rbi +2 -4
  340. data/rbi/lib/orb/models/top_level_ping_response.rbi +2 -4
  341. data/rbi/lib/orb/models/trial_discount.rbi +4 -8
  342. data/rbi/lib/orb/models/usage_discount.rbi +5 -8
  343. data/rbi/lib/orb/request_options.rbi +9 -11
  344. data/rbi/lib/orb/resources/alerts.rbi +44 -60
  345. data/rbi/lib/orb/resources/coupons/subscriptions.rbi +6 -9
  346. data/rbi/lib/orb/resources/coupons.rbi +18 -25
  347. data/rbi/lib/orb/resources/credit_notes.rbi +9 -15
  348. data/rbi/lib/orb/resources/customers/balance_transactions.rbi +26 -31
  349. data/rbi/lib/orb/resources/customers/costs.rbi +241 -246
  350. data/rbi/lib/orb/resources/customers/credits/ledger.rbi +387 -396
  351. data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +29 -40
  352. data/rbi/lib/orb/resources/customers/credits.rbi +15 -20
  353. data/rbi/lib/orb/resources/customers.rbi +407 -417
  354. data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +2 -4
  355. data/rbi/lib/orb/resources/dimensional_price_groups.rbi +13 -19
  356. data/rbi/lib/orb/resources/events/backfills.rbi +61 -69
  357. data/rbi/lib/orb/resources/events/volume.rbi +19 -22
  358. data/rbi/lib/orb/resources/events.rbi +311 -319
  359. data/rbi/lib/orb/resources/invoice_line_items.rbi +4 -7
  360. data/rbi/lib/orb/resources/invoices.rbi +62 -76
  361. data/rbi/lib/orb/resources/items.rbi +7 -14
  362. data/rbi/lib/orb/resources/metrics.rbi +17 -25
  363. data/rbi/lib/orb/resources/plans/external_plan_id.rbi +21 -25
  364. data/rbi/lib/orb/resources/plans.rbi +63 -71
  365. data/rbi/lib/orb/resources/prices/external_price_id.rbi +9 -13
  366. data/rbi/lib/orb/resources/prices.rbi +77 -87
  367. data/rbi/lib/orb/resources/subscription_changes.rbi +61 -0
  368. data/rbi/lib/orb/resources/subscriptions.rbi +933 -963
  369. data/rbi/lib/orb/resources/top_level.rbi +6 -8
  370. data/sig/orb/client.rbs +2 -0
  371. data/sig/orb/models/subscription.rbs +14 -0
  372. data/sig/orb/models/subscription_cancel_response.rbs +47 -2
  373. data/sig/orb/models/subscription_change_apply_params.rbs +24 -0
  374. data/sig/orb/models/subscription_change_apply_response.rbs +784 -0
  375. data/sig/orb/models/subscription_change_cancel_params.rbs +15 -0
  376. data/sig/orb/models/subscription_change_cancel_response.rbs +784 -0
  377. data/sig/orb/models/subscription_change_retrieve_params.rbs +15 -0
  378. data/sig/orb/models/subscription_change_retrieve_response.rbs +784 -0
  379. data/sig/orb/models/subscription_create_response.rbs +47 -2
  380. data/sig/orb/models/subscription_price_intervals_response.rbs +47 -2
  381. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +47 -2
  382. data/sig/orb/models/subscription_trigger_phase_response.rbs +47 -2
  383. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +47 -2
  384. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +47 -2
  385. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +47 -2
  386. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +47 -2
  387. data/sig/orb/models/subscription_update_trial_response.rbs +47 -2
  388. data/sig/orb/resources/customers.rbs +2 -2
  389. data/sig/orb/resources/subscription_changes.rbs +24 -0
  390. metadata +23 -2
@@ -12,34 +12,34 @@ module Orb
12
12
  currency: String,
13
13
  name: String,
14
14
  prices: T::Array[
15
- T.any(
16
- Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice,
17
- Orb::Internal::AnyHash,
18
- Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice,
19
- Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice,
20
- Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice,
21
- Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice,
22
- Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice,
23
- Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice,
24
- Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice,
25
- Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice,
26
- Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice,
27
- Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice,
28
- Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice,
29
- Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice,
30
- Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice,
31
- Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice,
32
- Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice,
33
- Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice,
34
- Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice,
35
- Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice,
36
- Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice,
37
- Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice,
38
- Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice,
39
- Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice,
40
- Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice,
41
- Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice
42
- )
15
+ T.any(
16
+ Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice,
17
+ Orb::Internal::AnyHash,
18
+ Orb::Models::PlanCreateParams::Price::NewPlanPackagePrice,
19
+ Orb::Models::PlanCreateParams::Price::NewPlanMatrixPrice,
20
+ Orb::Models::PlanCreateParams::Price::NewPlanTieredPrice,
21
+ Orb::Models::PlanCreateParams::Price::NewPlanTieredBpsPrice,
22
+ Orb::Models::PlanCreateParams::Price::NewPlanBpsPrice,
23
+ Orb::Models::PlanCreateParams::Price::NewPlanBulkBpsPrice,
24
+ Orb::Models::PlanCreateParams::Price::NewPlanBulkPrice,
25
+ Orb::Models::PlanCreateParams::Price::NewPlanThresholdTotalAmountPrice,
26
+ Orb::Models::PlanCreateParams::Price::NewPlanTieredPackagePrice,
27
+ Orb::Models::PlanCreateParams::Price::NewPlanTieredWithMinimumPrice,
28
+ Orb::Models::PlanCreateParams::Price::NewPlanUnitWithPercentPrice,
29
+ Orb::Models::PlanCreateParams::Price::NewPlanPackageWithAllocationPrice,
30
+ Orb::Models::PlanCreateParams::Price::NewPlanTierWithProrationPrice,
31
+ Orb::Models::PlanCreateParams::Price::NewPlanUnitWithProrationPrice,
32
+ Orb::Models::PlanCreateParams::Price::NewPlanGroupedAllocationPrice,
33
+ Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithProratedMinimumPrice,
34
+ Orb::Models::PlanCreateParams::Price::NewPlanGroupedWithMeteredMinimumPrice,
35
+ Orb::Models::PlanCreateParams::Price::NewPlanMatrixWithDisplayNamePrice,
36
+ Orb::Models::PlanCreateParams::Price::NewPlanBulkWithProrationPrice,
37
+ Orb::Models::PlanCreateParams::Price::NewPlanGroupedTieredPackagePrice,
38
+ Orb::Models::PlanCreateParams::Price::NewPlanMaxGroupTieredPackagePrice,
39
+ Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithUnitPricingPrice,
40
+ Orb::Models::PlanCreateParams::Price::NewPlanScalableMatrixWithTieredPricingPrice,
41
+ Orb::Models::PlanCreateParams::Price::NewPlanCumulativeGroupedBulkPrice
42
+ )
43
43
  ],
44
44
  default_invoice_memo: T.nilable(String),
45
45
  external_plan_id: T.nilable(String),
@@ -52,34 +52,32 @@ module Orb
52
52
  end
53
53
  def create(
54
54
  # An ISO 4217 currency string for invoices generated by subscriptions on this
55
- # plan.
55
+ # plan.
56
56
  currency:,
57
57
  name:,
58
58
  # Prices for this plan. If the plan has phases, this includes prices across all
59
- # phases of the plan.
59
+ # phases of the plan.
60
60
  prices:,
61
61
  # Free-form text which is available on the invoice PDF and the Orb invoice portal.
62
62
  default_invoice_memo: nil,
63
63
  external_plan_id: nil,
64
64
  # User-specified key/value pairs for the resource. Individual keys can be removed
65
- # by setting the value to `null`, and the entire metadata mapping can be cleared
66
- # by setting `metadata` to `null`.
65
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
66
+ # by setting `metadata` to `null`.
67
67
  metadata: nil,
68
68
  # The net terms determines the difference between the invoice date and the issue
69
- # date for the invoice. If you intend the invoice to be due on issue, set this
70
- # to 0.
69
+ # date for the invoice. If you intend the invoice to be due on issue, set this
70
+ # to 0.
71
71
  net_terms: nil,
72
72
  # The status of the plan to create (either active or draft). If not specified,
73
- # this defaults to active.
73
+ # this defaults to active.
74
74
  status: nil,
75
75
  request_options: {}
76
- )
77
- end
78
-
76
+ ); end
79
77
  # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
80
- # existing plan.
78
+ # existing plan.
81
79
  #
82
- # Other fields on a customer are currently immutable.
80
+ # Other fields on a customer are currently immutable.
83
81
  sig do
84
82
  params(
85
83
  plan_id: String,
@@ -92,22 +90,20 @@ module Orb
92
90
  def update(
93
91
  plan_id,
94
92
  # An optional user-defined ID for this plan resource, used throughout the system
95
- # as an alias for this Plan. Use this field to identify a plan by an existing
96
- # identifier in your system.
93
+ # as an alias for this Plan. Use this field to identify a plan by an existing
94
+ # identifier in your system.
97
95
  external_plan_id: nil,
98
96
  # User-specified key/value pairs for the resource. Individual keys can be removed
99
- # by setting the value to `null`, and the entire metadata mapping can be cleared
100
- # by setting `metadata` to `null`.
97
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
98
+ # by setting `metadata` to `null`.
101
99
  metadata: nil,
102
100
  request_options: {}
103
- )
104
- end
105
-
101
+ ); end
106
102
  # This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for
107
- # an account in a list format. The list of plans is ordered starting from the most
108
- # recently created plan. The response also includes
109
- # [`pagination_metadata`](/api-reference/pagination), which lets the caller
110
- # retrieve the next page of results if they exist.
103
+ # an account in a list format. The list of plans is ordered starting from the most
104
+ # recently created plan. The response also includes
105
+ # [`pagination_metadata`](/api-reference/pagination), which lets the caller
106
+ # retrieve the next page of results if they exist.
111
107
  sig do
112
108
  params(
113
109
  created_at_gt: T.nilable(Time),
@@ -127,33 +123,31 @@ module Orb
127
123
  created_at_lt: nil,
128
124
  created_at_lte: nil,
129
125
  # Cursor for pagination. This can be populated by the `next_cursor` value returned
130
- # from the initial request.
126
+ # from the initial request.
131
127
  cursor: nil,
132
128
  # The number of items to fetch. Defaults to 20.
133
129
  limit: nil,
134
130
  # The plan status to filter to ('active', 'archived', or 'draft').
135
131
  status: nil,
136
132
  request_options: {}
137
- )
138
- end
139
-
133
+ ); end
140
134
  # This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details
141
- # given a plan identifier. It returns information about the prices included in the
142
- # plan and their configuration, as well as the product that the plan is attached
143
- # to.
135
+ # given a plan identifier. It returns information about the prices included in the
136
+ # plan and their configuration, as well as the product that the plan is attached
137
+ # to.
144
138
  #
145
- # ## Serialized prices
139
+ # ## Serialized prices
146
140
  #
147
- # Orb supports a few different pricing models out of the box. Each of these models
148
- # is serialized differently in a given [Price](/core-concepts#plan-and-price)
149
- # object. The `model_type` field determines the key for the configuration object
150
- # that is present. A detailed explanation of price types can be found in the
151
- # [Price schema](/core-concepts#plan-and-price).
141
+ # Orb supports a few different pricing models out of the box. Each of these models
142
+ # is serialized differently in a given [Price](/core-concepts#plan-and-price)
143
+ # object. The `model_type` field determines the key for the configuration object
144
+ # that is present. A detailed explanation of price types can be found in the
145
+ # [Price schema](/core-concepts#plan-and-price).
152
146
  #
153
- # ## Phases
147
+ # ## Phases
154
148
  #
155
- # Orb supports plan phases, also known as contract ramps. For plans with phases,
156
- # the serialized prices refer to all prices across all phases.
149
+ # Orb supports plan phases, also known as contract ramps. For plans with phases,
150
+ # the serialized prices refer to all prices across all phases.
157
151
  sig do
158
152
  params(
159
153
  plan_id: String,
@@ -161,13 +155,11 @@ module Orb
161
155
  )
162
156
  .returns(Orb::Models::Plan)
163
157
  end
164
- def fetch(plan_id, request_options: {})
165
- end
158
+ def fetch(plan_id, request_options: {}); end
166
159
 
167
160
  # @api private
168
161
  sig { params(client: Orb::Client).returns(T.attached_class) }
169
- def self.new(client:)
170
- end
162
+ def self.new(client:); end
171
163
  end
172
164
  end
173
165
  end
@@ -5,8 +5,8 @@ module Orb
5
5
  class Prices
6
6
  class ExternalPriceID
7
7
  # This endpoint allows you to update the `metadata` property on a price. If you
8
- # pass null for the metadata value, it will clear any existing metadata for that
9
- # price.
8
+ # pass null for the metadata value, it will clear any existing metadata for that
9
+ # price.
10
10
  sig do
11
11
  params(
12
12
  external_price_id: String,
@@ -49,16 +49,14 @@ module Orb
49
49
  def update(
50
50
  external_price_id,
51
51
  # User-specified key/value pairs for the resource. Individual keys can be removed
52
- # by setting the value to `null`, and the entire metadata mapping can be cleared
53
- # by setting `metadata` to `null`.
52
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
53
+ # by setting `metadata` to `null`.
54
54
  metadata: nil,
55
55
  request_options: {}
56
- )
57
- end
58
-
56
+ ); end
59
57
  # This endpoint returns a price given an external price id. See the
60
- # [price creation API](/api-reference/price/create-price) for more information
61
- # about external price aliases.
58
+ # [price creation API](/api-reference/price/create-price) for more information
59
+ # about external price aliases.
62
60
  sig do
63
61
  params(
64
62
  external_price_id: String,
@@ -97,13 +95,11 @@ module Orb
97
95
  )
98
96
  )
99
97
  end
100
- def fetch(external_price_id, request_options: {})
101
- end
98
+ def fetch(external_price_id, request_options: {}); end
102
99
 
103
100
  # @api private
104
101
  sig { params(client: Orb::Client).returns(T.attached_class) }
105
- def self.new(client:)
106
- end
102
+ def self.new(client:); end
107
103
  end
108
104
  end
109
105
  end
@@ -7,15 +7,15 @@ module Orb
7
7
  attr_reader :external_price_id
8
8
 
9
9
  # This endpoint is used to create a [price](/product-catalog/price-configuration).
10
- # A price created using this endpoint is always an add-on, meaning that it’s not
11
- # associated with a specific plan and can instead be individually added to
12
- # subscriptions, including subscriptions on different plans.
10
+ # A price created using this endpoint is always an add-on, meaning that it’s not
11
+ # associated with a specific plan and can instead be individually added to
12
+ # subscriptions, including subscriptions on different plans.
13
13
  #
14
- # An `external_price_id` can be optionally specified as an alias to allow
15
- # ergonomic interaction with prices in the Orb API.
14
+ # An `external_price_id` can be optionally specified as an alias to allow
15
+ # ergonomic interaction with prices in the Orb API.
16
16
  #
17
- # See the [Price resource](/product-catalog/price-configuration) for the
18
- # specification of different price model configurations possible in this endpoint.
17
+ # See the [Price resource](/product-catalog/price-configuration) for the
18
+ # specification of different price model configurations possible in this endpoint.
19
19
  sig do
20
20
  params(
21
21
  cadence: Orb::Models::PriceCreateParams::Cadence::OrSymbol,
@@ -134,37 +134,35 @@ module Orb
134
134
  scalable_matrix_with_tiered_pricing_config:,
135
135
  cumulative_grouped_bulk_config:,
136
136
  # The id of the billable metric for the price. Only needed if the price is
137
- # usage-based.
137
+ # usage-based.
138
138
  billable_metric_id: nil,
139
139
  # If the Price represents a fixed cost, the price will be billed in-advance if
140
- # this is true, and in-arrears if this is false.
140
+ # this is true, and in-arrears if this is false.
141
141
  billed_in_advance: nil,
142
142
  # For custom cadence: specifies the duration of the billing period in days or
143
- # months.
143
+ # months.
144
144
  billing_cycle_configuration: nil,
145
145
  # The per unit conversion rate of the price currency to the invoicing currency.
146
146
  conversion_rate: nil,
147
147
  # An alias for the price.
148
148
  external_price_id: nil,
149
149
  # If the Price represents a fixed cost, this represents the quantity of units
150
- # applied.
150
+ # applied.
151
151
  fixed_price_quantity: nil,
152
152
  # The property used to group this price on an invoice
153
153
  invoice_grouping_key: nil,
154
154
  # Within each billing cycle, specifies the cadence at which invoices are produced.
155
- # If unspecified, a single invoice is produced per billing cycle.
155
+ # If unspecified, a single invoice is produced per billing cycle.
156
156
  invoicing_cycle_configuration: nil,
157
157
  # User-specified key/value pairs for the resource. Individual keys can be removed
158
- # by setting the value to `null`, and the entire metadata mapping can be cleared
159
- # by setting `metadata` to `null`.
158
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
159
+ # by setting `metadata` to `null`.
160
160
  metadata: nil,
161
161
  request_options: {}
162
- )
163
- end
164
-
162
+ ); end
165
163
  # This endpoint allows you to update the `metadata` property on a price. If you
166
- # pass null for the metadata value, it will clear any existing metadata for that
167
- # price.
164
+ # pass null for the metadata value, it will clear any existing metadata for that
165
+ # price.
168
166
  sig do
169
167
  params(
170
168
  price_id: String,
@@ -207,15 +205,13 @@ module Orb
207
205
  def update(
208
206
  price_id,
209
207
  # User-specified key/value pairs for the resource. Individual keys can be removed
210
- # by setting the value to `null`, and the entire metadata mapping can be cleared
211
- # by setting `metadata` to `null`.
208
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
209
+ # by setting `metadata` to `null`.
212
210
  metadata: nil,
213
211
  request_options: {}
214
- )
215
- end
216
-
212
+ ); end
217
213
  # This endpoint is used to list all add-on prices created using the
218
- # [price creation endpoint](/api-reference/price/create-price).
214
+ # [price creation endpoint](/api-reference/price/create-price).
219
215
  sig do
220
216
  params(
221
217
  cursor: T.nilable(String),
@@ -224,70 +220,68 @@ module Orb
224
220
  )
225
221
  .returns(
226
222
  Orb::Internal::Page[
227
- T.any(
228
- Orb::Models::Price::UnitPrice,
229
- Orb::Models::Price::PackagePrice,
230
- Orb::Models::Price::MatrixPrice,
231
- Orb::Models::Price::TieredPrice,
232
- Orb::Models::Price::TieredBpsPrice,
233
- Orb::Models::Price::BpsPrice,
234
- Orb::Models::Price::BulkBpsPrice,
235
- Orb::Models::Price::BulkPrice,
236
- Orb::Models::Price::ThresholdTotalAmountPrice,
237
- Orb::Models::Price::TieredPackagePrice,
238
- Orb::Models::Price::GroupedTieredPrice,
239
- Orb::Models::Price::TieredWithMinimumPrice,
240
- Orb::Models::Price::TieredPackageWithMinimumPrice,
241
- Orb::Models::Price::PackageWithAllocationPrice,
242
- Orb::Models::Price::UnitWithPercentPrice,
243
- Orb::Models::Price::MatrixWithAllocationPrice,
244
- Orb::Models::Price::TieredWithProrationPrice,
245
- Orb::Models::Price::UnitWithProrationPrice,
246
- Orb::Models::Price::GroupedAllocationPrice,
247
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
248
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
249
- Orb::Models::Price::MatrixWithDisplayNamePrice,
250
- Orb::Models::Price::BulkWithProrationPrice,
251
- Orb::Models::Price::GroupedTieredPackagePrice,
252
- Orb::Models::Price::MaxGroupTieredPackagePrice,
253
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
254
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
255
- Orb::Models::Price::CumulativeGroupedBulkPrice
256
- )
223
+ T.any(
224
+ Orb::Models::Price::UnitPrice,
225
+ Orb::Models::Price::PackagePrice,
226
+ Orb::Models::Price::MatrixPrice,
227
+ Orb::Models::Price::TieredPrice,
228
+ Orb::Models::Price::TieredBpsPrice,
229
+ Orb::Models::Price::BpsPrice,
230
+ Orb::Models::Price::BulkBpsPrice,
231
+ Orb::Models::Price::BulkPrice,
232
+ Orb::Models::Price::ThresholdTotalAmountPrice,
233
+ Orb::Models::Price::TieredPackagePrice,
234
+ Orb::Models::Price::GroupedTieredPrice,
235
+ Orb::Models::Price::TieredWithMinimumPrice,
236
+ Orb::Models::Price::TieredPackageWithMinimumPrice,
237
+ Orb::Models::Price::PackageWithAllocationPrice,
238
+ Orb::Models::Price::UnitWithPercentPrice,
239
+ Orb::Models::Price::MatrixWithAllocationPrice,
240
+ Orb::Models::Price::TieredWithProrationPrice,
241
+ Orb::Models::Price::UnitWithProrationPrice,
242
+ Orb::Models::Price::GroupedAllocationPrice,
243
+ Orb::Models::Price::GroupedWithProratedMinimumPrice,
244
+ Orb::Models::Price::GroupedWithMeteredMinimumPrice,
245
+ Orb::Models::Price::MatrixWithDisplayNamePrice,
246
+ Orb::Models::Price::BulkWithProrationPrice,
247
+ Orb::Models::Price::GroupedTieredPackagePrice,
248
+ Orb::Models::Price::MaxGroupTieredPackagePrice,
249
+ Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
250
+ Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
251
+ Orb::Models::Price::CumulativeGroupedBulkPrice
252
+ )
257
253
  ]
258
254
  )
259
255
  end
260
256
  def list(
261
257
  # Cursor for pagination. This can be populated by the `next_cursor` value returned
262
- # from the initial request.
258
+ # from the initial request.
263
259
  cursor: nil,
264
260
  # The number of items to fetch. Defaults to 20.
265
261
  limit: nil,
266
262
  request_options: {}
267
- )
268
- end
269
-
263
+ ); end
270
264
  # This endpoint is used to evaluate the output of a price for a given customer and
271
- # time range. It enables filtering and grouping the output using
272
- # [computed properties](/extensibility/advanced-metrics#computed-properties),
273
- # supporting the following workflows:
265
+ # time range. It enables filtering and grouping the output using
266
+ # [computed properties](/extensibility/advanced-metrics#computed-properties),
267
+ # supporting the following workflows:
274
268
  #
275
- # 1. Showing detailed usage and costs to the end customer.
276
- # 2. Auditing subtotals on invoice line items.
269
+ # 1. Showing detailed usage and costs to the end customer.
270
+ # 2. Auditing subtotals on invoice line items.
277
271
  #
278
- # For these workflows, the expressiveness of computed properties in both the
279
- # filters and grouping is critical. For example, if you'd like to show your
280
- # customer their usage grouped by hour and another property, you can do so with
281
- # the following `grouping_keys`:
282
- # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd
283
- # like to examine a customer's usage for a specific property value, you can do so
284
- # with the following `filter`:
285
- # `my_property = 'foo' AND my_other_property = 'bar'`.
272
+ # For these workflows, the expressiveness of computed properties in both the
273
+ # filters and grouping is critical. For example, if you'd like to show your
274
+ # customer their usage grouped by hour and another property, you can do so with
275
+ # the following `grouping_keys`:
276
+ # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd
277
+ # like to examine a customer's usage for a specific property value, you can do so
278
+ # with the following `filter`:
279
+ # `my_property = 'foo' AND my_other_property = 'bar'`.
286
280
  #
287
- # By default, the start of the time range must be no more than 100 days ago and
288
- # the length of the results must be no greater than 1000. Note that this is a POST
289
- # endpoint rather than a GET endpoint because it employs a JSON body rather than
290
- # query parameters.
281
+ # By default, the start of the time range must be no more than 100 days ago and
282
+ # the length of the results must be no greater than 1000. Note that this is a POST
283
+ # endpoint rather than a GET endpoint because it employs a JSON body rather than
284
+ # query parameters.
291
285
  sig do
292
286
  params(
293
287
  price_id: String,
@@ -312,17 +306,15 @@ module Orb
312
306
  # The external customer ID of the customer to which this evaluation is scoped.
313
307
  external_customer_id: nil,
314
308
  # A boolean
315
- # [computed property](/extensibility/advanced-metrics#computed-properties) used to
316
- # filter the underlying billable metric
309
+ # [computed property](/extensibility/advanced-metrics#computed-properties) used to
310
+ # filter the underlying billable metric
317
311
  filter: nil,
318
312
  # Properties (or
319
- # [computed properties](/extensibility/advanced-metrics#computed-properties)) used
320
- # to group the underlying billable metric
313
+ # [computed properties](/extensibility/advanced-metrics#computed-properties)) used
314
+ # to group the underlying billable metric
321
315
  grouping_keys: nil,
322
316
  request_options: {}
323
- )
324
- end
325
-
317
+ ); end
326
318
  # This endpoint returns a price given an identifier.
327
319
  sig do
328
320
  params(
@@ -362,13 +354,11 @@ module Orb
362
354
  )
363
355
  )
364
356
  end
365
- def fetch(price_id, request_options: {})
366
- end
357
+ def fetch(price_id, request_options: {}); end
367
358
 
368
359
  # @api private
369
360
  sig { params(client: Orb::Client).returns(T.attached_class) }
370
- def self.new(client:)
371
- end
361
+ def self.new(client:); end
372
362
  end
373
363
  end
374
364
  end
@@ -0,0 +1,61 @@
1
+ # typed: strong
2
+
3
+ module Orb
4
+ module Resources
5
+ class SubscriptionChanges
6
+ # This endpoint returns a subscription change given an identifier.
7
+ #
8
+ # A subscription change is created by including
9
+ # `Create-Pending-Subscription-Change: True` in the header of a subscription
10
+ # mutation API call (e.g.
11
+ # [create subscription endpoint](/api-reference/subscription/create-subscription),
12
+ # [schedule plan change endpoint](/api-reference/subscription/schedule-plan-change),
13
+ # ...). The subscription change will be referenced by the
14
+ # `pending_subscription_change` field in the response.
15
+ sig do
16
+ params(
17
+ subscription_change_id: String,
18
+ request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
19
+ )
20
+ .returns(Orb::Models::SubscriptionChangeRetrieveResponse)
21
+ end
22
+ def retrieve(subscription_change_id, request_options: {}); end
23
+
24
+ # Apply a subscription change to perform the intended action. If a positive amount
25
+ # is passed with a request to this endpoint, any eligible invoices that were
26
+ # created will be issued immediately if they only contain in-advance fees.
27
+ sig do
28
+ params(
29
+ subscription_change_id: String,
30
+ description: T.nilable(String),
31
+ previously_collected_amount: T.nilable(String),
32
+ request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
33
+ )
34
+ .returns(Orb::Models::SubscriptionChangeApplyResponse)
35
+ end
36
+ def apply(
37
+ subscription_change_id,
38
+ # Description to apply to the balance transaction representing this credit.
39
+ description: nil,
40
+ # Amount already collected to apply to the customer's balance.
41
+ previously_collected_amount: nil,
42
+ request_options: {}
43
+ ); end
44
+ # Cancel a subscription change. The change can no longer be applied. A
45
+ # subscription can only have one "pending" change at a time - use this endpoint to
46
+ # cancel an existing change before creating a new one.
47
+ sig do
48
+ params(
49
+ subscription_change_id: String,
50
+ request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
51
+ )
52
+ .returns(Orb::Models::SubscriptionChangeCancelResponse)
53
+ end
54
+ def cancel(subscription_change_id, request_options: {}); end
55
+
56
+ # @api private
57
+ sig { params(client: Orb::Client).returns(T.attached_class) }
58
+ def self.new(client:); end
59
+ end
60
+ end
61
+ end