orb-billing 0.3.0 → 0.3.2

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 (644) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +47 -0
  3. data/README.md +7 -7
  4. data/lib/orb/errors.rb +9 -9
  5. data/lib/orb/file_part.rb +2 -2
  6. data/lib/orb/internal/page.rb +3 -3
  7. data/lib/orb/internal/transport/base_client.rb +3 -3
  8. data/lib/orb/internal/type/base_model.rb +1 -9
  9. data/lib/orb/internal/type/boolean.rb +10 -11
  10. data/lib/orb/internal/type/enum.rb +13 -14
  11. data/lib/orb/internal/type/request_parameters.rb +6 -12
  12. data/lib/orb/internal/type/union.rb +4 -4
  13. data/lib/orb/internal/type/unknown.rb +10 -11
  14. data/lib/orb/internal/util.rb +21 -5
  15. data/lib/orb/models/alert.rb +29 -32
  16. data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
  17. data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
  18. data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
  19. data/lib/orb/models/alert_list_params.rb +0 -1
  20. data/lib/orb/models/alert_update_params.rb +4 -5
  21. data/lib/orb/models/amount_discount.rb +6 -7
  22. data/lib/orb/models/billable_metric.rb +9 -11
  23. data/lib/orb/models/coupon.rb +9 -12
  24. data/lib/orb/models/coupon_create_params.rb +8 -10
  25. data/lib/orb/models/coupon_list_params.rb +0 -2
  26. data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
  27. data/lib/orb/models/credit_note.rb +48 -46
  28. data/lib/orb/models/credit_note_create_params.rb +6 -6
  29. data/lib/orb/models/credit_note_list_params.rb +0 -1
  30. data/lib/orb/models/customer.rb +54 -61
  31. data/lib/orb/models/customer_create_params.rb +43 -55
  32. data/lib/orb/models/customer_list_params.rb +0 -1
  33. data/lib/orb/models/customer_update_by_external_id_params.rb +43 -57
  34. data/lib/orb/models/customer_update_params.rb +43 -53
  35. data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
  36. data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
  37. data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
  38. data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
  39. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
  40. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
  41. data/lib/orb/models/customers/cost_list_params.rb +3 -4
  42. data/lib/orb/models/customers/cost_list_response.rb +3 -3
  43. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
  44. data/lib/orb/models/customers/credit_list_params.rb +0 -2
  45. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
  46. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +106 -114
  47. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
  48. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +111 -126
  49. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
  50. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +110 -121
  51. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
  52. data/lib/orb/models/customers/credits/ledger_list_response.rb +112 -131
  53. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
  54. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
  55. data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
  56. data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
  57. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
  58. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
  59. data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
  60. data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
  61. data/lib/orb/models/dimensional_price_group.rb +1 -3
  62. data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
  63. data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
  64. data/lib/orb/models/dimensional_price_groups.rb +6 -6
  65. data/lib/orb/models/discount.rb +5 -5
  66. data/lib/orb/models/evaluate_price_group.rb +1 -1
  67. data/lib/orb/models/event_ingest_params.rb +4 -9
  68. data/lib/orb/models/event_ingest_response.rb +0 -3
  69. data/lib/orb/models/event_search_params.rb +0 -3
  70. data/lib/orb/models/event_search_response.rb +0 -4
  71. data/lib/orb/models/event_update_params.rb +0 -3
  72. data/lib/orb/models/events/backfill_close_response.rb +0 -4
  73. data/lib/orb/models/events/backfill_create_params.rb +0 -7
  74. data/lib/orb/models/events/backfill_create_response.rb +0 -4
  75. data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
  76. data/lib/orb/models/events/backfill_list_params.rb +0 -1
  77. data/lib/orb/models/events/backfill_list_response.rb +0 -4
  78. data/lib/orb/models/events/backfill_revert_response.rb +0 -4
  79. data/lib/orb/models/events/event_volumes.rb +3 -3
  80. data/lib/orb/models/events/volume_list_params.rb +0 -3
  81. data/lib/orb/models/invoice.rb +165 -224
  82. data/lib/orb/models/invoice_create_params.rb +14 -21
  83. data/lib/orb/models/invoice_fetch_upcoming_response.rb +58 -107
  84. data/lib/orb/models/invoice_issue_params.rb +0 -1
  85. data/lib/orb/models/invoice_level_discount.rb +4 -4
  86. data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
  87. data/lib/orb/models/invoice_line_item_create_response.rb +58 -81
  88. data/lib/orb/models/invoice_list_params.rb +6 -10
  89. data/lib/orb/models/invoice_update_params.rb +0 -1
  90. data/lib/orb/models/item.rb +7 -8
  91. data/lib/orb/models/item_list_params.rb +0 -1
  92. data/lib/orb/models/item_update_params.rb +7 -7
  93. data/lib/orb/models/metric_create_params.rb +0 -1
  94. data/lib/orb/models/metric_list_params.rb +0 -1
  95. data/lib/orb/models/metric_update_params.rb +0 -1
  96. data/lib/orb/models/percentage_discount.rb +6 -8
  97. data/lib/orb/models/plan.rb +83 -111
  98. data/lib/orb/models/plan_create_params.rb +753 -861
  99. data/lib/orb/models/plan_list_params.rb +3 -4
  100. data/lib/orb/models/plan_update_params.rb +0 -2
  101. data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
  102. data/lib/orb/models/price.rb +1699 -1804
  103. data/lib/orb/models/price_create_params.rb +75 -84
  104. data/lib/orb/models/price_evaluate_params.rb +0 -2
  105. data/lib/orb/models/price_evaluate_response.rb +3 -3
  106. data/lib/orb/models/price_list_params.rb +0 -1
  107. data/lib/orb/models/price_update_params.rb +0 -1
  108. data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
  109. data/lib/orb/models/subscription.rb +94 -136
  110. data/lib/orb/models/subscription_cancel_params.rb +3 -5
  111. data/lib/orb/models/subscription_cancel_response.rb +52 -91
  112. data/lib/orb/models/subscription_change_apply_response.rb +50 -88
  113. data/lib/orb/models/subscription_change_cancel_response.rb +50 -87
  114. data/lib/orb/models/subscription_change_retrieve_response.rb +50 -87
  115. data/lib/orb/models/subscription_create_params.rb +1927 -1928
  116. data/lib/orb/models/subscription_create_response.rb +52 -91
  117. data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
  118. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
  119. data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
  120. data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
  121. data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
  122. data/lib/orb/models/subscription_list_params.rb +3 -4
  123. data/lib/orb/models/subscription_price_intervals_params.rb +1141 -1079
  124. data/lib/orb/models/subscription_price_intervals_response.rb +51 -90
  125. data/lib/orb/models/subscription_schedule_plan_change_params.rb +1966 -1906
  126. data/lib/orb/models/subscription_schedule_plan_change_response.rb +50 -88
  127. data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
  128. data/lib/orb/models/subscription_trigger_phase_response.rb +51 -90
  129. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +50 -88
  130. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +50 -86
  131. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +50 -86
  132. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
  133. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +50 -88
  134. data/lib/orb/models/subscription_update_params.rb +0 -5
  135. data/lib/orb/models/subscription_update_trial_params.rb +4 -6
  136. data/lib/orb/models/subscription_update_trial_response.rb +52 -91
  137. data/lib/orb/models/subscription_usage.rb +46 -39
  138. data/lib/orb/models/subscriptions.rb +6 -6
  139. data/lib/orb/models/trial_discount.rb +6 -7
  140. data/lib/orb/models/usage_discount.rb +6 -8
  141. data/lib/orb/models.rb +220 -0
  142. data/lib/orb/request_options.rb +4 -5
  143. data/lib/orb/resources/alerts.rb +30 -31
  144. data/lib/orb/resources/coupons/subscriptions.rb +3 -4
  145. data/lib/orb/resources/coupons.rb +11 -21
  146. data/lib/orb/resources/credit_notes.rb +10 -11
  147. data/lib/orb/resources/customers/balance_transactions.rb +3 -4
  148. data/lib/orb/resources/customers/costs.rb +4 -6
  149. data/lib/orb/resources/customers/credits/ledger.rb +18 -37
  150. data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
  151. data/lib/orb/resources/customers/credits.rb +2 -6
  152. data/lib/orb/resources/customers.rb +40 -67
  153. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
  154. data/lib/orb/resources/dimensional_price_groups.rb +8 -10
  155. data/lib/orb/resources/events/backfills.rb +2 -10
  156. data/lib/orb/resources/events/volume.rb +3 -6
  157. data/lib/orb/resources/events.rb +4 -12
  158. data/lib/orb/resources/invoice_line_items.rb +1 -2
  159. data/lib/orb/resources/invoices.rb +26 -43
  160. data/lib/orb/resources/items.rb +12 -13
  161. data/lib/orb/resources/metrics.rb +11 -14
  162. data/lib/orb/resources/plans/external_plan_id.rb +5 -7
  163. data/lib/orb/resources/plans.rb +14 -23
  164. data/lib/orb/resources/prices/external_price_id.rb +5 -6
  165. data/lib/orb/resources/prices.rb +25 -35
  166. data/lib/orb/resources/subscription_changes.rb +1 -1
  167. data/lib/orb/resources/subscriptions.rb +49 -107
  168. data/lib/orb/version.rb +1 -1
  169. data/lib/orb.rb +1 -0
  170. data/rbi/{lib/orb → orb}/client.rbi +5 -4
  171. data/rbi/{lib/orb → orb}/errors.rbi +58 -27
  172. data/rbi/{lib/orb → orb}/file_part.rbi +9 -6
  173. data/rbi/{lib/orb → orb}/internal/page.rbi +19 -6
  174. data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +131 -73
  175. data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +25 -12
  176. data/rbi/orb/internal/type/array_of.rbi +98 -0
  177. data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +124 -65
  178. data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +11 -7
  179. data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +16 -10
  180. data/rbi/{lib/orb → orb}/internal/type/converter.rbi +66 -31
  181. data/rbi/{lib/orb → orb}/internal/type/enum.rbi +27 -15
  182. data/rbi/{lib/orb → orb}/internal/type/file_input.rbi +12 -10
  183. data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +34 -24
  184. data/rbi/orb/internal/type/request_parameters.rbi +29 -0
  185. data/rbi/orb/internal/type/union.rbi +110 -0
  186. data/rbi/orb/internal/type/unknown.rbi +50 -0
  187. data/rbi/orb/internal/util.rbi +424 -0
  188. data/rbi/{lib/orb → orb}/models/alert.rbi +107 -70
  189. data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +60 -27
  190. data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +68 -29
  191. data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +53 -26
  192. data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +17 -6
  193. data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +17 -6
  194. data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +23 -20
  195. data/rbi/orb/models/alert_retrieve_params.rbi +24 -0
  196. data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +25 -14
  197. data/rbi/{lib/orb → orb}/models/amount_discount.rbi +28 -19
  198. data/rbi/{lib/orb → orb}/models/billable_metric.rbi +33 -26
  199. data/rbi/orb/models/billing_cycle_relative_date.rbi +24 -0
  200. data/rbi/{lib/orb → orb}/models/coupon.rbi +28 -20
  201. data/rbi/orb/models/coupon_archive_params.rbi +24 -0
  202. data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +74 -40
  203. data/rbi/orb/models/coupon_fetch_params.rbi +24 -0
  204. data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +18 -15
  205. data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +16 -6
  206. data/rbi/{lib/orb → orb}/models/credit_note.rbi +293 -158
  207. data/rbi/orb/models/credit_note_create_params.rbi +117 -0
  208. data/rbi/orb/models/credit_note_fetch_params.rbi +24 -0
  209. data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +20 -17
  210. data/rbi/{lib/orb → orb}/models/customer.rbi +430 -329
  211. data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +664 -327
  212. data/rbi/orb/models/customer_delete_params.rbi +24 -0
  213. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +24 -0
  214. data/rbi/orb/models/customer_fetch_params.rbi +24 -0
  215. data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +20 -17
  216. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +24 -0
  217. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +24 -0
  218. data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +1138 -338
  219. data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +663 -326
  220. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +94 -0
  221. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +301 -0
  222. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +20 -17
  223. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +301 -0
  224. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +56 -22
  225. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +263 -0
  226. data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +45 -22
  227. data/rbi/orb/models/customers/cost_list_response.rbi +254 -0
  228. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +18 -15
  229. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +110 -0
  230. data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +18 -15
  231. data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +44 -21
  232. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_params.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi} +118 -60
  233. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +685 -468
  234. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi → orb/models/customers/credits/ledger_create_entry_params.rbi} +107 -69
  235. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +643 -470
  236. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +224 -0
  237. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +658 -469
  238. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +224 -0
  239. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_response.rbi +708 -459
  240. data/rbi/{lib/orb/models/customers/credits/top_up_create_params.rbi → orb/models/customers/credits/top_up_create_by_external_id_params.rbi} +87 -46
  241. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
  242. data/rbi/{lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi → orb/models/customers/credits/top_up_create_params.rbi} +73 -54
  243. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +83 -43
  244. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
  245. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +36 -0
  246. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
  247. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
  248. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +9 -5
  249. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +84 -43
  250. data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +18 -15
  251. data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +19 -16
  252. data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +16 -6
  253. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +24 -0
  254. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +26 -0
  255. data/rbi/orb/models/dimensional_price_groups.rbi +38 -0
  256. data/rbi/orb/models/discount.rbi +23 -0
  257. data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +28 -12
  258. data/rbi/orb/models/event_deprecate_params.rbi +24 -0
  259. data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +8 -3
  260. data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +37 -31
  261. data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +63 -23
  262. data/rbi/{lib/orb → orb}/models/event_search_params.rbi +17 -14
  263. data/rbi/{lib/orb → orb}/models/event_search_response.rbi +33 -21
  264. data/rbi/{lib/orb → orb}/models/event_update_params.rbi +19 -16
  265. data/rbi/{lib/orb → orb}/models/event_update_response.rbi +8 -3
  266. data/rbi/orb/models/events/backfill_close_params.rbi +26 -0
  267. data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +64 -29
  268. data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +21 -18
  269. data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +63 -29
  270. data/rbi/orb/models/events/backfill_fetch_params.rbi +26 -0
  271. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +64 -29
  272. data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +16 -6
  273. data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +62 -28
  274. data/rbi/orb/models/events/backfill_revert_params.rbi +26 -0
  275. data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +63 -29
  276. data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +34 -12
  277. data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -15
  278. data/rbi/{lib/orb → orb}/models/invoice.rbi +1294 -831
  279. data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +97 -69
  280. data/rbi/orb/models/invoice_fetch_params.rbi +24 -0
  281. data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +32 -0
  282. data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +2003 -885
  283. data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +16 -5
  284. data/rbi/orb/models/invoice_level_discount.rbi +22 -0
  285. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +20 -17
  286. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +594 -421
  287. data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +67 -47
  288. data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +17 -14
  289. data/rbi/orb/models/invoice_pay_params.rbi +24 -0
  290. data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +15 -10
  291. data/rbi/orb/models/invoice_void_params.rbi +24 -0
  292. data/rbi/orb/models/item.rbi +143 -0
  293. data/rbi/{lib/orb → orb}/models/item_create_params.rbi +14 -5
  294. data/rbi/orb/models/item_fetch_params.rbi +24 -0
  295. data/rbi/{lib/orb → orb}/models/item_list_params.rbi +16 -6
  296. data/rbi/orb/models/item_update_params.rbi +141 -0
  297. data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +19 -16
  298. data/rbi/orb/models/metric_fetch_params.rbi +24 -0
  299. data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +20 -17
  300. data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +15 -10
  301. data/rbi/orb/models/pagination_metadata.rbi +31 -0
  302. data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +32 -19
  303. data/rbi/{lib/orb → orb}/models/plan.rbi +501 -370
  304. data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +4243 -3094
  305. data/rbi/orb/models/plan_fetch_params.rbi +24 -0
  306. data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +34 -27
  307. data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +16 -13
  308. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +26 -0
  309. data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +16 -13
  310. data/rbi/orb/models/price.rbi +19414 -0
  311. data/rbi/{lib/orb → orb}/models/price_create_params.rbi +501 -245
  312. data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +20 -17
  313. data/rbi/orb/models/price_evaluate_response.rbi +24 -0
  314. data/rbi/orb/models/price_fetch_params.rbi +24 -0
  315. data/rbi/{lib/orb → orb}/models/price_list_params.rbi +16 -6
  316. data/rbi/{lib/orb → orb}/models/price_update_params.rbi +15 -10
  317. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +26 -0
  318. data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +15 -10
  319. data/rbi/{lib/orb → orb}/models/subscription.rbi +586 -428
  320. data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +44 -22
  321. data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +724 -462
  322. data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +16 -13
  323. data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +808 -528
  324. data/rbi/orb/models/subscription_change_cancel_params.rbi +24 -0
  325. data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +807 -538
  326. data/rbi/orb/models/subscription_change_retrieve_params.rbi +24 -0
  327. data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +806 -548
  328. data/rbi/{lib/orb/models/subscription_schedule_plan_change_params.rbi → orb/models/subscription_create_params.rbi} +8466 -7080
  329. data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +724 -462
  330. data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +47 -22
  331. data/rbi/orb/models/subscription_fetch_costs_response.rbi +252 -0
  332. data/rbi/orb/models/subscription_fetch_params.rbi +24 -0
  333. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +20 -17
  334. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +33 -19
  335. data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +81 -34
  336. data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +39 -28
  337. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +4973 -3944
  338. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +744 -477
  339. data/rbi/{lib/orb/models/subscription_create_params.rbi → orb/models/subscription_schedule_plan_change_params.rbi} +8649 -7019
  340. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +742 -491
  341. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +16 -13
  342. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +736 -472
  343. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +24 -0
  344. data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +743 -491
  345. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
  346. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +717 -526
  347. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +24 -0
  348. data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +732 -521
  349. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
  350. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +743 -491
  351. data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +19 -16
  352. data/rbi/orb/models/subscription_update_trial_params.rbi +104 -0
  353. data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +736 -471
  354. data/rbi/orb/models/subscription_usage.rbi +446 -0
  355. data/rbi/orb/models/subscriptions.rbi +38 -0
  356. data/rbi/orb/models/top_level_ping_params.rbi +24 -0
  357. data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +7 -3
  358. data/rbi/{lib/orb → orb}/models/trial_discount.rbi +29 -20
  359. data/rbi/{lib/orb → orb}/models/usage_discount.rbi +28 -19
  360. data/rbi/orb/models.rbi +231 -0
  361. data/rbi/{lib/orb → orb}/request_options.rbi +12 -4
  362. data/rbi/{lib/orb → orb}/resources/alerts.rbi +57 -42
  363. data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +7 -5
  364. data/rbi/{lib/orb → orb}/resources/coupons.rbi +25 -22
  365. data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +18 -15
  366. data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +17 -9
  367. data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +18 -11
  368. data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +98 -74
  369. data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +53 -29
  370. data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +16 -7
  371. data/rbi/{lib/orb → orb}/resources/customers.rbi +117 -82
  372. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +6 -5
  373. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +21 -14
  374. data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +25 -20
  375. data/rbi/{lib/orb → orb}/resources/events/volume.rbi +7 -5
  376. data/rbi/{lib/orb → orb}/resources/events.rbi +22 -18
  377. data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +7 -5
  378. data/rbi/{lib/orb → orb}/resources/invoices.rbi +55 -49
  379. data/rbi/{lib/orb → orb}/resources/items.rbi +31 -17
  380. data/rbi/{lib/orb → orb}/resources/metrics.rbi +21 -17
  381. data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +11 -9
  382. data/rbi/{lib/orb → orb}/resources/plans.rbi +53 -49
  383. data/rbi/orb/resources/prices/external_price_id.rbi +108 -0
  384. data/rbi/{lib/orb → orb}/resources/prices.rbi +170 -157
  385. data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +15 -13
  386. data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +188 -118
  387. data/rbi/{lib/orb → orb}/resources/top_level.rbi +7 -4
  388. data/sig/orb/internal/page.rbs +0 -2
  389. data/sig/orb/internal/type/request_parameters.rbs +3 -1
  390. data/sig/orb/internal/util.rbs +2 -0
  391. data/sig/orb/models/alert.rbs +19 -31
  392. data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
  393. data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
  394. data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
  395. data/sig/orb/models/alert_disable_params.rbs +0 -2
  396. data/sig/orb/models/alert_enable_params.rbs +0 -2
  397. data/sig/orb/models/alert_list_params.rbs +0 -2
  398. data/sig/orb/models/alert_retrieve_params.rbs +0 -2
  399. data/sig/orb/models/alert_update_params.rbs +3 -7
  400. data/sig/orb/models/amount_discount.rbs +4 -6
  401. data/sig/orb/models/billable_metric.rbs +7 -9
  402. data/sig/orb/models/coupon.rbs +5 -8
  403. data/sig/orb/models/coupon_archive_params.rbs +0 -2
  404. data/sig/orb/models/coupon_create_params.rbs +7 -14
  405. data/sig/orb/models/coupon_fetch_params.rbs +0 -2
  406. data/sig/orb/models/coupon_list_params.rbs +0 -2
  407. data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
  408. data/sig/orb/models/credit_note.rbs +48 -66
  409. data/sig/orb/models/credit_note_create_params.rbs +3 -7
  410. data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
  411. data/sig/orb/models/credit_note_list_params.rbs +0 -2
  412. data/sig/orb/models/customer.rbs +43 -63
  413. data/sig/orb/models/customer_create_params.rbs +36 -57
  414. data/sig/orb/models/customer_delete_params.rbs +0 -2
  415. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
  416. data/sig/orb/models/customer_fetch_params.rbs +0 -2
  417. data/sig/orb/models/customer_list_params.rbs +0 -2
  418. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
  419. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
  420. data/sig/orb/models/customer_update_by_external_id_params.rbs +36 -57
  421. data/sig/orb/models/customer_update_params.rbs +36 -57
  422. data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
  423. data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
  424. data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
  425. data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
  426. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
  427. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
  428. data/sig/orb/models/customers/cost_list_params.rbs +0 -2
  429. data/sig/orb/models/customers/cost_list_response.rbs +0 -6
  430. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
  431. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
  432. data/sig/orb/models/customers/credit_list_params.rbs +0 -2
  433. data/sig/orb/models/customers/credit_list_response.rbs +0 -2
  434. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
  435. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +92 -134
  436. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
  437. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +92 -134
  438. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
  439. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +92 -134
  440. data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
  441. data/sig/orb/models/customers/credits/ledger_list_response.rbs +92 -134
  442. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
  443. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
  444. data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
  445. data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
  446. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
  447. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
  448. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
  449. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
  450. data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
  451. data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
  452. data/sig/orb/models/dimensional_price_group.rbs +0 -2
  453. data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
  454. data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
  455. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
  456. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
  457. data/sig/orb/models/dimensional_price_groups.rbs +6 -8
  458. data/sig/orb/models/discount.rbs +5 -5
  459. data/sig/orb/models/evaluate_price_group.rbs +4 -6
  460. data/sig/orb/models/event_deprecate_params.rbs +0 -2
  461. data/sig/orb/models/event_deprecate_response.rbs +0 -2
  462. data/sig/orb/models/event_ingest_params.rbs +3 -7
  463. data/sig/orb/models/event_ingest_response.rbs +0 -6
  464. data/sig/orb/models/event_search_params.rbs +0 -2
  465. data/sig/orb/models/event_search_response.rbs +0 -4
  466. data/sig/orb/models/event_update_params.rbs +0 -2
  467. data/sig/orb/models/event_update_response.rbs +0 -2
  468. data/sig/orb/models/events/backfill_close_params.rbs +0 -2
  469. data/sig/orb/models/events/backfill_close_response.rbs +0 -2
  470. data/sig/orb/models/events/backfill_create_params.rbs +0 -2
  471. data/sig/orb/models/events/backfill_create_response.rbs +0 -2
  472. data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
  473. data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
  474. data/sig/orb/models/events/backfill_list_params.rbs +0 -2
  475. data/sig/orb/models/events/backfill_list_response.rbs +0 -2
  476. data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
  477. data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
  478. data/sig/orb/models/events/event_volumes.rbs +3 -10
  479. data/sig/orb/models/events/volume_list_params.rbs +0 -2
  480. data/sig/orb/models/invoice.rbs +126 -188
  481. data/sig/orb/models/invoice_create_params.rbs +10 -16
  482. data/sig/orb/models/invoice_fetch_params.rbs +0 -2
  483. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
  484. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +41 -103
  485. data/sig/orb/models/invoice_issue_params.rbs +0 -2
  486. data/sig/orb/models/invoice_level_discount.rbs +2 -4
  487. data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
  488. data/sig/orb/models/invoice_line_item_create_response.rbs +41 -75
  489. data/sig/orb/models/invoice_list_params.rbs +4 -6
  490. data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
  491. data/sig/orb/models/invoice_pay_params.rbs +0 -2
  492. data/sig/orb/models/invoice_update_params.rbs +0 -2
  493. data/sig/orb/models/invoice_void_params.rbs +0 -2
  494. data/sig/orb/models/item.rbs +7 -11
  495. data/sig/orb/models/item_create_params.rbs +0 -2
  496. data/sig/orb/models/item_fetch_params.rbs +0 -2
  497. data/sig/orb/models/item_list_params.rbs +0 -2
  498. data/sig/orb/models/item_update_params.rbs +7 -11
  499. data/sig/orb/models/metric_create_params.rbs +0 -2
  500. data/sig/orb/models/metric_fetch_params.rbs +0 -2
  501. data/sig/orb/models/metric_list_params.rbs +0 -2
  502. data/sig/orb/models/metric_update_params.rbs +0 -2
  503. data/sig/orb/models/pagination_metadata.rbs +0 -2
  504. data/sig/orb/models/percentage_discount.rbs +4 -6
  505. data/sig/orb/models/plan.rbs +55 -83
  506. data/sig/orb/models/plan_create_params.rbs +568 -746
  507. data/sig/orb/models/plan_fetch_params.rbs +0 -2
  508. data/sig/orb/models/plan_list_params.rbs +0 -2
  509. data/sig/orb/models/plan_update_params.rbs +0 -2
  510. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
  511. data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
  512. data/sig/orb/models/price.rbs +1250 -1790
  513. data/sig/orb/models/price_create_params.rbs +59 -97
  514. data/sig/orb/models/price_evaluate_params.rbs +0 -2
  515. data/sig/orb/models/price_evaluate_response.rbs +3 -6
  516. data/sig/orb/models/price_fetch_params.rbs +0 -2
  517. data/sig/orb/models/price_list_params.rbs +0 -2
  518. data/sig/orb/models/price_update_params.rbs +0 -2
  519. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
  520. data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
  521. data/sig/orb/models/subscription.rbs +72 -110
  522. data/sig/orb/models/subscription_cancel_params.rbs +0 -2
  523. data/sig/orb/models/subscription_cancel_response.rbs +44 -84
  524. data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
  525. data/sig/orb/models/subscription_change_apply_response.rbs +44 -86
  526. data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
  527. data/sig/orb/models/subscription_change_cancel_response.rbs +44 -86
  528. data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
  529. data/sig/orb/models/subscription_change_retrieve_response.rbs +44 -86
  530. data/sig/orb/models/subscription_create_params.rbs +1223 -1619
  531. data/sig/orb/models/subscription_create_response.rbs +44 -84
  532. data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
  533. data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
  534. data/sig/orb/models/subscription_fetch_params.rbs +0 -2
  535. data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
  536. data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
  537. data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
  538. data/sig/orb/models/subscription_list_params.rbs +0 -2
  539. data/sig/orb/models/subscription_price_intervals_params.rbs +738 -970
  540. data/sig/orb/models/subscription_price_intervals_response.rbs +44 -84
  541. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1223 -1619
  542. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +44 -84
  543. data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
  544. data/sig/orb/models/subscription_trigger_phase_response.rbs +44 -84
  545. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
  546. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +44 -84
  547. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
  548. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +44 -84
  549. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
  550. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +44 -84
  551. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
  552. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +44 -84
  553. data/sig/orb/models/subscription_update_params.rbs +0 -2
  554. data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
  555. data/sig/orb/models/subscription_update_trial_response.rbs +44 -84
  556. data/sig/orb/models/subscription_usage.rbs +35 -53
  557. data/sig/orb/models/subscriptions.rbs +6 -8
  558. data/sig/orb/models/top_level_ping_params.rbs +0 -2
  559. data/sig/orb/models/top_level_ping_response.rbs +0 -2
  560. data/sig/orb/models/trial_discount.rbs +4 -6
  561. data/sig/orb/models/usage_discount.rbs +4 -6
  562. data/sig/orb/models.rbs +215 -0
  563. data/sig/orb/request_options.rbs +1 -1
  564. data/sig/orb/resources/alerts.rbs +12 -12
  565. data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
  566. data/sig/orb/resources/coupons.rbs +4 -4
  567. data/sig/orb/resources/credit_notes.rbs +4 -4
  568. data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
  569. data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
  570. data/sig/orb/resources/customers.rbs +24 -24
  571. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
  572. data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
  573. data/sig/orb/resources/events/volume.rbs +1 -1
  574. data/sig/orb/resources/events.rbs +1 -1
  575. data/sig/orb/resources/invoices.rbs +10 -10
  576. data/sig/orb/resources/items.rbs +5 -5
  577. data/sig/orb/resources/metrics.rbs +4 -4
  578. data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
  579. data/sig/orb/resources/plans.rbs +5 -5
  580. data/sig/orb/resources/prices.rbs +11 -11
  581. data/sig/orb/resources/subscriptions.rbs +21 -21
  582. metadata +226 -223
  583. data/rbi/lib/orb/internal/type/array_of.rbi +0 -90
  584. data/rbi/lib/orb/internal/type/request_parameters.rbi +0 -21
  585. data/rbi/lib/orb/internal/type/union.rbi +0 -75
  586. data/rbi/lib/orb/internal/type/unknown.rbi +0 -42
  587. data/rbi/lib/orb/internal/util.rbi +0 -299
  588. data/rbi/lib/orb/models/alert_retrieve_params.rbi +0 -18
  589. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +0 -18
  590. data/rbi/lib/orb/models/coupon_archive_params.rbi +0 -18
  591. data/rbi/lib/orb/models/coupon_fetch_params.rbi +0 -18
  592. data/rbi/lib/orb/models/credit_note_create_params.rbi +0 -88
  593. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +0 -18
  594. data/rbi/lib/orb/models/customer_delete_params.rbi +0 -18
  595. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +0 -18
  596. data/rbi/lib/orb/models/customer_fetch_params.rbi +0 -18
  597. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -18
  598. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -18
  599. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +0 -65
  600. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +0 -208
  601. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +0 -196
  602. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -225
  603. data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -223
  604. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +0 -84
  605. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +0 -166
  606. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +0 -141
  607. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +0 -26
  608. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +0 -18
  609. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -25
  610. data/rbi/lib/orb/models/dimensional_price_groups.rbi +0 -33
  611. data/rbi/lib/orb/models/discount.rbi +0 -17
  612. data/rbi/lib/orb/models/event_deprecate_params.rbi +0 -18
  613. data/rbi/lib/orb/models/events/backfill_close_params.rbi +0 -25
  614. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +0 -25
  615. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +0 -25
  616. data/rbi/lib/orb/models/invoice_fetch_params.rbi +0 -18
  617. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +0 -22
  618. data/rbi/lib/orb/models/invoice_level_discount.rbi +0 -15
  619. data/rbi/lib/orb/models/invoice_pay_params.rbi +0 -18
  620. data/rbi/lib/orb/models/invoice_void_params.rbi +0 -18
  621. data/rbi/lib/orb/models/item.rbi +0 -95
  622. data/rbi/lib/orb/models/item_fetch_params.rbi +0 -18
  623. data/rbi/lib/orb/models/item_update_params.rbi +0 -101
  624. data/rbi/lib/orb/models/metric_fetch_params.rbi +0 -18
  625. data/rbi/lib/orb/models/pagination_metadata.rbi +0 -19
  626. data/rbi/lib/orb/models/plan_fetch_params.rbi +0 -18
  627. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +0 -25
  628. data/rbi/lib/orb/models/price.rbi +0 -14861
  629. data/rbi/lib/orb/models/price_evaluate_response.rbi +0 -19
  630. data/rbi/lib/orb/models/price_fetch_params.rbi +0 -18
  631. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +0 -25
  632. data/rbi/lib/orb/models/subscription_change_cancel_params.rbi +0 -18
  633. data/rbi/lib/orb/models/subscription_change_retrieve_params.rbi +0 -18
  634. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -221
  635. data/rbi/lib/orb/models/subscription_fetch_params.rbi +0 -18
  636. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +0 -18
  637. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -18
  638. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +0 -66
  639. data/rbi/lib/orb/models/subscription_usage.rbi +0 -296
  640. data/rbi/lib/orb/models/subscriptions.rbi +0 -31
  641. data/rbi/lib/orb/models/top_level_ping_params.rbi +0 -18
  642. data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
  643. /data/rbi/{lib/orb → orb}/internal.rbi +0 -0
  644. /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -88,8 +88,8 @@ module Orb
88
88
  # your account's timezone. See [Timezone localization](/essentials/timezones) for
89
89
  # information on what this timezone parameter influences within Orb.
90
90
  #
91
- # @return [Orb::Models::Customer]
92
- required :customer, -> { Orb::Models::Customer }
91
+ # @return [Orb::Customer]
92
+ required :customer, -> { Orb::Customer }
93
93
 
94
94
  # @!attribute default_invoice_memo
95
95
  # Determines the default memo on this subscriptions' invoices. Note that if this
@@ -101,7 +101,7 @@ module Orb
101
101
  # @!attribute discount_intervals
102
102
  # The discount intervals for this subscription sorted by the start_date.
103
103
  #
104
- # @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval>]
104
+ # @return [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage>]
105
105
  required :discount_intervals,
106
106
  -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval] }
107
107
 
@@ -168,8 +168,8 @@ module Orb
168
168
  # subscription. You can see more about how to configure prices in the
169
169
  # [Price resource](/reference/price).
170
170
  #
171
- # @return [Orb::Models::Plan]
172
- required :plan, -> { Orb::Models::Plan }
171
+ # @return [Orb::Plan]
172
+ required :plan, -> { Orb::Plan }
173
173
 
174
174
  # @!attribute price_intervals
175
175
  # The price intervals for this subscription.
@@ -218,34 +218,26 @@ module Orb
218
218
  # @param id [String]
219
219
  #
220
220
  # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
221
- # ...
222
221
  #
223
222
  # @param adjustment_intervals [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
224
- # ...
225
223
  #
226
224
  # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
227
- # ...
228
225
  #
229
226
  # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionSchedulePlanChangeResponse::BillingCycleAnchorConfiguration]
230
227
  #
231
228
  # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
232
- # ...
233
229
  #
234
230
  # @param created_at [Time]
235
231
  #
236
232
  # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
237
- # ...
238
233
  #
239
234
  # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
240
- # ...
241
235
  #
242
- # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
243
- # ...
236
+ # @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
244
237
  #
245
238
  # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
246
- # ...
247
239
  #
248
- # @param discount_intervals [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
240
+ # @param discount_intervals [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
249
241
  #
250
242
  # @param end_date [Time, nil] The date Orb stops billing for this subscription.
251
243
  #
@@ -256,17 +248,14 @@ module Orb
256
248
  # @param maximum_intervals [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
257
249
  #
258
250
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
259
- # ...
260
251
  #
261
252
  # @param minimum_intervals [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
262
253
  #
263
254
  # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
264
- # ...
265
255
  #
266
256
  # @param pending_subscription_change [Orb::Models::SubscriptionSchedulePlanChangeResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
267
257
  #
268
- # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
269
- # ...
258
+ # @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
270
259
  #
271
260
  # @param price_intervals [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval>] The price intervals for this subscription.
272
261
  #
@@ -279,7 +268,6 @@ module Orb
279
268
  # @param trial_info [Orb::Models::SubscriptionSchedulePlanChangeResponse::TrialInfo]
280
269
  #
281
270
  # @param changed_resources [Orb::Models::SubscriptionSchedulePlanChangeResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
282
- # ...
283
271
 
284
272
  class AdjustmentInterval < Orb::Internal::Type::BaseModel
285
273
  # @!attribute id
@@ -289,7 +277,7 @@ module Orb
289
277
 
290
278
  # @!attribute adjustment
291
279
  #
292
- # @return [Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
280
+ # @return [Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum]
293
281
  required :adjustment,
294
282
  union: -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment }
295
283
 
@@ -314,7 +302,7 @@ module Orb
314
302
  # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
315
303
  # @param id [String]
316
304
  #
317
- # @param adjustment [Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
305
+ # @param adjustment [Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum]
318
306
  #
319
307
  # @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
320
308
  #
@@ -329,21 +317,21 @@ module Orb
329
317
  discriminator :adjustment_type
330
318
 
331
319
  variant :usage_discount,
332
- -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment }
320
+ -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount }
333
321
 
334
322
  variant :amount_discount,
335
- -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment }
323
+ -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount }
336
324
 
337
325
  variant :percentage_discount,
338
- -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment }
326
+ -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
339
327
 
340
328
  variant :minimum,
341
- -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment }
329
+ -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum }
342
330
 
343
331
  variant :maximum,
344
- -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
332
+ -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum }
345
333
 
346
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
334
+ class UsageDiscount < Orb::Internal::Type::BaseModel
347
335
  # @!attribute id
348
336
  #
349
337
  # @return [String]
@@ -388,7 +376,7 @@ module Orb
388
376
 
389
377
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
390
378
  # Some parameter documentations has been truncated, see
391
- # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment}
379
+ # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount}
392
380
  # for more details.
393
381
  #
394
382
  # @param id [String]
@@ -396,19 +384,17 @@ module Orb
396
384
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
397
385
  #
398
386
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
399
- # ...
400
387
  #
401
388
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
402
389
  #
403
390
  # @param reason [String, nil] The reason for the adjustment.
404
391
  #
405
392
  # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
406
- # ...
407
393
  #
408
394
  # @param adjustment_type [Symbol, :usage_discount]
409
395
  end
410
396
 
411
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
397
+ class AmountDiscount < Orb::Internal::Type::BaseModel
412
398
  # @!attribute id
413
399
  #
414
400
  # @return [String]
@@ -453,18 +439,16 @@ module Orb
453
439
 
454
440
  # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
455
441
  # Some parameter documentations has been truncated, see
456
- # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment}
442
+ # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount}
457
443
  # for more details.
458
444
  #
459
445
  # @param id [String]
460
446
  #
461
447
  # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
462
- # ...
463
448
  #
464
449
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
465
450
  #
466
451
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
467
- # ...
468
452
  #
469
453
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
470
454
  #
@@ -473,7 +457,7 @@ module Orb
473
457
  # @param adjustment_type [Symbol, :amount_discount]
474
458
  end
475
459
 
476
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
460
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
477
461
  # @!attribute id
478
462
  #
479
463
  # @return [String]
@@ -518,7 +502,7 @@ module Orb
518
502
 
519
503
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
520
504
  # Some parameter documentations has been truncated, see
521
- # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment}
505
+ # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
522
506
  # for more details.
523
507
  #
524
508
  # @param id [String]
@@ -526,10 +510,8 @@ module Orb
526
510
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
527
511
  #
528
512
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
529
- # ...
530
513
  #
531
514
  # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
532
- # ...
533
515
  #
534
516
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
535
517
  #
@@ -538,7 +520,7 @@ module Orb
538
520
  # @param adjustment_type [Symbol, :percentage_discount]
539
521
  end
540
522
 
541
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
523
+ class Minimum < Orb::Internal::Type::BaseModel
542
524
  # @!attribute id
543
525
  #
544
526
  # @return [String]
@@ -589,7 +571,7 @@ module Orb
589
571
 
590
572
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
591
573
  # Some parameter documentations has been truncated, see
592
- # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment}
574
+ # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum}
593
575
  # for more details.
594
576
  #
595
577
  # @param id [String]
@@ -597,12 +579,10 @@ module Orb
597
579
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
598
580
  #
599
581
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
600
- # ...
601
582
  #
602
583
  # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
603
584
  #
604
585
  # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
605
- # ...
606
586
  #
607
587
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
608
588
  #
@@ -611,7 +591,7 @@ module Orb
611
591
  # @param adjustment_type [Symbol, :minimum]
612
592
  end
613
593
 
614
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
594
+ class Maximum < Orb::Internal::Type::BaseModel
615
595
  # @!attribute id
616
596
  #
617
597
  # @return [String]
@@ -656,7 +636,7 @@ module Orb
656
636
 
657
637
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
658
638
  # Some parameter documentations has been truncated, see
659
- # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment}
639
+ # {Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum}
660
640
  # for more details.
661
641
  #
662
642
  # @param id [String]
@@ -664,10 +644,8 @@ module Orb
664
644
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
665
645
  #
666
646
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
667
- # ...
668
647
  #
669
648
  # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
670
- # ...
671
649
  #
672
650
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
673
651
  #
@@ -677,7 +655,7 @@ module Orb
677
655
  end
678
656
 
679
657
  # @!method self.variants
680
- # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
658
+ # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionSchedulePlanChangeResponse::AdjustmentInterval::Adjustment::Maximum)]
681
659
  end
682
660
  end
683
661
 
@@ -713,13 +691,10 @@ module Orb
713
691
  # for more details.
714
692
  #
715
693
  # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
716
- # ...
717
694
  #
718
695
  # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
719
- # ...
720
696
  #
721
697
  # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
722
- # ...
723
698
  end
724
699
 
725
700
  module DiscountInterval
@@ -727,16 +702,14 @@ module Orb
727
702
 
728
703
  discriminator :discount_type
729
704
 
730
- variant :amount,
731
- -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval }
705
+ variant :amount, -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount }
732
706
 
733
707
  variant :percentage,
734
- -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval }
708
+ -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage }
735
709
 
736
- variant :usage,
737
- -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval }
710
+ variant :usage, -> { Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage }
738
711
 
739
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
712
+ class Amount < Orb::Internal::Type::BaseModel
740
713
  # @!attribute amount_discount
741
714
  # Only available if discount_type is `amount`.
742
715
  #
@@ -786,7 +759,7 @@ module Orb
786
759
  # @param discount_type [Symbol, :amount]
787
760
  end
788
761
 
789
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
762
+ class Percentage < Orb::Internal::Type::BaseModel
790
763
  # @!attribute applies_to_price_ids
791
764
  # The price ids that this discount interval applies to.
792
765
  #
@@ -825,7 +798,7 @@ module Orb
825
798
 
826
799
  # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
827
800
  # Some parameter documentations has been truncated, see
828
- # {Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval}
801
+ # {Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage}
829
802
  # for more details.
830
803
  #
831
804
  # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
@@ -835,14 +808,13 @@ module Orb
835
808
  # @param end_date [Time, nil] The end date of the discount interval.
836
809
  #
837
810
  # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
838
- # ...
839
811
  #
840
812
  # @param start_date [Time] The start date of the discount interval.
841
813
  #
842
814
  # @param discount_type [Symbol, :percentage]
843
815
  end
844
816
 
845
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
817
+ class Usage < Orb::Internal::Type::BaseModel
846
818
  # @!attribute applies_to_price_ids
847
819
  # The price ids that this discount interval applies to.
848
820
  #
@@ -881,7 +853,7 @@ module Orb
881
853
 
882
854
  # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
883
855
  # Some parameter documentations has been truncated, see
884
- # {Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval}
856
+ # {Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage}
885
857
  # for more details.
886
858
  #
887
859
  # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
@@ -893,13 +865,12 @@ module Orb
893
865
  # @param start_date [Time] The start date of the discount interval.
894
866
  #
895
867
  # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
896
- # ...
897
868
  #
898
869
  # @param discount_type [Symbol, :usage]
899
870
  end
900
871
 
901
872
  # @!method self.variants
902
- # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::UsageDiscountInterval)]
873
+ # @return [Array(Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Amount, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionSchedulePlanChangeResponse::DiscountInterval::Usage)]
903
874
  end
904
875
 
905
876
  class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -974,7 +945,6 @@ module Orb
974
945
  # @param end_date [Time, nil] The end date of the maximum interval.
975
946
  #
976
947
  # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
977
- # ...
978
948
  #
979
949
  # @param start_date [Time] The start date of the maximum interval.
980
950
  end
@@ -1023,7 +993,6 @@ module Orb
1023
993
  # @param end_date [Time, nil] The end date of the minimum interval.
1024
994
  #
1025
995
  # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
1026
- # ...
1027
996
  #
1028
997
  # @param start_date [Time] The start date of the minimum interval.
1029
998
  end
@@ -1103,8 +1072,8 @@ module Orb
1103
1072
  # For more on the types of prices, see
1104
1073
  # [the core concepts documentation](/core-concepts#plan-and-price)
1105
1074
  #
1106
- # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
1107
- required :price, union: -> { Orb::Models::Price }
1075
+ # @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk]
1076
+ required :price, union: -> { Orb::Price }
1108
1077
 
1109
1078
  # @!attribute start_date
1110
1079
  # The start date of the price interval. This is the date that Orb starts billing
@@ -1134,27 +1103,20 @@ module Orb
1134
1103
  # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
1135
1104
  #
1136
1105
  # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
1137
- # ...
1138
1106
  #
1139
1107
  # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
1140
- # ...
1141
1108
  #
1142
1109
  # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
1143
- # ...
1144
1110
  #
1145
1111
  # @param filter [String, nil] An additional filter to apply to usage queries.
1146
1112
  #
1147
1113
  # @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionSchedulePlanChangeResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
1148
- # ...
1149
1114
  #
1150
- # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu
1151
- # ...
1115
+ # @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
1152
1116
  #
1153
1117
  # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
1154
- # ...
1155
1118
  #
1156
1119
  # @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
1157
- # ...
1158
1120
 
1159
1121
  class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1160
1122
  # @!attribute effective_date
@@ -1230,39 +1192,39 @@ module Orb
1230
1192
  # @!attribute created_credit_notes
1231
1193
  # The credit notes that were created as part of this operation.
1232
1194
  #
1233
- # @return [Array<Orb::Models::CreditNote>]
1234
- required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] }
1195
+ # @return [Array<Orb::CreditNote>]
1196
+ required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
1235
1197
 
1236
1198
  # @!attribute created_invoices
1237
1199
  # The invoices that were created as part of this operation.
1238
1200
  #
1239
- # @return [Array<Orb::Models::Invoice>]
1240
- required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
1201
+ # @return [Array<Orb::Invoice>]
1202
+ required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
1241
1203
 
1242
1204
  # @!attribute voided_credit_notes
1243
1205
  # The credit notes that were voided as part of this operation.
1244
1206
  #
1245
- # @return [Array<Orb::Models::CreditNote>]
1246
- required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] }
1207
+ # @return [Array<Orb::CreditNote>]
1208
+ required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
1247
1209
 
1248
1210
  # @!attribute voided_invoices
1249
1211
  # The invoices that were voided as part of this operation.
1250
1212
  #
1251
- # @return [Array<Orb::Models::Invoice>]
1252
- required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
1213
+ # @return [Array<Orb::Invoice>]
1214
+ required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
1253
1215
 
1254
1216
  # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
1255
1217
  # The resources that were changed as part of this operation. Only present when
1256
1218
  # fetched through the subscription changes API or if the
1257
1219
  # `include_changed_resources` parameter was passed in the request.
1258
1220
  #
1259
- # @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
1221
+ # @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
1260
1222
  #
1261
- # @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
1223
+ # @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
1262
1224
  #
1263
- # @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
1225
+ # @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
1264
1226
  #
1265
- # @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
1227
+ # @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
1266
1228
  end
1267
1229
  end
1268
1230
  end
@@ -27,10 +27,8 @@ module Orb
27
27
  # {Orb::Models::SubscriptionTriggerPhaseParams} for more details.
28
28
  #
29
29
  # @param allow_invoice_credit_or_void [Boolean, nil] If false, this request will fail if it would void an issued invoice or create a
30
- # ...
31
30
  #
32
31
  # @param effective_date [Date, nil] The date on which the phase change should take effect. If not provided, defaults
33
- # ...
34
32
  #
35
33
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
36
34
  end