orb-billing 0.2.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (488) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +67 -0
  3. data/README.md +63 -53
  4. data/lib/orb/client.rb +4 -4
  5. data/lib/orb/errors.rb +9 -9
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +7 -11
  8. data/lib/orb/internal/transport/base_client.rb +10 -10
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
  10. data/lib/orb/internal/type/array_of.rb +11 -0
  11. data/lib/orb/internal/type/base_model.rb +33 -23
  12. data/lib/orb/internal/type/base_page.rb +9 -1
  13. data/lib/orb/internal/type/boolean.rb +14 -11
  14. data/lib/orb/internal/type/converter.rb +4 -1
  15. data/lib/orb/internal/type/enum.rb +19 -16
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
  17. data/lib/orb/internal/type/hash_of.rb +11 -0
  18. data/lib/orb/internal/type/request_parameters.rb +3 -10
  19. data/lib/orb/internal/type/union.rb +10 -1
  20. data/lib/orb/internal/type/unknown.rb +14 -11
  21. data/lib/orb/internal/util.rb +88 -64
  22. data/lib/orb/internal.rb +0 -1
  23. data/lib/orb/models/alert.rb +68 -71
  24. data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
  25. data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
  26. data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
  27. data/lib/orb/models/alert_disable_params.rb +5 -9
  28. data/lib/orb/models/alert_enable_params.rb +5 -9
  29. data/lib/orb/models/alert_list_params.rb +26 -36
  30. data/lib/orb/models/alert_retrieve_params.rb +3 -8
  31. data/lib/orb/models/alert_update_params.rb +14 -18
  32. data/lib/orb/models/amount_discount.rb +14 -14
  33. data/lib/orb/models/billable_metric.rb +23 -20
  34. data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
  35. data/lib/orb/models/coupon.rb +28 -21
  36. data/lib/orb/models/coupon_archive_params.rb +3 -8
  37. data/lib/orb/models/coupon_create_params.rb +29 -34
  38. data/lib/orb/models/coupon_fetch_params.rb +3 -8
  39. data/lib/orb/models/coupon_list_params.rb +17 -17
  40. data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
  41. data/lib/orb/models/credit_note.rb +100 -166
  42. data/lib/orb/models/credit_note_create_params.rb +15 -23
  43. data/lib/orb/models/credit_note_fetch_params.rb +3 -8
  44. data/lib/orb/models/credit_note_list_params.rb +20 -30
  45. data/lib/orb/models/customer.rb +224 -271
  46. data/lib/orb/models/customer_create_params.rb +216 -257
  47. data/lib/orb/models/customer_delete_params.rb +3 -8
  48. data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
  49. data/lib/orb/models/customer_fetch_params.rb +3 -8
  50. data/lib/orb/models/customer_list_params.rb +20 -30
  51. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
  52. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
  53. data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
  54. data/lib/orb/models/customer_update_params.rb +212 -255
  55. data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
  56. data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
  57. data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
  58. data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
  59. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
  60. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +23 -27
  63. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
  64. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
  65. data/lib/orb/models/customers/credit_list_params.rb +18 -22
  66. data/lib/orb/models/customers/credit_list_response.rb +10 -17
  67. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
  68. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
  69. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
  70. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
  71. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
  72. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
  75. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
  76. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
  77. data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
  78. data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
  79. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
  80. data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
  81. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
  82. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
  83. data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
  84. data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
  85. data/lib/orb/models/dimensional_price_group.rb +21 -15
  86. data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
  87. data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
  88. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
  89. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
  90. data/lib/orb/models/dimensional_price_groups.rb +3 -7
  91. data/lib/orb/models/discount.rb +2 -3
  92. data/lib/orb/models/evaluate_price_group.rb +8 -11
  93. data/lib/orb/models/event_deprecate_params.rb +3 -8
  94. data/lib/orb/models/event_deprecate_response.rb +2 -6
  95. data/lib/orb/models/event_ingest_params.rb +33 -27
  96. data/lib/orb/models/event_ingest_response.rb +23 -24
  97. data/lib/orb/models/event_search_params.rb +15 -11
  98. data/lib/orb/models/event_search_response.rb +27 -22
  99. data/lib/orb/models/event_update_params.rb +19 -13
  100. data/lib/orb/models/event_update_response.rb +2 -6
  101. data/lib/orb/models/events/backfill_close_params.rb +3 -8
  102. data/lib/orb/models/events/backfill_close_response.rb +34 -39
  103. data/lib/orb/models/events/backfill_create_params.rb +28 -32
  104. data/lib/orb/models/events/backfill_create_response.rb +34 -39
  105. data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
  106. data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
  107. data/lib/orb/models/events/backfill_list_params.rb +12 -15
  108. data/lib/orb/models/events/backfill_list_response.rb +34 -39
  109. data/lib/orb/models/events/backfill_revert_params.rb +3 -8
  110. data/lib/orb/models/events/backfill_revert_response.rb +34 -39
  111. data/lib/orb/models/events/event_volumes.rb +11 -17
  112. data/lib/orb/models/events/volume_list_params.rb +19 -22
  113. data/lib/orb/models/invoice.rb +619 -681
  114. data/lib/orb/models/invoice_create_params.rb +52 -61
  115. data/lib/orb/models/invoice_fetch_params.rb +3 -8
  116. data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
  117. data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
  118. data/lib/orb/models/invoice_issue_params.rb +10 -14
  119. data/lib/orb/models/invoice_level_discount.rb +2 -3
  120. data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
  121. data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
  122. data/lib/orb/models/invoice_list_params.rb +51 -66
  123. data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
  124. data/lib/orb/models/invoice_pay_params.rb +3 -8
  125. data/lib/orb/models/invoice_update_params.rb +9 -9
  126. data/lib/orb/models/invoice_void_params.rb +3 -8
  127. data/lib/orb/models/item.rb +14 -25
  128. data/lib/orb/models/item_create_params.rb +5 -9
  129. data/lib/orb/models/item_fetch_params.rb +3 -8
  130. data/lib/orb/models/item_list_params.rb +12 -15
  131. data/lib/orb/models/item_update_params.rb +10 -22
  132. data/lib/orb/models/metric_create_params.rb +17 -13
  133. data/lib/orb/models/metric_fetch_params.rb +3 -8
  134. data/lib/orb/models/metric_list_params.rb +20 -30
  135. data/lib/orb/models/metric_update_params.rb +9 -9
  136. data/lib/orb/models/pagination_metadata.rb +3 -7
  137. data/lib/orb/models/percentage_discount.rb +15 -14
  138. data/lib/orb/models/plan.rb +259 -291
  139. data/lib/orb/models/plan_create_params.rb +2070 -2466
  140. data/lib/orb/models/plan_fetch_params.rb +3 -8
  141. data/lib/orb/models/plan_list_params.rb +25 -42
  142. data/lib/orb/models/plan_update_params.rb +12 -10
  143. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
  144. data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
  145. data/lib/orb/models/price.rb +3842 -5005
  146. data/lib/orb/models/price_create_params.rb +203 -244
  147. data/lib/orb/models/price_evaluate_params.rb +21 -30
  148. data/lib/orb/models/price_evaluate_response.rb +2 -6
  149. data/lib/orb/models/price_fetch_params.rb +3 -8
  150. data/lib/orb/models/price_list_params.rb +12 -15
  151. data/lib/orb/models/price_update_params.rb +9 -9
  152. data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
  153. data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
  154. data/lib/orb/models/subscription.rb +360 -405
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +358 -399
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +384 -418
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
  163. data/lib/orb/models/subscription_create_params.rb +4735 -5417
  164. data/lib/orb/models/subscription_create_response.rb +358 -399
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
  167. data/lib/orb/models/subscription_fetch_params.rb +3 -8
  168. data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
  169. data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
  170. data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
  171. data/lib/orb/models/subscription_list_params.rb +28 -41
  172. data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
  173. data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
  180. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
  181. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
  182. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
  183. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
  184. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
  185. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
  186. data/lib/orb/models/subscription_update_params.rb +21 -23
  187. data/lib/orb/models/subscription_update_trial_params.rb +15 -18
  188. data/lib/orb/models/subscription_update_trial_response.rb +360 -399
  189. data/lib/orb/models/subscription_usage.rb +37 -80
  190. data/lib/orb/models/subscriptions.rb +3 -7
  191. data/lib/orb/models/top_level_ping_params.rb +3 -8
  192. data/lib/orb/models/top_level_ping_response.rb +2 -6
  193. data/lib/orb/models/trial_discount.rb +16 -24
  194. data/lib/orb/models/usage_discount.rb +15 -14
  195. data/lib/orb/models.rb +220 -0
  196. data/lib/orb/request_options.rb +4 -6
  197. data/lib/orb/resources/alerts.rb +48 -17
  198. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  199. data/lib/orb/resources/coupons.rb +26 -8
  200. data/lib/orb/resources/credit_notes.rb +17 -4
  201. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  202. data/lib/orb/resources/customers/costs.rb +26 -8
  203. data/lib/orb/resources/customers/credits/ledger.rb +112 -32
  204. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  205. data/lib/orb/resources/customers/credits.rb +28 -8
  206. data/lib/orb/resources/customers.rb +138 -39
  207. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  208. data/lib/orb/resources/events/backfills.rb +32 -9
  209. data/lib/orb/resources/events/volume.rb +14 -4
  210. data/lib/orb/resources/events.rb +40 -11
  211. data/lib/orb/resources/invoice_line_items.rb +16 -6
  212. data/lib/orb/resources/invoices.rb +77 -17
  213. data/lib/orb/resources/items.rb +10 -3
  214. data/lib/orb/resources/metrics.rb +33 -8
  215. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  216. data/lib/orb/resources/plans.rb +47 -11
  217. data/lib/orb/resources/prices/external_price_id.rb +9 -3
  218. data/lib/orb/resources/prices.rb +101 -26
  219. data/lib/orb/resources/subscription_changes.rb +5 -2
  220. data/lib/orb/resources/subscriptions.rb +292 -78
  221. data/lib/orb/version.rb +1 -1
  222. data/lib/orb.rb +2 -10
  223. data/rbi/{lib/orb → orb}/client.rbi +4 -4
  224. data/rbi/{lib/orb → orb}/errors.rbi +1 -1
  225. data/rbi/orb/file_part.rbi +34 -0
  226. data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
  227. data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
  228. data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
  229. data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
  230. data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
  231. data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
  232. data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
  233. data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
  234. data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
  235. data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
  236. data/rbi/{lib/orb → orb}/internal.rbi +0 -1
  237. data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
  238. data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
  239. data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
  240. data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
  241. data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
  242. data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
  243. data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
  244. data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
  245. data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
  246. data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
  247. data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
  248. data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
  249. data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
  250. data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
  251. data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
  252. data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
  253. data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
  254. data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
  255. data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
  256. data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
  257. data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
  258. data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
  259. data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
  260. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
  261. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
  262. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
  263. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
  264. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
  265. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
  266. data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
  267. data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
  268. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
  269. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
  270. data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
  271. data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
  272. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  273. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
  274. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  275. data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
  276. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  277. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
  278. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
  279. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
  280. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  281. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  282. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
  283. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
  284. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  285. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  286. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
  287. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
  288. data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
  289. data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
  290. data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
  291. data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
  292. data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
  293. data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
  294. data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
  295. data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
  296. data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
  297. data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
  298. data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
  299. data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
  300. data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
  301. data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
  302. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
  303. data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
  304. data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
  305. data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
  306. data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
  307. data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
  308. data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
  309. data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
  310. data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
  311. data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
  312. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
  313. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
  314. data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
  315. data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
  316. data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
  317. data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
  318. data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
  319. data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
  320. data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
  321. data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
  322. data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
  323. data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
  324. data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
  325. data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
  326. data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
  327. data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
  328. data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
  329. data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
  330. data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
  331. data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
  332. data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
  333. data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
  334. data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
  335. data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
  336. data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
  337. data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
  338. data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
  339. data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
  340. data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
  341. data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
  342. data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
  343. data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
  344. data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
  345. data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
  346. data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
  347. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
  348. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
  349. data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
  350. data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
  351. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
  352. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
  353. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
  354. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
  355. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
  356. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
  357. data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
  358. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  359. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
  360. data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
  361. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  362. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
  363. data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
  364. data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
  365. data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
  366. data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
  367. data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
  368. data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
  369. data/rbi/orb/models.rbi +220 -0
  370. data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
  371. data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
  372. data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
  373. data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
  374. data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
  375. data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
  376. data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
  377. data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
  378. data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
  379. data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
  380. data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
  381. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
  382. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
  383. data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
  384. data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
  385. data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
  386. data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
  387. data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
  388. data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
  389. data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
  390. data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
  391. data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
  392. data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
  393. data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
  394. data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
  395. data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
  396. data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
  397. data/sig/orb/file_part.rbs +21 -0
  398. data/sig/orb/internal/transport/base_client.rbs +9 -3
  399. data/sig/orb/internal/type/array_of.rbs +2 -0
  400. data/sig/orb/internal/type/base_model.rbs +4 -0
  401. data/sig/orb/internal/type/enum.rbs +2 -2
  402. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  403. data/sig/orb/internal/type/hash_of.rbs +2 -0
  404. data/sig/orb/internal/type/union.rbs +2 -0
  405. data/sig/orb/internal/util.rbs +16 -12
  406. data/sig/orb/models/coupon_create_params.rbs +9 -10
  407. data/sig/orb/models/customer_create_params.rbs +9 -10
  408. data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
  409. data/sig/orb/models/customer_update_params.rbs +9 -10
  410. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
  411. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
  412. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
  413. data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
  414. data/sig/orb/models/invoice.rbs +54 -54
  415. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
  416. data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
  417. data/sig/orb/models/plan.rbs +21 -21
  418. data/sig/orb/models/plan_create_params.rbs +653 -653
  419. data/sig/orb/models/price.rbs +1517 -1521
  420. data/sig/orb/models/subscription.rbs +34 -34
  421. data/sig/orb/models/subscription_cancel_response.rbs +34 -34
  422. data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
  423. data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
  424. data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
  425. data/sig/orb/models/subscription_create_params.rbs +1348 -1348
  426. data/sig/orb/models/subscription_create_response.rbs +34 -34
  427. data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
  428. data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
  429. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
  430. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
  431. data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
  432. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
  433. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
  434. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
  435. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
  436. data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
  437. data/sig/orb/models.rbs +215 -0
  438. metadata +230 -224
  439. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
  440. data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
  441. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
  442. data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
  443. /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
  444. /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
  445. /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
  446. /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
  447. /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
  448. /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
  449. /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
  450. /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
  451. /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
  452. /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
  453. /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
  454. /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
  455. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
  456. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
  457. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
  458. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
  459. /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
  460. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
  461. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
  462. /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
  463. /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
  464. /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
  465. /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
  466. /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
  467. /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
  468. /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
  469. /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
  470. /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
  471. /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
  472. /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
  473. /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
  474. /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
  475. /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
  476. /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
  477. /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
  478. /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
  479. /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
  480. /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
  481. /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
  482. /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
  483. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
  484. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
  485. /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
  486. /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
  487. /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
  488. /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -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::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval>]
104
+ # @return [Array<Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage>]
105
105
  required :discount_intervals,
106
106
  -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionCancelResponse::DiscountInterval] }
107
107
 
@@ -207,69 +207,75 @@ module Orb
207
207
  # @return [Orb::Models::SubscriptionCancelResponse::ChangedResources, nil]
208
208
  optional :changed_resources, -> { Orb::Models::SubscriptionCancelResponse::ChangedResources }, nil?: true
209
209
 
210
- # @!parse
211
- # # @param id [String]
212
- # # @param active_plan_phase_order [Integer, nil]
213
- # # @param adjustment_intervals [Array<Orb::Models::SubscriptionCancelResponse::AdjustmentInterval>]
214
- # # @param auto_collection [Boolean, nil]
215
- # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCancelResponse::BillingCycleAnchorConfiguration]
216
- # # @param billing_cycle_day [Integer]
217
- # # @param created_at [Time]
218
- # # @param current_billing_period_end_date [Time, nil]
219
- # # @param current_billing_period_start_date [Time, nil]
220
- # # @param customer [Orb::Models::Customer]
221
- # # @param default_invoice_memo [String, nil]
222
- # # @param discount_intervals [Array<Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval>]
223
- # # @param end_date [Time, nil]
224
- # # @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionCancelResponse::FixedFeeQuantitySchedule>]
225
- # # @param invoicing_threshold [String, nil]
226
- # # @param maximum_intervals [Array<Orb::Models::SubscriptionCancelResponse::MaximumInterval>]
227
- # # @param metadata [Hash{Symbol=>String}]
228
- # # @param minimum_intervals [Array<Orb::Models::SubscriptionCancelResponse::MinimumInterval>]
229
- # # @param net_terms [Integer]
230
- # # @param pending_subscription_change [Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, nil]
231
- # # @param plan [Orb::Models::Plan]
232
- # # @param price_intervals [Array<Orb::Models::SubscriptionCancelResponse::PriceInterval>]
233
- # # @param redeemed_coupon [Orb::Models::SubscriptionCancelResponse::RedeemedCoupon, nil]
234
- # # @param start_date [Time]
235
- # # @param status [Symbol, Orb::Models::SubscriptionCancelResponse::Status]
236
- # # @param trial_info [Orb::Models::SubscriptionCancelResponse::TrialInfo]
237
- # # @param changed_resources [Orb::Models::SubscriptionCancelResponse::ChangedResources, nil]
238
- # #
239
- # def initialize(
240
- # id:,
241
- # active_plan_phase_order:,
242
- # adjustment_intervals:,
243
- # auto_collection:,
244
- # billing_cycle_anchor_configuration:,
245
- # billing_cycle_day:,
246
- # created_at:,
247
- # current_billing_period_end_date:,
248
- # current_billing_period_start_date:,
249
- # customer:,
250
- # default_invoice_memo:,
251
- # discount_intervals:,
252
- # end_date:,
253
- # fixed_fee_quantity_schedule:,
254
- # invoicing_threshold:,
255
- # maximum_intervals:,
256
- # metadata:,
257
- # minimum_intervals:,
258
- # net_terms:,
259
- # pending_subscription_change:,
260
- # plan:,
261
- # price_intervals:,
262
- # redeemed_coupon:,
263
- # start_date:,
264
- # status:,
265
- # trial_info:,
266
- # changed_resources: nil,
267
- # **
268
- # )
269
- # super
270
- # end
271
-
272
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
210
+ # @!method initialize(id:, active_plan_phase_order:, adjustment_intervals:, auto_collection:, billing_cycle_anchor_configuration:, billing_cycle_day:, created_at:, current_billing_period_end_date:, current_billing_period_start_date:, customer:, default_invoice_memo:, discount_intervals:, end_date:, fixed_fee_quantity_schedule:, invoicing_threshold:, maximum_intervals:, metadata:, minimum_intervals:, net_terms:, pending_subscription_change:, plan:, price_intervals:, redeemed_coupon:, start_date:, status:, trial_info:, changed_resources: nil)
211
+ # Some parameter documentations has been truncated, see
212
+ # {Orb::Models::SubscriptionCancelResponse} for more details.
213
+ #
214
+ # @param id [String]
215
+ #
216
+ # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
217
+ # ...
218
+ #
219
+ # @param adjustment_intervals [Array<Orb::Models::SubscriptionCancelResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
220
+ # ...
221
+ #
222
+ # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
223
+ # ...
224
+ #
225
+ # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionCancelResponse::BillingCycleAnchorConfiguration]
226
+ #
227
+ # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
228
+ # ...
229
+ #
230
+ # @param created_at [Time]
231
+ #
232
+ # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
233
+ # ...
234
+ #
235
+ # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
236
+ # ...
237
+ #
238
+ # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
239
+ # ...
240
+ #
241
+ # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
242
+ # ...
243
+ #
244
+ # @param discount_intervals [Array<Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
245
+ #
246
+ # @param end_date [Time, nil] The date Orb stops billing for this subscription.
247
+ #
248
+ # @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionCancelResponse::FixedFeeQuantitySchedule>]
249
+ #
250
+ # @param invoicing_threshold [String, nil]
251
+ #
252
+ # @param maximum_intervals [Array<Orb::Models::SubscriptionCancelResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
253
+ #
254
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
255
+ # ...
256
+ #
257
+ # @param minimum_intervals [Array<Orb::Models::SubscriptionCancelResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
258
+ #
259
+ # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
260
+ # ...
261
+ #
262
+ # @param pending_subscription_change [Orb::Models::SubscriptionCancelResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
263
+ #
264
+ # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
265
+ # ...
266
+ #
267
+ # @param price_intervals [Array<Orb::Models::SubscriptionCancelResponse::PriceInterval>] The price intervals for this subscription.
268
+ #
269
+ # @param redeemed_coupon [Orb::Models::SubscriptionCancelResponse::RedeemedCoupon, nil]
270
+ #
271
+ # @param start_date [Time] The date Orb starts billing for this subscription.
272
+ #
273
+ # @param status [Symbol, Orb::Models::SubscriptionCancelResponse::Status]
274
+ #
275
+ # @param trial_info [Orb::Models::SubscriptionCancelResponse::TrialInfo]
276
+ #
277
+ # @param changed_resources [Orb::Models::SubscriptionCancelResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
278
+ # ...
273
279
 
274
280
  class AdjustmentInterval < Orb::Internal::Type::BaseModel
275
281
  # @!attribute id
@@ -279,7 +285,7 @@ module Orb
279
285
 
280
286
  # @!attribute adjustment
281
287
  #
282
- # @return [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
288
+ # @return [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum]
283
289
  required :adjustment,
284
290
  union: -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment }
285
291
 
@@ -301,16 +307,16 @@ module Orb
301
307
  # @return [Time]
302
308
  required :start_date, Time
303
309
 
304
- # @!parse
305
- # # @param id [String]
306
- # # @param adjustment [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
307
- # # @param applies_to_price_interval_ids [Array<String>]
308
- # # @param end_date [Time, nil]
309
- # # @param start_date [Time]
310
- # #
311
- # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super
312
-
313
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
310
+ # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
311
+ # @param id [String]
312
+ #
313
+ # @param adjustment [Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum]
314
+ #
315
+ # @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
316
+ #
317
+ # @param end_date [Time, nil] The end date of the adjustment interval.
318
+ #
319
+ # @param start_date [Time] The start date of the adjustment interval.
314
320
 
315
321
  # @see Orb::Models::SubscriptionCancelResponse::AdjustmentInterval#adjustment
316
322
  module Adjustment
@@ -319,21 +325,19 @@ module Orb
319
325
  discriminator :adjustment_type
320
326
 
321
327
  variant :usage_discount,
322
- -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment }
328
+ -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount }
323
329
 
324
330
  variant :amount_discount,
325
- -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment }
331
+ -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount }
326
332
 
327
333
  variant :percentage_discount,
328
- -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment }
334
+ -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
329
335
 
330
- variant :minimum,
331
- -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment }
336
+ variant :minimum, -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum }
332
337
 
333
- variant :maximum,
334
- -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
338
+ variant :maximum, -> { Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum }
335
339
 
336
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
340
+ class UsageDiscount < Orb::Internal::Type::BaseModel
337
341
  # @!attribute id
338
342
  #
339
343
  # @return [String]
@@ -376,32 +380,29 @@ module Orb
376
380
  # @return [Float]
377
381
  required :usage_discount, Float
378
382
 
379
- # @!parse
380
- # # @param id [String]
381
- # # @param applies_to_price_ids [Array<String>]
382
- # # @param is_invoice_level [Boolean]
383
- # # @param plan_phase_order [Integer, nil]
384
- # # @param reason [String, nil]
385
- # # @param usage_discount [Float]
386
- # # @param adjustment_type [Symbol, :usage_discount]
387
- # #
388
- # def initialize(
389
- # id:,
390
- # applies_to_price_ids:,
391
- # is_invoice_level:,
392
- # plan_phase_order:,
393
- # reason:,
394
- # usage_discount:,
395
- # adjustment_type: :usage_discount,
396
- # **
397
- # )
398
- # super
399
- # end
400
-
401
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
383
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
384
+ # Some parameter documentations has been truncated, see
385
+ # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount}
386
+ # for more details.
387
+ #
388
+ # @param id [String]
389
+ #
390
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
391
+ #
392
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
393
+ # ...
394
+ #
395
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
396
+ #
397
+ # @param reason [String, nil] The reason for the adjustment.
398
+ #
399
+ # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
400
+ # ...
401
+ #
402
+ # @param adjustment_type [Symbol, :usage_discount]
402
403
  end
403
404
 
404
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
405
+ class AmountDiscount < Orb::Internal::Type::BaseModel
405
406
  # @!attribute id
406
407
  #
407
408
  # @return [String]
@@ -444,32 +445,29 @@ module Orb
444
445
  # @return [String, nil]
445
446
  required :reason, String, nil?: true
446
447
 
447
- # @!parse
448
- # # @param id [String]
449
- # # @param amount_discount [String]
450
- # # @param applies_to_price_ids [Array<String>]
451
- # # @param is_invoice_level [Boolean]
452
- # # @param plan_phase_order [Integer, nil]
453
- # # @param reason [String, nil]
454
- # # @param adjustment_type [Symbol, :amount_discount]
455
- # #
456
- # def initialize(
457
- # id:,
458
- # amount_discount:,
459
- # applies_to_price_ids:,
460
- # is_invoice_level:,
461
- # plan_phase_order:,
462
- # reason:,
463
- # adjustment_type: :amount_discount,
464
- # **
465
- # )
466
- # super
467
- # end
468
-
469
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
448
+ # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
449
+ # Some parameter documentations has been truncated, see
450
+ # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount}
451
+ # for more details.
452
+ #
453
+ # @param id [String]
454
+ #
455
+ # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
456
+ # ...
457
+ #
458
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
459
+ #
460
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
461
+ # ...
462
+ #
463
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
464
+ #
465
+ # @param reason [String, nil] The reason for the adjustment.
466
+ #
467
+ # @param adjustment_type [Symbol, :amount_discount]
470
468
  end
471
469
 
472
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
470
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
473
471
  # @!attribute id
474
472
  #
475
473
  # @return [String]
@@ -512,32 +510,29 @@ module Orb
512
510
  # @return [String, nil]
513
511
  required :reason, String, nil?: true
514
512
 
515
- # @!parse
516
- # # @param id [String]
517
- # # @param applies_to_price_ids [Array<String>]
518
- # # @param is_invoice_level [Boolean]
519
- # # @param percentage_discount [Float]
520
- # # @param plan_phase_order [Integer, nil]
521
- # # @param reason [String, nil]
522
- # # @param adjustment_type [Symbol, :percentage_discount]
523
- # #
524
- # def initialize(
525
- # id:,
526
- # applies_to_price_ids:,
527
- # is_invoice_level:,
528
- # percentage_discount:,
529
- # plan_phase_order:,
530
- # reason:,
531
- # adjustment_type: :percentage_discount,
532
- # **
533
- # )
534
- # super
535
- # end
536
-
537
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
513
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
514
+ # Some parameter documentations has been truncated, see
515
+ # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
516
+ # for more details.
517
+ #
518
+ # @param id [String]
519
+ #
520
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
521
+ #
522
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
523
+ # ...
524
+ #
525
+ # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
526
+ # ...
527
+ #
528
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
529
+ #
530
+ # @param reason [String, nil] The reason for the adjustment.
531
+ #
532
+ # @param adjustment_type [Symbol, :percentage_discount]
538
533
  end
539
534
 
540
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
535
+ class Minimum < Orb::Internal::Type::BaseModel
541
536
  # @!attribute id
542
537
  #
543
538
  # @return [String]
@@ -586,34 +581,31 @@ module Orb
586
581
  # @return [String, nil]
587
582
  required :reason, String, nil?: true
588
583
 
589
- # @!parse
590
- # # @param id [String]
591
- # # @param applies_to_price_ids [Array<String>]
592
- # # @param is_invoice_level [Boolean]
593
- # # @param item_id [String]
594
- # # @param minimum_amount [String]
595
- # # @param plan_phase_order [Integer, nil]
596
- # # @param reason [String, nil]
597
- # # @param adjustment_type [Symbol, :minimum]
598
- # #
599
- # def initialize(
600
- # id:,
601
- # applies_to_price_ids:,
602
- # is_invoice_level:,
603
- # item_id:,
604
- # minimum_amount:,
605
- # plan_phase_order:,
606
- # reason:,
607
- # adjustment_type: :minimum,
608
- # **
609
- # )
610
- # super
611
- # end
612
-
613
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
584
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
585
+ # Some parameter documentations has been truncated, see
586
+ # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum}
587
+ # for more details.
588
+ #
589
+ # @param id [String]
590
+ #
591
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
592
+ #
593
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
594
+ # ...
595
+ #
596
+ # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
597
+ #
598
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
599
+ # ...
600
+ #
601
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
602
+ #
603
+ # @param reason [String, nil] The reason for the adjustment.
604
+ #
605
+ # @param adjustment_type [Symbol, :minimum]
614
606
  end
615
607
 
616
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
608
+ class Maximum < Orb::Internal::Type::BaseModel
617
609
  # @!attribute id
618
610
  #
619
611
  # @return [String]
@@ -656,34 +648,30 @@ module Orb
656
648
  # @return [String, nil]
657
649
  required :reason, String, nil?: true
658
650
 
659
- # @!parse
660
- # # @param id [String]
661
- # # @param applies_to_price_ids [Array<String>]
662
- # # @param is_invoice_level [Boolean]
663
- # # @param maximum_amount [String]
664
- # # @param plan_phase_order [Integer, nil]
665
- # # @param reason [String, nil]
666
- # # @param adjustment_type [Symbol, :maximum]
667
- # #
668
- # def initialize(
669
- # id:,
670
- # applies_to_price_ids:,
671
- # is_invoice_level:,
672
- # maximum_amount:,
673
- # plan_phase_order:,
674
- # reason:,
675
- # adjustment_type: :maximum,
676
- # **
677
- # )
678
- # super
679
- # end
680
-
681
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
651
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
652
+ # Some parameter documentations has been truncated, see
653
+ # {Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum}
654
+ # for more details.
655
+ #
656
+ # @param id [String]
657
+ #
658
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
659
+ #
660
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
661
+ # ...
662
+ #
663
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
664
+ # ...
665
+ #
666
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
667
+ #
668
+ # @param reason [String, nil] The reason for the adjustment.
669
+ #
670
+ # @param adjustment_type [Symbol, :maximum]
682
671
  end
683
672
 
684
- # @!parse
685
- # # @return [Array(Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
686
- # def self.variants; end
673
+ # @!method self.variants
674
+ # @return [Array(Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionCancelResponse::AdjustmentInterval::Adjustment::Maximum)]
687
675
  end
688
676
  end
689
677
 
@@ -713,14 +701,19 @@ module Orb
713
701
  # @return [Integer, nil]
714
702
  optional :year, Integer, nil?: true
715
703
 
716
- # @!parse
717
- # # @param day [Integer]
718
- # # @param month [Integer, nil]
719
- # # @param year [Integer, nil]
720
- # #
721
- # def initialize(day:, month: nil, year: nil, **) = super
722
-
723
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
704
+ # @!method initialize(day:, month: nil, year: nil)
705
+ # Some parameter documentations has been truncated, see
706
+ # {Orb::Models::SubscriptionCancelResponse::BillingCycleAnchorConfiguration} for
707
+ # more details.
708
+ #
709
+ # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
710
+ # ...
711
+ #
712
+ # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
713
+ # ...
714
+ #
715
+ # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
716
+ # ...
724
717
  end
725
718
 
726
719
  module DiscountInterval
@@ -728,14 +721,13 @@ module Orb
728
721
 
729
722
  discriminator :discount_type
730
723
 
731
- variant :amount, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval }
724
+ variant :amount, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount }
732
725
 
733
- variant :percentage,
734
- -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval }
726
+ variant :percentage, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage }
735
727
 
736
- variant :usage, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval }
728
+ variant :usage, -> { Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage }
737
729
 
738
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
730
+ class Amount < Orb::Internal::Type::BaseModel
739
731
  # @!attribute amount_discount
740
732
  # Only available if discount_type is `amount`.
741
733
  #
@@ -771,30 +763,21 @@ module Orb
771
763
  # @return [Time]
772
764
  required :start_date, Time
773
765
 
774
- # @!parse
775
- # # @param amount_discount [String]
776
- # # @param applies_to_price_ids [Array<String>]
777
- # # @param applies_to_price_interval_ids [Array<String>]
778
- # # @param end_date [Time, nil]
779
- # # @param start_date [Time]
780
- # # @param discount_type [Symbol, :amount]
781
- # #
782
- # def initialize(
783
- # amount_discount:,
784
- # applies_to_price_ids:,
785
- # applies_to_price_interval_ids:,
786
- # end_date:,
787
- # start_date:,
788
- # discount_type: :amount,
789
- # **
790
- # )
791
- # super
792
- # end
793
-
794
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
766
+ # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
767
+ # @param amount_discount [String] Only available if discount_type is `amount`.
768
+ #
769
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
770
+ #
771
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
772
+ #
773
+ # @param end_date [Time, nil] The end date of the discount interval.
774
+ #
775
+ # @param start_date [Time] The start date of the discount interval.
776
+ #
777
+ # @param discount_type [Symbol, :amount]
795
778
  end
796
779
 
797
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
780
+ class Percentage < Orb::Internal::Type::BaseModel
798
781
  # @!attribute applies_to_price_ids
799
782
  # The price ids that this discount interval applies to.
800
783
  #
@@ -831,30 +814,26 @@ module Orb
831
814
  # @return [Time]
832
815
  required :start_date, Time
833
816
 
834
- # @!parse
835
- # # @param applies_to_price_ids [Array<String>]
836
- # # @param applies_to_price_interval_ids [Array<String>]
837
- # # @param end_date [Time, nil]
838
- # # @param percentage_discount [Float]
839
- # # @param start_date [Time]
840
- # # @param discount_type [Symbol, :percentage]
841
- # #
842
- # def initialize(
843
- # applies_to_price_ids:,
844
- # applies_to_price_interval_ids:,
845
- # end_date:,
846
- # percentage_discount:,
847
- # start_date:,
848
- # discount_type: :percentage,
849
- # **
850
- # )
851
- # super
852
- # end
853
-
854
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
817
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
818
+ # Some parameter documentations has been truncated, see
819
+ # {Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage} for more
820
+ # details.
821
+ #
822
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
823
+ #
824
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
825
+ #
826
+ # @param end_date [Time, nil] The end date of the discount interval.
827
+ #
828
+ # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
829
+ # ...
830
+ #
831
+ # @param start_date [Time] The start date of the discount interval.
832
+ #
833
+ # @param discount_type [Symbol, :percentage]
855
834
  end
856
835
 
857
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
836
+ class Usage < Orb::Internal::Type::BaseModel
858
837
  # @!attribute applies_to_price_ids
859
838
  # The price ids that this discount interval applies to.
860
839
  #
@@ -891,32 +870,27 @@ module Orb
891
870
  # @return [Float]
892
871
  required :usage_discount, Float
893
872
 
894
- # @!parse
895
- # # @param applies_to_price_ids [Array<String>]
896
- # # @param applies_to_price_interval_ids [Array<String>]
897
- # # @param end_date [Time, nil]
898
- # # @param start_date [Time]
899
- # # @param usage_discount [Float]
900
- # # @param discount_type [Symbol, :usage]
901
- # #
902
- # def initialize(
903
- # applies_to_price_ids:,
904
- # applies_to_price_interval_ids:,
905
- # end_date:,
906
- # start_date:,
907
- # usage_discount:,
908
- # discount_type: :usage,
909
- # **
910
- # )
911
- # super
912
- # end
913
-
914
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
873
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
874
+ # Some parameter documentations has been truncated, see
875
+ # {Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage} for more
876
+ # details.
877
+ #
878
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
879
+ #
880
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
881
+ #
882
+ # @param end_date [Time, nil] The end date of the discount interval.
883
+ #
884
+ # @param start_date [Time] The start date of the discount interval.
885
+ #
886
+ # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
887
+ # ...
888
+ #
889
+ # @param discount_type [Symbol, :usage]
915
890
  end
916
891
 
917
- # @!parse
918
- # # @return [Array(Orb::Models::SubscriptionCancelResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionCancelResponse::DiscountInterval::UsageDiscountInterval)]
919
- # def self.variants; end
892
+ # @!method self.variants
893
+ # @return [Array(Orb::Models::SubscriptionCancelResponse::DiscountInterval::Amount, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionCancelResponse::DiscountInterval::Usage)]
920
894
  end
921
895
 
922
896
  class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -940,15 +914,11 @@ module Orb
940
914
  # @return [Time]
941
915
  required :start_date, Time
942
916
 
943
- # @!parse
944
- # # @param end_date [Time, nil]
945
- # # @param price_id [String]
946
- # # @param quantity [Float]
947
- # # @param start_date [Time]
948
- # #
949
- # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
950
-
951
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
917
+ # @!method initialize(end_date:, price_id:, quantity:, start_date:)
918
+ # @param end_date [Time, nil]
919
+ # @param price_id [String]
920
+ # @param quantity [Float]
921
+ # @param start_date [Time]
952
922
  end
953
923
 
954
924
  class MaximumInterval < Orb::Internal::Type::BaseModel
@@ -983,16 +953,20 @@ module Orb
983
953
  # @return [Time]
984
954
  required :start_date, Time
985
955
 
986
- # @!parse
987
- # # @param applies_to_price_ids [Array<String>]
988
- # # @param applies_to_price_interval_ids [Array<String>]
989
- # # @param end_date [Time, nil]
990
- # # @param maximum_amount [String]
991
- # # @param start_date [Time]
992
- # #
993
- # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super
994
-
995
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
956
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
957
+ # Some parameter documentations has been truncated, see
958
+ # {Orb::Models::SubscriptionCancelResponse::MaximumInterval} for more details.
959
+ #
960
+ # @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
961
+ #
962
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
963
+ #
964
+ # @param end_date [Time, nil] The end date of the maximum interval.
965
+ #
966
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
967
+ # ...
968
+ #
969
+ # @param start_date [Time] The start date of the maximum interval.
996
970
  end
997
971
 
998
972
  class MinimumInterval < Orb::Internal::Type::BaseModel
@@ -1027,16 +1001,20 @@ module Orb
1027
1001
  # @return [Time]
1028
1002
  required :start_date, Time
1029
1003
 
1030
- # @!parse
1031
- # # @param applies_to_price_ids [Array<String>]
1032
- # # @param applies_to_price_interval_ids [Array<String>]
1033
- # # @param end_date [Time, nil]
1034
- # # @param minimum_amount [String]
1035
- # # @param start_date [Time]
1036
- # #
1037
- # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super
1038
-
1039
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1004
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
1005
+ # Some parameter documentations has been truncated, see
1006
+ # {Orb::Models::SubscriptionCancelResponse::MinimumInterval} for more details.
1007
+ #
1008
+ # @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
1009
+ #
1010
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
1011
+ #
1012
+ # @param end_date [Time, nil] The end date of the minimum interval.
1013
+ #
1014
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
1015
+ # ...
1016
+ #
1017
+ # @param start_date [Time] The start date of the minimum interval.
1040
1018
  end
1041
1019
 
1042
1020
  # @see Orb::Models::SubscriptionCancelResponse#pending_subscription_change
@@ -1046,14 +1024,10 @@ module Orb
1046
1024
  # @return [String]
1047
1025
  required :id, String
1048
1026
 
1049
- # @!parse
1050
- # # A pending subscription change if one exists on this subscription.
1051
- # #
1052
- # # @param id [String]
1053
- # #
1054
- # def initialize(id:, **) = super
1055
-
1056
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1027
+ # @!method initialize(id:)
1028
+ # A pending subscription change if one exists on this subscription.
1029
+ #
1030
+ # @param id [String]
1057
1031
  end
1058
1032
 
1059
1033
  class PriceInterval < Orb::Internal::Type::BaseModel
@@ -1118,7 +1092,7 @@ module Orb
1118
1092
  # For more on the types of prices, see
1119
1093
  # [the core concepts documentation](/core-concepts#plan-and-price)
1120
1094
  #
1121
- # @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]
1095
+ # @return [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk]
1122
1096
  required :price, union: -> { Orb::Models::Price }
1123
1097
 
1124
1098
  # @!attribute start_date
@@ -1135,39 +1109,40 @@ module Orb
1135
1109
  # @return [Array<String>, nil]
1136
1110
  required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
1137
1111
 
1138
- # @!parse
1139
- # # The Price Interval resource represents a period of time for which a price will
1140
- # # bill on a subscription. A subscription’s price intervals define its billing
1141
- # # behavior.
1142
- # #
1143
- # # @param id [String]
1144
- # # @param billing_cycle_day [Integer]
1145
- # # @param current_billing_period_end_date [Time, nil]
1146
- # # @param current_billing_period_start_date [Time, nil]
1147
- # # @param end_date [Time, nil]
1148
- # # @param filter [String, nil]
1149
- # # @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionCancelResponse::PriceInterval::FixedFeeQuantityTransition>, nil]
1150
- # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
1151
- # # @param start_date [Time]
1152
- # # @param usage_customer_ids [Array<String>, nil]
1153
- # #
1154
- # def initialize(
1155
- # id:,
1156
- # billing_cycle_day:,
1157
- # current_billing_period_end_date:,
1158
- # current_billing_period_start_date:,
1159
- # end_date:,
1160
- # filter:,
1161
- # fixed_fee_quantity_transitions:,
1162
- # price:,
1163
- # start_date:,
1164
- # usage_customer_ids:,
1165
- # **
1166
- # )
1167
- # super
1168
- # end
1169
-
1170
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1112
+ # @!method initialize(id:, billing_cycle_day:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
1113
+ # Some parameter documentations has been truncated, see
1114
+ # {Orb::Models::SubscriptionCancelResponse::PriceInterval} for more details.
1115
+ #
1116
+ # The Price Interval resource represents a period of time for which a price will
1117
+ # bill on a subscription. A subscription’s price intervals define its billing
1118
+ # behavior.
1119
+ #
1120
+ # @param id [String]
1121
+ #
1122
+ # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
1123
+ #
1124
+ # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
1125
+ # ...
1126
+ #
1127
+ # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
1128
+ # ...
1129
+ #
1130
+ # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
1131
+ # ...
1132
+ #
1133
+ # @param filter [String, nil] An additional filter to apply to usage queries.
1134
+ #
1135
+ # @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionCancelResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
1136
+ # ...
1137
+ #
1138
+ # @param price [Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk] The Price resource represents a price that can be billed on a subscription, resu
1139
+ # ...
1140
+ #
1141
+ # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
1142
+ # ...
1143
+ #
1144
+ # @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
1145
+ # ...
1171
1146
 
1172
1147
  class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1173
1148
  # @!attribute effective_date
@@ -1185,14 +1160,10 @@ module Orb
1185
1160
  # @return [Integer]
1186
1161
  required :quantity, Integer
1187
1162
 
1188
- # @!parse
1189
- # # @param effective_date [Time]
1190
- # # @param price_id [String]
1191
- # # @param quantity [Integer]
1192
- # #
1193
- # def initialize(effective_date:, price_id:, quantity:, **) = super
1194
-
1195
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1163
+ # @!method initialize(effective_date:, price_id:, quantity:)
1164
+ # @param effective_date [Time]
1165
+ # @param price_id [String]
1166
+ # @param quantity [Integer]
1196
1167
  end
1197
1168
  end
1198
1169
 
@@ -1213,14 +1184,10 @@ module Orb
1213
1184
  # @return [Time]
1214
1185
  required :start_date, Time
1215
1186
 
1216
- # @!parse
1217
- # # @param coupon_id [String]
1218
- # # @param end_date [Time, nil]
1219
- # # @param start_date [Time]
1220
- # #
1221
- # def initialize(coupon_id:, end_date:, start_date:, **) = super
1222
-
1223
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1187
+ # @!method initialize(coupon_id:, end_date:, start_date:)
1188
+ # @param coupon_id [String]
1189
+ # @param end_date [Time, nil]
1190
+ # @param start_date [Time]
1224
1191
  end
1225
1192
 
1226
1193
  # @see Orb::Models::SubscriptionCancelResponse#status
@@ -1231,11 +1198,8 @@ module Orb
1231
1198
  ENDED = :ended
1232
1199
  UPCOMING = :upcoming
1233
1200
 
1234
- finalize!
1235
-
1236
- # @!parse
1237
- # # @return [Array<Symbol>]
1238
- # def self.values; end
1201
+ # @!method self.values
1202
+ # @return [Array<Symbol>]
1239
1203
  end
1240
1204
 
1241
1205
  # @see Orb::Models::SubscriptionCancelResponse#trial_info
@@ -1245,12 +1209,8 @@ module Orb
1245
1209
  # @return [Time, nil]
1246
1210
  required :end_date, Time, nil?: true
1247
1211
 
1248
- # @!parse
1249
- # # @param end_date [Time, nil]
1250
- # #
1251
- # def initialize(end_date:, **) = super
1252
-
1253
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1212
+ # @!method initialize(end_date:)
1213
+ # @param end_date [Time, nil]
1254
1214
  end
1255
1215
 
1256
1216
  # @see Orb::Models::SubscriptionCancelResponse#changed_resources
@@ -1279,19 +1239,18 @@ module Orb
1279
1239
  # @return [Array<Orb::Models::Invoice>]
1280
1240
  required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
1281
1241
 
1282
- # @!parse
1283
- # # The resources that were changed as part of this operation. Only present when
1284
- # # fetched through the subscription changes API or if the
1285
- # # `include_changed_resources` parameter was passed in the request.
1286
- # #
1287
- # # @param created_credit_notes [Array<Orb::Models::CreditNote>]
1288
- # # @param created_invoices [Array<Orb::Models::Invoice>]
1289
- # # @param voided_credit_notes [Array<Orb::Models::CreditNote>]
1290
- # # @param voided_invoices [Array<Orb::Models::Invoice>]
1291
- # #
1292
- # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super
1293
-
1294
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1242
+ # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
1243
+ # The resources that were changed as part of this operation. Only present when
1244
+ # fetched through the subscription changes API or if the
1245
+ # `include_changed_resources` parameter was passed in the request.
1246
+ #
1247
+ # @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
1248
+ #
1249
+ # @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
1250
+ #
1251
+ # @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
1252
+ #
1253
+ # @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
1295
1254
  end
1296
1255
  end
1297
1256
  end