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
@@ -12,8 +12,8 @@ module Orb
12
12
 
13
13
  # @!attribute discount_type
14
14
  #
15
- # @return [Symbol, Orb::Models::PercentageDiscount::DiscountType]
16
- required :discount_type, enum: -> { Orb::Models::PercentageDiscount::DiscountType }
15
+ # @return [Symbol, Orb::PercentageDiscount::DiscountType]
16
+ required :discount_type, enum: -> { Orb::PercentageDiscount::DiscountType }
17
17
 
18
18
  # @!attribute percentage_discount
19
19
  # Only available if discount_type is `percentage`. This is a number between 0
@@ -28,20 +28,18 @@ module Orb
28
28
  optional :reason, String, nil?: true
29
29
 
30
30
  # @!method initialize(applies_to_price_ids:, discount_type:, percentage_discount:, reason: nil)
31
- # Some parameter documentations has been truncated, see
32
- # {Orb::Models::PercentageDiscount} for more details.
31
+ # Some parameter documentations has been truncated, see {Orb::PercentageDiscount}
32
+ # for more details.
33
33
  #
34
34
  # @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
35
- # ...
36
35
  #
37
- # @param discount_type [Symbol, Orb::Models::PercentageDiscount::DiscountType]
36
+ # @param discount_type [Symbol, Orb::PercentageDiscount::DiscountType]
38
37
  #
39
38
  # @param percentage_discount [Float] Only available if discount_type is `percentage`. This is a number between 0 and
40
- # ...
41
39
  #
42
40
  # @param reason [String, nil]
43
41
 
44
- # @see Orb::Models::PercentageDiscount#discount_type
42
+ # @see Orb::PercentageDiscount#discount_type
45
43
  module DiscountType
46
44
  extend Orb::Internal::Type::Enum
47
45
 
@@ -13,13 +13,13 @@ module Orb
13
13
  # Adjustments for this plan. If the plan has phases, this includes adjustments
14
14
  # across all phases of the plan.
15
15
  #
16
- # @return [Array<Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment>]
17
- required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Plan::Adjustment] }
16
+ # @return [Array<Orb::Plan::Adjustment::UsageDiscount, Orb::Plan::Adjustment::AmountDiscount, Orb::Plan::Adjustment::PercentageDiscount, Orb::Plan::Adjustment::Minimum, Orb::Plan::Adjustment::Maximum>]
17
+ required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Plan::Adjustment] }
18
18
 
19
19
  # @!attribute base_plan
20
20
  #
21
- # @return [Orb::Models::Plan::BasePlan, nil]
22
- required :base_plan, -> { Orb::Models::Plan::BasePlan }, nil?: true
21
+ # @return [Orb::Plan::BasePlan, nil]
22
+ required :base_plan, -> { Orb::Plan::BasePlan }, nil?: true
23
23
 
24
24
  # @!attribute base_plan_id
25
25
  # The parent plan id if the given plan was created by overriding one or more of
@@ -56,8 +56,8 @@ module Orb
56
56
 
57
57
  # @!attribute discount
58
58
  #
59
- # @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
60
- required :discount, union: -> { Orb::Models::Discount }, nil?: true
59
+ # @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
60
+ required :discount, union: -> { Orb::Discount }, nil?: true
61
61
 
62
62
  # @!attribute external_plan_id
63
63
  # An optional user-defined ID for this plan resource, used throughout the system
@@ -76,8 +76,8 @@ module Orb
76
76
 
77
77
  # @!attribute maximum
78
78
  #
79
- # @return [Orb::Models::Plan::Maximum, nil]
80
- required :maximum, -> { Orb::Models::Plan::Maximum }, nil?: true
79
+ # @return [Orb::Plan::Maximum, nil]
80
+ required :maximum, -> { Orb::Plan::Maximum }, nil?: true
81
81
 
82
82
  # @!attribute maximum_amount
83
83
  #
@@ -95,8 +95,8 @@ module Orb
95
95
 
96
96
  # @!attribute minimum
97
97
  #
98
- # @return [Orb::Models::Plan::Minimum, nil]
99
- required :minimum, -> { Orb::Models::Plan::Minimum }, nil?: true
98
+ # @return [Orb::Plan::Minimum, nil]
99
+ required :minimum, -> { Orb::Plan::Minimum }, nil?: true
100
100
 
101
101
  # @!attribute minimum_amount
102
102
  #
@@ -120,30 +120,30 @@ module Orb
120
120
 
121
121
  # @!attribute plan_phases
122
122
  #
123
- # @return [Array<Orb::Models::Plan::PlanPhase>, nil]
124
- required :plan_phases, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Plan::PlanPhase] }, nil?: true
123
+ # @return [Array<Orb::Plan::PlanPhase>, nil]
124
+ required :plan_phases, -> { Orb::Internal::Type::ArrayOf[Orb::Plan::PlanPhase] }, nil?: true
125
125
 
126
126
  # @!attribute prices
127
127
  # Prices for this plan. If the plan has phases, this includes prices across all
128
128
  # phases of the plan.
129
129
  #
130
- # @return [Array<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>]
131
- required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Price] }
130
+ # @return [Array<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>]
131
+ required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }
132
132
 
133
133
  # @!attribute product
134
134
  #
135
- # @return [Orb::Models::Plan::Product]
136
- required :product, -> { Orb::Models::Plan::Product }
135
+ # @return [Orb::Plan::Product]
136
+ required :product, -> { Orb::Plan::Product }
137
137
 
138
138
  # @!attribute status
139
139
  #
140
- # @return [Symbol, Orb::Models::Plan::Status]
141
- required :status, enum: -> { Orb::Models::Plan::Status }
140
+ # @return [Symbol, Orb::Plan::Status]
141
+ required :status, enum: -> { Orb::Plan::Status }
142
142
 
143
143
  # @!attribute trial_config
144
144
  #
145
- # @return [Orb::Models::Plan::TrialConfig]
146
- required :trial_config, -> { Orb::Models::Plan::TrialConfig }
145
+ # @return [Orb::Plan::TrialConfig]
146
+ required :trial_config, -> { Orb::Plan::TrialConfig }
147
147
 
148
148
  # @!attribute version
149
149
  #
@@ -151,8 +151,8 @@ module Orb
151
151
  required :version, Integer
152
152
 
153
153
  # @!method initialize(id:, adjustments:, base_plan:, base_plan_id:, created_at:, currency:, default_invoice_memo:, description:, discount:, external_plan_id:, invoicing_currency:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, net_terms:, plan_phases:, prices:, product:, status:, trial_config:, version:)
154
- # Some parameter documentations has been truncated, see {Orb::Models::Plan} for
155
- # more details.
154
+ # Some parameter documentations has been truncated, see {Orb::Plan} for more
155
+ # details.
156
156
  #
157
157
  # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
158
158
  # subscribed to by a customer. Plans define the billing behavior of the
@@ -161,58 +161,49 @@ module Orb
161
161
  #
162
162
  # @param id [String]
163
163
  #
164
- # @param adjustments [Array<Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
165
- # ...
164
+ # @param adjustments [Array<Orb::Plan::Adjustment::UsageDiscount, Orb::Plan::Adjustment::AmountDiscount, Orb::Plan::Adjustment::PercentageDiscount, Orb::Plan::Adjustment::Minimum, Orb::Plan::Adjustment::Maximum>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
166
165
  #
167
- # @param base_plan [Orb::Models::Plan::BasePlan, nil]
166
+ # @param base_plan [Orb::Plan::BasePlan, nil]
168
167
  #
169
168
  # @param base_plan_id [String, nil] The parent plan id if the given plan was created by overriding one or more of th
170
- # ...
171
169
  #
172
170
  # @param created_at [Time]
173
171
  #
174
172
  # @param currency [String] An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's p
175
- # ...
176
173
  #
177
174
  # @param default_invoice_memo [String, nil] The default memo text on the invoices corresponding to subscriptions on this pla
178
- # ...
179
175
  #
180
176
  # @param description [String]
181
177
  #
182
- # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
178
+ # @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
183
179
  #
184
180
  # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
185
- # ...
186
181
  #
187
182
  # @param invoicing_currency [String] An ISO 4217 currency string for which this plan is billed in. Matches `currency`
188
- # ...
189
183
  #
190
- # @param maximum [Orb::Models::Plan::Maximum, nil]
184
+ # @param maximum [Orb::Plan::Maximum, nil]
191
185
  #
192
186
  # @param maximum_amount [String, nil]
193
187
  #
194
188
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
195
- # ...
196
189
  #
197
- # @param minimum [Orb::Models::Plan::Minimum, nil]
190
+ # @param minimum [Orb::Plan::Minimum, nil]
198
191
  #
199
192
  # @param minimum_amount [String, nil]
200
193
  #
201
194
  # @param name [String]
202
195
  #
203
196
  # @param net_terms [Integer, nil] Determines the difference between the invoice issue date and the due date. A val
204
- # ...
205
197
  #
206
- # @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
198
+ # @param plan_phases [Array<Orb::Plan::PlanPhase>, nil]
207
199
  #
208
- # @param prices [Array<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>] Prices for this plan. If the plan has phases, this includes prices across all ph
209
- # ...
200
+ # @param prices [Array<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>] Prices for this plan. If the plan has phases, this includes prices across all ph
210
201
  #
211
- # @param product [Orb::Models::Plan::Product]
202
+ # @param product [Orb::Plan::Product]
212
203
  #
213
- # @param status [Symbol, Orb::Models::Plan::Status]
204
+ # @param status [Symbol, Orb::Plan::Status]
214
205
  #
215
- # @param trial_config [Orb::Models::Plan::TrialConfig]
206
+ # @param trial_config [Orb::Plan::TrialConfig]
216
207
  #
217
208
  # @param version [Integer]
218
209
 
@@ -221,17 +212,17 @@ module Orb
221
212
 
222
213
  discriminator :adjustment_type
223
214
 
224
- variant :usage_discount, -> { Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment }
215
+ variant :usage_discount, -> { Orb::Plan::Adjustment::UsageDiscount }
225
216
 
226
- variant :amount_discount, -> { Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment }
217
+ variant :amount_discount, -> { Orb::Plan::Adjustment::AmountDiscount }
227
218
 
228
- variant :percentage_discount, -> { Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment }
219
+ variant :percentage_discount, -> { Orb::Plan::Adjustment::PercentageDiscount }
229
220
 
230
- variant :minimum, -> { Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment }
221
+ variant :minimum, -> { Orb::Plan::Adjustment::Minimum }
231
222
 
232
- variant :maximum, -> { Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment }
223
+ variant :maximum, -> { Orb::Plan::Adjustment::Maximum }
233
224
 
234
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
225
+ class UsageDiscount < Orb::Internal::Type::BaseModel
235
226
  # @!attribute id
236
227
  #
237
228
  # @return [String]
@@ -276,27 +267,24 @@ module Orb
276
267
 
277
268
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
278
269
  # Some parameter documentations has been truncated, see
279
- # {Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment} for more
280
- # details.
270
+ # {Orb::Plan::Adjustment::UsageDiscount} for more details.
281
271
  #
282
272
  # @param id [String]
283
273
  #
284
274
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
285
275
  #
286
276
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
287
- # ...
288
277
  #
289
278
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
290
279
  #
291
280
  # @param reason [String, nil] The reason for the adjustment.
292
281
  #
293
282
  # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
294
- # ...
295
283
  #
296
284
  # @param adjustment_type [Symbol, :usage_discount]
297
285
  end
298
286
 
299
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
287
+ class AmountDiscount < Orb::Internal::Type::BaseModel
300
288
  # @!attribute id
301
289
  #
302
290
  # @return [String]
@@ -341,18 +329,15 @@ module Orb
341
329
 
342
330
  # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
343
331
  # Some parameter documentations has been truncated, see
344
- # {Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment} for more
345
- # details.
332
+ # {Orb::Plan::Adjustment::AmountDiscount} for more details.
346
333
  #
347
334
  # @param id [String]
348
335
  #
349
336
  # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
350
- # ...
351
337
  #
352
338
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
353
339
  #
354
340
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
355
- # ...
356
341
  #
357
342
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
358
343
  #
@@ -361,7 +346,7 @@ module Orb
361
346
  # @param adjustment_type [Symbol, :amount_discount]
362
347
  end
363
348
 
364
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
349
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
365
350
  # @!attribute id
366
351
  #
367
352
  # @return [String]
@@ -406,18 +391,15 @@ module Orb
406
391
 
407
392
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
408
393
  # Some parameter documentations has been truncated, see
409
- # {Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment} for more
410
- # details.
394
+ # {Orb::Plan::Adjustment::PercentageDiscount} for more details.
411
395
  #
412
396
  # @param id [String]
413
397
  #
414
398
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
415
399
  #
416
400
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
417
- # ...
418
401
  #
419
402
  # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
420
- # ...
421
403
  #
422
404
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
423
405
  #
@@ -426,7 +408,7 @@ module Orb
426
408
  # @param adjustment_type [Symbol, :percentage_discount]
427
409
  end
428
410
 
429
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
411
+ class Minimum < Orb::Internal::Type::BaseModel
430
412
  # @!attribute id
431
413
  #
432
414
  # @return [String]
@@ -477,19 +459,17 @@ module Orb
477
459
 
478
460
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
479
461
  # Some parameter documentations has been truncated, see
480
- # {Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment} for more details.
462
+ # {Orb::Plan::Adjustment::Minimum} for more details.
481
463
  #
482
464
  # @param id [String]
483
465
  #
484
466
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
485
467
  #
486
468
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
487
- # ...
488
469
  #
489
470
  # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
490
471
  #
491
472
  # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
492
- # ...
493
473
  #
494
474
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
495
475
  #
@@ -498,7 +478,7 @@ module Orb
498
478
  # @param adjustment_type [Symbol, :minimum]
499
479
  end
500
480
 
501
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
481
+ class Maximum < Orb::Internal::Type::BaseModel
502
482
  # @!attribute id
503
483
  #
504
484
  # @return [String]
@@ -543,17 +523,15 @@ module Orb
543
523
 
544
524
  # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
545
525
  # Some parameter documentations has been truncated, see
546
- # {Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment} for more details.
526
+ # {Orb::Plan::Adjustment::Maximum} for more details.
547
527
  #
548
528
  # @param id [String]
549
529
  #
550
530
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
551
531
  #
552
532
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
553
- # ...
554
533
  #
555
534
  # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
556
- # ...
557
535
  #
558
536
  # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
559
537
  #
@@ -563,10 +541,10 @@ module Orb
563
541
  end
564
542
 
565
543
  # @!method self.variants
566
- # @return [Array(Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment)]
544
+ # @return [Array(Orb::Plan::Adjustment::UsageDiscount, Orb::Plan::Adjustment::AmountDiscount, Orb::Plan::Adjustment::PercentageDiscount, Orb::Plan::Adjustment::Minimum, Orb::Plan::Adjustment::Maximum)]
567
545
  end
568
546
 
569
- # @see Orb::Models::Plan#base_plan
547
+ # @see Orb::Plan#base_plan
570
548
  class BasePlan < Orb::Internal::Type::BaseModel
571
549
  # @!attribute id
572
550
  #
@@ -587,18 +565,17 @@ module Orb
587
565
  required :name, String, nil?: true
588
566
 
589
567
  # @!method initialize(id:, external_plan_id:, name:)
590
- # Some parameter documentations has been truncated, see
591
- # {Orb::Models::Plan::BasePlan} for more details.
568
+ # Some parameter documentations has been truncated, see {Orb::Plan::BasePlan} for
569
+ # more details.
592
570
  #
593
571
  # @param id [String, nil]
594
572
  #
595
573
  # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
596
- # ...
597
574
  #
598
575
  # @param name [String, nil]
599
576
  end
600
577
 
601
- # @see Orb::Models::Plan#maximum
578
+ # @see Orb::Plan#maximum
602
579
  class Maximum < Orb::Internal::Type::BaseModel
603
580
  # @!attribute applies_to_price_ids
604
581
  # List of price_ids that this maximum amount applies to. For plan/plan phase
@@ -614,16 +591,15 @@ module Orb
614
591
  required :maximum_amount, String
615
592
 
616
593
  # @!method initialize(applies_to_price_ids:, maximum_amount:)
617
- # Some parameter documentations has been truncated, see
618
- # {Orb::Models::Plan::Maximum} for more details.
594
+ # Some parameter documentations has been truncated, see {Orb::Plan::Maximum} for
595
+ # more details.
619
596
  #
620
597
  # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
621
- # ...
622
598
  #
623
599
  # @param maximum_amount [String] Maximum amount applied
624
600
  end
625
601
 
626
- # @see Orb::Models::Plan#minimum
602
+ # @see Orb::Plan#minimum
627
603
  class Minimum < Orb::Internal::Type::BaseModel
628
604
  # @!attribute applies_to_price_ids
629
605
  # List of price_ids that this minimum amount applies to. For plan/plan phase
@@ -639,11 +615,10 @@ module Orb
639
615
  required :minimum_amount, String
640
616
 
641
617
  # @!method initialize(applies_to_price_ids:, minimum_amount:)
642
- # Some parameter documentations has been truncated, see
643
- # {Orb::Models::Plan::Minimum} for more details.
618
+ # Some parameter documentations has been truncated, see {Orb::Plan::Minimum} for
619
+ # more details.
644
620
  #
645
621
  # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
646
- # ...
647
622
  #
648
623
  # @param minimum_amount [String] Minimum amount applied
649
624
  end
@@ -661,8 +636,8 @@ module Orb
661
636
 
662
637
  # @!attribute discount
663
638
  #
664
- # @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
665
- required :discount, union: -> { Orb::Models::Discount }, nil?: true
639
+ # @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
640
+ required :discount, union: -> { Orb::Discount }, nil?: true
666
641
 
667
642
  # @!attribute duration
668
643
  # How many terms of length `duration_unit` this phase is active for. If null, this
@@ -673,13 +648,13 @@ module Orb
673
648
 
674
649
  # @!attribute duration_unit
675
650
  #
676
- # @return [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
677
- required :duration_unit, enum: -> { Orb::Models::Plan::PlanPhase::DurationUnit }, nil?: true
651
+ # @return [Symbol, Orb::Plan::PlanPhase::DurationUnit, nil]
652
+ required :duration_unit, enum: -> { Orb::Plan::PlanPhase::DurationUnit }, nil?: true
678
653
 
679
654
  # @!attribute maximum
680
655
  #
681
- # @return [Orb::Models::Plan::PlanPhase::Maximum, nil]
682
- required :maximum, -> { Orb::Models::Plan::PlanPhase::Maximum }, nil?: true
656
+ # @return [Orb::Plan::PlanPhase::Maximum, nil]
657
+ required :maximum, -> { Orb::Plan::PlanPhase::Maximum }, nil?: true
683
658
 
684
659
  # @!attribute maximum_amount
685
660
  #
@@ -688,8 +663,8 @@ module Orb
688
663
 
689
664
  # @!attribute minimum
690
665
  #
691
- # @return [Orb::Models::Plan::PlanPhase::Minimum, nil]
692
- required :minimum, -> { Orb::Models::Plan::PlanPhase::Minimum }, nil?: true
666
+ # @return [Orb::Plan::PlanPhase::Minimum, nil]
667
+ required :minimum, -> { Orb::Plan::PlanPhase::Minimum }, nil?: true
693
668
 
694
669
  # @!attribute minimum_amount
695
670
  #
@@ -708,25 +683,24 @@ module Orb
708
683
  required :order, Integer
709
684
 
710
685
  # @!method initialize(id:, description:, discount:, duration:, duration_unit:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, order:)
711
- # Some parameter documentations has been truncated, see
712
- # {Orb::Models::Plan::PlanPhase} for more details.
686
+ # Some parameter documentations has been truncated, see {Orb::Plan::PlanPhase} for
687
+ # more details.
713
688
  #
714
689
  # @param id [String]
715
690
  #
716
691
  # @param description [String, nil]
717
692
  #
718
- # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
693
+ # @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
719
694
  #
720
695
  # @param duration [Integer, nil] How many terms of length `duration_unit` this phase is active for. If null, this
721
- # ...
722
696
  #
723
- # @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
697
+ # @param duration_unit [Symbol, Orb::Plan::PlanPhase::DurationUnit, nil]
724
698
  #
725
- # @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil]
699
+ # @param maximum [Orb::Plan::PlanPhase::Maximum, nil]
726
700
  #
727
701
  # @param maximum_amount [String, nil]
728
702
  #
729
- # @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil]
703
+ # @param minimum [Orb::Plan::PlanPhase::Minimum, nil]
730
704
  #
731
705
  # @param minimum_amount [String, nil]
732
706
  #
@@ -734,7 +708,7 @@ module Orb
734
708
  #
735
709
  # @param order [Integer] Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
736
710
 
737
- # @see Orb::Models::Plan::PlanPhase#duration_unit
711
+ # @see Orb::Plan::PlanPhase#duration_unit
738
712
  module DurationUnit
739
713
  extend Orb::Internal::Type::Enum
740
714
 
@@ -748,7 +722,7 @@ module Orb
748
722
  # @return [Array<Symbol>]
749
723
  end
750
724
 
751
- # @see Orb::Models::Plan::PlanPhase#maximum
725
+ # @see Orb::Plan::PlanPhase#maximum
752
726
  class Maximum < Orb::Internal::Type::BaseModel
753
727
  # @!attribute applies_to_price_ids
754
728
  # List of price_ids that this maximum amount applies to. For plan/plan phase
@@ -765,15 +739,14 @@ module Orb
765
739
 
766
740
  # @!method initialize(applies_to_price_ids:, maximum_amount:)
767
741
  # Some parameter documentations has been truncated, see
768
- # {Orb::Models::Plan::PlanPhase::Maximum} for more details.
742
+ # {Orb::Plan::PlanPhase::Maximum} for more details.
769
743
  #
770
744
  # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
771
- # ...
772
745
  #
773
746
  # @param maximum_amount [String] Maximum amount applied
774
747
  end
775
748
 
776
- # @see Orb::Models::Plan::PlanPhase#minimum
749
+ # @see Orb::Plan::PlanPhase#minimum
777
750
  class Minimum < Orb::Internal::Type::BaseModel
778
751
  # @!attribute applies_to_price_ids
779
752
  # List of price_ids that this minimum amount applies to. For plan/plan phase
@@ -790,16 +763,15 @@ module Orb
790
763
 
791
764
  # @!method initialize(applies_to_price_ids:, minimum_amount:)
792
765
  # Some parameter documentations has been truncated, see
793
- # {Orb::Models::Plan::PlanPhase::Minimum} for more details.
766
+ # {Orb::Plan::PlanPhase::Minimum} for more details.
794
767
  #
795
768
  # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
796
- # ...
797
769
  #
798
770
  # @param minimum_amount [String] Minimum amount applied
799
771
  end
800
772
  end
801
773
 
802
- # @see Orb::Models::Plan#product
774
+ # @see Orb::Plan#product
803
775
  class Product < Orb::Internal::Type::BaseModel
804
776
  # @!attribute id
805
777
  #
@@ -822,7 +794,7 @@ module Orb
822
794
  # @param name [String]
823
795
  end
824
796
 
825
- # @see Orb::Models::Plan#status
797
+ # @see Orb::Plan#status
826
798
  module Status
827
799
  extend Orb::Internal::Type::Enum
828
800
 
@@ -834,7 +806,7 @@ module Orb
834
806
  # @return [Array<Symbol>]
835
807
  end
836
808
 
837
- # @see Orb::Models::Plan#trial_config
809
+ # @see Orb::Plan#trial_config
838
810
  class TrialConfig < Orb::Internal::Type::BaseModel
839
811
  # @!attribute trial_period
840
812
  #
@@ -843,14 +815,14 @@ module Orb
843
815
 
844
816
  # @!attribute trial_period_unit
845
817
  #
846
- # @return [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
847
- required :trial_period_unit, enum: -> { Orb::Models::Plan::TrialConfig::TrialPeriodUnit }
818
+ # @return [Symbol, Orb::Plan::TrialConfig::TrialPeriodUnit]
819
+ required :trial_period_unit, enum: -> { Orb::Plan::TrialConfig::TrialPeriodUnit }
848
820
 
849
821
  # @!method initialize(trial_period:, trial_period_unit:)
850
822
  # @param trial_period [Integer, nil]
851
- # @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
823
+ # @param trial_period_unit [Symbol, Orb::Plan::TrialConfig::TrialPeriodUnit]
852
824
 
853
- # @see Orb::Models::Plan::TrialConfig#trial_period_unit
825
+ # @see Orb::Plan::TrialConfig#trial_period_unit
854
826
  module TrialPeriodUnit
855
827
  extend Orb::Internal::Type::Enum
856
828