orb-billing 0.3.1 → 0.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (572) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +3 -3
  4. data/lib/orb/file_part.rb +2 -2
  5. data/lib/orb/internal/type/enum.rb +3 -3
  6. data/lib/orb/internal/type/request_parameters.rb +4 -4
  7. data/lib/orb/internal/type/union.rb +4 -4
  8. data/lib/orb/internal/util.rb +1 -1
  9. data/lib/orb/models/alert.rb +29 -32
  10. data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
  11. data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
  12. data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
  13. data/lib/orb/models/alert_list_params.rb +0 -1
  14. data/lib/orb/models/alert_update_params.rb +4 -5
  15. data/lib/orb/models/amount_discount.rb +6 -7
  16. data/lib/orb/models/billable_metric.rb +9 -11
  17. data/lib/orb/models/coupon.rb +9 -12
  18. data/lib/orb/models/coupon_create_params.rb +6 -8
  19. data/lib/orb/models/coupon_list_params.rb +0 -2
  20. data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
  21. data/lib/orb/models/credit_note.rb +48 -46
  22. data/lib/orb/models/credit_note_create_params.rb +6 -6
  23. data/lib/orb/models/credit_note_list_params.rb +0 -1
  24. data/lib/orb/models/customer.rb +54 -61
  25. data/lib/orb/models/customer_create_params.rb +41 -53
  26. data/lib/orb/models/customer_list_params.rb +0 -1
  27. data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
  28. data/lib/orb/models/customer_update_params.rb +41 -51
  29. data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
  30. data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
  31. data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
  32. data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
  33. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
  34. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
  35. data/lib/orb/models/customers/cost_list_params.rb +3 -4
  36. data/lib/orb/models/customers/cost_list_response.rb +3 -3
  37. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
  38. data/lib/orb/models/customers/credit_list_params.rb +0 -2
  39. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
  40. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
  41. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
  42. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
  43. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
  44. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
  45. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
  46. data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
  47. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
  48. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
  49. data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
  50. data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
  51. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
  52. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
  53. data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
  54. data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
  55. data/lib/orb/models/dimensional_price_group.rb +1 -3
  56. data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
  57. data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
  58. data/lib/orb/models/dimensional_price_groups.rb +6 -6
  59. data/lib/orb/models/discount.rb +5 -5
  60. data/lib/orb/models/evaluate_price_group.rb +1 -1
  61. data/lib/orb/models/event_ingest_params.rb +4 -9
  62. data/lib/orb/models/event_ingest_response.rb +0 -3
  63. data/lib/orb/models/event_search_params.rb +0 -3
  64. data/lib/orb/models/event_search_response.rb +0 -4
  65. data/lib/orb/models/event_update_params.rb +0 -3
  66. data/lib/orb/models/events/backfill_close_response.rb +0 -4
  67. data/lib/orb/models/events/backfill_create_params.rb +0 -7
  68. data/lib/orb/models/events/backfill_create_response.rb +0 -4
  69. data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
  70. data/lib/orb/models/events/backfill_list_params.rb +0 -1
  71. data/lib/orb/models/events/backfill_list_response.rb +0 -4
  72. data/lib/orb/models/events/backfill_revert_response.rb +0 -4
  73. data/lib/orb/models/events/event_volumes.rb +3 -3
  74. data/lib/orb/models/events/volume_list_params.rb +0 -3
  75. data/lib/orb/models/invoice.rb +157 -202
  76. data/lib/orb/models/invoice_create_params.rb +14 -21
  77. data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
  78. data/lib/orb/models/invoice_issue_params.rb +0 -1
  79. data/lib/orb/models/invoice_level_discount.rb +4 -4
  80. data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
  81. data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
  82. data/lib/orb/models/invoice_list_params.rb +6 -10
  83. data/lib/orb/models/invoice_update_params.rb +0 -1
  84. data/lib/orb/models/item.rb +7 -8
  85. data/lib/orb/models/item_list_params.rb +0 -1
  86. data/lib/orb/models/item_update_params.rb +7 -7
  87. data/lib/orb/models/metric_create_params.rb +0 -1
  88. data/lib/orb/models/metric_list_params.rb +0 -1
  89. data/lib/orb/models/metric_update_params.rb +0 -1
  90. data/lib/orb/models/percentage_discount.rb +6 -8
  91. data/lib/orb/models/plan.rb +78 -103
  92. data/lib/orb/models/plan_create_params.rb +727 -800
  93. data/lib/orb/models/plan_list_params.rb +3 -4
  94. data/lib/orb/models/plan_update_params.rb +0 -2
  95. data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
  96. data/lib/orb/models/price.rb +1671 -1724
  97. data/lib/orb/models/price_create_params.rb +75 -84
  98. data/lib/orb/models/price_evaluate_params.rb +0 -2
  99. data/lib/orb/models/price_evaluate_response.rb +3 -3
  100. data/lib/orb/models/price_list_params.rb +0 -1
  101. data/lib/orb/models/price_update_params.rb +0 -1
  102. data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
  103. data/lib/orb/models/subscription.rb +86 -122
  104. data/lib/orb/models/subscription_cancel_params.rb +3 -5
  105. data/lib/orb/models/subscription_cancel_response.rb +21 -57
  106. data/lib/orb/models/subscription_change_apply_response.rb +21 -58
  107. data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
  108. data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
  109. data/lib/orb/models/subscription_create_params.rb +1865 -1815
  110. data/lib/orb/models/subscription_create_response.rb +21 -57
  111. data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
  112. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
  113. data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
  114. data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
  115. data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
  116. data/lib/orb/models/subscription_list_params.rb +3 -4
  117. data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
  118. data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
  119. data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
  120. data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
  121. data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
  122. data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
  123. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
  124. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
  125. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
  126. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
  127. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
  128. data/lib/orb/models/subscription_update_params.rb +0 -5
  129. data/lib/orb/models/subscription_update_trial_params.rb +4 -6
  130. data/lib/orb/models/subscription_update_trial_response.rb +21 -57
  131. data/lib/orb/models/subscription_usage.rb +46 -39
  132. data/lib/orb/models/subscriptions.rb +6 -6
  133. data/lib/orb/models/trial_discount.rb +6 -7
  134. data/lib/orb/models/usage_discount.rb +6 -8
  135. data/lib/orb/resources/alerts.rb +30 -31
  136. data/lib/orb/resources/coupons/subscriptions.rb +3 -4
  137. data/lib/orb/resources/coupons.rb +11 -21
  138. data/lib/orb/resources/credit_notes.rb +10 -11
  139. data/lib/orb/resources/customers/balance_transactions.rb +3 -4
  140. data/lib/orb/resources/customers/costs.rb +4 -6
  141. data/lib/orb/resources/customers/credits/ledger.rb +14 -33
  142. data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
  143. data/lib/orb/resources/customers/credits.rb +2 -6
  144. data/lib/orb/resources/customers.rb +40 -67
  145. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
  146. data/lib/orb/resources/dimensional_price_groups.rb +8 -10
  147. data/lib/orb/resources/events/backfills.rb +2 -10
  148. data/lib/orb/resources/events/volume.rb +3 -6
  149. data/lib/orb/resources/events.rb +4 -12
  150. data/lib/orb/resources/invoice_line_items.rb +1 -2
  151. data/lib/orb/resources/invoices.rb +26 -43
  152. data/lib/orb/resources/items.rb +12 -13
  153. data/lib/orb/resources/metrics.rb +11 -14
  154. data/lib/orb/resources/plans/external_plan_id.rb +5 -7
  155. data/lib/orb/resources/plans.rb +14 -23
  156. data/lib/orb/resources/prices/external_price_id.rb +5 -6
  157. data/lib/orb/resources/prices.rb +25 -35
  158. data/lib/orb/resources/subscription_changes.rb +1 -1
  159. data/lib/orb/resources/subscriptions.rb +49 -107
  160. data/lib/orb/version.rb +1 -1
  161. data/lib/orb.rb +1 -0
  162. data/rbi/orb/client.rbi +5 -4
  163. data/rbi/orb/errors.rbi +59 -28
  164. data/rbi/orb/file_part.rbi +9 -6
  165. data/rbi/orb/internal/page.rbi +19 -6
  166. data/rbi/orb/internal/transport/base_client.rbi +131 -73
  167. data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
  168. data/rbi/orb/internal/type/array_of.rbi +42 -34
  169. data/rbi/orb/internal/type/base_model.rbi +124 -65
  170. data/rbi/orb/internal/type/base_page.rbi +11 -7
  171. data/rbi/orb/internal/type/boolean.rbi +16 -10
  172. data/rbi/orb/internal/type/converter.rbi +66 -31
  173. data/rbi/orb/internal/type/enum.rbi +27 -15
  174. data/rbi/orb/internal/type/file_input.rbi +12 -10
  175. data/rbi/orb/internal/type/hash_of.rbi +34 -24
  176. data/rbi/orb/internal/type/request_parameters.rbi +12 -4
  177. data/rbi/orb/internal/type/union.rbi +60 -25
  178. data/rbi/orb/internal/type/unknown.rbi +20 -12
  179. data/rbi/orb/internal/util.rbi +210 -89
  180. data/rbi/orb/models/alert.rbi +107 -70
  181. data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
  182. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
  183. data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
  184. data/rbi/orb/models/alert_disable_params.rbi +17 -6
  185. data/rbi/orb/models/alert_enable_params.rbi +17 -6
  186. data/rbi/orb/models/alert_list_params.rbi +23 -20
  187. data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
  188. data/rbi/orb/models/alert_update_params.rbi +25 -14
  189. data/rbi/orb/models/amount_discount.rbi +28 -19
  190. data/rbi/orb/models/billable_metric.rbi +33 -26
  191. data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
  192. data/rbi/orb/models/coupon.rbi +28 -20
  193. data/rbi/orb/models/coupon_archive_params.rbi +10 -4
  194. data/rbi/orb/models/coupon_create_params.rbi +72 -38
  195. data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
  196. data/rbi/orb/models/coupon_list_params.rbi +18 -15
  197. data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
  198. data/rbi/orb/models/credit_note.rbi +293 -158
  199. data/rbi/orb/models/credit_note_create_params.rbi +58 -29
  200. data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
  201. data/rbi/orb/models/credit_note_list_params.rbi +20 -17
  202. data/rbi/orb/models/customer.rbi +430 -329
  203. data/rbi/orb/models/customer_create_params.rbi +662 -325
  204. data/rbi/orb/models/customer_delete_params.rbi +10 -4
  205. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
  206. data/rbi/orb/models/customer_fetch_params.rbi +10 -4
  207. data/rbi/orb/models/customer_list_params.rbi +20 -17
  208. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
  209. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
  210. data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
  211. data/rbi/orb/models/customer_update_params.rbi +661 -324
  212. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
  213. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
  214. data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
  215. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
  216. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
  217. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
  218. data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
  219. data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
  220. data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
  221. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
  222. data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
  223. data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
  224. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
  225. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
  226. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
  227. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
  228. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
  229. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
  230. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
  231. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
  232. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
  233. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
  234. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
  235. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
  236. data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
  237. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
  238. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
  239. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
  240. data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
  241. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
  242. data/rbi/orb/models/dimensional_price_group.rbi +18 -15
  243. data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
  244. data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
  245. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
  246. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
  247. data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
  248. data/rbi/orb/models/discount.rbi +11 -5
  249. data/rbi/orb/models/evaluate_price_group.rbi +28 -12
  250. data/rbi/orb/models/event_deprecate_params.rbi +10 -4
  251. data/rbi/orb/models/event_deprecate_response.rbi +8 -3
  252. data/rbi/orb/models/event_ingest_params.rbi +37 -31
  253. data/rbi/orb/models/event_ingest_response.rbi +63 -23
  254. data/rbi/orb/models/event_search_params.rbi +17 -14
  255. data/rbi/orb/models/event_search_response.rbi +33 -21
  256. data/rbi/orb/models/event_update_params.rbi +19 -16
  257. data/rbi/orb/models/event_update_response.rbi +8 -3
  258. data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
  259. data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
  260. data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
  261. data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
  262. data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
  263. data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
  264. data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
  265. data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
  266. data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
  267. data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
  268. data/rbi/orb/models/events/event_volumes.rbi +32 -10
  269. data/rbi/orb/models/events/volume_list_params.rbi +18 -15
  270. data/rbi/orb/models/invoice.rbi +1286 -805
  271. data/rbi/orb/models/invoice_create_params.rbi +97 -69
  272. data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
  273. data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
  274. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
  275. data/rbi/orb/models/invoice_issue_params.rbi +16 -5
  276. data/rbi/orb/models/invoice_level_discount.rbi +11 -4
  277. data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
  278. data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
  279. data/rbi/orb/models/invoice_list_params.rbi +67 -47
  280. data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
  281. data/rbi/orb/models/invoice_pay_params.rbi +10 -4
  282. data/rbi/orb/models/invoice_update_params.rbi +15 -10
  283. data/rbi/orb/models/invoice_void_params.rbi +10 -4
  284. data/rbi/orb/models/item.rbi +87 -39
  285. data/rbi/orb/models/item_create_params.rbi +14 -5
  286. data/rbi/orb/models/item_fetch_params.rbi +10 -4
  287. data/rbi/orb/models/item_list_params.rbi +16 -6
  288. data/rbi/orb/models/item_update_params.rbi +79 -39
  289. data/rbi/orb/models/metric_create_params.rbi +19 -16
  290. data/rbi/orb/models/metric_fetch_params.rbi +10 -4
  291. data/rbi/orb/models/metric_list_params.rbi +20 -17
  292. data/rbi/orb/models/metric_update_params.rbi +15 -10
  293. data/rbi/orb/models/pagination_metadata.rbi +16 -4
  294. data/rbi/orb/models/percentage_discount.rbi +32 -19
  295. data/rbi/orb/models/plan.rbi +496 -365
  296. data/rbi/orb/models/plan_create_params.rbi +4785 -2875
  297. data/rbi/orb/models/plan_fetch_params.rbi +10 -4
  298. data/rbi/orb/models/plan_list_params.rbi +34 -27
  299. data/rbi/orb/models/plan_update_params.rbi +16 -13
  300. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
  301. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
  302. data/rbi/orb/models/price.rbi +9969 -5024
  303. data/rbi/orb/models/price_create_params.rbi +501 -245
  304. data/rbi/orb/models/price_evaluate_params.rbi +20 -17
  305. data/rbi/orb/models/price_evaluate_response.rbi +11 -6
  306. data/rbi/orb/models/price_fetch_params.rbi +10 -4
  307. data/rbi/orb/models/price_list_params.rbi +16 -6
  308. data/rbi/orb/models/price_update_params.rbi +15 -10
  309. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
  310. data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
  311. data/rbi/orb/models/subscription.rbi +578 -420
  312. data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
  313. data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
  314. data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
  315. data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
  316. data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
  317. data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
  318. data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
  319. data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
  320. data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
  321. data/rbi/orb/models/subscription_create_response.rbi +700 -438
  322. data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
  323. data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
  324. data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
  325. data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
  326. data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
  327. data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
  328. data/rbi/orb/models/subscription_list_params.rbi +39 -28
  329. data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
  330. data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
  331. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
  332. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
  333. data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
  334. data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
  335. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
  336. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
  337. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
  338. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
  339. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
  340. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
  341. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
  342. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
  343. data/rbi/orb/models/subscription_update_params.rbi +19 -16
  344. data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
  345. data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
  346. data/rbi/orb/models/subscription_usage.rbi +271 -121
  347. data/rbi/orb/models/subscriptions.rbi +18 -11
  348. data/rbi/orb/models/top_level_ping_params.rbi +10 -4
  349. data/rbi/orb/models/top_level_ping_response.rbi +7 -3
  350. data/rbi/orb/models/trial_discount.rbi +29 -20
  351. data/rbi/orb/models/usage_discount.rbi +28 -19
  352. data/rbi/orb/models.rbi +22 -11
  353. data/rbi/orb/request_options.rbi +12 -6
  354. data/rbi/orb/resources/alerts.rbi +61 -40
  355. data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
  356. data/rbi/orb/resources/coupons.rbi +33 -18
  357. data/rbi/orb/resources/credit_notes.rbi +22 -13
  358. data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
  359. data/rbi/orb/resources/customers/costs.rbi +18 -11
  360. data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
  361. data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
  362. data/rbi/orb/resources/customers/credits.rbi +16 -7
  363. data/rbi/orb/resources/customers.rbi +137 -72
  364. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
  365. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
  366. data/rbi/orb/resources/events/backfills.rbi +35 -17
  367. data/rbi/orb/resources/events/volume.rbi +7 -5
  368. data/rbi/orb/resources/events.rbi +26 -16
  369. data/rbi/orb/resources/invoice_line_items.rbi +7 -5
  370. data/rbi/orb/resources/invoices.rbi +72 -41
  371. data/rbi/orb/resources/items.rbi +40 -13
  372. data/rbi/orb/resources/metrics.rbi +25 -15
  373. data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
  374. data/rbi/orb/resources/plans.rbi +57 -47
  375. data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
  376. data/rbi/orb/resources/prices.rbi +176 -156
  377. data/rbi/orb/resources/subscription_changes.rbi +19 -11
  378. data/rbi/orb/resources/subscriptions.rbi +200 -114
  379. data/rbi/orb/resources/top_level.rbi +9 -3
  380. data/sig/orb/internal/page.rbs +0 -2
  381. data/sig/orb/internal/type/request_parameters.rbs +3 -1
  382. data/sig/orb/models/alert.rbs +19 -31
  383. data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
  384. data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
  385. data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
  386. data/sig/orb/models/alert_disable_params.rbs +0 -2
  387. data/sig/orb/models/alert_enable_params.rbs +0 -2
  388. data/sig/orb/models/alert_list_params.rbs +0 -2
  389. data/sig/orb/models/alert_retrieve_params.rbs +0 -2
  390. data/sig/orb/models/alert_update_params.rbs +3 -7
  391. data/sig/orb/models/amount_discount.rbs +4 -6
  392. data/sig/orb/models/billable_metric.rbs +7 -9
  393. data/sig/orb/models/coupon.rbs +5 -8
  394. data/sig/orb/models/coupon_archive_params.rbs +0 -2
  395. data/sig/orb/models/coupon_create_params.rbs +3 -9
  396. data/sig/orb/models/coupon_fetch_params.rbs +0 -2
  397. data/sig/orb/models/coupon_list_params.rbs +0 -2
  398. data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
  399. data/sig/orb/models/credit_note.rbs +48 -66
  400. data/sig/orb/models/credit_note_create_params.rbs +3 -7
  401. data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
  402. data/sig/orb/models/credit_note_list_params.rbs +0 -2
  403. data/sig/orb/models/customer.rbs +43 -63
  404. data/sig/orb/models/customer_create_params.rbs +32 -52
  405. data/sig/orb/models/customer_delete_params.rbs +0 -2
  406. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
  407. data/sig/orb/models/customer_fetch_params.rbs +0 -2
  408. data/sig/orb/models/customer_list_params.rbs +0 -2
  409. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
  410. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
  411. data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
  412. data/sig/orb/models/customer_update_params.rbs +32 -52
  413. data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
  414. data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
  415. data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
  416. data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
  417. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
  418. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
  419. data/sig/orb/models/customers/cost_list_params.rbs +0 -2
  420. data/sig/orb/models/customers/cost_list_response.rbs +0 -6
  421. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
  422. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
  423. data/sig/orb/models/customers/credit_list_params.rbs +0 -2
  424. data/sig/orb/models/customers/credit_list_response.rbs +0 -2
  425. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
  426. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
  427. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
  428. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
  429. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
  430. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
  431. data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
  432. data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
  433. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
  434. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
  435. data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
  436. data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
  437. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
  438. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
  439. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
  440. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
  441. data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
  442. data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
  443. data/sig/orb/models/dimensional_price_group.rbs +0 -2
  444. data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
  445. data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
  446. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
  447. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
  448. data/sig/orb/models/dimensional_price_groups.rbs +6 -8
  449. data/sig/orb/models/discount.rbs +5 -5
  450. data/sig/orb/models/evaluate_price_group.rbs +4 -6
  451. data/sig/orb/models/event_deprecate_params.rbs +0 -2
  452. data/sig/orb/models/event_deprecate_response.rbs +0 -2
  453. data/sig/orb/models/event_ingest_params.rbs +3 -7
  454. data/sig/orb/models/event_ingest_response.rbs +0 -6
  455. data/sig/orb/models/event_search_params.rbs +0 -2
  456. data/sig/orb/models/event_search_response.rbs +0 -4
  457. data/sig/orb/models/event_update_params.rbs +0 -2
  458. data/sig/orb/models/event_update_response.rbs +0 -2
  459. data/sig/orb/models/events/backfill_close_params.rbs +0 -2
  460. data/sig/orb/models/events/backfill_close_response.rbs +0 -2
  461. data/sig/orb/models/events/backfill_create_params.rbs +0 -2
  462. data/sig/orb/models/events/backfill_create_response.rbs +0 -2
  463. data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
  464. data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
  465. data/sig/orb/models/events/backfill_list_params.rbs +0 -2
  466. data/sig/orb/models/events/backfill_list_response.rbs +0 -2
  467. data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
  468. data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
  469. data/sig/orb/models/events/event_volumes.rbs +3 -10
  470. data/sig/orb/models/events/volume_list_params.rbs +0 -2
  471. data/sig/orb/models/invoice.rbs +110 -172
  472. data/sig/orb/models/invoice_create_params.rbs +10 -16
  473. data/sig/orb/models/invoice_fetch_params.rbs +0 -2
  474. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
  475. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
  476. data/sig/orb/models/invoice_issue_params.rbs +0 -2
  477. data/sig/orb/models/invoice_level_discount.rbs +2 -4
  478. data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
  479. data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
  480. data/sig/orb/models/invoice_list_params.rbs +4 -6
  481. data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
  482. data/sig/orb/models/invoice_pay_params.rbs +0 -2
  483. data/sig/orb/models/invoice_update_params.rbs +0 -2
  484. data/sig/orb/models/invoice_void_params.rbs +0 -2
  485. data/sig/orb/models/item.rbs +7 -11
  486. data/sig/orb/models/item_create_params.rbs +0 -2
  487. data/sig/orb/models/item_fetch_params.rbs +0 -2
  488. data/sig/orb/models/item_list_params.rbs +0 -2
  489. data/sig/orb/models/item_update_params.rbs +7 -11
  490. data/sig/orb/models/metric_create_params.rbs +0 -2
  491. data/sig/orb/models/metric_fetch_params.rbs +0 -2
  492. data/sig/orb/models/metric_list_params.rbs +0 -2
  493. data/sig/orb/models/metric_update_params.rbs +0 -2
  494. data/sig/orb/models/pagination_metadata.rbs +0 -2
  495. data/sig/orb/models/percentage_discount.rbs +4 -6
  496. data/sig/orb/models/plan.rbs +45 -73
  497. data/sig/orb/models/plan_create_params.rbs +518 -696
  498. data/sig/orb/models/plan_fetch_params.rbs +0 -2
  499. data/sig/orb/models/plan_list_params.rbs +0 -2
  500. data/sig/orb/models/plan_update_params.rbs +0 -2
  501. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
  502. data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
  503. data/sig/orb/models/price.rbs +1194 -1730
  504. data/sig/orb/models/price_create_params.rbs +59 -97
  505. data/sig/orb/models/price_evaluate_params.rbs +0 -2
  506. data/sig/orb/models/price_evaluate_response.rbs +3 -6
  507. data/sig/orb/models/price_fetch_params.rbs +0 -2
  508. data/sig/orb/models/price_list_params.rbs +0 -2
  509. data/sig/orb/models/price_update_params.rbs +0 -2
  510. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
  511. data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
  512. data/sig/orb/models/subscription.rbs +56 -94
  513. data/sig/orb/models/subscription_cancel_params.rbs +0 -2
  514. data/sig/orb/models/subscription_cancel_response.rbs +20 -60
  515. data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
  516. data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
  517. data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
  518. data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
  519. data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
  520. data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
  521. data/sig/orb/models/subscription_create_params.rbs +1103 -1499
  522. data/sig/orb/models/subscription_create_response.rbs +20 -60
  523. data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
  524. data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
  525. data/sig/orb/models/subscription_fetch_params.rbs +0 -2
  526. data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
  527. data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
  528. data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
  529. data/sig/orb/models/subscription_list_params.rbs +0 -2
  530. data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
  531. data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
  532. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
  533. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
  534. data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
  535. data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
  536. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
  537. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
  538. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
  539. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
  540. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
  541. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
  542. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
  543. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
  544. data/sig/orb/models/subscription_update_params.rbs +0 -2
  545. data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
  546. data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
  547. data/sig/orb/models/subscription_usage.rbs +35 -53
  548. data/sig/orb/models/subscriptions.rbs +6 -8
  549. data/sig/orb/models/top_level_ping_params.rbs +0 -2
  550. data/sig/orb/models/top_level_ping_response.rbs +0 -2
  551. data/sig/orb/models/trial_discount.rbs +4 -6
  552. data/sig/orb/models/usage_discount.rbs +4 -6
  553. data/sig/orb/request_options.rbs +1 -1
  554. data/sig/orb/resources/alerts.rbs +12 -12
  555. data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
  556. data/sig/orb/resources/coupons.rbs +4 -4
  557. data/sig/orb/resources/credit_notes.rbs +4 -4
  558. data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
  559. data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
  560. data/sig/orb/resources/customers.rbs +24 -24
  561. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
  562. data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
  563. data/sig/orb/resources/events/volume.rbs +1 -1
  564. data/sig/orb/resources/events.rbs +1 -1
  565. data/sig/orb/resources/invoices.rbs +10 -10
  566. data/sig/orb/resources/items.rbs +5 -5
  567. data/sig/orb/resources/metrics.rbs +4 -4
  568. data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
  569. data/sig/orb/resources/plans.rbs +5 -5
  570. data/sig/orb/resources/prices.rbs +11 -11
  571. data/sig/orb/resources/subscriptions.rbs +21 -21
  572. metadata +2 -2
@@ -3,6 +3,8 @@
3
3
  module Orb
4
4
  module Models
5
5
  class Subscription < Orb::Internal::Type::BaseModel
6
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
7
+
6
8
  sig { returns(String) }
7
9
  attr_accessor :id
8
10
 
@@ -13,7 +15,7 @@ module Orb
13
15
 
14
16
  # The adjustment intervals for this subscription sorted by the start_date of the
15
17
  # adjustment interval.
16
- sig { returns(T::Array[Orb::Models::Subscription::AdjustmentInterval]) }
18
+ sig { returns(T::Array[Orb::Subscription::AdjustmentInterval]) }
17
19
  attr_accessor :adjustment_intervals
18
20
 
19
21
  # Determines whether issued invoices for this subscription will automatically be
@@ -22,14 +24,14 @@ module Orb
22
24
  sig { returns(T.nilable(T::Boolean)) }
23
25
  attr_accessor :auto_collection
24
26
 
25
- sig { returns(Orb::Models::Subscription::BillingCycleAnchorConfiguration) }
27
+ sig { returns(Orb::Subscription::BillingCycleAnchorConfiguration) }
26
28
  attr_reader :billing_cycle_anchor_configuration
27
29
 
28
30
  sig do
29
31
  params(
30
- billing_cycle_anchor_configuration: T.any(Orb::Models::Subscription::BillingCycleAnchorConfiguration, Orb::Internal::AnyHash)
31
- )
32
- .void
32
+ billing_cycle_anchor_configuration:
33
+ Orb::Subscription::BillingCycleAnchorConfiguration::OrHash
34
+ ).void
33
35
  end
34
36
  attr_writer :billing_cycle_anchor_configuration
35
37
 
@@ -73,10 +75,10 @@ module Orb
73
75
  # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
74
76
  # your account's timezone. See [Timezone localization](/essentials/timezones) for
75
77
  # information on what this timezone parameter influences within Orb.
76
- sig { returns(Orb::Models::Customer) }
78
+ sig { returns(Orb::Customer) }
77
79
  attr_reader :customer
78
80
 
79
- sig { params(customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash)).void }
81
+ sig { params(customer: Orb::Customer::OrHash).void }
80
82
  attr_writer :customer
81
83
 
82
84
  # Determines the default memo on this subscriptions' invoices. Note that if this
@@ -89,9 +91,9 @@ module Orb
89
91
  returns(
90
92
  T::Array[
91
93
  T.any(
92
- Orb::Models::Subscription::DiscountInterval::Amount,
93
- Orb::Models::Subscription::DiscountInterval::Percentage,
94
- Orb::Models::Subscription::DiscountInterval::Usage
94
+ Orb::Subscription::DiscountInterval::Amount,
95
+ Orb::Subscription::DiscountInterval::Percentage,
96
+ Orb::Subscription::DiscountInterval::Usage
95
97
  )
96
98
  ]
97
99
  )
@@ -102,14 +104,14 @@ module Orb
102
104
  sig { returns(T.nilable(Time)) }
103
105
  attr_accessor :end_date
104
106
 
105
- sig { returns(T::Array[Orb::Models::Subscription::FixedFeeQuantitySchedule]) }
107
+ sig { returns(T::Array[Orb::Subscription::FixedFeeQuantitySchedule]) }
106
108
  attr_accessor :fixed_fee_quantity_schedule
107
109
 
108
110
  sig { returns(T.nilable(String)) }
109
111
  attr_accessor :invoicing_threshold
110
112
 
111
113
  # The maximum intervals for this subscription sorted by the start_date.
112
- sig { returns(T::Array[Orb::Models::Subscription::MaximumInterval]) }
114
+ sig { returns(T::Array[Orb::Subscription::MaximumInterval]) }
113
115
  attr_accessor :maximum_intervals
114
116
 
115
117
  # User specified key-value pairs for the resource. If not present, this defaults
@@ -120,7 +122,7 @@ module Orb
120
122
  attr_accessor :metadata
121
123
 
122
124
  # The minimum intervals for this subscription sorted by the start_date.
123
- sig { returns(T::Array[Orb::Models::Subscription::MinimumInterval]) }
125
+ sig { returns(T::Array[Orb::Subscription::MinimumInterval]) }
124
126
  attr_accessor :minimum_intervals
125
127
 
126
128
  # Determines the difference between the invoice issue date for subscription
@@ -131,14 +133,14 @@ module Orb
131
133
  attr_accessor :net_terms
132
134
 
133
135
  # A pending subscription change if one exists on this subscription.
134
- sig { returns(T.nilable(Orb::Models::Subscription::PendingSubscriptionChange)) }
136
+ sig { returns(T.nilable(Orb::Subscription::PendingSubscriptionChange)) }
135
137
  attr_reader :pending_subscription_change
136
138
 
137
139
  sig do
138
140
  params(
139
- pending_subscription_change: T.nilable(T.any(Orb::Models::Subscription::PendingSubscriptionChange, Orb::Internal::AnyHash))
140
- )
141
- .void
141
+ pending_subscription_change:
142
+ T.nilable(Orb::Subscription::PendingSubscriptionChange::OrHash)
143
+ ).void
142
144
  end
143
145
  attr_writer :pending_subscription_change
144
146
 
@@ -146,24 +148,23 @@ module Orb
146
148
  # subscribed to by a customer. Plans define the billing behavior of the
147
149
  # subscription. You can see more about how to configure prices in the
148
150
  # [Price resource](/reference/price).
149
- sig { returns(Orb::Models::Plan) }
151
+ sig { returns(Orb::Plan) }
150
152
  attr_reader :plan
151
153
 
152
- sig { params(plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash)).void }
154
+ sig { params(plan: Orb::Plan::OrHash).void }
153
155
  attr_writer :plan
154
156
 
155
157
  # The price intervals for this subscription.
156
- sig { returns(T::Array[Orb::Models::Subscription::PriceInterval]) }
158
+ sig { returns(T::Array[Orb::Subscription::PriceInterval]) }
157
159
  attr_accessor :price_intervals
158
160
 
159
- sig { returns(T.nilable(Orb::Models::Subscription::RedeemedCoupon)) }
161
+ sig { returns(T.nilable(Orb::Subscription::RedeemedCoupon)) }
160
162
  attr_reader :redeemed_coupon
161
163
 
162
164
  sig do
163
165
  params(
164
- redeemed_coupon: T.nilable(T.any(Orb::Models::Subscription::RedeemedCoupon, Orb::Internal::AnyHash))
165
- )
166
- .void
166
+ redeemed_coupon: T.nilable(Orb::Subscription::RedeemedCoupon::OrHash)
167
+ ).void
167
168
  end
168
169
  attr_writer :redeemed_coupon
169
170
 
@@ -171,13 +172,13 @@ module Orb
171
172
  sig { returns(Time) }
172
173
  attr_accessor :start_date
173
174
 
174
- sig { returns(Orb::Models::Subscription::Status::TaggedSymbol) }
175
+ sig { returns(Orb::Subscription::Status::TaggedSymbol) }
175
176
  attr_accessor :status
176
177
 
177
- sig { returns(Orb::Models::Subscription::TrialInfo) }
178
+ sig { returns(Orb::Subscription::TrialInfo) }
178
179
  attr_reader :trial_info
179
180
 
180
- sig { params(trial_info: T.any(Orb::Models::Subscription::TrialInfo, Orb::Internal::AnyHash)).void }
181
+ sig { params(trial_info: Orb::Subscription::TrialInfo::OrHash).void }
181
182
  attr_writer :trial_info
182
183
 
183
184
  # A [subscription](/core-concepts#subscription) represents the purchase of a plan
@@ -203,39 +204,44 @@ module Orb
203
204
  params(
204
205
  id: String,
205
206
  active_plan_phase_order: T.nilable(Integer),
206
- adjustment_intervals: T::Array[T.any(Orb::Models::Subscription::AdjustmentInterval, Orb::Internal::AnyHash)],
207
+ adjustment_intervals:
208
+ T::Array[Orb::Subscription::AdjustmentInterval::OrHash],
207
209
  auto_collection: T.nilable(T::Boolean),
208
- billing_cycle_anchor_configuration: T.any(Orb::Models::Subscription::BillingCycleAnchorConfiguration, Orb::Internal::AnyHash),
210
+ billing_cycle_anchor_configuration:
211
+ Orb::Subscription::BillingCycleAnchorConfiguration::OrHash,
209
212
  billing_cycle_day: Integer,
210
213
  created_at: Time,
211
214
  current_billing_period_end_date: T.nilable(Time),
212
215
  current_billing_period_start_date: T.nilable(Time),
213
- customer: T.any(Orb::Models::Customer, Orb::Internal::AnyHash),
216
+ customer: Orb::Customer::OrHash,
214
217
  default_invoice_memo: T.nilable(String),
215
- discount_intervals: T::Array[
216
- T.any(
217
- Orb::Models::Subscription::DiscountInterval::Amount,
218
- Orb::Internal::AnyHash,
219
- Orb::Models::Subscription::DiscountInterval::Percentage,
220
- Orb::Models::Subscription::DiscountInterval::Usage
221
- )
222
- ],
218
+ discount_intervals:
219
+ T::Array[
220
+ T.any(
221
+ Orb::Subscription::DiscountInterval::Amount::OrHash,
222
+ Orb::Subscription::DiscountInterval::Percentage::OrHash,
223
+ Orb::Subscription::DiscountInterval::Usage::OrHash
224
+ )
225
+ ],
223
226
  end_date: T.nilable(Time),
224
- fixed_fee_quantity_schedule: T::Array[T.any(Orb::Models::Subscription::FixedFeeQuantitySchedule, Orb::Internal::AnyHash)],
227
+ fixed_fee_quantity_schedule:
228
+ T::Array[Orb::Subscription::FixedFeeQuantitySchedule::OrHash],
225
229
  invoicing_threshold: T.nilable(String),
226
- maximum_intervals: T::Array[T.any(Orb::Models::Subscription::MaximumInterval, Orb::Internal::AnyHash)],
230
+ maximum_intervals:
231
+ T::Array[Orb::Subscription::MaximumInterval::OrHash],
227
232
  metadata: T::Hash[Symbol, String],
228
- minimum_intervals: T::Array[T.any(Orb::Models::Subscription::MinimumInterval, Orb::Internal::AnyHash)],
233
+ minimum_intervals:
234
+ T::Array[Orb::Subscription::MinimumInterval::OrHash],
229
235
  net_terms: Integer,
230
- pending_subscription_change: T.nilable(T.any(Orb::Models::Subscription::PendingSubscriptionChange, Orb::Internal::AnyHash)),
231
- plan: T.any(Orb::Models::Plan, Orb::Internal::AnyHash),
232
- price_intervals: T::Array[T.any(Orb::Models::Subscription::PriceInterval, Orb::Internal::AnyHash)],
233
- redeemed_coupon: T.nilable(T.any(Orb::Models::Subscription::RedeemedCoupon, Orb::Internal::AnyHash)),
236
+ pending_subscription_change:
237
+ T.nilable(Orb::Subscription::PendingSubscriptionChange::OrHash),
238
+ plan: Orb::Plan::OrHash,
239
+ price_intervals: T::Array[Orb::Subscription::PriceInterval::OrHash],
240
+ redeemed_coupon: T.nilable(Orb::Subscription::RedeemedCoupon::OrHash),
234
241
  start_date: Time,
235
- status: Orb::Models::Subscription::Status::OrSymbol,
236
- trial_info: T.any(Orb::Models::Subscription::TrialInfo, Orb::Internal::AnyHash)
237
- )
238
- .returns(T.attached_class)
242
+ status: Orb::Subscription::Status::OrSymbol,
243
+ trial_info: Orb::Subscription::TrialInfo::OrHash
244
+ ).returns(T.attached_class)
239
245
  end
240
246
  def self.new(
241
247
  id:,
@@ -320,60 +326,69 @@ module Orb
320
326
  start_date:,
321
327
  status:,
322
328
  trial_info:
323
- ); end
329
+ )
330
+ end
331
+
324
332
  sig do
325
- override
326
- .returns(
327
- {
328
- id: String,
329
- active_plan_phase_order: T.nilable(Integer),
330
- adjustment_intervals: T::Array[Orb::Models::Subscription::AdjustmentInterval],
331
- auto_collection: T.nilable(T::Boolean),
332
- billing_cycle_anchor_configuration: Orb::Models::Subscription::BillingCycleAnchorConfiguration,
333
- billing_cycle_day: Integer,
334
- created_at: Time,
335
- current_billing_period_end_date: T.nilable(Time),
336
- current_billing_period_start_date: T.nilable(Time),
337
- customer: Orb::Models::Customer,
338
- default_invoice_memo: T.nilable(String),
339
- discount_intervals: T::Array[
333
+ override.returns(
334
+ {
335
+ id: String,
336
+ active_plan_phase_order: T.nilable(Integer),
337
+ adjustment_intervals:
338
+ T::Array[Orb::Subscription::AdjustmentInterval],
339
+ auto_collection: T.nilable(T::Boolean),
340
+ billing_cycle_anchor_configuration:
341
+ Orb::Subscription::BillingCycleAnchorConfiguration,
342
+ billing_cycle_day: Integer,
343
+ created_at: Time,
344
+ current_billing_period_end_date: T.nilable(Time),
345
+ current_billing_period_start_date: T.nilable(Time),
346
+ customer: Orb::Customer,
347
+ default_invoice_memo: T.nilable(String),
348
+ discount_intervals:
349
+ T::Array[
340
350
  T.any(
341
- Orb::Models::Subscription::DiscountInterval::Amount,
342
- Orb::Models::Subscription::DiscountInterval::Percentage,
343
- Orb::Models::Subscription::DiscountInterval::Usage
351
+ Orb::Subscription::DiscountInterval::Amount,
352
+ Orb::Subscription::DiscountInterval::Percentage,
353
+ Orb::Subscription::DiscountInterval::Usage
344
354
  )
345
355
  ],
346
- end_date: T.nilable(Time),
347
- fixed_fee_quantity_schedule: T::Array[Orb::Models::Subscription::FixedFeeQuantitySchedule],
348
- invoicing_threshold: T.nilable(String),
349
- maximum_intervals: T::Array[Orb::Models::Subscription::MaximumInterval],
350
- metadata: T::Hash[Symbol, String],
351
- minimum_intervals: T::Array[Orb::Models::Subscription::MinimumInterval],
352
- net_terms: Integer,
353
- pending_subscription_change: T.nilable(Orb::Models::Subscription::PendingSubscriptionChange),
354
- plan: Orb::Models::Plan,
355
- price_intervals: T::Array[Orb::Models::Subscription::PriceInterval],
356
- redeemed_coupon: T.nilable(Orb::Models::Subscription::RedeemedCoupon),
357
- start_date: Time,
358
- status: Orb::Models::Subscription::Status::TaggedSymbol,
359
- trial_info: Orb::Models::Subscription::TrialInfo
360
- }
361
- )
356
+ end_date: T.nilable(Time),
357
+ fixed_fee_quantity_schedule:
358
+ T::Array[Orb::Subscription::FixedFeeQuantitySchedule],
359
+ invoicing_threshold: T.nilable(String),
360
+ maximum_intervals: T::Array[Orb::Subscription::MaximumInterval],
361
+ metadata: T::Hash[Symbol, String],
362
+ minimum_intervals: T::Array[Orb::Subscription::MinimumInterval],
363
+ net_terms: Integer,
364
+ pending_subscription_change:
365
+ T.nilable(Orb::Subscription::PendingSubscriptionChange),
366
+ plan: Orb::Plan,
367
+ price_intervals: T::Array[Orb::Subscription::PriceInterval],
368
+ redeemed_coupon: T.nilable(Orb::Subscription::RedeemedCoupon),
369
+ start_date: Time,
370
+ status: Orb::Subscription::Status::TaggedSymbol,
371
+ trial_info: Orb::Subscription::TrialInfo
372
+ }
373
+ )
374
+ end
375
+ def to_hash
362
376
  end
363
- def to_hash; end
364
377
 
365
378
  class AdjustmentInterval < Orb::Internal::Type::BaseModel
379
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
380
+
366
381
  sig { returns(String) }
367
382
  attr_accessor :id
368
383
 
369
384
  sig do
370
385
  returns(
371
386
  T.any(
372
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
373
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
374
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
375
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum,
376
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum
387
+ Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
388
+ Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
389
+ Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
390
+ Orb::Subscription::AdjustmentInterval::Adjustment::Minimum,
391
+ Orb::Subscription::AdjustmentInterval::Adjustment::Maximum
377
392
  )
378
393
  )
379
394
  end
@@ -394,19 +409,18 @@ module Orb
394
409
  sig do
395
410
  params(
396
411
  id: String,
397
- adjustment: T.any(
398
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
399
- Orb::Internal::AnyHash,
400
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
401
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
402
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum,
403
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum
404
- ),
412
+ adjustment:
413
+ T.any(
414
+ Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount::OrHash,
415
+ Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount::OrHash,
416
+ Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount::OrHash,
417
+ Orb::Subscription::AdjustmentInterval::Adjustment::Minimum::OrHash,
418
+ Orb::Subscription::AdjustmentInterval::Adjustment::Maximum::OrHash
419
+ ),
405
420
  applies_to_price_interval_ids: T::Array[String],
406
421
  end_date: T.nilable(Time),
407
422
  start_date: Time
408
- )
409
- .returns(T.attached_class)
423
+ ).returns(T.attached_class)
410
424
  end
411
425
  def self.new(
412
426
  id:,
@@ -417,31 +431,47 @@ module Orb
417
431
  end_date:,
418
432
  # The start date of the adjustment interval.
419
433
  start_date:
420
- ); end
434
+ )
435
+ end
436
+
421
437
  sig do
422
- override
423
- .returns(
424
- {
425
- id: String,
426
- adjustment: T.any(
427
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
428
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
429
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
430
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum,
431
- Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum
438
+ override.returns(
439
+ {
440
+ id: String,
441
+ adjustment:
442
+ T.any(
443
+ Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
444
+ Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
445
+ Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
446
+ Orb::Subscription::AdjustmentInterval::Adjustment::Minimum,
447
+ Orb::Subscription::AdjustmentInterval::Adjustment::Maximum
432
448
  ),
433
- applies_to_price_interval_ids: T::Array[String],
434
- end_date: T.nilable(Time),
435
- start_date: Time
436
- }
437
- )
449
+ applies_to_price_interval_ids: T::Array[String],
450
+ end_date: T.nilable(Time),
451
+ start_date: Time
452
+ }
453
+ )
454
+ end
455
+ def to_hash
438
456
  end
439
- def to_hash; end
440
457
 
441
458
  module Adjustment
442
459
  extend Orb::Internal::Type::Union
443
460
 
461
+ Variants =
462
+ T.type_alias do
463
+ T.any(
464
+ Orb::Subscription::AdjustmentInterval::Adjustment::UsageDiscount,
465
+ Orb::Subscription::AdjustmentInterval::Adjustment::AmountDiscount,
466
+ Orb::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount,
467
+ Orb::Subscription::AdjustmentInterval::Adjustment::Minimum,
468
+ Orb::Subscription::AdjustmentInterval::Adjustment::Maximum
469
+ )
470
+ end
471
+
444
472
  class UsageDiscount < Orb::Internal::Type::BaseModel
473
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
474
+
445
475
  sig { returns(String) }
446
476
  attr_accessor :id
447
477
 
@@ -479,8 +509,7 @@ module Orb
479
509
  reason: T.nilable(String),
480
510
  usage_discount: Float,
481
511
  adjustment_type: Symbol
482
- )
483
- .returns(T.attached_class)
512
+ ).returns(T.attached_class)
484
513
  end
485
514
  def self.new(
486
515
  id:,
@@ -497,25 +526,29 @@ module Orb
497
526
  # to in a given billing period.
498
527
  usage_discount:,
499
528
  adjustment_type: :usage_discount
500
- ); end
529
+ )
530
+ end
531
+
501
532
  sig do
502
- override
503
- .returns(
504
- {
505
- id: String,
506
- adjustment_type: Symbol,
507
- applies_to_price_ids: T::Array[String],
508
- is_invoice_level: T::Boolean,
509
- plan_phase_order: T.nilable(Integer),
510
- reason: T.nilable(String),
511
- usage_discount: Float
512
- }
513
- )
533
+ override.returns(
534
+ {
535
+ id: String,
536
+ adjustment_type: Symbol,
537
+ applies_to_price_ids: T::Array[String],
538
+ is_invoice_level: T::Boolean,
539
+ plan_phase_order: T.nilable(Integer),
540
+ reason: T.nilable(String),
541
+ usage_discount: Float
542
+ }
543
+ )
544
+ end
545
+ def to_hash
514
546
  end
515
- def to_hash; end
516
547
  end
517
548
 
518
549
  class AmountDiscount < Orb::Internal::Type::BaseModel
550
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
551
+
519
552
  sig { returns(String) }
520
553
  attr_accessor :id
521
554
 
@@ -553,8 +586,7 @@ module Orb
553
586
  plan_phase_order: T.nilable(Integer),
554
587
  reason: T.nilable(String),
555
588
  adjustment_type: Symbol
556
- )
557
- .returns(T.attached_class)
589
+ ).returns(T.attached_class)
558
590
  end
559
591
  def self.new(
560
592
  id:,
@@ -571,25 +603,29 @@ module Orb
571
603
  # The reason for the adjustment.
572
604
  reason:,
573
605
  adjustment_type: :amount_discount
574
- ); end
606
+ )
607
+ end
608
+
575
609
  sig do
576
- override
577
- .returns(
578
- {
579
- id: String,
580
- adjustment_type: Symbol,
581
- amount_discount: String,
582
- applies_to_price_ids: T::Array[String],
583
- is_invoice_level: T::Boolean,
584
- plan_phase_order: T.nilable(Integer),
585
- reason: T.nilable(String)
586
- }
587
- )
610
+ override.returns(
611
+ {
612
+ id: String,
613
+ adjustment_type: Symbol,
614
+ amount_discount: String,
615
+ applies_to_price_ids: T::Array[String],
616
+ is_invoice_level: T::Boolean,
617
+ plan_phase_order: T.nilable(Integer),
618
+ reason: T.nilable(String)
619
+ }
620
+ )
621
+ end
622
+ def to_hash
588
623
  end
589
- def to_hash; end
590
624
  end
591
625
 
592
626
  class PercentageDiscount < Orb::Internal::Type::BaseModel
627
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
628
+
593
629
  sig { returns(String) }
594
630
  attr_accessor :id
595
631
 
@@ -627,8 +663,7 @@ module Orb
627
663
  plan_phase_order: T.nilable(Integer),
628
664
  reason: T.nilable(String),
629
665
  adjustment_type: Symbol
630
- )
631
- .returns(T.attached_class)
666
+ ).returns(T.attached_class)
632
667
  end
633
668
  def self.new(
634
669
  id:,
@@ -645,25 +680,29 @@ module Orb
645
680
  # The reason for the adjustment.
646
681
  reason:,
647
682
  adjustment_type: :percentage_discount
648
- ); end
683
+ )
684
+ end
685
+
649
686
  sig do
650
- override
651
- .returns(
652
- {
653
- id: String,
654
- adjustment_type: Symbol,
655
- applies_to_price_ids: T::Array[String],
656
- is_invoice_level: T::Boolean,
657
- percentage_discount: Float,
658
- plan_phase_order: T.nilable(Integer),
659
- reason: T.nilable(String)
660
- }
661
- )
687
+ override.returns(
688
+ {
689
+ id: String,
690
+ adjustment_type: Symbol,
691
+ applies_to_price_ids: T::Array[String],
692
+ is_invoice_level: T::Boolean,
693
+ percentage_discount: Float,
694
+ plan_phase_order: T.nilable(Integer),
695
+ reason: T.nilable(String)
696
+ }
697
+ )
698
+ end
699
+ def to_hash
662
700
  end
663
- def to_hash; end
664
701
  end
665
702
 
666
703
  class Minimum < Orb::Internal::Type::BaseModel
704
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
705
+
667
706
  sig { returns(String) }
668
707
  attr_accessor :id
669
708
 
@@ -706,8 +745,7 @@ module Orb
706
745
  plan_phase_order: T.nilable(Integer),
707
746
  reason: T.nilable(String),
708
747
  adjustment_type: Symbol
709
- )
710
- .returns(T.attached_class)
748
+ ).returns(T.attached_class)
711
749
  end
712
750
  def self.new(
713
751
  id:,
@@ -726,26 +764,30 @@ module Orb
726
764
  # The reason for the adjustment.
727
765
  reason:,
728
766
  adjustment_type: :minimum
729
- ); end
767
+ )
768
+ end
769
+
730
770
  sig do
731
- override
732
- .returns(
733
- {
734
- id: String,
735
- adjustment_type: Symbol,
736
- applies_to_price_ids: T::Array[String],
737
- is_invoice_level: T::Boolean,
738
- item_id: String,
739
- minimum_amount: String,
740
- plan_phase_order: T.nilable(Integer),
741
- reason: T.nilable(String)
742
- }
743
- )
771
+ override.returns(
772
+ {
773
+ id: String,
774
+ adjustment_type: Symbol,
775
+ applies_to_price_ids: T::Array[String],
776
+ is_invoice_level: T::Boolean,
777
+ item_id: String,
778
+ minimum_amount: String,
779
+ plan_phase_order: T.nilable(Integer),
780
+ reason: T.nilable(String)
781
+ }
782
+ )
783
+ end
784
+ def to_hash
744
785
  end
745
- def to_hash; end
746
786
  end
747
787
 
748
788
  class Maximum < Orb::Internal::Type::BaseModel
789
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
790
+
749
791
  sig { returns(String) }
750
792
  attr_accessor :id
751
793
 
@@ -783,8 +825,7 @@ module Orb
783
825
  plan_phase_order: T.nilable(Integer),
784
826
  reason: T.nilable(String),
785
827
  adjustment_type: Symbol
786
- )
787
- .returns(T.attached_class)
828
+ ).returns(T.attached_class)
788
829
  end
789
830
  def self.new(
790
831
  id:,
@@ -801,35 +842,41 @@ module Orb
801
842
  # The reason for the adjustment.
802
843
  reason:,
803
844
  adjustment_type: :maximum
804
- ); end
845
+ )
846
+ end
847
+
805
848
  sig do
806
- override
807
- .returns(
808
- {
809
- id: String,
810
- adjustment_type: Symbol,
811
- applies_to_price_ids: T::Array[String],
812
- is_invoice_level: T::Boolean,
813
- maximum_amount: String,
814
- plan_phase_order: T.nilable(Integer),
815
- reason: T.nilable(String)
816
- }
817
- )
849
+ override.returns(
850
+ {
851
+ id: String,
852
+ adjustment_type: Symbol,
853
+ applies_to_price_ids: T::Array[String],
854
+ is_invoice_level: T::Boolean,
855
+ maximum_amount: String,
856
+ plan_phase_order: T.nilable(Integer),
857
+ reason: T.nilable(String)
858
+ }
859
+ )
860
+ end
861
+ def to_hash
818
862
  end
819
- def to_hash; end
820
863
  end
821
864
 
822
865
  sig do
823
- override
824
- .returns(
825
- [Orb::Models::Subscription::AdjustmentInterval::Adjustment::UsageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::AmountDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::PercentageDiscount, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Minimum, Orb::Models::Subscription::AdjustmentInterval::Adjustment::Maximum]
826
- )
866
+ override.returns(
867
+ T::Array[
868
+ Orb::Subscription::AdjustmentInterval::Adjustment::Variants
869
+ ]
870
+ )
871
+ end
872
+ def self.variants
827
873
  end
828
- def self.variants; end
829
874
  end
830
875
  end
831
876
 
832
877
  class BillingCycleAnchorConfiguration < Orb::Internal::Type::BaseModel
878
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
879
+
833
880
  # The day of the month on which the billing cycle is anchored. If the maximum
834
881
  # number of days in a month is greater than this value, the last day of the month
835
882
  # is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing
@@ -849,7 +896,11 @@ module Orb
849
896
  attr_accessor :year
850
897
 
851
898
  sig do
852
- params(day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)).returns(T.attached_class)
899
+ params(
900
+ day: Integer,
901
+ month: T.nilable(Integer),
902
+ year: T.nilable(Integer)
903
+ ).returns(T.attached_class)
853
904
  end
854
905
  def self.new(
855
906
  # The day of the month on which the billing cycle is anchored. If the maximum
@@ -864,15 +915,37 @@ module Orb
864
915
  # The year on which the billing cycle is anchored (e.g. a 2 year billing cycle
865
916
  # anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.).
866
917
  year: nil
867
- ); end
868
- sig { override.returns({day: Integer, month: T.nilable(Integer), year: T.nilable(Integer)}) }
869
- def to_hash; end
918
+ )
919
+ end
920
+
921
+ sig do
922
+ override.returns(
923
+ {
924
+ day: Integer,
925
+ month: T.nilable(Integer),
926
+ year: T.nilable(Integer)
927
+ }
928
+ )
929
+ end
930
+ def to_hash
931
+ end
870
932
  end
871
933
 
872
934
  module DiscountInterval
873
935
  extend Orb::Internal::Type::Union
874
936
 
937
+ Variants =
938
+ T.type_alias do
939
+ T.any(
940
+ Orb::Subscription::DiscountInterval::Amount,
941
+ Orb::Subscription::DiscountInterval::Percentage,
942
+ Orb::Subscription::DiscountInterval::Usage
943
+ )
944
+ end
945
+
875
946
  class Amount < Orb::Internal::Type::BaseModel
947
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
948
+
876
949
  # Only available if discount_type is `amount`.
877
950
  sig { returns(String) }
878
951
  attr_accessor :amount_discount
@@ -904,8 +977,7 @@ module Orb
904
977
  end_date: T.nilable(Time),
905
978
  start_date: Time,
906
979
  discount_type: Symbol
907
- )
908
- .returns(T.attached_class)
980
+ ).returns(T.attached_class)
909
981
  end
910
982
  def self.new(
911
983
  # Only available if discount_type is `amount`.
@@ -919,24 +991,28 @@ module Orb
919
991
  # The start date of the discount interval.
920
992
  start_date:,
921
993
  discount_type: :amount
922
- ); end
994
+ )
995
+ end
996
+
923
997
  sig do
924
- override
925
- .returns(
926
- {
927
- amount_discount: String,
928
- applies_to_price_ids: T::Array[String],
929
- applies_to_price_interval_ids: T::Array[String],
930
- discount_type: Symbol,
931
- end_date: T.nilable(Time),
932
- start_date: Time
933
- }
934
- )
998
+ override.returns(
999
+ {
1000
+ amount_discount: String,
1001
+ applies_to_price_ids: T::Array[String],
1002
+ applies_to_price_interval_ids: T::Array[String],
1003
+ discount_type: Symbol,
1004
+ end_date: T.nilable(Time),
1005
+ start_date: Time
1006
+ }
1007
+ )
1008
+ end
1009
+ def to_hash
935
1010
  end
936
- def to_hash; end
937
1011
  end
938
1012
 
939
1013
  class Percentage < Orb::Internal::Type::BaseModel
1014
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1015
+
940
1016
  # The price ids that this discount interval applies to.
941
1017
  sig { returns(T::Array[String]) }
942
1018
  attr_accessor :applies_to_price_ids
@@ -969,8 +1045,7 @@ module Orb
969
1045
  percentage_discount: Float,
970
1046
  start_date: Time,
971
1047
  discount_type: Symbol
972
- )
973
- .returns(T.attached_class)
1048
+ ).returns(T.attached_class)
974
1049
  end
975
1050
  def self.new(
976
1051
  # The price ids that this discount interval applies to.
@@ -985,24 +1060,28 @@ module Orb
985
1060
  # The start date of the discount interval.
986
1061
  start_date:,
987
1062
  discount_type: :percentage
988
- ); end
1063
+ )
1064
+ end
1065
+
989
1066
  sig do
990
- override
991
- .returns(
992
- {
993
- applies_to_price_ids: T::Array[String],
994
- applies_to_price_interval_ids: T::Array[String],
995
- discount_type: Symbol,
996
- end_date: T.nilable(Time),
997
- percentage_discount: Float,
998
- start_date: Time
999
- }
1000
- )
1067
+ override.returns(
1068
+ {
1069
+ applies_to_price_ids: T::Array[String],
1070
+ applies_to_price_interval_ids: T::Array[String],
1071
+ discount_type: Symbol,
1072
+ end_date: T.nilable(Time),
1073
+ percentage_discount: Float,
1074
+ start_date: Time
1075
+ }
1076
+ )
1077
+ end
1078
+ def to_hash
1001
1079
  end
1002
- def to_hash; end
1003
1080
  end
1004
1081
 
1005
1082
  class Usage < Orb::Internal::Type::BaseModel
1083
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1084
+
1006
1085
  # The price ids that this discount interval applies to.
1007
1086
  sig { returns(T::Array[String]) }
1008
1087
  attr_accessor :applies_to_price_ids
@@ -1035,8 +1114,7 @@ module Orb
1035
1114
  start_date: Time,
1036
1115
  usage_discount: Float,
1037
1116
  discount_type: Symbol
1038
- )
1039
- .returns(T.attached_class)
1117
+ ).returns(T.attached_class)
1040
1118
  end
1041
1119
  def self.new(
1042
1120
  # The price ids that this discount interval applies to.
@@ -1051,33 +1129,37 @@ module Orb
1051
1129
  # discount is for
1052
1130
  usage_discount:,
1053
1131
  discount_type: :usage
1054
- ); end
1132
+ )
1133
+ end
1134
+
1055
1135
  sig do
1056
- override
1057
- .returns(
1058
- {
1059
- applies_to_price_ids: T::Array[String],
1060
- applies_to_price_interval_ids: T::Array[String],
1061
- discount_type: Symbol,
1062
- end_date: T.nilable(Time),
1063
- start_date: Time,
1064
- usage_discount: Float
1065
- }
1066
- )
1136
+ override.returns(
1137
+ {
1138
+ applies_to_price_ids: T::Array[String],
1139
+ applies_to_price_interval_ids: T::Array[String],
1140
+ discount_type: Symbol,
1141
+ end_date: T.nilable(Time),
1142
+ start_date: Time,
1143
+ usage_discount: Float
1144
+ }
1145
+ )
1146
+ end
1147
+ def to_hash
1067
1148
  end
1068
- def to_hash; end
1069
1149
  end
1070
1150
 
1071
1151
  sig do
1072
- override
1073
- .returns(
1074
- [Orb::Models::Subscription::DiscountInterval::Amount, Orb::Models::Subscription::DiscountInterval::Percentage, Orb::Models::Subscription::DiscountInterval::Usage]
1075
- )
1152
+ override.returns(
1153
+ T::Array[Orb::Subscription::DiscountInterval::Variants]
1154
+ )
1155
+ end
1156
+ def self.variants
1076
1157
  end
1077
- def self.variants; end
1078
1158
  end
1079
1159
 
1080
1160
  class FixedFeeQuantitySchedule < Orb::Internal::Type::BaseModel
1161
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1162
+
1081
1163
  sig { returns(T.nilable(Time)) }
1082
1164
  attr_accessor :end_date
1083
1165
 
@@ -1091,18 +1173,33 @@ module Orb
1091
1173
  attr_accessor :start_date
1092
1174
 
1093
1175
  sig do
1094
- params(end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time)
1095
- .returns(T.attached_class)
1176
+ params(
1177
+ end_date: T.nilable(Time),
1178
+ price_id: String,
1179
+ quantity: Float,
1180
+ start_date: Time
1181
+ ).returns(T.attached_class)
1182
+ end
1183
+ def self.new(end_date:, price_id:, quantity:, start_date:)
1096
1184
  end
1097
- def self.new(end_date:, price_id:, quantity:, start_date:); end
1098
1185
 
1099
1186
  sig do
1100
- override.returns({end_date: T.nilable(Time), price_id: String, quantity: Float, start_date: Time})
1187
+ override.returns(
1188
+ {
1189
+ end_date: T.nilable(Time),
1190
+ price_id: String,
1191
+ quantity: Float,
1192
+ start_date: Time
1193
+ }
1194
+ )
1195
+ end
1196
+ def to_hash
1101
1197
  end
1102
- def to_hash; end
1103
1198
  end
1104
1199
 
1105
1200
  class MaximumInterval < Orb::Internal::Type::BaseModel
1201
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1202
+
1106
1203
  # The price ids that this maximum interval applies to.
1107
1204
  sig { returns(T::Array[String]) }
1108
1205
  attr_accessor :applies_to_price_ids
@@ -1131,8 +1228,7 @@ module Orb
1131
1228
  end_date: T.nilable(Time),
1132
1229
  maximum_amount: String,
1133
1230
  start_date: Time
1134
- )
1135
- .returns(T.attached_class)
1231
+ ).returns(T.attached_class)
1136
1232
  end
1137
1233
  def self.new(
1138
1234
  # The price ids that this maximum interval applies to.
@@ -1146,23 +1242,27 @@ module Orb
1146
1242
  maximum_amount:,
1147
1243
  # The start date of the maximum interval.
1148
1244
  start_date:
1149
- ); end
1245
+ )
1246
+ end
1247
+
1150
1248
  sig do
1151
- override
1152
- .returns(
1153
- {
1154
- applies_to_price_ids: T::Array[String],
1155
- applies_to_price_interval_ids: T::Array[String],
1156
- end_date: T.nilable(Time),
1157
- maximum_amount: String,
1158
- start_date: Time
1159
- }
1160
- )
1249
+ override.returns(
1250
+ {
1251
+ applies_to_price_ids: T::Array[String],
1252
+ applies_to_price_interval_ids: T::Array[String],
1253
+ end_date: T.nilable(Time),
1254
+ maximum_amount: String,
1255
+ start_date: Time
1256
+ }
1257
+ )
1258
+ end
1259
+ def to_hash
1161
1260
  end
1162
- def to_hash; end
1163
1261
  end
1164
1262
 
1165
1263
  class MinimumInterval < Orb::Internal::Type::BaseModel
1264
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1265
+
1166
1266
  # The price ids that this minimum interval applies to.
1167
1267
  sig { returns(T::Array[String]) }
1168
1268
  attr_accessor :applies_to_price_ids
@@ -1191,8 +1291,7 @@ module Orb
1191
1291
  end_date: T.nilable(Time),
1192
1292
  minimum_amount: String,
1193
1293
  start_date: Time
1194
- )
1195
- .returns(T.attached_class)
1294
+ ).returns(T.attached_class)
1196
1295
  end
1197
1296
  def self.new(
1198
1297
  # The price ids that this minimum interval applies to.
@@ -1206,35 +1305,43 @@ module Orb
1206
1305
  minimum_amount:,
1207
1306
  # The start date of the minimum interval.
1208
1307
  start_date:
1209
- ); end
1308
+ )
1309
+ end
1310
+
1210
1311
  sig do
1211
- override
1212
- .returns(
1213
- {
1214
- applies_to_price_ids: T::Array[String],
1215
- applies_to_price_interval_ids: T::Array[String],
1216
- end_date: T.nilable(Time),
1217
- minimum_amount: String,
1218
- start_date: Time
1219
- }
1220
- )
1312
+ override.returns(
1313
+ {
1314
+ applies_to_price_ids: T::Array[String],
1315
+ applies_to_price_interval_ids: T::Array[String],
1316
+ end_date: T.nilable(Time),
1317
+ minimum_amount: String,
1318
+ start_date: Time
1319
+ }
1320
+ )
1321
+ end
1322
+ def to_hash
1221
1323
  end
1222
- def to_hash; end
1223
1324
  end
1224
1325
 
1225
1326
  class PendingSubscriptionChange < Orb::Internal::Type::BaseModel
1327
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1328
+
1226
1329
  sig { returns(String) }
1227
1330
  attr_accessor :id
1228
1331
 
1229
1332
  # A pending subscription change if one exists on this subscription.
1230
1333
  sig { params(id: String).returns(T.attached_class) }
1231
- def self.new(id:); end
1334
+ def self.new(id:)
1335
+ end
1232
1336
 
1233
- sig { override.returns({id: String}) }
1234
- def to_hash; end
1337
+ sig { override.returns({ id: String }) }
1338
+ def to_hash
1339
+ end
1235
1340
  end
1236
1341
 
1237
1342
  class PriceInterval < Orb::Internal::Type::BaseModel
1343
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1344
+
1238
1345
  sig { returns(String) }
1239
1346
  attr_accessor :id
1240
1347
 
@@ -1265,7 +1372,15 @@ module Orb
1265
1372
 
1266
1373
  # The fixed fee quantity transitions for this price interval. This is only
1267
1374
  # relevant for fixed fees.
1268
- sig { returns(T.nilable(T::Array[Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition])) }
1375
+ sig do
1376
+ returns(
1377
+ T.nilable(
1378
+ T::Array[
1379
+ Orb::Subscription::PriceInterval::FixedFeeQuantityTransition
1380
+ ]
1381
+ )
1382
+ )
1383
+ end
1269
1384
  attr_accessor :fixed_fee_quantity_transitions
1270
1385
 
1271
1386
  # The Price resource represents a price that can be billed on a subscription,
@@ -1281,34 +1396,34 @@ module Orb
1281
1396
  sig do
1282
1397
  returns(
1283
1398
  T.any(
1284
- Orb::Models::Price::Unit,
1285
- Orb::Models::Price::Package,
1286
- Orb::Models::Price::Matrix,
1287
- Orb::Models::Price::Tiered,
1288
- Orb::Models::Price::TieredBps,
1289
- Orb::Models::Price::Bps,
1290
- Orb::Models::Price::BulkBps,
1291
- Orb::Models::Price::Bulk,
1292
- Orb::Models::Price::ThresholdTotalAmount,
1293
- Orb::Models::Price::TieredPackage,
1294
- Orb::Models::Price::GroupedTiered,
1295
- Orb::Models::Price::TieredWithMinimum,
1296
- Orb::Models::Price::TieredPackageWithMinimum,
1297
- Orb::Models::Price::PackageWithAllocation,
1298
- Orb::Models::Price::UnitWithPercent,
1299
- Orb::Models::Price::MatrixWithAllocation,
1300
- Orb::Models::Price::TieredWithProration,
1301
- Orb::Models::Price::UnitWithProration,
1302
- Orb::Models::Price::GroupedAllocation,
1303
- Orb::Models::Price::GroupedWithProratedMinimum,
1304
- Orb::Models::Price::GroupedWithMeteredMinimum,
1305
- Orb::Models::Price::MatrixWithDisplayName,
1306
- Orb::Models::Price::BulkWithProration,
1307
- Orb::Models::Price::GroupedTieredPackage,
1308
- Orb::Models::Price::MaxGroupTieredPackage,
1309
- Orb::Models::Price::ScalableMatrixWithUnitPricing,
1310
- Orb::Models::Price::ScalableMatrixWithTieredPricing,
1311
- Orb::Models::Price::CumulativeGroupedBulk
1399
+ Orb::Price::Unit,
1400
+ Orb::Price::Package,
1401
+ Orb::Price::Matrix,
1402
+ Orb::Price::Tiered,
1403
+ Orb::Price::TieredBps,
1404
+ Orb::Price::Bps,
1405
+ Orb::Price::BulkBps,
1406
+ Orb::Price::Bulk,
1407
+ Orb::Price::ThresholdTotalAmount,
1408
+ Orb::Price::TieredPackage,
1409
+ Orb::Price::GroupedTiered,
1410
+ Orb::Price::TieredWithMinimum,
1411
+ Orb::Price::TieredPackageWithMinimum,
1412
+ Orb::Price::PackageWithAllocation,
1413
+ Orb::Price::UnitWithPercent,
1414
+ Orb::Price::MatrixWithAllocation,
1415
+ Orb::Price::TieredWithProration,
1416
+ Orb::Price::UnitWithProration,
1417
+ Orb::Price::GroupedAllocation,
1418
+ Orb::Price::GroupedWithProratedMinimum,
1419
+ Orb::Price::GroupedWithMeteredMinimum,
1420
+ Orb::Price::MatrixWithDisplayName,
1421
+ Orb::Price::BulkWithProration,
1422
+ Orb::Price::GroupedTieredPackage,
1423
+ Orb::Price::MaxGroupTieredPackage,
1424
+ Orb::Price::ScalableMatrixWithUnitPricing,
1425
+ Orb::Price::ScalableMatrixWithTieredPricing,
1426
+ Orb::Price::CumulativeGroupedBulk
1312
1427
  )
1313
1428
  )
1314
1429
  end
@@ -1335,44 +1450,46 @@ module Orb
1335
1450
  current_billing_period_start_date: T.nilable(Time),
1336
1451
  end_date: T.nilable(Time),
1337
1452
  filter: T.nilable(String),
1338
- fixed_fee_quantity_transitions: T.nilable(
1339
- T::Array[T.any(Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition, Orb::Internal::AnyHash)]
1340
- ),
1341
- price: T.any(
1342
- Orb::Models::Price::Unit,
1343
- Orb::Internal::AnyHash,
1344
- Orb::Models::Price::Package,
1345
- Orb::Models::Price::Matrix,
1346
- Orb::Models::Price::Tiered,
1347
- Orb::Models::Price::TieredBps,
1348
- Orb::Models::Price::Bps,
1349
- Orb::Models::Price::BulkBps,
1350
- Orb::Models::Price::Bulk,
1351
- Orb::Models::Price::ThresholdTotalAmount,
1352
- Orb::Models::Price::TieredPackage,
1353
- Orb::Models::Price::GroupedTiered,
1354
- Orb::Models::Price::TieredWithMinimum,
1355
- Orb::Models::Price::TieredPackageWithMinimum,
1356
- Orb::Models::Price::PackageWithAllocation,
1357
- Orb::Models::Price::UnitWithPercent,
1358
- Orb::Models::Price::MatrixWithAllocation,
1359
- Orb::Models::Price::TieredWithProration,
1360
- Orb::Models::Price::UnitWithProration,
1361
- Orb::Models::Price::GroupedAllocation,
1362
- Orb::Models::Price::GroupedWithProratedMinimum,
1363
- Orb::Models::Price::GroupedWithMeteredMinimum,
1364
- Orb::Models::Price::MatrixWithDisplayName,
1365
- Orb::Models::Price::BulkWithProration,
1366
- Orb::Models::Price::GroupedTieredPackage,
1367
- Orb::Models::Price::MaxGroupTieredPackage,
1368
- Orb::Models::Price::ScalableMatrixWithUnitPricing,
1369
- Orb::Models::Price::ScalableMatrixWithTieredPricing,
1370
- Orb::Models::Price::CumulativeGroupedBulk
1371
- ),
1453
+ fixed_fee_quantity_transitions:
1454
+ T.nilable(
1455
+ T::Array[
1456
+ Orb::Subscription::PriceInterval::FixedFeeQuantityTransition::OrHash
1457
+ ]
1458
+ ),
1459
+ price:
1460
+ T.any(
1461
+ Orb::Price::Unit::OrHash,
1462
+ Orb::Price::Package::OrHash,
1463
+ Orb::Price::Matrix::OrHash,
1464
+ Orb::Price::Tiered::OrHash,
1465
+ Orb::Price::TieredBps::OrHash,
1466
+ Orb::Price::Bps::OrHash,
1467
+ Orb::Price::BulkBps::OrHash,
1468
+ Orb::Price::Bulk::OrHash,
1469
+ Orb::Price::ThresholdTotalAmount::OrHash,
1470
+ Orb::Price::TieredPackage::OrHash,
1471
+ Orb::Price::GroupedTiered::OrHash,
1472
+ Orb::Price::TieredWithMinimum::OrHash,
1473
+ Orb::Price::TieredPackageWithMinimum::OrHash,
1474
+ Orb::Price::PackageWithAllocation::OrHash,
1475
+ Orb::Price::UnitWithPercent::OrHash,
1476
+ Orb::Price::MatrixWithAllocation::OrHash,
1477
+ Orb::Price::TieredWithProration::OrHash,
1478
+ Orb::Price::UnitWithProration::OrHash,
1479
+ Orb::Price::GroupedAllocation::OrHash,
1480
+ Orb::Price::GroupedWithProratedMinimum::OrHash,
1481
+ Orb::Price::GroupedWithMeteredMinimum::OrHash,
1482
+ Orb::Price::MatrixWithDisplayName::OrHash,
1483
+ Orb::Price::BulkWithProration::OrHash,
1484
+ Orb::Price::GroupedTieredPackage::OrHash,
1485
+ Orb::Price::MaxGroupTieredPackage::OrHash,
1486
+ Orb::Price::ScalableMatrixWithUnitPricing::OrHash,
1487
+ Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
1488
+ Orb::Price::CumulativeGroupedBulk::OrHash
1489
+ ),
1372
1490
  start_date: Time,
1373
1491
  usage_customer_ids: T.nilable(T::Array[String])
1374
- )
1375
- .returns(T.attached_class)
1492
+ ).returns(T.attached_class)
1376
1493
  end
1377
1494
  def self.new(
1378
1495
  id:,
@@ -1411,56 +1528,66 @@ module Orb
1411
1528
  # A list of customer IDs whose usage events will be aggregated and billed under
1412
1529
  # this price interval.
1413
1530
  usage_customer_ids:
1414
- ); end
1531
+ )
1532
+ end
1533
+
1415
1534
  sig do
1416
- override
1417
- .returns(
1418
- {
1419
- id: String,
1420
- billing_cycle_day: Integer,
1421
- current_billing_period_end_date: T.nilable(Time),
1422
- current_billing_period_start_date: T.nilable(Time),
1423
- end_date: T.nilable(Time),
1424
- filter: T.nilable(String),
1425
- fixed_fee_quantity_transitions: T.nilable(T::Array[Orb::Models::Subscription::PriceInterval::FixedFeeQuantityTransition]),
1426
- price: T.any(
1427
- Orb::Models::Price::Unit,
1428
- Orb::Models::Price::Package,
1429
- Orb::Models::Price::Matrix,
1430
- Orb::Models::Price::Tiered,
1431
- Orb::Models::Price::TieredBps,
1432
- Orb::Models::Price::Bps,
1433
- Orb::Models::Price::BulkBps,
1434
- Orb::Models::Price::Bulk,
1435
- Orb::Models::Price::ThresholdTotalAmount,
1436
- Orb::Models::Price::TieredPackage,
1437
- Orb::Models::Price::GroupedTiered,
1438
- Orb::Models::Price::TieredWithMinimum,
1439
- Orb::Models::Price::TieredPackageWithMinimum,
1440
- Orb::Models::Price::PackageWithAllocation,
1441
- Orb::Models::Price::UnitWithPercent,
1442
- Orb::Models::Price::MatrixWithAllocation,
1443
- Orb::Models::Price::TieredWithProration,
1444
- Orb::Models::Price::UnitWithProration,
1445
- Orb::Models::Price::GroupedAllocation,
1446
- Orb::Models::Price::GroupedWithProratedMinimum,
1447
- Orb::Models::Price::GroupedWithMeteredMinimum,
1448
- Orb::Models::Price::MatrixWithDisplayName,
1449
- Orb::Models::Price::BulkWithProration,
1450
- Orb::Models::Price::GroupedTieredPackage,
1451
- Orb::Models::Price::MaxGroupTieredPackage,
1452
- Orb::Models::Price::ScalableMatrixWithUnitPricing,
1453
- Orb::Models::Price::ScalableMatrixWithTieredPricing,
1454
- Orb::Models::Price::CumulativeGroupedBulk
1535
+ override.returns(
1536
+ {
1537
+ id: String,
1538
+ billing_cycle_day: Integer,
1539
+ current_billing_period_end_date: T.nilable(Time),
1540
+ current_billing_period_start_date: T.nilable(Time),
1541
+ end_date: T.nilable(Time),
1542
+ filter: T.nilable(String),
1543
+ fixed_fee_quantity_transitions:
1544
+ T.nilable(
1545
+ T::Array[
1546
+ Orb::Subscription::PriceInterval::FixedFeeQuantityTransition
1547
+ ]
1455
1548
  ),
1456
- start_date: Time,
1457
- usage_customer_ids: T.nilable(T::Array[String])
1458
- }
1459
- )
1549
+ price:
1550
+ T.any(
1551
+ Orb::Price::Unit,
1552
+ Orb::Price::Package,
1553
+ Orb::Price::Matrix,
1554
+ Orb::Price::Tiered,
1555
+ Orb::Price::TieredBps,
1556
+ Orb::Price::Bps,
1557
+ Orb::Price::BulkBps,
1558
+ Orb::Price::Bulk,
1559
+ Orb::Price::ThresholdTotalAmount,
1560
+ Orb::Price::TieredPackage,
1561
+ Orb::Price::GroupedTiered,
1562
+ Orb::Price::TieredWithMinimum,
1563
+ Orb::Price::TieredPackageWithMinimum,
1564
+ Orb::Price::PackageWithAllocation,
1565
+ Orb::Price::UnitWithPercent,
1566
+ Orb::Price::MatrixWithAllocation,
1567
+ Orb::Price::TieredWithProration,
1568
+ Orb::Price::UnitWithProration,
1569
+ Orb::Price::GroupedAllocation,
1570
+ Orb::Price::GroupedWithProratedMinimum,
1571
+ Orb::Price::GroupedWithMeteredMinimum,
1572
+ Orb::Price::MatrixWithDisplayName,
1573
+ Orb::Price::BulkWithProration,
1574
+ Orb::Price::GroupedTieredPackage,
1575
+ Orb::Price::MaxGroupTieredPackage,
1576
+ Orb::Price::ScalableMatrixWithUnitPricing,
1577
+ Orb::Price::ScalableMatrixWithTieredPricing,
1578
+ Orb::Price::CumulativeGroupedBulk
1579
+ ),
1580
+ start_date: Time,
1581
+ usage_customer_ids: T.nilable(T::Array[String])
1582
+ }
1583
+ )
1584
+ end
1585
+ def to_hash
1460
1586
  end
1461
- def to_hash; end
1462
1587
 
1463
1588
  class FixedFeeQuantityTransition < Orb::Internal::Type::BaseModel
1589
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1590
+
1464
1591
  sig { returns(Time) }
1465
1592
  attr_accessor :effective_date
1466
1593
 
@@ -1470,15 +1597,29 @@ module Orb
1470
1597
  sig { returns(Integer) }
1471
1598
  attr_accessor :quantity
1472
1599
 
1473
- sig { params(effective_date: Time, price_id: String, quantity: Integer).returns(T.attached_class) }
1474
- def self.new(effective_date:, price_id:, quantity:); end
1600
+ sig do
1601
+ params(
1602
+ effective_date: Time,
1603
+ price_id: String,
1604
+ quantity: Integer
1605
+ ).returns(T.attached_class)
1606
+ end
1607
+ def self.new(effective_date:, price_id:, quantity:)
1608
+ end
1475
1609
 
1476
- sig { override.returns({effective_date: Time, price_id: String, quantity: Integer}) }
1477
- def to_hash; end
1610
+ sig do
1611
+ override.returns(
1612
+ { effective_date: Time, price_id: String, quantity: Integer }
1613
+ )
1614
+ end
1615
+ def to_hash
1616
+ end
1478
1617
  end
1479
1618
  end
1480
1619
 
1481
1620
  class RedeemedCoupon < Orb::Internal::Type::BaseModel
1621
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1622
+
1482
1623
  sig { returns(String) }
1483
1624
  attr_accessor :coupon_id
1484
1625
 
@@ -1489,37 +1630,54 @@ module Orb
1489
1630
  attr_accessor :start_date
1490
1631
 
1491
1632
  sig do
1492
- params(coupon_id: String, end_date: T.nilable(Time), start_date: Time).returns(T.attached_class)
1633
+ params(
1634
+ coupon_id: String,
1635
+ end_date: T.nilable(Time),
1636
+ start_date: Time
1637
+ ).returns(T.attached_class)
1638
+ end
1639
+ def self.new(coupon_id:, end_date:, start_date:)
1493
1640
  end
1494
- def self.new(coupon_id:, end_date:, start_date:); end
1495
1641
 
1496
- sig { override.returns({coupon_id: String, end_date: T.nilable(Time), start_date: Time}) }
1497
- def to_hash; end
1642
+ sig do
1643
+ override.returns(
1644
+ { coupon_id: String, end_date: T.nilable(Time), start_date: Time }
1645
+ )
1646
+ end
1647
+ def to_hash
1648
+ end
1498
1649
  end
1499
1650
 
1500
1651
  module Status
1501
1652
  extend Orb::Internal::Type::Enum
1502
1653
 
1503
- TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Subscription::Status) }
1654
+ TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Subscription::Status) }
1504
1655
  OrSymbol = T.type_alias { T.any(Symbol, String) }
1505
1656
 
1506
- ACTIVE = T.let(:active, Orb::Models::Subscription::Status::TaggedSymbol)
1507
- ENDED = T.let(:ended, Orb::Models::Subscription::Status::TaggedSymbol)
1508
- UPCOMING = T.let(:upcoming, Orb::Models::Subscription::Status::TaggedSymbol)
1657
+ ACTIVE = T.let(:active, Orb::Subscription::Status::TaggedSymbol)
1658
+ ENDED = T.let(:ended, Orb::Subscription::Status::TaggedSymbol)
1659
+ UPCOMING = T.let(:upcoming, Orb::Subscription::Status::TaggedSymbol)
1509
1660
 
1510
- sig { override.returns(T::Array[Orb::Models::Subscription::Status::TaggedSymbol]) }
1511
- def self.values; end
1661
+ sig do
1662
+ override.returns(T::Array[Orb::Subscription::Status::TaggedSymbol])
1663
+ end
1664
+ def self.values
1665
+ end
1512
1666
  end
1513
1667
 
1514
1668
  class TrialInfo < Orb::Internal::Type::BaseModel
1669
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
1670
+
1515
1671
  sig { returns(T.nilable(Time)) }
1516
1672
  attr_accessor :end_date
1517
1673
 
1518
1674
  sig { params(end_date: T.nilable(Time)).returns(T.attached_class) }
1519
- def self.new(end_date:); end
1675
+ def self.new(end_date:)
1676
+ end
1520
1677
 
1521
- sig { override.returns({end_date: T.nilable(Time)}) }
1522
- def to_hash; end
1678
+ sig { override.returns({ end_date: T.nilable(Time) }) }
1679
+ def to_hash
1680
+ end
1523
1681
  end
1524
1682
  end
1525
1683
  end