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::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval>]
104
+ # @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage>]
105
105
  required :discount_intervals,
106
106
  -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::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.
@@ -219,34 +219,26 @@ module Orb
219
219
  # @param id [String]
220
220
  #
221
221
  # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
222
- # ...
223
222
  #
224
223
  # @param adjustment_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
225
- # ...
226
224
  #
227
225
  # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
228
- # ...
229
226
  #
230
227
  # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::BillingCycleAnchorConfiguration]
231
228
  #
232
229
  # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
233
- # ...
234
230
  #
235
231
  # @param created_at [Time]
236
232
  #
237
233
  # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
238
- # ...
239
234
  #
240
235
  # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
241
- # ...
242
236
  #
243
- # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
244
- # ...
237
+ # @param customer [Orb::Customer] A customer is a buyer of your products, and the other party to the billing relat
245
238
  #
246
239
  # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
247
- # ...
248
240
  #
249
- # @param discount_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
241
+ # @param discount_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
250
242
  #
251
243
  # @param end_date [Time, nil] The date Orb stops billing for this subscription.
252
244
  #
@@ -257,17 +249,14 @@ module Orb
257
249
  # @param maximum_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
258
250
  #
259
251
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
260
- # ...
261
252
  #
262
253
  # @param minimum_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
263
254
  #
264
255
  # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
265
- # ...
266
256
  #
267
257
  # @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
268
258
  #
269
- # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
270
- # ...
259
+ # @param plan [Orb::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
271
260
  #
272
261
  # @param price_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval>] The price intervals for this subscription.
273
262
  #
@@ -280,7 +269,6 @@ module Orb
280
269
  # @param trial_info [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo]
281
270
  #
282
271
  # @param changed_resources [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
283
- # ...
284
272
 
285
273
  class AdjustmentInterval < Orb::Internal::Type::BaseModel
286
274
  # @!attribute id
@@ -290,7 +278,7 @@ module Orb
290
278
 
291
279
  # @!attribute adjustment
292
280
  #
293
- # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
281
+ # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum]
294
282
  required :adjustment,
295
283
  union: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment }
296
284
 
@@ -315,7 +303,7 @@ module Orb
315
303
  # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
316
304
  # @param id [String]
317
305
  #
318
- # @param adjustment [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
306
+ # @param adjustment [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum]
319
307
  #
320
308
  # @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
321
309
  #
@@ -330,21 +318,21 @@ module Orb
330
318
  discriminator :adjustment_type
331
319
 
332
320
  variant :usage_discount,
333
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment }
321
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount }
334
322
 
335
323
  variant :amount_discount,
336
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment }
324
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount }
337
325
 
338
326
  variant :percentage_discount,
339
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment }
327
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
340
328
 
341
329
  variant :minimum,
342
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment }
330
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum }
343
331
 
344
332
  variant :maximum,
345
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
333
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum }
346
334
 
347
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
335
+ class UsageDiscount < Orb::Internal::Type::BaseModel
348
336
  # @!attribute id
349
337
  #
350
338
  # @return [String]
@@ -389,7 +377,7 @@ module Orb
389
377
 
390
378
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
391
379
  # Some parameter documentations has been truncated, see
392
- # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment}
380
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount}
393
381
  # for more details.
394
382
  #
395
383
  # @param id [String]
@@ -397,19 +385,17 @@ module Orb
397
385
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
398
386
  #
399
387
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
400
- # ...
401
388
  #
402
389
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
403
390
  #
404
391
  # @param reason [String, nil] The reason for the adjustment.
405
392
  #
406
393
  # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
407
- # ...
408
394
  #
409
395
  # @param adjustment_type [Symbol, :usage_discount]
410
396
  end
411
397
 
412
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
398
+ class AmountDiscount < Orb::Internal::Type::BaseModel
413
399
  # @!attribute id
414
400
  #
415
401
  # @return [String]
@@ -454,18 +440,16 @@ module Orb
454
440
 
455
441
  # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
456
442
  # Some parameter documentations has been truncated, see
457
- # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment}
443
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount}
458
444
  # for more details.
459
445
  #
460
446
  # @param id [String]
461
447
  #
462
448
  # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
463
- # ...
464
449
  #
465
450
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
466
451
  #
467
452
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
468
- # ...
469
453
  #
470
454
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
471
455
  #
@@ -474,7 +458,7 @@ module Orb
474
458
  # @param adjustment_type [Symbol, :amount_discount]
475
459
  end
476
460
 
477
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
461
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
478
462
  # @!attribute id
479
463
  #
480
464
  # @return [String]
@@ -519,7 +503,7 @@ module Orb
519
503
 
520
504
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
521
505
  # Some parameter documentations has been truncated, see
522
- # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment}
506
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
523
507
  # for more details.
524
508
  #
525
509
  # @param id [String]
@@ -527,10 +511,8 @@ module Orb
527
511
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
528
512
  #
529
513
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
530
- # ...
531
514
  #
532
515
  # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
533
- # ...
534
516
  #
535
517
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
536
518
  #
@@ -539,7 +521,7 @@ module Orb
539
521
  # @param adjustment_type [Symbol, :percentage_discount]
540
522
  end
541
523
 
542
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
524
+ class Minimum < Orb::Internal::Type::BaseModel
543
525
  # @!attribute id
544
526
  #
545
527
  # @return [String]
@@ -590,7 +572,7 @@ module Orb
590
572
 
591
573
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
592
574
  # Some parameter documentations has been truncated, see
593
- # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment}
575
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum}
594
576
  # for more details.
595
577
  #
596
578
  # @param id [String]
@@ -598,12 +580,10 @@ module Orb
598
580
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
599
581
  #
600
582
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
601
- # ...
602
583
  #
603
584
  # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
604
585
  #
605
586
  # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
606
- # ...
607
587
  #
608
588
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
609
589
  #
@@ -612,7 +592,7 @@ module Orb
612
592
  # @param adjustment_type [Symbol, :minimum]
613
593
  end
614
594
 
615
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
595
+ class Maximum < Orb::Internal::Type::BaseModel
616
596
  # @!attribute id
617
597
  #
618
598
  # @return [String]
@@ -657,7 +637,7 @@ module Orb
657
637
 
658
638
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
659
639
  # Some parameter documentations has been truncated, see
660
- # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment}
640
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum}
661
641
  # for more details.
662
642
  #
663
643
  # @param id [String]
@@ -665,10 +645,8 @@ module Orb
665
645
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
666
646
  #
667
647
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
668
- # ...
669
648
  #
670
649
  # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
671
- # ...
672
650
  #
673
651
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
674
652
  #
@@ -678,7 +656,7 @@ module Orb
678
656
  end
679
657
 
680
658
  # @!method self.variants
681
- # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
659
+ # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum)]
682
660
  end
683
661
  end
684
662
 
@@ -714,13 +692,10 @@ module Orb
714
692
  # for more details.
715
693
  #
716
694
  # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
717
- # ...
718
695
  #
719
696
  # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
720
- # ...
721
697
  #
722
698
  # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
723
- # ...
724
699
  end
725
700
 
726
701
  module DiscountInterval
@@ -729,15 +704,15 @@ module Orb
729
704
  discriminator :discount_type
730
705
 
731
706
  variant :amount,
732
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval }
707
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount }
733
708
 
734
709
  variant :percentage,
735
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval }
710
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage }
736
711
 
737
712
  variant :usage,
738
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval }
713
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage }
739
714
 
740
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
715
+ class Amount < Orb::Internal::Type::BaseModel
741
716
  # @!attribute amount_discount
742
717
  # Only available if discount_type is `amount`.
743
718
  #
@@ -787,7 +762,7 @@ module Orb
787
762
  # @param discount_type [Symbol, :amount]
788
763
  end
789
764
 
790
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
765
+ class Percentage < Orb::Internal::Type::BaseModel
791
766
  # @!attribute applies_to_price_ids
792
767
  # The price ids that this discount interval applies to.
793
768
  #
@@ -826,7 +801,7 @@ module Orb
826
801
 
827
802
  # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
828
803
  # Some parameter documentations has been truncated, see
829
- # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval}
804
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage}
830
805
  # for more details.
831
806
  #
832
807
  # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
@@ -836,14 +811,13 @@ module Orb
836
811
  # @param end_date [Time, nil] The end date of the discount interval.
837
812
  #
838
813
  # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
839
- # ...
840
814
  #
841
815
  # @param start_date [Time] The start date of the discount interval.
842
816
  #
843
817
  # @param discount_type [Symbol, :percentage]
844
818
  end
845
819
 
846
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
820
+ class Usage < Orb::Internal::Type::BaseModel
847
821
  # @!attribute applies_to_price_ids
848
822
  # The price ids that this discount interval applies to.
849
823
  #
@@ -882,7 +856,7 @@ module Orb
882
856
 
883
857
  # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
884
858
  # Some parameter documentations has been truncated, see
885
- # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval}
859
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage}
886
860
  # for more details.
887
861
  #
888
862
  # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
@@ -894,13 +868,12 @@ module Orb
894
868
  # @param start_date [Time] The start date of the discount interval.
895
869
  #
896
870
  # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
897
- # ...
898
871
  #
899
872
  # @param discount_type [Symbol, :usage]
900
873
  end
901
874
 
902
875
  # @!method self.variants
903
- # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval)]
876
+ # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage)]
904
877
  end
905
878
 
906
879
  class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -975,7 +948,6 @@ module Orb
975
948
  # @param end_date [Time, nil] The end date of the maximum interval.
976
949
  #
977
950
  # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
978
- # ...
979
951
  #
980
952
  # @param start_date [Time] The start date of the maximum interval.
981
953
  end
@@ -1024,7 +996,6 @@ module Orb
1024
996
  # @param end_date [Time, nil] The end date of the minimum interval.
1025
997
  #
1026
998
  # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
1027
- # ...
1028
999
  #
1029
1000
  # @param start_date [Time] The start date of the minimum interval.
1030
1001
  end
@@ -1108,8 +1079,8 @@ module Orb
1108
1079
  # For more on the types of prices, see
1109
1080
  # [the core concepts documentation](/core-concepts#plan-and-price)
1110
1081
  #
1111
- # @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]
1112
- required :price, union: -> { Orb::Models::Price }
1082
+ # @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]
1083
+ required :price, union: -> { Orb::Price }
1113
1084
 
1114
1085
  # @!attribute start_date
1115
1086
  # The start date of the price interval. This is the date that Orb starts billing
@@ -1139,27 +1110,20 @@ module Orb
1139
1110
  # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
1140
1111
  #
1141
1112
  # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
1142
- # ...
1143
1113
  #
1144
1114
  # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
1145
- # ...
1146
1115
  #
1147
1116
  # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
1148
- # ...
1149
1117
  #
1150
1118
  # @param filter [String, nil] An additional filter to apply to usage queries.
1151
1119
  #
1152
1120
  # @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
1153
- # ...
1154
1121
  #
1155
- # @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
1156
- # ...
1122
+ # @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
1157
1123
  #
1158
1124
  # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
1159
- # ...
1160
1125
  #
1161
1126
  # @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
1162
- # ...
1163
1127
 
1164
1128
  class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1165
1129
  # @!attribute effective_date
@@ -1235,39 +1199,39 @@ module Orb
1235
1199
  # @!attribute created_credit_notes
1236
1200
  # The credit notes that were created as part of this operation.
1237
1201
  #
1238
- # @return [Array<Orb::Models::CreditNote>]
1239
- required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] }
1202
+ # @return [Array<Orb::CreditNote>]
1203
+ required :created_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
1240
1204
 
1241
1205
  # @!attribute created_invoices
1242
1206
  # The invoices that were created as part of this operation.
1243
1207
  #
1244
- # @return [Array<Orb::Models::Invoice>]
1245
- required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
1208
+ # @return [Array<Orb::Invoice>]
1209
+ required :created_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
1246
1210
 
1247
1211
  # @!attribute voided_credit_notes
1248
1212
  # The credit notes that were voided as part of this operation.
1249
1213
  #
1250
- # @return [Array<Orb::Models::CreditNote>]
1251
- required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditNote] }
1214
+ # @return [Array<Orb::CreditNote>]
1215
+ required :voided_credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::CreditNote] }
1252
1216
 
1253
1217
  # @!attribute voided_invoices
1254
1218
  # The invoices that were voided as part of this operation.
1255
1219
  #
1256
- # @return [Array<Orb::Models::Invoice>]
1257
- required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
1220
+ # @return [Array<Orb::Invoice>]
1221
+ required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice] }
1258
1222
 
1259
1223
  # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
1260
1224
  # The resources that were changed as part of this operation. Only present when
1261
1225
  # fetched through the subscription changes API or if the
1262
1226
  # `include_changed_resources` parameter was passed in the request.
1263
1227
  #
1264
- # @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
1228
+ # @param created_credit_notes [Array<Orb::CreditNote>] The credit notes that were created as part of this operation.
1265
1229
  #
1266
- # @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
1230
+ # @param created_invoices [Array<Orb::Invoice>] The invoices that were created as part of this operation.
1267
1231
  #
1268
- # @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
1232
+ # @param voided_credit_notes [Array<Orb::CreditNote>] The credit notes that were voided as part of this operation.
1269
1233
  #
1270
- # @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
1234
+ # @param voided_invoices [Array<Orb::Invoice>] The invoices that were voided as part of this operation.
1271
1235
  end
1272
1236
  end
1273
1237
  end