orb-billing 0.1.3 → 0.3.0

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 (381) hide show
  1. checksums.yaml +4 -4
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +65 -0
  4. data/README.md +61 -51
  5. data/lib/orb/client.rb +7 -6
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +37 -39
  8. data/lib/orb/internal/transport/base_client.rb +21 -11
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
  10. data/lib/orb/internal/type/array_of.rb +28 -2
  11. data/lib/orb/internal/type/base_model.rb +83 -21
  12. data/lib/orb/internal/type/base_page.rb +10 -1
  13. data/lib/orb/internal/type/boolean.rb +6 -0
  14. data/lib/orb/internal/type/converter.rb +28 -1
  15. data/lib/orb/internal/type/enum.rb +28 -8
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
  17. data/lib/orb/internal/type/hash_of.rb +28 -2
  18. data/lib/orb/internal/type/request_parameters.rb +1 -2
  19. data/lib/orb/internal/type/union.rb +27 -4
  20. data/lib/orb/internal/type/unknown.rb +6 -0
  21. data/lib/orb/internal/util.rb +105 -70
  22. data/lib/orb/internal.rb +5 -2
  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 +24 -29
  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 +211 -252
  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 +207 -250
  54. data/lib/orb/models/customer_update_params.rb +207 -250
  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 +22 -26
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +22 -26
  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 +300 -406
  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 +300 -406
  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 +300 -406
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
  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 +589 -637
  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 +584 -631
  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 +247 -269
  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 +250 -279
  139. data/lib/orb/models/plan_create_params.rb +1623 -1984
  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 +2709 -3820
  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 +343 -382
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +339 -377
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +365 -398
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
  163. data/lib/orb/models/subscription_create_params.rb +3771 -4402
  164. data/lib/orb/models/subscription_create_response.rb +339 -377
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
  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 +2018 -2472
  173. data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
  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 +343 -377
  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 +343 -377
  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 +342 -377
  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 +341 -377
  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/request_options.rb +3 -4
  196. data/lib/orb/resources/alerts.rb +48 -17
  197. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  198. data/lib/orb/resources/coupons.rb +25 -7
  199. data/lib/orb/resources/credit_notes.rb +17 -4
  200. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  201. data/lib/orb/resources/customers/costs.rb +26 -8
  202. data/lib/orb/resources/customers/credits/ledger.rb +108 -28
  203. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  204. data/lib/orb/resources/customers/credits.rb +28 -8
  205. data/lib/orb/resources/customers.rb +135 -36
  206. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  207. data/lib/orb/resources/events/backfills.rb +32 -9
  208. data/lib/orb/resources/events/volume.rb +14 -4
  209. data/lib/orb/resources/events.rb +40 -11
  210. data/lib/orb/resources/invoice_line_items.rb +16 -6
  211. data/lib/orb/resources/invoices.rb +77 -17
  212. data/lib/orb/resources/items.rb +10 -3
  213. data/lib/orb/resources/metrics.rb +33 -8
  214. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  215. data/lib/orb/resources/plans.rb +47 -11
  216. data/lib/orb/resources/prices/external_price_id.rb +7 -1
  217. data/lib/orb/resources/prices.rb +97 -22
  218. data/lib/orb/resources/subscription_changes.rb +5 -2
  219. data/lib/orb/resources/subscriptions.rb +292 -78
  220. data/lib/orb/version.rb +1 -1
  221. data/lib/orb.rb +2 -10
  222. data/rbi/lib/orb/client.rbi +7 -6
  223. data/rbi/lib/orb/file_part.rbi +34 -0
  224. data/rbi/lib/orb/internal/page.rbi +1 -0
  225. data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
  226. data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
  227. data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
  228. data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
  229. data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
  230. data/rbi/lib/orb/internal/type/converter.rbi +8 -0
  231. data/rbi/lib/orb/internal/type/enum.rbi +7 -6
  232. data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
  233. data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
  234. data/rbi/lib/orb/internal/type/union.rbi +7 -0
  235. data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
  236. data/rbi/lib/orb/internal/util.rbi +39 -19
  237. data/rbi/lib/orb/internal.rbi +1 -2
  238. data/rbi/lib/orb/models/alert.rbi +28 -8
  239. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
  240. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
  241. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
  242. data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
  243. data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
  244. data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
  245. data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
  246. data/rbi/lib/orb/models/amount_discount.rbi +10 -4
  247. data/rbi/lib/orb/models/billable_metric.rbi +16 -3
  248. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
  249. data/rbi/lib/orb/models/coupon.rbi +10 -3
  250. data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
  251. data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
  252. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
  253. data/rbi/lib/orb/models/credit_note.rbi +44 -12
  254. data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
  255. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
  256. data/rbi/lib/orb/models/customer.rbi +130 -11
  257. data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
  258. data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
  259. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
  260. data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
  261. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
  262. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
  263. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
  264. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
  265. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
  266. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
  267. data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
  268. data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
  269. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
  270. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
  271. data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
  272. data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
  273. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  274. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
  275. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  276. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
  277. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  278. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
  279. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
  280. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
  281. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  282. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  283. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
  284. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
  285. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  286. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  287. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
  288. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
  289. data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
  290. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
  291. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
  292. data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
  293. data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
  294. data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
  295. data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
  296. data/rbi/lib/orb/models/event_search_params.rbi +14 -2
  297. data/rbi/lib/orb/models/event_search_response.rbi +14 -3
  298. data/rbi/lib/orb/models/event_update_params.rbi +10 -3
  299. data/rbi/lib/orb/models/event_update_response.rbi +4 -2
  300. data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
  301. data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
  302. data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
  303. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
  304. data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
  305. data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
  306. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
  307. data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
  308. data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
  309. data/rbi/lib/orb/models/invoice.rbi +375 -46
  310. data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
  311. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
  312. data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
  313. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
  314. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
  315. data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
  316. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
  317. data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
  318. data/rbi/lib/orb/models/item.rbi +1 -2
  319. data/rbi/lib/orb/models/item_create_params.rbi +5 -2
  320. data/rbi/lib/orb/models/item_list_params.rbi +8 -2
  321. data/rbi/lib/orb/models/item_update_params.rbi +1 -8
  322. data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
  323. data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
  324. data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
  325. data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
  326. data/rbi/lib/orb/models/plan.rbi +102 -15
  327. data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
  328. data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
  329. data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
  330. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
  331. data/rbi/lib/orb/models/price.rbi +717 -688
  332. data/rbi/lib/orb/models/price_create_params.rbi +137 -53
  333. data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
  334. data/rbi/lib/orb/models/price_list_params.rbi +8 -2
  335. data/rbi/lib/orb/models/price_update_params.rbi +7 -2
  336. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
  337. data/rbi/lib/orb/models/subscription.rbi +174 -11
  338. data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
  339. data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
  340. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
  341. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
  342. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
  343. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
  344. data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
  345. data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
  346. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
  347. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
  348. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
  349. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
  350. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
  351. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
  352. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
  353. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
  354. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
  355. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
  356. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
  357. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
  358. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
  359. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  360. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
  361. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
  362. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  363. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
  364. data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
  365. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
  366. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
  367. data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
  368. data/rbi/lib/orb/models/trial_discount.rbi +5 -1
  369. data/rbi/lib/orb/models/usage_discount.rbi +11 -3
  370. data/sig/orb/file_part.rbs +21 -0
  371. data/sig/orb/internal/transport/base_client.rbs +9 -3
  372. data/sig/orb/internal/type/array_of.rbs +4 -0
  373. data/sig/orb/internal/type/base_model.rbs +12 -0
  374. data/sig/orb/internal/type/converter.rbs +4 -0
  375. data/sig/orb/internal/type/enum.rbs +4 -2
  376. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  377. data/sig/orb/internal/type/hash_of.rbs +4 -0
  378. data/sig/orb/internal/type/union.rbs +4 -0
  379. data/sig/orb/internal/util.rbs +16 -12
  380. data/sig/orb/internal.rbs +1 -1
  381. metadata +9 -5
@@ -37,22 +37,27 @@ module Orb
37
37
  # @return [Time, nil]
38
38
  optional :cancelled_at, Time, nil?: true
39
39
 
40
- # @!parse
41
- # # A subscription change represents a desired new subscription / pending change to
42
- # # an existing subscription. It is a way to first preview the effects on the
43
- # # subscription as well as any changes/creation of invoices (see
44
- # # `subscription.changed_resources`).
45
- # #
46
- # # @param id [String]
47
- # # @param expiration_time [Time]
48
- # # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status]
49
- # # @param subscription [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription, nil]
50
- # # @param applied_at [Time, nil]
51
- # # @param cancelled_at [Time, nil]
52
- # #
53
- # def initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil, **) = super
54
-
55
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
40
+ # @!method initialize(id:, expiration_time:, status:, subscription:, applied_at: nil, cancelled_at: nil)
41
+ # Some parameter documentations has been truncated, see
42
+ # {Orb::Models::SubscriptionChangeRetrieveResponse} for more details.
43
+ #
44
+ # A subscription change represents a desired new subscription / pending change to
45
+ # an existing subscription. It is a way to first preview the effects on the
46
+ # subscription as well as any changes/creation of invoices (see
47
+ # `subscription.changed_resources`).
48
+ #
49
+ # @param id [String]
50
+ #
51
+ # @param expiration_time [Time] Subscription change will be cancelled at this time and can no longer be applied.
52
+ # ...
53
+ #
54
+ # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Status]
55
+ #
56
+ # @param subscription [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription, nil]
57
+ #
58
+ # @param applied_at [Time, nil] When this change was applied.
59
+ #
60
+ # @param cancelled_at [Time, nil] When this change was cancelled.
56
61
 
57
62
  # @see Orb::Models::SubscriptionChangeRetrieveResponse#status
58
63
  module Status
@@ -62,11 +67,8 @@ module Orb
62
67
  APPLIED = :applied
63
68
  CANCELLED = :cancelled
64
69
 
65
- finalize!
66
-
67
- # @!parse
68
- # # @return [Array<Symbol>]
69
- # def self.values; end
70
+ # @!method self.values
71
+ # @return [Array<Symbol>]
70
72
  end
71
73
 
72
74
  # @see Orb::Models::SubscriptionChangeRetrieveResponse#subscription
@@ -278,69 +280,76 @@ module Orb
278
280
  -> { Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources },
279
281
  nil?: true
280
282
 
281
- # @!parse
282
- # # @param id [String]
283
- # # @param active_plan_phase_order [Integer, nil]
284
- # # @param adjustment_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval>]
285
- # # @param auto_collection [Boolean, nil]
286
- # # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration]
287
- # # @param billing_cycle_day [Integer]
288
- # # @param created_at [Time]
289
- # # @param current_billing_period_end_date [Time, nil]
290
- # # @param current_billing_period_start_date [Time, nil]
291
- # # @param customer [Orb::Models::Customer]
292
- # # @param default_invoice_memo [String, nil]
293
- # # @param discount_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval>]
294
- # # @param end_date [Time, nil]
295
- # # @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule>]
296
- # # @param invoicing_threshold [String, nil]
297
- # # @param maximum_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval>]
298
- # # @param metadata [Hash{Symbol=>String}]
299
- # # @param minimum_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval>]
300
- # # @param net_terms [Integer]
301
- # # @param pending_subscription_change [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange, nil]
302
- # # @param plan [Orb::Models::Plan]
303
- # # @param price_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval>]
304
- # # @param redeemed_coupon [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon, nil]
305
- # # @param start_date [Time]
306
- # # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status]
307
- # # @param trial_info [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo]
308
- # # @param changed_resources [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources, nil]
309
- # #
310
- # def initialize(
311
- # id:,
312
- # active_plan_phase_order:,
313
- # adjustment_intervals:,
314
- # auto_collection:,
315
- # billing_cycle_anchor_configuration:,
316
- # billing_cycle_day:,
317
- # created_at:,
318
- # current_billing_period_end_date:,
319
- # current_billing_period_start_date:,
320
- # customer:,
321
- # default_invoice_memo:,
322
- # discount_intervals:,
323
- # end_date:,
324
- # fixed_fee_quantity_schedule:,
325
- # invoicing_threshold:,
326
- # maximum_intervals:,
327
- # metadata:,
328
- # minimum_intervals:,
329
- # net_terms:,
330
- # pending_subscription_change:,
331
- # plan:,
332
- # price_intervals:,
333
- # redeemed_coupon:,
334
- # start_date:,
335
- # status:,
336
- # trial_info:,
337
- # changed_resources: nil,
338
- # **
339
- # )
340
- # super
341
- # end
342
-
343
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
283
+ # @!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)
284
+ # Some parameter documentations has been truncated, see
285
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription} for more
286
+ # details.
287
+ #
288
+ # @param id [String]
289
+ #
290
+ # @param active_plan_phase_order [Integer, nil] The current plan phase that is active, only if the subscription's plan has phase
291
+ # ...
292
+ #
293
+ # @param adjustment_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval>] The adjustment intervals for this subscription sorted by the start_date of the a
294
+ # ...
295
+ #
296
+ # @param auto_collection [Boolean, nil] Determines whether issued invoices for this subscription will automatically be c
297
+ # ...
298
+ #
299
+ # @param billing_cycle_anchor_configuration [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration]
300
+ #
301
+ # @param billing_cycle_day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
302
+ # ...
303
+ #
304
+ # @param created_at [Time]
305
+ #
306
+ # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
307
+ # ...
308
+ #
309
+ # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
310
+ # ...
311
+ #
312
+ # @param customer [Orb::Models::Customer] A customer is a buyer of your products, and the other party to the billing relat
313
+ # ...
314
+ #
315
+ # @param default_invoice_memo [String, nil] Determines the default memo on this subscriptions' invoices. Note that if this i
316
+ # ...
317
+ #
318
+ # @param discount_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval>] The discount intervals for this subscription sorted by the start_date.
319
+ #
320
+ # @param end_date [Time, nil] The date Orb stops billing for this subscription.
321
+ #
322
+ # @param fixed_fee_quantity_schedule [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::FixedFeeQuantitySchedule>]
323
+ #
324
+ # @param invoicing_threshold [String, nil]
325
+ #
326
+ # @param maximum_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval>] The maximum intervals for this subscription sorted by the start_date.
327
+ #
328
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
329
+ # ...
330
+ #
331
+ # @param minimum_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval>] The minimum intervals for this subscription sorted by the start_date.
332
+ #
333
+ # @param net_terms [Integer] Determines the difference between the invoice issue date for subscription invoic
334
+ # ...
335
+ #
336
+ # @param pending_subscription_change [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PendingSubscriptionChange, nil] A pending subscription change if one exists on this subscription.
337
+ #
338
+ # @param plan [Orb::Models::Plan] The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
339
+ # ...
340
+ #
341
+ # @param price_intervals [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval>] The price intervals for this subscription.
342
+ #
343
+ # @param redeemed_coupon [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::RedeemedCoupon, nil]
344
+ #
345
+ # @param start_date [Time] The date Orb starts billing for this subscription.
346
+ #
347
+ # @param status [Symbol, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::Status]
348
+ #
349
+ # @param trial_info [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::TrialInfo]
350
+ #
351
+ # @param changed_resources [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::ChangedResources, nil] The resources that were changed as part of this operation. Only present when fet
352
+ # ...
344
353
 
345
354
  class AdjustmentInterval < Orb::Internal::Type::BaseModel
346
355
  # @!attribute id
@@ -372,16 +381,16 @@ module Orb
372
381
  # @return [Time]
373
382
  required :start_date, Time
374
383
 
375
- # @!parse
376
- # # @param id [String]
377
- # # @param adjustment [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
378
- # # @param applies_to_price_interval_ids [Array<String>]
379
- # # @param end_date [Time, nil]
380
- # # @param start_date [Time]
381
- # #
382
- # def initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:, **) = super
383
-
384
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
384
+ # @!method initialize(id:, adjustment:, applies_to_price_interval_ids:, end_date:, start_date:)
385
+ # @param id [String]
386
+ #
387
+ # @param adjustment [Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment]
388
+ #
389
+ # @param applies_to_price_interval_ids [Array<String>] The price interval IDs that this adjustment applies to.
390
+ #
391
+ # @param end_date [Time, nil] The end date of the adjustment interval.
392
+ #
393
+ # @param start_date [Time] The start date of the adjustment interval.
385
394
 
386
395
  # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval#adjustment
387
396
  module Adjustment
@@ -447,29 +456,26 @@ module Orb
447
456
  # @return [Float]
448
457
  required :usage_discount, Float
449
458
 
450
- # @!parse
451
- # # @param id [String]
452
- # # @param applies_to_price_ids [Array<String>]
453
- # # @param is_invoice_level [Boolean]
454
- # # @param plan_phase_order [Integer, nil]
455
- # # @param reason [String, nil]
456
- # # @param usage_discount [Float]
457
- # # @param adjustment_type [Symbol, :usage_discount]
458
- # #
459
- # def initialize(
460
- # id:,
461
- # applies_to_price_ids:,
462
- # is_invoice_level:,
463
- # plan_phase_order:,
464
- # reason:,
465
- # usage_discount:,
466
- # adjustment_type: :usage_discount,
467
- # **
468
- # )
469
- # super
470
- # end
471
-
472
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
459
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
460
+ # Some parameter documentations has been truncated, see
461
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment}
462
+ # for more details.
463
+ #
464
+ # @param id [String]
465
+ #
466
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
467
+ #
468
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
469
+ # ...
470
+ #
471
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
472
+ #
473
+ # @param reason [String, nil] The reason for the adjustment.
474
+ #
475
+ # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
476
+ # ...
477
+ #
478
+ # @param adjustment_type [Symbol, :usage_discount]
473
479
  end
474
480
 
475
481
  class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
@@ -515,29 +521,26 @@ module Orb
515
521
  # @return [String, nil]
516
522
  required :reason, String, nil?: true
517
523
 
518
- # @!parse
519
- # # @param id [String]
520
- # # @param amount_discount [String]
521
- # # @param applies_to_price_ids [Array<String>]
522
- # # @param is_invoice_level [Boolean]
523
- # # @param plan_phase_order [Integer, nil]
524
- # # @param reason [String, nil]
525
- # # @param adjustment_type [Symbol, :amount_discount]
526
- # #
527
- # def initialize(
528
- # id:,
529
- # amount_discount:,
530
- # applies_to_price_ids:,
531
- # is_invoice_level:,
532
- # plan_phase_order:,
533
- # reason:,
534
- # adjustment_type: :amount_discount,
535
- # **
536
- # )
537
- # super
538
- # end
539
-
540
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
524
+ # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
525
+ # Some parameter documentations has been truncated, see
526
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment}
527
+ # for more details.
528
+ #
529
+ # @param id [String]
530
+ #
531
+ # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
532
+ # ...
533
+ #
534
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
535
+ #
536
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
537
+ # ...
538
+ #
539
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
540
+ #
541
+ # @param reason [String, nil] The reason for the adjustment.
542
+ #
543
+ # @param adjustment_type [Symbol, :amount_discount]
541
544
  end
542
545
 
543
546
  class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
@@ -583,29 +586,26 @@ module Orb
583
586
  # @return [String, nil]
584
587
  required :reason, String, nil?: true
585
588
 
586
- # @!parse
587
- # # @param id [String]
588
- # # @param applies_to_price_ids [Array<String>]
589
- # # @param is_invoice_level [Boolean]
590
- # # @param percentage_discount [Float]
591
- # # @param plan_phase_order [Integer, nil]
592
- # # @param reason [String, nil]
593
- # # @param adjustment_type [Symbol, :percentage_discount]
594
- # #
595
- # def initialize(
596
- # id:,
597
- # applies_to_price_ids:,
598
- # is_invoice_level:,
599
- # percentage_discount:,
600
- # plan_phase_order:,
601
- # reason:,
602
- # adjustment_type: :percentage_discount,
603
- # **
604
- # )
605
- # super
606
- # end
607
-
608
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
589
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
590
+ # Some parameter documentations has been truncated, see
591
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment}
592
+ # for more details.
593
+ #
594
+ # @param id [String]
595
+ #
596
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
597
+ #
598
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
599
+ # ...
600
+ #
601
+ # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
602
+ # ...
603
+ #
604
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
605
+ #
606
+ # @param reason [String, nil] The reason for the adjustment.
607
+ #
608
+ # @param adjustment_type [Symbol, :percentage_discount]
609
609
  end
610
610
 
611
611
  class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
@@ -657,31 +657,28 @@ module Orb
657
657
  # @return [String, nil]
658
658
  required :reason, String, nil?: true
659
659
 
660
- # @!parse
661
- # # @param id [String]
662
- # # @param applies_to_price_ids [Array<String>]
663
- # # @param is_invoice_level [Boolean]
664
- # # @param item_id [String]
665
- # # @param minimum_amount [String]
666
- # # @param plan_phase_order [Integer, nil]
667
- # # @param reason [String, nil]
668
- # # @param adjustment_type [Symbol, :minimum]
669
- # #
670
- # def initialize(
671
- # id:,
672
- # applies_to_price_ids:,
673
- # is_invoice_level:,
674
- # item_id:,
675
- # minimum_amount:,
676
- # plan_phase_order:,
677
- # reason:,
678
- # adjustment_type: :minimum,
679
- # **
680
- # )
681
- # super
682
- # end
683
-
684
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
660
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
661
+ # Some parameter documentations has been truncated, see
662
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment}
663
+ # for more details.
664
+ #
665
+ # @param id [String]
666
+ #
667
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
668
+ #
669
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
670
+ # ...
671
+ #
672
+ # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
673
+ #
674
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
675
+ # ...
676
+ #
677
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
678
+ #
679
+ # @param reason [String, nil] The reason for the adjustment.
680
+ #
681
+ # @param adjustment_type [Symbol, :minimum]
685
682
  end
686
683
 
687
684
  class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
@@ -727,34 +724,30 @@ module Orb
727
724
  # @return [String, nil]
728
725
  required :reason, String, nil?: true
729
726
 
730
- # @!parse
731
- # # @param id [String]
732
- # # @param applies_to_price_ids [Array<String>]
733
- # # @param is_invoice_level [Boolean]
734
- # # @param maximum_amount [String]
735
- # # @param plan_phase_order [Integer, nil]
736
- # # @param reason [String, nil]
737
- # # @param adjustment_type [Symbol, :maximum]
738
- # #
739
- # def initialize(
740
- # id:,
741
- # applies_to_price_ids:,
742
- # is_invoice_level:,
743
- # maximum_amount:,
744
- # plan_phase_order:,
745
- # reason:,
746
- # adjustment_type: :maximum,
747
- # **
748
- # )
749
- # super
750
- # end
751
-
752
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
727
+ # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
728
+ # Some parameter documentations has been truncated, see
729
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment}
730
+ # for more details.
731
+ #
732
+ # @param id [String]
733
+ #
734
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
735
+ #
736
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
737
+ # ...
738
+ #
739
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
740
+ # ...
741
+ #
742
+ # @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
743
+ #
744
+ # @param reason [String, nil] The reason for the adjustment.
745
+ #
746
+ # @param adjustment_type [Symbol, :maximum]
753
747
  end
754
748
 
755
- # @!parse
756
- # # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
757
- # def self.variants; end
749
+ # @!method self.variants
750
+ # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::AdjustmentInterval::Adjustment::PlanPhaseMaximumAdjustment)]
758
751
  end
759
752
  end
760
753
 
@@ -784,14 +777,19 @@ module Orb
784
777
  # @return [Integer, nil]
785
778
  optional :year, Integer, nil?: true
786
779
 
787
- # @!parse
788
- # # @param day [Integer]
789
- # # @param month [Integer, nil]
790
- # # @param year [Integer, nil]
791
- # #
792
- # def initialize(day:, month: nil, year: nil, **) = super
793
-
794
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
780
+ # @!method initialize(day:, month: nil, year: nil)
781
+ # Some parameter documentations has been truncated, see
782
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::BillingCycleAnchorConfiguration}
783
+ # for more details.
784
+ #
785
+ # @param day [Integer] The day of the month on which the billing cycle is anchored. If the maximum numb
786
+ # ...
787
+ #
788
+ # @param month [Integer, nil] The month on which the billing cycle is anchored (e.g. a quarterly price anchore
789
+ # ...
790
+ #
791
+ # @param year [Integer, nil] The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anc
792
+ # ...
795
793
  end
796
794
 
797
795
  module DiscountInterval
@@ -844,27 +842,18 @@ module Orb
844
842
  # @return [Time]
845
843
  required :start_date, Time
846
844
 
847
- # @!parse
848
- # # @param amount_discount [String]
849
- # # @param applies_to_price_ids [Array<String>]
850
- # # @param applies_to_price_interval_ids [Array<String>]
851
- # # @param end_date [Time, nil]
852
- # # @param start_date [Time]
853
- # # @param discount_type [Symbol, :amount]
854
- # #
855
- # def initialize(
856
- # amount_discount:,
857
- # applies_to_price_ids:,
858
- # applies_to_price_interval_ids:,
859
- # end_date:,
860
- # start_date:,
861
- # discount_type: :amount,
862
- # **
863
- # )
864
- # super
865
- # end
866
-
867
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
845
+ # @!method initialize(amount_discount:, applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, discount_type: :amount)
846
+ # @param amount_discount [String] Only available if discount_type is `amount`.
847
+ #
848
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
849
+ #
850
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
851
+ #
852
+ # @param end_date [Time, nil] The end date of the discount interval.
853
+ #
854
+ # @param start_date [Time] The start date of the discount interval.
855
+ #
856
+ # @param discount_type [Symbol, :amount]
868
857
  end
869
858
 
870
859
  class PercentageDiscountInterval < Orb::Internal::Type::BaseModel
@@ -904,27 +893,23 @@ module Orb
904
893
  # @return [Time]
905
894
  required :start_date, Time
906
895
 
907
- # @!parse
908
- # # @param applies_to_price_ids [Array<String>]
909
- # # @param applies_to_price_interval_ids [Array<String>]
910
- # # @param end_date [Time, nil]
911
- # # @param percentage_discount [Float]
912
- # # @param start_date [Time]
913
- # # @param discount_type [Symbol, :percentage]
914
- # #
915
- # def initialize(
916
- # applies_to_price_ids:,
917
- # applies_to_price_interval_ids:,
918
- # end_date:,
919
- # percentage_discount:,
920
- # start_date:,
921
- # discount_type: :percentage,
922
- # **
923
- # )
924
- # super
925
- # end
926
-
927
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
896
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, percentage_discount:, start_date:, discount_type: :percentage)
897
+ # Some parameter documentations has been truncated, see
898
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval}
899
+ # for more details.
900
+ #
901
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
902
+ #
903
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
904
+ #
905
+ # @param end_date [Time, nil] The end date of the discount interval.
906
+ #
907
+ # @param percentage_discount [Float] Only available if discount_type is `percentage`.This is a number between 0 and 1
908
+ # ...
909
+ #
910
+ # @param start_date [Time] The start date of the discount interval.
911
+ #
912
+ # @param discount_type [Symbol, :percentage]
928
913
  end
929
914
 
930
915
  class UsageDiscountInterval < Orb::Internal::Type::BaseModel
@@ -964,32 +949,27 @@ module Orb
964
949
  # @return [Float]
965
950
  required :usage_discount, Float
966
951
 
967
- # @!parse
968
- # # @param applies_to_price_ids [Array<String>]
969
- # # @param applies_to_price_interval_ids [Array<String>]
970
- # # @param end_date [Time, nil]
971
- # # @param start_date [Time]
972
- # # @param usage_discount [Float]
973
- # # @param discount_type [Symbol, :usage]
974
- # #
975
- # def initialize(
976
- # applies_to_price_ids:,
977
- # applies_to_price_interval_ids:,
978
- # end_date:,
979
- # start_date:,
980
- # usage_discount:,
981
- # discount_type: :usage,
982
- # **
983
- # )
984
- # super
985
- # end
986
-
987
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
952
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, start_date:, usage_discount:, discount_type: :usage)
953
+ # Some parameter documentations has been truncated, see
954
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval}
955
+ # for more details.
956
+ #
957
+ # @param applies_to_price_ids [Array<String>] The price ids that this discount interval applies to.
958
+ #
959
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this discount interval applies to.
960
+ #
961
+ # @param end_date [Time, nil] The end date of the discount interval.
962
+ #
963
+ # @param start_date [Time] The start date of the discount interval.
964
+ #
965
+ # @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
966
+ # ...
967
+ #
968
+ # @param discount_type [Symbol, :usage]
988
969
  end
989
970
 
990
- # @!parse
991
- # # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval)]
992
- # def self.variants; end
971
+ # @!method self.variants
972
+ # @return [Array(Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::AmountDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::PercentageDiscountInterval, Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::DiscountInterval::UsageDiscountInterval)]
993
973
  end
994
974
 
995
975
  class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
@@ -1013,15 +993,11 @@ module Orb
1013
993
  # @return [Time]
1014
994
  required :start_date, Time
1015
995
 
1016
- # @!parse
1017
- # # @param end_date [Time, nil]
1018
- # # @param price_id [String]
1019
- # # @param quantity [Float]
1020
- # # @param start_date [Time]
1021
- # #
1022
- # def initialize(end_date:, price_id:, quantity:, start_date:, **) = super
1023
-
1024
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
996
+ # @!method initialize(end_date:, price_id:, quantity:, start_date:)
997
+ # @param end_date [Time, nil]
998
+ # @param price_id [String]
999
+ # @param quantity [Float]
1000
+ # @param start_date [Time]
1025
1001
  end
1026
1002
 
1027
1003
  class MaximumInterval < Orb::Internal::Type::BaseModel
@@ -1056,16 +1032,21 @@ module Orb
1056
1032
  # @return [Time]
1057
1033
  required :start_date, Time
1058
1034
 
1059
- # @!parse
1060
- # # @param applies_to_price_ids [Array<String>]
1061
- # # @param applies_to_price_interval_ids [Array<String>]
1062
- # # @param end_date [Time, nil]
1063
- # # @param maximum_amount [String]
1064
- # # @param start_date [Time]
1065
- # #
1066
- # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:, **) = super
1067
-
1068
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1035
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, maximum_amount:, start_date:)
1036
+ # Some parameter documentations has been truncated, see
1037
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MaximumInterval}
1038
+ # for more details.
1039
+ #
1040
+ # @param applies_to_price_ids [Array<String>] The price ids that this maximum interval applies to.
1041
+ #
1042
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this maximum interval applies to.
1043
+ #
1044
+ # @param end_date [Time, nil] The end date of the maximum interval.
1045
+ #
1046
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the price intervals t
1047
+ # ...
1048
+ #
1049
+ # @param start_date [Time] The start date of the maximum interval.
1069
1050
  end
1070
1051
 
1071
1052
  class MinimumInterval < Orb::Internal::Type::BaseModel
@@ -1100,16 +1081,21 @@ module Orb
1100
1081
  # @return [Time]
1101
1082
  required :start_date, Time
1102
1083
 
1103
- # @!parse
1104
- # # @param applies_to_price_ids [Array<String>]
1105
- # # @param applies_to_price_interval_ids [Array<String>]
1106
- # # @param end_date [Time, nil]
1107
- # # @param minimum_amount [String]
1108
- # # @param start_date [Time]
1109
- # #
1110
- # def initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:, **) = super
1111
-
1112
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1084
+ # @!method initialize(applies_to_price_ids:, applies_to_price_interval_ids:, end_date:, minimum_amount:, start_date:)
1085
+ # Some parameter documentations has been truncated, see
1086
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::MinimumInterval}
1087
+ # for more details.
1088
+ #
1089
+ # @param applies_to_price_ids [Array<String>] The price ids that this minimum interval applies to.
1090
+ #
1091
+ # @param applies_to_price_interval_ids [Array<String>] The price interval ids that this minimum interval applies to.
1092
+ #
1093
+ # @param end_date [Time, nil] The end date of the minimum interval.
1094
+ #
1095
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the price intervals t
1096
+ # ...
1097
+ #
1098
+ # @param start_date [Time] The start date of the minimum interval.
1113
1099
  end
1114
1100
 
1115
1101
  # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#pending_subscription_change
@@ -1119,14 +1105,10 @@ module Orb
1119
1105
  # @return [String]
1120
1106
  required :id, String
1121
1107
 
1122
- # @!parse
1123
- # # A pending subscription change if one exists on this subscription.
1124
- # #
1125
- # # @param id [String]
1126
- # #
1127
- # def initialize(id:, **) = super
1128
-
1129
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1108
+ # @!method initialize(id:)
1109
+ # A pending subscription change if one exists on this subscription.
1110
+ #
1111
+ # @param id [String]
1130
1112
  end
1131
1113
 
1132
1114
  class PriceInterval < Orb::Internal::Type::BaseModel
@@ -1208,39 +1190,41 @@ module Orb
1208
1190
  # @return [Array<String>, nil]
1209
1191
  required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
1210
1192
 
1211
- # @!parse
1212
- # # The Price Interval resource represents a period of time for which a price will
1213
- # # bill on a subscription. A subscription’s price intervals define its billing
1214
- # # behavior.
1215
- # #
1216
- # # @param id [String]
1217
- # # @param billing_cycle_day [Integer]
1218
- # # @param current_billing_period_end_date [Time, nil]
1219
- # # @param current_billing_period_start_date [Time, nil]
1220
- # # @param end_date [Time, nil]
1221
- # # @param filter [String, nil]
1222
- # # @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil]
1223
- # # @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]
1224
- # # @param start_date [Time]
1225
- # # @param usage_customer_ids [Array<String>, nil]
1226
- # #
1227
- # def initialize(
1228
- # id:,
1229
- # billing_cycle_day:,
1230
- # current_billing_period_end_date:,
1231
- # current_billing_period_start_date:,
1232
- # end_date:,
1233
- # filter:,
1234
- # fixed_fee_quantity_transitions:,
1235
- # price:,
1236
- # start_date:,
1237
- # usage_customer_ids:,
1238
- # **
1239
- # )
1240
- # super
1241
- # end
1242
-
1243
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1193
+ # @!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:)
1194
+ # Some parameter documentations has been truncated, see
1195
+ # {Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval}
1196
+ # for more details.
1197
+ #
1198
+ # The Price Interval resource represents a period of time for which a price will
1199
+ # bill on a subscription. A subscription’s price intervals define its billing
1200
+ # behavior.
1201
+ #
1202
+ # @param id [String]
1203
+ #
1204
+ # @param billing_cycle_day [Integer] The day of the month that Orb bills for this price
1205
+ #
1206
+ # @param current_billing_period_end_date [Time, nil] The end of the current billing period. This is an exclusive timestamp, such that
1207
+ # ...
1208
+ #
1209
+ # @param current_billing_period_start_date [Time, nil] The start date of the current billing period. This is an inclusive timestamp; th
1210
+ # ...
1211
+ #
1212
+ # @param end_date [Time, nil] The end date of the price interval. This is the date that Orb stops billing for
1213
+ # ...
1214
+ #
1215
+ # @param filter [String, nil] An additional filter to apply to usage queries.
1216
+ #
1217
+ # @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionChangeRetrieveResponse::Subscription::PriceInterval::FixedFeeQuantityTransition>, nil] The fixed fee quantity transitions for this price interval. This is only relevan
1218
+ # ...
1219
+ #
1220
+ # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice] The Price resource represents a price that can be billed on a subscription, resu
1221
+ # ...
1222
+ #
1223
+ # @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
1224
+ # ...
1225
+ #
1226
+ # @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
1227
+ # ...
1244
1228
 
1245
1229
  class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1246
1230
  # @!attribute effective_date
@@ -1258,14 +1242,10 @@ module Orb
1258
1242
  # @return [Integer]
1259
1243
  required :quantity, Integer
1260
1244
 
1261
- # @!parse
1262
- # # @param effective_date [Time]
1263
- # # @param price_id [String]
1264
- # # @param quantity [Integer]
1265
- # #
1266
- # def initialize(effective_date:, price_id:, quantity:, **) = super
1267
-
1268
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1245
+ # @!method initialize(effective_date:, price_id:, quantity:)
1246
+ # @param effective_date [Time]
1247
+ # @param price_id [String]
1248
+ # @param quantity [Integer]
1269
1249
  end
1270
1250
  end
1271
1251
 
@@ -1286,14 +1266,10 @@ module Orb
1286
1266
  # @return [Time]
1287
1267
  required :start_date, Time
1288
1268
 
1289
- # @!parse
1290
- # # @param coupon_id [String]
1291
- # # @param end_date [Time, nil]
1292
- # # @param start_date [Time]
1293
- # #
1294
- # def initialize(coupon_id:, end_date:, start_date:, **) = super
1295
-
1296
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1269
+ # @!method initialize(coupon_id:, end_date:, start_date:)
1270
+ # @param coupon_id [String]
1271
+ # @param end_date [Time, nil]
1272
+ # @param start_date [Time]
1297
1273
  end
1298
1274
 
1299
1275
  # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#status
@@ -1304,11 +1280,8 @@ module Orb
1304
1280
  ENDED = :ended
1305
1281
  UPCOMING = :upcoming
1306
1282
 
1307
- finalize!
1308
-
1309
- # @!parse
1310
- # # @return [Array<Symbol>]
1311
- # def self.values; end
1283
+ # @!method self.values
1284
+ # @return [Array<Symbol>]
1312
1285
  end
1313
1286
 
1314
1287
  # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#trial_info
@@ -1318,12 +1291,8 @@ module Orb
1318
1291
  # @return [Time, nil]
1319
1292
  required :end_date, Time, nil?: true
1320
1293
 
1321
- # @!parse
1322
- # # @param end_date [Time, nil]
1323
- # #
1324
- # def initialize(end_date:, **) = super
1325
-
1326
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1294
+ # @!method initialize(end_date:)
1295
+ # @param end_date [Time, nil]
1327
1296
  end
1328
1297
 
1329
1298
  # @see Orb::Models::SubscriptionChangeRetrieveResponse::Subscription#changed_resources
@@ -1352,19 +1321,18 @@ module Orb
1352
1321
  # @return [Array<Orb::Models::Invoice>]
1353
1322
  required :voided_invoices, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice] }
1354
1323
 
1355
- # @!parse
1356
- # # The resources that were changed as part of this operation. Only present when
1357
- # # fetched through the subscription changes API or if the
1358
- # # `include_changed_resources` parameter was passed in the request.
1359
- # #
1360
- # # @param created_credit_notes [Array<Orb::Models::CreditNote>]
1361
- # # @param created_invoices [Array<Orb::Models::Invoice>]
1362
- # # @param voided_credit_notes [Array<Orb::Models::CreditNote>]
1363
- # # @param voided_invoices [Array<Orb::Models::Invoice>]
1364
- # #
1365
- # def initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:, **) = super
1366
-
1367
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1324
+ # @!method initialize(created_credit_notes:, created_invoices:, voided_credit_notes:, voided_invoices:)
1325
+ # The resources that were changed as part of this operation. Only present when
1326
+ # fetched through the subscription changes API or if the
1327
+ # `include_changed_resources` parameter was passed in the request.
1328
+ #
1329
+ # @param created_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were created as part of this operation.
1330
+ #
1331
+ # @param created_invoices [Array<Orb::Models::Invoice>] The invoices that were created as part of this operation.
1332
+ #
1333
+ # @param voided_credit_notes [Array<Orb::Models::CreditNote>] The credit notes that were voided as part of this operation.
1334
+ #
1335
+ # @param voided_invoices [Array<Orb::Models::Invoice>] The invoices that were voided as part of this operation.
1368
1336
  end
1369
1337
  end
1370
1338
  end