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::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval>]
104
+ # @return [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage>]
105
105
  required :discount_intervals,
106
106
  -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval] }
107
107
 
@@ -211,69 +211,76 @@ module Orb
211
211
  -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources },
212
212
  nil?: true
213
213
 
214
- # @!parse
215
- # # @param id [String]
216
- # # @param active_plan_phase_order [Integer, nil]
217
- # # @param adjustment_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval>]
218
- # # @param auto_collection [Boolean, nil]
219
- # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::BillingCycleAnchorConfiguration]
220
- # # @param billing_cycle_day [Integer]
221
- # # @param created_at [Time]
222
- # # @param current_billing_period_end_date [Time, nil]
223
- # # @param current_billing_period_start_date [Time, nil]
224
- # # @param customer [Orb::Models::Customer]
225
- # # @param default_invoice_memo [String, nil]
226
- # # @param discount_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval>]
227
- # # @param end_date [Time, nil]
228
- # # @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::FixedFeeQuantitySchedule>]
229
- # # @param invoicing_threshold [String, nil]
230
- # # @param maximum_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval>]
231
- # # @param metadata [Hash{Symbol=>String}]
232
- # # @param minimum_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval>]
233
- # # @param net_terms [Integer]
234
- # # @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, nil]
235
- # # @param plan [Orb::Models::Plan]
236
- # # @param price_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval>]
237
- # # @param redeemed_coupon [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::RedeemedCoupon, nil]
238
- # # @param start_date [Time]
239
- # # @param status [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status]
240
- # # @param trial_info [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo]
241
- # # @param changed_resources [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources, nil]
242
- # #
243
- # def initialize(
244
- # id:,
245
- # active_plan_phase_order:,
246
- # adjustment_intervals:,
247
- # auto_collection:,
248
- # billing_cycle_anchor_configuration:,
249
- # billing_cycle_day:,
250
- # created_at:,
251
- # current_billing_period_end_date:,
252
- # current_billing_period_start_date:,
253
- # customer:,
254
- # default_invoice_memo:,
255
- # discount_intervals:,
256
- # end_date:,
257
- # fixed_fee_quantity_schedule:,
258
- # invoicing_threshold:,
259
- # maximum_intervals:,
260
- # metadata:,
261
- # minimum_intervals:,
262
- # net_terms:,
263
- # pending_subscription_change:,
264
- # plan:,
265
- # price_intervals:,
266
- # redeemed_coupon:,
267
- # start_date:,
268
- # status:,
269
- # trial_info:,
270
- # changed_resources: nil,
271
- # **
272
- # )
273
- # super
274
- # end
275
-
276
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
214
+ # @!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)
215
+ # Some parameter documentations has been truncated, see
216
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse} for more
217
+ # details.
218
+ #
219
+ # @param id [String]
220
+ #
221
+ # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
222
+ # ...
223
+ #
224
+ # @param adjustment_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
225
+ # ...
226
+ #
227
+ # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
228
+ # ...
229
+ #
230
+ # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::BillingCycleAnchorConfiguration]
231
+ #
232
+ # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
233
+ # ...
234
+ #
235
+ # @param created_at [Time]
236
+ #
237
+ # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
238
+ # ...
239
+ #
240
+ # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
241
+ # ...
242
+ #
243
+ # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
244
+ # ...
245
+ #
246
+ # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
247
+ # ...
248
+ #
249
+ # @param discount_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage>] The discount intervals for this subscription sorted by the start_date.
250
+ #
251
+ # @param end_date [Time, nil] The date Orb stops billing for this subscription.
252
+ #
253
+ # @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::FixedFeeQuantitySchedule>]
254
+ #
255
+ # @param invoicing_threshold [String, nil]
256
+ #
257
+ # @param maximum_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
258
+ #
259
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
260
+ # ...
261
+ #
262
+ # @param minimum_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
263
+ #
264
+ # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
265
+ # ...
266
+ #
267
+ # @param pending_subscription_change [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
268
+ #
269
+ # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
270
+ # ...
271
+ #
272
+ # @param price_intervals [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval>] The price intervals for this subscription.
273
+ #
274
+ # @param redeemed_coupon [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::RedeemedCoupon, nil]
275
+ #
276
+ # @param start_date [Time] The date Orb starts billing for this subscription.
277
+ #
278
+ # @param status [Symbol, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::Status]
279
+ #
280
+ # @param trial_info [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::TrialInfo]
281
+ #
282
+ # @param changed_resources [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
283
+ # ...
277
284
 
278
285
  class AdjustmentInterval < Orb::Internal::Type::BaseModel
279
286
  # @!attribute id
@@ -283,7 +290,7 @@ module Orb
283
290
 
284
291
  # @!attribute adjustment
285
292
  #
286
- # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
293
+ # @return [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum]
287
294
  required :adjustment,
288
295
  union: -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment }
289
296
 
@@ -305,16 +312,16 @@ module Orb
305
312
  # @return [Time]
306
313
  required :start_date, Time
307
314
 
308
- # @!parse
309
- # # @param id [String]
310
- # # @param adjustment [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
311
- # # @param applies_to_price_interval_ids [Array<String>]
312
- # # @param end_date [Time, nil]
313
- # # @param start_date [Time]
314
- # #
315
- # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super
316
-
317
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
315
+ # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
316
+ # @param id [String]
317
+ #
318
+ # @param adjustment [Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum]
319
+ #
320
+ # @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
321
+ #
322
+ # @param end_date [Time, nil] The end date of the adjustment interval.
323
+ #
324
+ # @param start_date [Time] The start date of the adjustment interval.
318
325
 
319
326
  # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval#adjustment
320
327
  module Adjustment
@@ -323,21 +330,21 @@ module Orb
323
330
  discriminator :adjustment_type
324
331
 
325
332
  variant :usage_discount,
326
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment }
333
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount }
327
334
 
328
335
  variant :amount_discount,
329
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment }
336
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount }
330
337
 
331
338
  variant :percentage_discount,
332
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment }
339
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount }
333
340
 
334
341
  variant :minimum,
335
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment }
342
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum }
336
343
 
337
344
  variant :maximum,
338
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment }
345
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum }
339
346
 
340
- class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
347
+ class UsageDiscount < Orb::Internal::Type::BaseModel
341
348
  # @!attribute id
342
349
  #
343
350
  # @return [String]
@@ -380,32 +387,29 @@ module Orb
380
387
  # @return [Float]
381
388
  required :usage_discount, Float
382
389
 
383
- # @!parse
384
- # # @param id [String]
385
- # # @param applies_to_price_ids [Array<String>]
386
- # # @param is_invoice_level [Boolean]
387
- # # @param plan_phase_order [Integer, nil]
388
- # # @param reason [String, nil]
389
- # # @param usage_discount [Float]
390
- # # @param adjustment_type [Symbol, :usage_discount]
391
- # #
392
- # def initialize(
393
- # id:,
394
- # applies_to_price_ids:,
395
- # is_invoice_level:,
396
- # plan_phase_order:,
397
- # reason:,
398
- # usage_discount:,
399
- # adjustment_type: :usage_discount,
400
- # **
401
- # )
402
- # super
403
- # end
404
-
405
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
390
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
391
+ # Some parameter documentations has been truncated, see
392
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount}
393
+ # for more details.
394
+ #
395
+ # @param id [String]
396
+ #
397
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
398
+ #
399
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
400
+ # ...
401
+ #
402
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
403
+ #
404
+ # @param reason [String, nil] The reason for the adjustment.
405
+ #
406
+ # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
407
+ # ...
408
+ #
409
+ # @param adjustment_type [Symbol, :usage_discount]
406
410
  end
407
411
 
408
- class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
412
+ class AmountDiscount < Orb::Internal::Type::BaseModel
409
413
  # @!attribute id
410
414
  #
411
415
  # @return [String]
@@ -448,32 +452,29 @@ module Orb
448
452
  # @return [String, nil]
449
453
  required :reason, String, nil?: true
450
454
 
451
- # @!parse
452
- # # @param id [String]
453
- # # @param amount_discount [String]
454
- # # @param applies_to_price_ids [Array<String>]
455
- # # @param is_invoice_level [Boolean]
456
- # # @param plan_phase_order [Integer, nil]
457
- # # @param reason [String, nil]
458
- # # @param adjustment_type [Symbol, :amount_discount]
459
- # #
460
- # def initialize(
461
- # id:,
462
- # amount_discount:,
463
- # applies_to_price_ids:,
464
- # is_invoice_level:,
465
- # plan_phase_order:,
466
- # reason:,
467
- # adjustment_type: :amount_discount,
468
- # **
469
- # )
470
- # super
471
- # end
472
-
473
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
455
+ # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
456
+ # Some parameter documentations has been truncated, see
457
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount}
458
+ # for more details.
459
+ #
460
+ # @param id [String]
461
+ #
462
+ # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
463
+ # ...
464
+ #
465
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
466
+ #
467
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
468
+ # ...
469
+ #
470
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
471
+ #
472
+ # @param reason [String, nil] The reason for the adjustment.
473
+ #
474
+ # @param adjustment_type [Symbol, :amount_discount]
474
475
  end
475
476
 
476
- class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
477
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
477
478
  # @!attribute id
478
479
  #
479
480
  # @return [String]
@@ -516,32 +517,29 @@ module Orb
516
517
  # @return [String, nil]
517
518
  required :reason, String, nil?: true
518
519
 
519
- # @!parse
520
- # # @param id [String]
521
- # # @param applies_to_price_ids [Array<String>]
522
- # # @param is_invoice_level [Boolean]
523
- # # @param percentage_discount [Float]
524
- # # @param plan_phase_order [Integer, nil]
525
- # # @param reason [String, nil]
526
- # # @param adjustment_type [Symbol, :percentage_discount]
527
- # #
528
- # def initialize(
529
- # id:,
530
- # applies_to_price_ids:,
531
- # is_invoice_level:,
532
- # percentage_discount:,
533
- # plan_phase_order:,
534
- # reason:,
535
- # adjustment_type: :percentage_discount,
536
- # **
537
- # )
538
- # super
539
- # end
540
-
541
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
520
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
521
+ # Some parameter documentations has been truncated, see
522
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount}
523
+ # for more details.
524
+ #
525
+ # @param id [String]
526
+ #
527
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
528
+ #
529
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
530
+ # ...
531
+ #
532
+ # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
533
+ # ...
534
+ #
535
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
536
+ #
537
+ # @param reason [String, nil] The reason for the adjustment.
538
+ #
539
+ # @param adjustment_type [Symbol, :percentage_discount]
542
540
  end
543
541
 
544
- class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
542
+ class Minimum < Orb::Internal::Type::BaseModel
545
543
  # @!attribute id
546
544
  #
547
545
  # @return [String]
@@ -590,34 +588,31 @@ module Orb
590
588
  # @return [String, nil]
591
589
  required :reason, String, nil?: true
592
590
 
593
- # @!parse
594
- # # @param id [String]
595
- # # @param applies_to_price_ids [Array<String>]
596
- # # @param is_invoice_level [Boolean]
597
- # # @param item_id [String]
598
- # # @param minimum_amount [String]
599
- # # @param plan_phase_order [Integer, nil]
600
- # # @param reason [String, nil]
601
- # # @param adjustment_type [Symbol, :minimum]
602
- # #
603
- # def initialize(
604
- # id:,
605
- # applies_to_price_ids:,
606
- # is_invoice_level:,
607
- # item_id:,
608
- # minimum_amount:,
609
- # plan_phase_order:,
610
- # reason:,
611
- # adjustment_type: :minimum,
612
- # **
613
- # )
614
- # super
615
- # end
616
-
617
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
591
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
592
+ # Some parameter documentations has been truncated, see
593
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum}
594
+ # for more details.
595
+ #
596
+ # @param id [String]
597
+ #
598
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
599
+ #
600
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
601
+ # ...
602
+ #
603
+ # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
604
+ #
605
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
606
+ # ...
607
+ #
608
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
609
+ #
610
+ # @param reason [String, nil] The reason for the adjustment.
611
+ #
612
+ # @param adjustment_type [Symbol, :minimum]
618
613
  end
619
614
 
620
- class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
615
+ class Maximum < Orb::Internal::Type::BaseModel
621
616
  # @!attribute id
622
617
  #
623
618
  # @return [String]
@@ -660,34 +655,30 @@ module Orb
660
655
  # @return [String, nil]
661
656
  required :reason, String, nil?: true
662
657
 
663
- # @!parse
664
- # # @param id [String]
665
- # # @param applies_to_price_ids [Array<String>]
666
- # # @param is_invoice_level [Boolean]
667
- # # @param maximum_amount [String]
668
- # # @param plan_phase_order [Integer, nil]
669
- # # @param reason [String, nil]
670
- # # @param adjustment_type [Symbol, :maximum]
671
- # #
672
- # def initialize(
673
- # id:,
674
- # applies_to_price_ids:,
675
- # is_invoice_level:,
676
- # maximum_amount:,
677
- # plan_phase_order:,
678
- # reason:,
679
- # adjustment_type: :maximum,
680
- # **
681
- # )
682
- # super
683
- # end
684
-
685
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
658
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
659
+ # Some parameter documentations has been truncated, see
660
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum}
661
+ # for more details.
662
+ #
663
+ # @param id [String]
664
+ #
665
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
666
+ #
667
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
668
+ # ...
669
+ #
670
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
671
+ # ...
672
+ #
673
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
674
+ #
675
+ # @param reason [String, nil] The reason for the adjustment.
676
+ #
677
+ # @param adjustment_type [Symbol, :maximum]
686
678
  end
687
679
 
688
- # @!parse
689
- # # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
690
- # def self.variants; end
680
+ # @!method self.variants
681
+ # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Minimum, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::AdjustmentInterval::Adjustment::Maximum)]
691
682
  end
692
683
  end
693
684
 
@@ -717,14 +708,19 @@ module Orb
717
708
  # @return [Integer, nil]
718
709
  optional :year, Integer, nil?: true
719
710
 
720
- # @!parse
721
- # # @param day [Integer]
722
- # # @param month [Integer, nil]
723
- # # @param year [Integer, nil]
724
- # #
725
- # def initialize(day:, month: nil, year: nil, **) = super
726
-
727
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
711
+ # @!method initialize(day:, month: nil, year: nil)
712
+ # Some parameter documentations has been truncated, see
713
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::BillingCycleAnchorConfiguration}
714
+ # for more details.
715
+ #
716
+ # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
717
+ # ...
718
+ #
719
+ # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
720
+ # ...
721
+ #
722
+ # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
723
+ # ...
728
724
  end
729
725
 
730
726
  module DiscountInterval
@@ -733,15 +729,15 @@ module Orb
733
729
  discriminator :discount_type
734
730
 
735
731
  variant :amount,
736
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval }
732
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount }
737
733
 
738
734
  variant :percentage,
739
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval }
735
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage }
740
736
 
741
737
  variant :usage,
742
- -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval }
738
+ -> { Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage }
743
739
 
744
- class AmountDiscountInterval < Orb::Internal::Type::BaseModel
740
+ class Amount < Orb::Internal::Type::BaseModel
745
741
  # @!attribute amount_discount
746
742
  # Only available if discount_type is `amount`.
747
743
  #
@@ -777,30 +773,21 @@ module Orb
777
773
  # @return [Time]
778
774
  required :start_date, Time
779
775
 
780
- # @!parse
781
- # # @param amount_discount [String]
782
- # # @param applies_to_price_ids [Array<String>]
783
- # # @param applies_to_price_interval_ids [Array<String>]
784
- # # @param end_date [Time, nil]
785
- # # @param start_date [Time]
786
- # # @param discount_type [Symbol, :amount]
787
- # #
788
- # def initialize(
789
- # amount_discount:,
790
- # applies_to_price_ids:,
791
- # applies_to_price_interval_ids:,
792
- # end_date:,
793
- # start_date:,
794
- # discount_type: :amount,
795
- # **
796
- # )
797
- # super
798
- # end
799
-
800
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
776
+ # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
777
+ # @param amount_discount [String] Only available if discount_type is `amount`.
778
+ #
779
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
780
+ #
781
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
782
+ #
783
+ # @param end_date [Time, nil] The end date of the discount interval.
784
+ #
785
+ # @param start_date [Time] The start date of the discount interval.
786
+ #
787
+ # @param discount_type [Symbol, :amount]
801
788
  end
802
789
 
803
- class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
790
+ class Percentage < Orb::Internal::Type::BaseModel
804
791
  # @!attribute applies_to_price_ids
805
792
  # The price ids that this discount interval applies to.
806
793
  #
@@ -837,30 +824,26 @@ module Orb
837
824
  # @return [Time]
838
825
  required :start_date, Time
839
826
 
840
- # @!parse
841
- # # @param applies_to_price_ids [Array<String>]
842
- # # @param applies_to_price_interval_ids [Array<String>]
843
- # # @param end_date [Time, nil]
844
- # # @param percentage_discount [Float]
845
- # # @param start_date [Time]
846
- # # @param discount_type [Symbol, :percentage]
847
- # #
848
- # def initialize(
849
- # applies_to_price_ids:,
850
- # applies_to_price_interval_ids:,
851
- # end_date:,
852
- # percentage_discount:,
853
- # start_date:,
854
- # discount_type: :percentage,
855
- # **
856
- # )
857
- # super
858
- # end
859
-
860
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
827
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
828
+ # Some parameter documentations has been truncated, see
829
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage}
830
+ # for more details.
831
+ #
832
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
833
+ #
834
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
835
+ #
836
+ # @param end_date [Time, nil] The end date of the discount interval.
837
+ #
838
+ # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
839
+ # ...
840
+ #
841
+ # @param start_date [Time] The start date of the discount interval.
842
+ #
843
+ # @param discount_type [Symbol, :percentage]
861
844
  end
862
845
 
863
- class UsageDiscountInterval < Orb::Internal::Type::BaseModel
846
+ class Usage < Orb::Internal::Type::BaseModel
864
847
  # @!attribute applies_to_price_ids
865
848
  # The price ids that this discount interval applies to.
866
849
  #
@@ -897,32 +880,27 @@ module Orb
897
880
  # @return [Float]
898
881
  required :usage_discount, Float
899
882
 
900
- # @!parse
901
- # # @param applies_to_price_ids [Array<String>]
902
- # # @param applies_to_price_interval_ids [Array<String>]
903
- # # @param end_date [Time, nil]
904
- # # @param start_date [Time]
905
- # # @param usage_discount [Float]
906
- # # @param discount_type [Symbol, :usage]
907
- # #
908
- # def initialize(
909
- # applies_to_price_ids:,
910
- # applies_to_price_interval_ids:,
911
- # end_date:,
912
- # start_date:,
913
- # usage_discount:,
914
- # discount_type: :usage,
915
- # **
916
- # )
917
- # super
918
- # end
919
-
920
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
883
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
884
+ # Some parameter documentations has been truncated, see
885
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage}
886
+ # for more details.
887
+ #
888
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
889
+ #
890
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
891
+ #
892
+ # @param end_date [Time, nil] The end date of the discount interval.
893
+ #
894
+ # @param start_date [Time] The start date of the discount interval.
895
+ #
896
+ # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
897
+ # ...
898
+ #
899
+ # @param discount_type [Symbol, :usage]
921
900
  end
922
901
 
923
- # @!parse
924
- # # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::UsageDiscountInterval)]
925
- # def self.variants; end
902
+ # @!method self.variants
903
+ # @return [Array(Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Amount, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Percentage, Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::DiscountInterval::Usage)]
926
904
  end
927
905
 
928
906
  class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -946,15 +924,11 @@ module Orb
946
924
  # @return [Time]
947
925
  required :start_date, Time
948
926
 
949
- # @!parse
950
- # # @param end_date [Time, nil]
951
- # # @param price_id [String]
952
- # # @param quantity [Float]
953
- # # @param start_date [Time]
954
- # #
955
- # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
956
-
957
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
927
+ # @!method initialize(end_date:, price_id:, quantity:, start_date:)
928
+ # @param end_date [Time, nil]
929
+ # @param price_id [String]
930
+ # @param quantity [Float]
931
+ # @param start_date [Time]
958
932
  end
959
933
 
960
934
  class MaximumInterval < Orb::Internal::Type::BaseModel
@@ -989,16 +963,21 @@ module Orb
989
963
  # @return [Time]
990
964
  required :start_date, Time
991
965
 
992
- # @!parse
993
- # # @param applies_to_price_ids [Array<String>]
994
- # # @param applies_to_price_interval_ids [Array<String>]
995
- # # @param end_date [Time, nil]
996
- # # @param maximum_amount [String]
997
- # # @param start_date [Time]
998
- # #
999
- # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super
1000
-
1001
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
966
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
967
+ # Some parameter documentations has been truncated, see
968
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MaximumInterval}
969
+ # for more details.
970
+ #
971
+ # @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
972
+ #
973
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
974
+ #
975
+ # @param end_date [Time, nil] The end date of the maximum interval.
976
+ #
977
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
978
+ # ...
979
+ #
980
+ # @param start_date [Time] The start date of the maximum interval.
1002
981
  end
1003
982
 
1004
983
  class MinimumInterval < Orb::Internal::Type::BaseModel
@@ -1033,16 +1012,21 @@ module Orb
1033
1012
  # @return [Time]
1034
1013
  required :start_date, Time
1035
1014
 
1036
- # @!parse
1037
- # # @param applies_to_price_ids [Array<String>]
1038
- # # @param applies_to_price_interval_ids [Array<String>]
1039
- # # @param end_date [Time, nil]
1040
- # # @param minimum_amount [String]
1041
- # # @param start_date [Time]
1042
- # #
1043
- # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super
1044
-
1045
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1015
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
1016
+ # Some parameter documentations has been truncated, see
1017
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::MinimumInterval}
1018
+ # for more details.
1019
+ #
1020
+ # @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
1021
+ #
1022
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
1023
+ #
1024
+ # @param end_date [Time, nil] The end date of the minimum interval.
1025
+ #
1026
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
1027
+ # ...
1028
+ #
1029
+ # @param start_date [Time] The start date of the minimum interval.
1046
1030
  end
1047
1031
 
1048
1032
  # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#pending_subscription_change
@@ -1052,14 +1036,10 @@ module Orb
1052
1036
  # @return [String]
1053
1037
  required :id, String
1054
1038
 
1055
- # @!parse
1056
- # # A pending subscription change if one exists on this subscription.
1057
- # #
1058
- # # @param id [String]
1059
- # #
1060
- # def initialize(id:, **) = super
1061
-
1062
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1039
+ # @!method initialize(id:)
1040
+ # A pending subscription change if one exists on this subscription.
1041
+ #
1042
+ # @param id [String]
1063
1043
  end
1064
1044
 
1065
1045
  class PriceInterval < Orb::Internal::Type::BaseModel
@@ -1128,7 +1108,7 @@ module Orb
1128
1108
  # For more on the types of prices, see
1129
1109
  # [the core concepts documentation](/core-concepts#plan-and-price)
1130
1110
  #
1131
- # @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]
1111
+ # @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]
1132
1112
  required :price, union: -> { Orb::Models::Price }
1133
1113
 
1134
1114
  # @!attribute start_date
@@ -1145,39 +1125,41 @@ module Orb
1145
1125
  # @return [Array<String>, nil]
1146
1126
  required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
1147
1127
 
1148
- # @!parse
1149
- # # The Price Interval resource represents a period of time for which a price will
1150
- # # bill on a subscription. A subscription’s price intervals define its billing
1151
- # # behavior.
1152
- # #
1153
- # # @param id [String]
1154
- # # @param billing_cycle_day [Integer]
1155
- # # @param current_billing_period_end_date [Time, nil]
1156
- # # @param current_billing_period_start_date [Time, nil]
1157
- # # @param end_date [Time, nil]
1158
- # # @param filter [String, nil]
1159
- # # @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition>, nil]
1160
- # # @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]
1161
- # # @param start_date [Time]
1162
- # # @param usage_customer_ids [Array<String>, nil]
1163
- # #
1164
- # def initialize(
1165
- # id:,
1166
- # billing_cycle_day:,
1167
- # current_billing_period_end_date:,
1168
- # current_billing_period_start_date:,
1169
- # end_date:,
1170
- # filter:,
1171
- # fixed_fee_quantity_transitions:,
1172
- # price:,
1173
- # start_date:,
1174
- # usage_customer_ids:,
1175
- # **
1176
- # )
1177
- # super
1178
- # end
1179
-
1180
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1128
+ # @!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:)
1129
+ # Some parameter documentations has been truncated, see
1130
+ # {Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval}
1131
+ # for more details.
1132
+ #
1133
+ # The Price Interval resource represents a period of time for which a price will
1134
+ # bill on a subscription. A subscription’s price intervals define its billing
1135
+ # behavior.
1136
+ #
1137
+ # @param id [String]
1138
+ #
1139
+ # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
1140
+ #
1141
+ # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
1142
+ # ...
1143
+ #
1144
+ # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
1145
+ # ...
1146
+ #
1147
+ # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
1148
+ # ...
1149
+ #
1150
+ # @param filter [String, nil] An additional filter to apply to usage queries.
1151
+ #
1152
+ # @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
1153
+ # ...
1154
+ #
1155
+ # @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
1156
+ # ...
1157
+ #
1158
+ # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
1159
+ # ...
1160
+ #
1161
+ # @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
1162
+ # ...
1181
1163
 
1182
1164
  class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1183
1165
  # @!attribute effective_date
@@ -1195,14 +1177,10 @@ module Orb
1195
1177
  # @return [Integer]
1196
1178
  required :quantity, Integer
1197
1179
 
1198
- # @!parse
1199
- # # @param effective_date [Time]
1200
- # # @param price_id [String]
1201
- # # @param quantity [Integer]
1202
- # #
1203
- # def initialize(effective_date:, price_id:, quantity:, **) = super
1204
-
1205
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1180
+ # @!method initialize(effective_date:, price_id:, quantity:)
1181
+ # @param effective_date [Time]
1182
+ # @param price_id [String]
1183
+ # @param quantity [Integer]
1206
1184
  end
1207
1185
  end
1208
1186
 
@@ -1223,14 +1201,10 @@ module Orb
1223
1201
  # @return [Time]
1224
1202
  required :start_date, Time
1225
1203
 
1226
- # @!parse
1227
- # # @param coupon_id [String]
1228
- # # @param end_date [Time, nil]
1229
- # # @param start_date [Time]
1230
- # #
1231
- # def initialize(coupon_id:, end_date:, start_date:, **) = super
1232
-
1233
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1204
+ # @!method initialize(coupon_id:, end_date:, start_date:)
1205
+ # @param coupon_id [String]
1206
+ # @param end_date [Time, nil]
1207
+ # @param start_date [Time]
1234
1208
  end
1235
1209
 
1236
1210
  # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#status
@@ -1241,11 +1215,8 @@ module Orb
1241
1215
  ENDED = :ended
1242
1216
  UPCOMING = :upcoming
1243
1217
 
1244
- finalize!
1245
-
1246
- # @!parse
1247
- # # @return [Array<Symbol>]
1248
- # def self.values; end
1218
+ # @!method self.values
1219
+ # @return [Array<Symbol>]
1249
1220
  end
1250
1221
 
1251
1222
  # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#trial_info
@@ -1255,12 +1226,8 @@ module Orb
1255
1226
  # @return [Time, nil]
1256
1227
  required :end_date, Time, nil?: true
1257
1228
 
1258
- # @!parse
1259
- # # @param end_date [Time, nil]
1260
- # #
1261
- # def initialize(end_date:, **) = super
1262
-
1263
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1229
+ # @!method initialize(end_date:)
1230
+ # @param end_date [Time, nil]
1264
1231
  end
1265
1232
 
1266
1233
  # @see Orb::Models::SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse#changed_resources
@@ -1289,19 +1256,18 @@ module Orb
1289
1256
  # @return [Array<Orb::Models::Invoice>]
1290
1257
  required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
1291
1258
 
1292
- # @!parse
1293
- # # The resources that were changed as part of this operation. Only present when
1294
- # # fetched through the subscription changes API or if the
1295
- # # `include_changed_resources` parameter was passed in the request.
1296
- # #
1297
- # # @param created_credit_notes [Array<Orb::Models::CreditNote>]
1298
- # # @param created_invoices [Array<Orb::Models::Invoice>]
1299
- # # @param voided_credit_notes [Array<Orb::Models::CreditNote>]
1300
- # # @param voided_invoices [Array<Orb::Models::Invoice>]
1301
- # #
1302
- # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super
1303
-
1304
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1259
+ # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
1260
+ # The resources that were changed as part of this operation. Only present when
1261
+ # fetched through the subscription changes API or if the
1262
+ # `include_changed_resources` parameter was passed in the request.
1263
+ #
1264
+ # @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
1265
+ #
1266
+ # @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
1267
+ #
1268
+ # @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
1269
+ #
1270
+ # @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
1305
1271
  end
1306
1272
  end
1307
1273
  end