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
@@ -13,32 +13,32 @@ module Orb
13
13
  name: String,
14
14
  prices: T::Array[
15
15
  T.any(
16
- Orb::Models::PlanCreateParams::Price::NewPlanUnitPrice,
16
+ Orb::Models::PlanCreateParams::Price::Unit,
17
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
18
+ Orb::Models::PlanCreateParams::Price::Package,
19
+ Orb::Models::PlanCreateParams::Price::Matrix,
20
+ Orb::Models::PlanCreateParams::Price::Tiered,
21
+ Orb::Models::PlanCreateParams::Price::TieredBps,
22
+ Orb::Models::PlanCreateParams::Price::Bps,
23
+ Orb::Models::PlanCreateParams::Price::BulkBps,
24
+ Orb::Models::PlanCreateParams::Price::Bulk,
25
+ Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount,
26
+ Orb::Models::PlanCreateParams::Price::TieredPackage,
27
+ Orb::Models::PlanCreateParams::Price::TieredWithMinimum,
28
+ Orb::Models::PlanCreateParams::Price::UnitWithPercent,
29
+ Orb::Models::PlanCreateParams::Price::PackageWithAllocation,
30
+ Orb::Models::PlanCreateParams::Price::TieredWithProration,
31
+ Orb::Models::PlanCreateParams::Price::UnitWithProration,
32
+ Orb::Models::PlanCreateParams::Price::GroupedAllocation,
33
+ Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum,
34
+ Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum,
35
+ Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName,
36
+ Orb::Models::PlanCreateParams::Price::BulkWithProration,
37
+ Orb::Models::PlanCreateParams::Price::GroupedTieredPackage,
38
+ Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage,
39
+ Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing,
40
+ Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing,
41
+ Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk
42
42
  )
43
43
  ],
44
44
  default_invoice_memo: T.nilable(String),
@@ -46,7 +46,7 @@ module Orb
46
46
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
47
47
  net_terms: T.nilable(Integer),
48
48
  status: Orb::Models::PlanCreateParams::Status::OrSymbol,
49
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
49
+ request_options: Orb::RequestOpts
50
50
  )
51
51
  .returns(Orb::Models::Plan)
52
52
  end
@@ -83,7 +83,7 @@ module Orb
83
83
  plan_id: String,
84
84
  external_plan_id: T.nilable(String),
85
85
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
86
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
86
+ request_options: Orb::RequestOpts
87
87
  )
88
88
  .returns(Orb::Models::Plan)
89
89
  end
@@ -113,7 +113,7 @@ module Orb
113
113
  cursor: T.nilable(String),
114
114
  limit: Integer,
115
115
  status: Orb::Models::PlanListParams::Status::OrSymbol,
116
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
116
+ request_options: Orb::RequestOpts
117
117
  )
118
118
  .returns(Orb::Internal::Page[Orb::Models::Plan])
119
119
  end
@@ -148,13 +148,7 @@ module Orb
148
148
  #
149
149
  # Orb supports plan phases, also known as contract ramps. For plans with phases,
150
150
  # the serialized prices refer to all prices across all phases.
151
- sig do
152
- params(
153
- plan_id: String,
154
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
155
- )
156
- .returns(Orb::Models::Plan)
157
- end
151
+ sig { params(plan_id: String, request_options: Orb::RequestOpts).returns(Orb::Models::Plan) }
158
152
  def fetch(plan_id, request_options: {}); end
159
153
 
160
154
  # @api private
@@ -0,0 +1,103 @@
1
+ # typed: strong
2
+
3
+ module Orb
4
+ module Resources
5
+ class Prices
6
+ class ExternalPriceID
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.
10
+ sig do
11
+ params(
12
+ external_price_id: String,
13
+ metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
14
+ request_options: Orb::RequestOpts
15
+ )
16
+ .returns(
17
+ T.any(
18
+ Orb::Models::Price::Unit,
19
+ Orb::Models::Price::Package,
20
+ Orb::Models::Price::Matrix,
21
+ Orb::Models::Price::Tiered,
22
+ Orb::Models::Price::TieredBps,
23
+ Orb::Models::Price::Bps,
24
+ Orb::Models::Price::BulkBps,
25
+ Orb::Models::Price::Bulk,
26
+ Orb::Models::Price::ThresholdTotalAmount,
27
+ Orb::Models::Price::TieredPackage,
28
+ Orb::Models::Price::GroupedTiered,
29
+ Orb::Models::Price::TieredWithMinimum,
30
+ Orb::Models::Price::TieredPackageWithMinimum,
31
+ Orb::Models::Price::PackageWithAllocation,
32
+ Orb::Models::Price::UnitWithPercent,
33
+ Orb::Models::Price::MatrixWithAllocation,
34
+ Orb::Models::Price::TieredWithProration,
35
+ Orb::Models::Price::UnitWithProration,
36
+ Orb::Models::Price::GroupedAllocation,
37
+ Orb::Models::Price::GroupedWithProratedMinimum,
38
+ Orb::Models::Price::GroupedWithMeteredMinimum,
39
+ Orb::Models::Price::MatrixWithDisplayName,
40
+ Orb::Models::Price::BulkWithProration,
41
+ Orb::Models::Price::GroupedTieredPackage,
42
+ Orb::Models::Price::MaxGroupTieredPackage,
43
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
44
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
45
+ Orb::Models::Price::CumulativeGroupedBulk
46
+ )
47
+ )
48
+ end
49
+ def update(
50
+ external_price_id,
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`.
54
+ metadata: nil,
55
+ request_options: {}
56
+ ); end
57
+ # This endpoint returns a price given an external price id. See the
58
+ # [price creation API](/api-reference/price/create-price) for more information
59
+ # about external price aliases.
60
+ sig do
61
+ params(external_price_id: String, request_options: Orb::RequestOpts)
62
+ .returns(
63
+ T.any(
64
+ Orb::Models::Price::Unit,
65
+ Orb::Models::Price::Package,
66
+ Orb::Models::Price::Matrix,
67
+ Orb::Models::Price::Tiered,
68
+ Orb::Models::Price::TieredBps,
69
+ Orb::Models::Price::Bps,
70
+ Orb::Models::Price::BulkBps,
71
+ Orb::Models::Price::Bulk,
72
+ Orb::Models::Price::ThresholdTotalAmount,
73
+ Orb::Models::Price::TieredPackage,
74
+ Orb::Models::Price::GroupedTiered,
75
+ Orb::Models::Price::TieredWithMinimum,
76
+ Orb::Models::Price::TieredPackageWithMinimum,
77
+ Orb::Models::Price::PackageWithAllocation,
78
+ Orb::Models::Price::UnitWithPercent,
79
+ Orb::Models::Price::MatrixWithAllocation,
80
+ Orb::Models::Price::TieredWithProration,
81
+ Orb::Models::Price::UnitWithProration,
82
+ Orb::Models::Price::GroupedAllocation,
83
+ Orb::Models::Price::GroupedWithProratedMinimum,
84
+ Orb::Models::Price::GroupedWithMeteredMinimum,
85
+ Orb::Models::Price::MatrixWithDisplayName,
86
+ Orb::Models::Price::BulkWithProration,
87
+ Orb::Models::Price::GroupedTieredPackage,
88
+ Orb::Models::Price::MaxGroupTieredPackage,
89
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
90
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
91
+ Orb::Models::Price::CumulativeGroupedBulk
92
+ )
93
+ )
94
+ end
95
+ def fetch(external_price_id, request_options: {}); end
96
+
97
+ # @api private
98
+ sig { params(client: Orb::Client).returns(T.attached_class) }
99
+ def self.new(client:); end
100
+ end
101
+ end
102
+ end
103
+ end
@@ -60,38 +60,38 @@ module Orb
60
60
  invoice_grouping_key: T.nilable(String),
61
61
  invoicing_cycle_configuration: T.nilable(T.any(Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, Orb::Internal::AnyHash)),
62
62
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
63
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
63
+ request_options: Orb::RequestOpts
64
64
  )
65
65
  .returns(
66
66
  T.any(
67
- Orb::Models::Price::UnitPrice,
68
- Orb::Models::Price::PackagePrice,
69
- Orb::Models::Price::MatrixPrice,
70
- Orb::Models::Price::TieredPrice,
71
- Orb::Models::Price::TieredBpsPrice,
72
- Orb::Models::Price::BpsPrice,
73
- Orb::Models::Price::BulkBpsPrice,
74
- Orb::Models::Price::BulkPrice,
75
- Orb::Models::Price::ThresholdTotalAmountPrice,
76
- Orb::Models::Price::TieredPackagePrice,
77
- Orb::Models::Price::GroupedTieredPrice,
78
- Orb::Models::Price::TieredWithMinimumPrice,
79
- Orb::Models::Price::TieredPackageWithMinimumPrice,
80
- Orb::Models::Price::PackageWithAllocationPrice,
81
- Orb::Models::Price::UnitWithPercentPrice,
82
- Orb::Models::Price::MatrixWithAllocationPrice,
83
- Orb::Models::Price::TieredWithProrationPrice,
84
- Orb::Models::Price::UnitWithProrationPrice,
85
- Orb::Models::Price::GroupedAllocationPrice,
86
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
87
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
88
- Orb::Models::Price::MatrixWithDisplayNamePrice,
89
- Orb::Models::Price::BulkWithProrationPrice,
90
- Orb::Models::Price::GroupedTieredPackagePrice,
91
- Orb::Models::Price::MaxGroupTieredPackagePrice,
92
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
93
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
94
- Orb::Models::Price::CumulativeGroupedBulkPrice
67
+ Orb::Models::Price::Unit,
68
+ Orb::Models::Price::Package,
69
+ Orb::Models::Price::Matrix,
70
+ Orb::Models::Price::Tiered,
71
+ Orb::Models::Price::TieredBps,
72
+ Orb::Models::Price::Bps,
73
+ Orb::Models::Price::BulkBps,
74
+ Orb::Models::Price::Bulk,
75
+ Orb::Models::Price::ThresholdTotalAmount,
76
+ Orb::Models::Price::TieredPackage,
77
+ Orb::Models::Price::GroupedTiered,
78
+ Orb::Models::Price::TieredWithMinimum,
79
+ Orb::Models::Price::TieredPackageWithMinimum,
80
+ Orb::Models::Price::PackageWithAllocation,
81
+ Orb::Models::Price::UnitWithPercent,
82
+ Orb::Models::Price::MatrixWithAllocation,
83
+ Orb::Models::Price::TieredWithProration,
84
+ Orb::Models::Price::UnitWithProration,
85
+ Orb::Models::Price::GroupedAllocation,
86
+ Orb::Models::Price::GroupedWithProratedMinimum,
87
+ Orb::Models::Price::GroupedWithMeteredMinimum,
88
+ Orb::Models::Price::MatrixWithDisplayName,
89
+ Orb::Models::Price::BulkWithProration,
90
+ Orb::Models::Price::GroupedTieredPackage,
91
+ Orb::Models::Price::MaxGroupTieredPackage,
92
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
93
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
94
+ Orb::Models::Price::CumulativeGroupedBulk
95
95
  )
96
96
  )
97
97
  end
@@ -167,38 +167,38 @@ module Orb
167
167
  params(
168
168
  price_id: String,
169
169
  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
170
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
170
+ request_options: Orb::RequestOpts
171
171
  )
172
172
  .returns(
173
173
  T.any(
174
- Orb::Models::Price::UnitPrice,
175
- Orb::Models::Price::PackagePrice,
176
- Orb::Models::Price::MatrixPrice,
177
- Orb::Models::Price::TieredPrice,
178
- Orb::Models::Price::TieredBpsPrice,
179
- Orb::Models::Price::BpsPrice,
180
- Orb::Models::Price::BulkBpsPrice,
181
- Orb::Models::Price::BulkPrice,
182
- Orb::Models::Price::ThresholdTotalAmountPrice,
183
- Orb::Models::Price::TieredPackagePrice,
184
- Orb::Models::Price::GroupedTieredPrice,
185
- Orb::Models::Price::TieredWithMinimumPrice,
186
- Orb::Models::Price::TieredPackageWithMinimumPrice,
187
- Orb::Models::Price::PackageWithAllocationPrice,
188
- Orb::Models::Price::UnitWithPercentPrice,
189
- Orb::Models::Price::MatrixWithAllocationPrice,
190
- Orb::Models::Price::TieredWithProrationPrice,
191
- Orb::Models::Price::UnitWithProrationPrice,
192
- Orb::Models::Price::GroupedAllocationPrice,
193
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
194
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
195
- Orb::Models::Price::MatrixWithDisplayNamePrice,
196
- Orb::Models::Price::BulkWithProrationPrice,
197
- Orb::Models::Price::GroupedTieredPackagePrice,
198
- Orb::Models::Price::MaxGroupTieredPackagePrice,
199
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
200
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
201
- Orb::Models::Price::CumulativeGroupedBulkPrice
174
+ Orb::Models::Price::Unit,
175
+ Orb::Models::Price::Package,
176
+ Orb::Models::Price::Matrix,
177
+ Orb::Models::Price::Tiered,
178
+ Orb::Models::Price::TieredBps,
179
+ Orb::Models::Price::Bps,
180
+ Orb::Models::Price::BulkBps,
181
+ Orb::Models::Price::Bulk,
182
+ Orb::Models::Price::ThresholdTotalAmount,
183
+ Orb::Models::Price::TieredPackage,
184
+ Orb::Models::Price::GroupedTiered,
185
+ Orb::Models::Price::TieredWithMinimum,
186
+ Orb::Models::Price::TieredPackageWithMinimum,
187
+ Orb::Models::Price::PackageWithAllocation,
188
+ Orb::Models::Price::UnitWithPercent,
189
+ Orb::Models::Price::MatrixWithAllocation,
190
+ Orb::Models::Price::TieredWithProration,
191
+ Orb::Models::Price::UnitWithProration,
192
+ Orb::Models::Price::GroupedAllocation,
193
+ Orb::Models::Price::GroupedWithProratedMinimum,
194
+ Orb::Models::Price::GroupedWithMeteredMinimum,
195
+ Orb::Models::Price::MatrixWithDisplayName,
196
+ Orb::Models::Price::BulkWithProration,
197
+ Orb::Models::Price::GroupedTieredPackage,
198
+ Orb::Models::Price::MaxGroupTieredPackage,
199
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
200
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
201
+ Orb::Models::Price::CumulativeGroupedBulk
202
202
  )
203
203
  )
204
204
  end
@@ -213,42 +213,38 @@ module Orb
213
213
  # This endpoint is used to list all add-on prices created using the
214
214
  # [price creation endpoint](/api-reference/price/create-price).
215
215
  sig do
216
- params(
217
- cursor: T.nilable(String),
218
- limit: Integer,
219
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
220
- )
216
+ params(cursor: T.nilable(String), limit: Integer, request_options: Orb::RequestOpts)
221
217
  .returns(
222
218
  Orb::Internal::Page[
223
219
  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
220
+ Orb::Models::Price::Unit,
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
252
248
  )
253
249
  ]
254
250
  )
@@ -291,7 +287,7 @@ module Orb
291
287
  external_customer_id: T.nilable(String),
292
288
  filter: T.nilable(String),
293
289
  grouping_keys: T::Array[String],
294
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
290
+ request_options: Orb::RequestOpts
295
291
  )
296
292
  .returns(Orb::Models::PriceEvaluateResponse)
297
293
  end
@@ -317,40 +313,37 @@ module Orb
317
313
  ); end
318
314
  # This endpoint returns a price given an identifier.
319
315
  sig do
320
- params(
321
- price_id: String,
322
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
323
- )
316
+ params(price_id: String, request_options: Orb::RequestOpts)
324
317
  .returns(
325
318
  T.any(
326
- Orb::Models::Price::UnitPrice,
327
- Orb::Models::Price::PackagePrice,
328
- Orb::Models::Price::MatrixPrice,
329
- Orb::Models::Price::TieredPrice,
330
- Orb::Models::Price::TieredBpsPrice,
331
- Orb::Models::Price::BpsPrice,
332
- Orb::Models::Price::BulkBpsPrice,
333
- Orb::Models::Price::BulkPrice,
334
- Orb::Models::Price::ThresholdTotalAmountPrice,
335
- Orb::Models::Price::TieredPackagePrice,
336
- Orb::Models::Price::GroupedTieredPrice,
337
- Orb::Models::Price::TieredWithMinimumPrice,
338
- Orb::Models::Price::TieredPackageWithMinimumPrice,
339
- Orb::Models::Price::PackageWithAllocationPrice,
340
- Orb::Models::Price::UnitWithPercentPrice,
341
- Orb::Models::Price::MatrixWithAllocationPrice,
342
- Orb::Models::Price::TieredWithProrationPrice,
343
- Orb::Models::Price::UnitWithProrationPrice,
344
- Orb::Models::Price::GroupedAllocationPrice,
345
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
346
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
347
- Orb::Models::Price::MatrixWithDisplayNamePrice,
348
- Orb::Models::Price::BulkWithProrationPrice,
349
- Orb::Models::Price::GroupedTieredPackagePrice,
350
- Orb::Models::Price::MaxGroupTieredPackagePrice,
351
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
352
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
353
- Orb::Models::Price::CumulativeGroupedBulkPrice
319
+ Orb::Models::Price::Unit,
320
+ Orb::Models::Price::Package,
321
+ Orb::Models::Price::Matrix,
322
+ Orb::Models::Price::Tiered,
323
+ Orb::Models::Price::TieredBps,
324
+ Orb::Models::Price::Bps,
325
+ Orb::Models::Price::BulkBps,
326
+ Orb::Models::Price::Bulk,
327
+ Orb::Models::Price::ThresholdTotalAmount,
328
+ Orb::Models::Price::TieredPackage,
329
+ Orb::Models::Price::GroupedTiered,
330
+ Orb::Models::Price::TieredWithMinimum,
331
+ Orb::Models::Price::TieredPackageWithMinimum,
332
+ Orb::Models::Price::PackageWithAllocation,
333
+ Orb::Models::Price::UnitWithPercent,
334
+ Orb::Models::Price::MatrixWithAllocation,
335
+ Orb::Models::Price::TieredWithProration,
336
+ Orb::Models::Price::UnitWithProration,
337
+ Orb::Models::Price::GroupedAllocation,
338
+ Orb::Models::Price::GroupedWithProratedMinimum,
339
+ Orb::Models::Price::GroupedWithMeteredMinimum,
340
+ Orb::Models::Price::MatrixWithDisplayName,
341
+ Orb::Models::Price::BulkWithProration,
342
+ Orb::Models::Price::GroupedTieredPackage,
343
+ Orb::Models::Price::MaxGroupTieredPackage,
344
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
345
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
346
+ Orb::Models::Price::CumulativeGroupedBulk
354
347
  )
355
348
  )
356
349
  end
@@ -13,10 +13,7 @@ module Orb
13
13
  # ...). The subscription change will be referenced by the
14
14
  # `pending_subscription_change` field in the response.
15
15
  sig do
16
- params(
17
- subscription_change_id: String,
18
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
19
- )
16
+ params(subscription_change_id: String, request_options: Orb::RequestOpts)
20
17
  .returns(Orb::Models::SubscriptionChangeRetrieveResponse)
21
18
  end
22
19
  def retrieve(subscription_change_id, request_options: {}); end
@@ -29,7 +26,7 @@ module Orb
29
26
  subscription_change_id: String,
30
27
  description: T.nilable(String),
31
28
  previously_collected_amount: T.nilable(String),
32
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
29
+ request_options: Orb::RequestOpts
33
30
  )
34
31
  .returns(Orb::Models::SubscriptionChangeApplyResponse)
35
32
  end
@@ -45,10 +42,7 @@ module Orb
45
42
  # subscription can only have one "pending" change at a time - use this endpoint to
46
43
  # cancel an existing change before creating a new one.
47
44
  sig do
48
- params(
49
- subscription_change_id: String,
50
- request_options: T.nilable(T.any(Orb::RequestOptions, Orb::Internal::AnyHash))
51
- )
45
+ params(subscription_change_id: String, request_options: Orb::RequestOpts)
52
46
  .returns(Orb::Models::SubscriptionChangeCancelResponse)
53
47
  end
54
48
  def cancel(subscription_change_id, request_options: {}); end