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