orb-billing 0.3.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (592) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +3 -3
  4. data/lib/orb/errors.rb +1 -1
  5. data/lib/orb/file_part.rb +2 -2
  6. data/lib/orb/internal/transport/base_client.rb +74 -5
  7. data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
  8. data/lib/orb/internal/type/array_of.rb +1 -1
  9. data/lib/orb/internal/type/base_model.rb +62 -30
  10. data/lib/orb/internal/type/converter.rb +18 -0
  11. data/lib/orb/internal/type/enum.rb +4 -3
  12. data/lib/orb/internal/type/hash_of.rb +1 -1
  13. data/lib/orb/internal/type/request_parameters.rb +4 -4
  14. data/lib/orb/internal/type/union.rb +5 -4
  15. data/lib/orb/internal/util.rb +57 -1
  16. data/lib/orb/internal.rb +6 -0
  17. data/lib/orb/models/alert.rb +29 -32
  18. data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
  19. data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
  20. data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
  21. data/lib/orb/models/alert_list_params.rb +0 -1
  22. data/lib/orb/models/alert_update_params.rb +4 -5
  23. data/lib/orb/models/amount_discount.rb +6 -7
  24. data/lib/orb/models/billable_metric.rb +9 -11
  25. data/lib/orb/models/coupon.rb +13 -12
  26. data/lib/orb/models/coupon_create_params.rb +12 -8
  27. data/lib/orb/models/coupon_list_params.rb +0 -2
  28. data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
  29. data/lib/orb/models/credit_note.rb +48 -46
  30. data/lib/orb/models/credit_note_create_params.rb +6 -6
  31. data/lib/orb/models/credit_note_list_params.rb +0 -1
  32. data/lib/orb/models/customer.rb +54 -61
  33. data/lib/orb/models/customer_create_params.rb +50 -53
  34. data/lib/orb/models/customer_list_params.rb +0 -1
  35. data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
  36. data/lib/orb/models/customer_update_params.rb +50 -51
  37. data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
  38. data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
  39. data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
  40. data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
  41. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
  42. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
  43. data/lib/orb/models/customers/cost_list_params.rb +3 -4
  44. data/lib/orb/models/customers/cost_list_response.rb +3 -3
  45. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
  46. data/lib/orb/models/customers/credit_list_params.rb +0 -2
  47. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
  48. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +14 -7
  49. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
  50. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -7
  51. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
  52. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +14 -7
  53. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
  54. data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -7
  55. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
  56. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
  57. data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
  58. data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
  59. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
  60. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
  61. data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
  62. data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
  63. data/lib/orb/models/dimensional_price_group.rb +1 -3
  64. data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
  65. data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
  66. data/lib/orb/models/dimensional_price_groups.rb +6 -6
  67. data/lib/orb/models/discount.rb +11 -5
  68. data/lib/orb/models/evaluate_price_group.rb +5 -1
  69. data/lib/orb/models/event_ingest_params.rb +4 -9
  70. data/lib/orb/models/event_ingest_response.rb +0 -3
  71. data/lib/orb/models/event_search_params.rb +0 -3
  72. data/lib/orb/models/event_search_response.rb +0 -4
  73. data/lib/orb/models/event_update_params.rb +0 -3
  74. data/lib/orb/models/events/backfill_close_response.rb +0 -4
  75. data/lib/orb/models/events/backfill_create_params.rb +0 -7
  76. data/lib/orb/models/events/backfill_create_response.rb +0 -4
  77. data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
  78. data/lib/orb/models/events/backfill_list_params.rb +0 -1
  79. data/lib/orb/models/events/backfill_list_response.rb +0 -4
  80. data/lib/orb/models/events/backfill_revert_response.rb +0 -4
  81. data/lib/orb/models/events/event_volumes.rb +3 -3
  82. data/lib/orb/models/events/volume_list_params.rb +0 -3
  83. data/lib/orb/models/invoice.rb +179 -202
  84. data/lib/orb/models/invoice_create_params.rb +14 -21
  85. data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
  86. data/lib/orb/models/invoice_issue_params.rb +0 -1
  87. data/lib/orb/models/invoice_level_discount.rb +8 -4
  88. data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
  89. data/lib/orb/models/invoice_line_item_create_response.rb +28 -26
  90. data/lib/orb/models/invoice_list_params.rb +6 -10
  91. data/lib/orb/models/invoice_update_params.rb +0 -1
  92. data/lib/orb/models/item.rb +7 -8
  93. data/lib/orb/models/item_list_params.rb +0 -1
  94. data/lib/orb/models/item_update_params.rb +7 -7
  95. data/lib/orb/models/metric_create_params.rb +0 -1
  96. data/lib/orb/models/metric_list_params.rb +0 -1
  97. data/lib/orb/models/metric_update_params.rb +0 -1
  98. data/lib/orb/models/percentage_discount.rb +6 -8
  99. data/lib/orb/models/plan.rb +90 -103
  100. data/lib/orb/models/plan_create_params.rb +759 -800
  101. data/lib/orb/models/plan_list_params.rb +3 -4
  102. data/lib/orb/models/plan_update_params.rb +0 -2
  103. data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
  104. data/lib/orb/models/price.rb +1706 -1724
  105. data/lib/orb/models/price_create_params.rb +75 -84
  106. data/lib/orb/models/price_evaluate_params.rb +0 -2
  107. data/lib/orb/models/price_evaluate_response.rb +3 -3
  108. data/lib/orb/models/price_list_params.rb +0 -1
  109. data/lib/orb/models/price_update_params.rb +0 -1
  110. data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
  111. data/lib/orb/models/subscription.rb +108 -122
  112. data/lib/orb/models/subscription_cancel_params.rb +3 -5
  113. data/lib/orb/models/subscription_cancel_response.rb +43 -57
  114. data/lib/orb/models/subscription_change_apply_response.rb +43 -58
  115. data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
  116. data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
  117. data/lib/orb/models/subscription_create_params.rb +1953 -1815
  118. data/lib/orb/models/subscription_create_response.rb +43 -57
  119. data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
  120. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
  121. data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
  122. data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
  123. data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
  124. data/lib/orb/models/subscription_list_params.rb +3 -4
  125. data/lib/orb/models/subscription_price_intervals_params.rb +1194 -1017
  126. data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
  127. data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
  128. data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
  129. data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
  130. data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
  131. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
  132. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
  133. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -57
  134. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
  135. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +43 -57
  136. data/lib/orb/models/subscription_update_params.rb +0 -5
  137. data/lib/orb/models/subscription_update_trial_params.rb +8 -6
  138. data/lib/orb/models/subscription_update_trial_response.rb +43 -57
  139. data/lib/orb/models/subscription_usage.rb +55 -39
  140. data/lib/orb/models/subscriptions.rb +6 -6
  141. data/lib/orb/models/trial_discount.rb +6 -7
  142. data/lib/orb/models/usage_discount.rb +6 -8
  143. data/lib/orb/models.rb +24 -0
  144. data/lib/orb/request_options.rb +4 -0
  145. data/lib/orb/resources/alerts.rb +30 -31
  146. data/lib/orb/resources/coupons/subscriptions.rb +3 -4
  147. data/lib/orb/resources/coupons.rb +11 -21
  148. data/lib/orb/resources/credit_notes.rb +10 -11
  149. data/lib/orb/resources/customers/balance_transactions.rb +3 -4
  150. data/lib/orb/resources/customers/costs.rb +4 -6
  151. data/lib/orb/resources/customers/credits/ledger.rb +14 -33
  152. data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
  153. data/lib/orb/resources/customers/credits.rb +2 -6
  154. data/lib/orb/resources/customers.rb +40 -67
  155. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
  156. data/lib/orb/resources/dimensional_price_groups.rb +8 -10
  157. data/lib/orb/resources/events/backfills.rb +2 -10
  158. data/lib/orb/resources/events/volume.rb +3 -6
  159. data/lib/orb/resources/events.rb +4 -12
  160. data/lib/orb/resources/invoice_line_items.rb +1 -2
  161. data/lib/orb/resources/invoices.rb +26 -43
  162. data/lib/orb/resources/items.rb +12 -13
  163. data/lib/orb/resources/metrics.rb +11 -14
  164. data/lib/orb/resources/plans/external_plan_id.rb +5 -7
  165. data/lib/orb/resources/plans.rb +14 -23
  166. data/lib/orb/resources/prices/external_price_id.rb +5 -6
  167. data/lib/orb/resources/prices.rb +25 -35
  168. data/lib/orb/resources/subscription_changes.rb +1 -1
  169. data/lib/orb/resources/subscriptions.rb +49 -107
  170. data/lib/orb/version.rb +1 -1
  171. data/lib/orb.rb +3 -0
  172. data/rbi/orb/client.rbi +5 -4
  173. data/rbi/orb/errors.rbi +59 -28
  174. data/rbi/orb/file_part.rbi +9 -6
  175. data/rbi/orb/internal/page.rbi +20 -6
  176. data/rbi/orb/internal/transport/base_client.rbi +159 -78
  177. data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
  178. data/rbi/orb/internal/type/array_of.rbi +42 -34
  179. data/rbi/orb/internal/type/base_model.rbi +144 -69
  180. data/rbi/orb/internal/type/base_page.rbi +12 -8
  181. data/rbi/orb/internal/type/boolean.rbi +16 -10
  182. data/rbi/orb/internal/type/converter.rbi +68 -31
  183. data/rbi/orb/internal/type/enum.rbi +28 -15
  184. data/rbi/orb/internal/type/file_input.rbi +12 -10
  185. data/rbi/orb/internal/type/hash_of.rbi +34 -24
  186. data/rbi/orb/internal/type/request_parameters.rbi +12 -4
  187. data/rbi/orb/internal/type/union.rbi +61 -25
  188. data/rbi/orb/internal/type/unknown.rbi +20 -12
  189. data/rbi/orb/internal/util.rbi +232 -90
  190. data/rbi/orb/internal.rbi +2 -0
  191. data/rbi/orb/models/alert.rbi +114 -70
  192. data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
  193. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
  194. data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
  195. data/rbi/orb/models/alert_disable_params.rbi +18 -6
  196. data/rbi/orb/models/alert_enable_params.rbi +18 -6
  197. data/rbi/orb/models/alert_list_params.rbi +24 -20
  198. data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
  199. data/rbi/orb/models/alert_update_params.rbi +29 -14
  200. data/rbi/orb/models/amount_discount.rbi +29 -19
  201. data/rbi/orb/models/billable_metric.rbi +34 -26
  202. data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
  203. data/rbi/orb/models/coupon.rbi +28 -20
  204. data/rbi/orb/models/coupon_archive_params.rbi +11 -4
  205. data/rbi/orb/models/coupon_create_params.rbi +85 -38
  206. data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
  207. data/rbi/orb/models/coupon_list_params.rbi +19 -15
  208. data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
  209. data/rbi/orb/models/credit_note.rbi +329 -158
  210. data/rbi/orb/models/credit_note_create_params.rbi +64 -29
  211. data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
  212. data/rbi/orb/models/credit_note_list_params.rbi +23 -17
  213. data/rbi/orb/models/customer.rbi +461 -329
  214. data/rbi/orb/models/customer_create_params.rbi +713 -325
  215. data/rbi/orb/models/customer_delete_params.rbi +13 -4
  216. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
  217. data/rbi/orb/models/customer_fetch_params.rbi +11 -4
  218. data/rbi/orb/models/customer_list_params.rbi +21 -17
  219. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
  220. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
  221. data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
  222. data/rbi/orb/models/customer_update_params.rbi +712 -324
  223. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
  224. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
  225. data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
  226. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
  227. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
  228. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
  229. data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
  230. data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
  231. data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
  232. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
  233. data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
  234. data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
  235. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
  236. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
  237. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
  238. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
  239. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
  240. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
  241. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
  242. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
  243. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
  244. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
  245. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
  246. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
  247. data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
  248. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
  249. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
  250. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
  251. data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
  252. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
  253. data/rbi/orb/models/dimensional_price_group.rbi +21 -15
  254. data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
  255. data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
  256. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
  257. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
  258. data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
  259. data/rbi/orb/models/discount.rbi +11 -5
  260. data/rbi/orb/models/evaluate_price_group.rbi +29 -12
  261. data/rbi/orb/models/event_deprecate_params.rbi +13 -4
  262. data/rbi/orb/models/event_deprecate_response.rbi +11 -3
  263. data/rbi/orb/models/event_ingest_params.rbi +41 -31
  264. data/rbi/orb/models/event_ingest_response.rbi +78 -23
  265. data/rbi/orb/models/event_search_params.rbi +18 -14
  266. data/rbi/orb/models/event_search_response.rbi +42 -21
  267. data/rbi/orb/models/event_update_params.rbi +20 -16
  268. data/rbi/orb/models/event_update_response.rbi +11 -3
  269. data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
  270. data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
  271. data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
  272. data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
  273. data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
  274. data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
  275. data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
  276. data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
  277. data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
  278. data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
  279. data/rbi/orb/models/events/event_volumes.rbi +38 -10
  280. data/rbi/orb/models/events/volume_list_params.rbi +21 -15
  281. data/rbi/orb/models/invoice.rbi +1411 -805
  282. data/rbi/orb/models/invoice_create_params.rbi +107 -69
  283. data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
  284. data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
  285. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
  286. data/rbi/orb/models/invoice_issue_params.rbi +17 -5
  287. data/rbi/orb/models/invoice_level_discount.rbi +11 -4
  288. data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
  289. data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
  290. data/rbi/orb/models/invoice_list_params.rbi +68 -47
  291. data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
  292. data/rbi/orb/models/invoice_pay_params.rbi +11 -4
  293. data/rbi/orb/models/invoice_update_params.rbi +16 -10
  294. data/rbi/orb/models/invoice_void_params.rbi +11 -4
  295. data/rbi/orb/models/item.rbi +90 -39
  296. data/rbi/orb/models/item_create_params.rbi +15 -5
  297. data/rbi/orb/models/item_fetch_params.rbi +11 -4
  298. data/rbi/orb/models/item_list_params.rbi +17 -6
  299. data/rbi/orb/models/item_update_params.rbi +86 -39
  300. data/rbi/orb/models/metric_create_params.rbi +20 -16
  301. data/rbi/orb/models/metric_fetch_params.rbi +11 -4
  302. data/rbi/orb/models/metric_list_params.rbi +21 -17
  303. data/rbi/orb/models/metric_update_params.rbi +16 -10
  304. data/rbi/orb/models/pagination_metadata.rbi +17 -4
  305. data/rbi/orb/models/percentage_discount.rbi +33 -19
  306. data/rbi/orb/models/plan.rbi +532 -365
  307. data/rbi/orb/models/plan_create_params.rbi +5295 -2870
  308. data/rbi/orb/models/plan_fetch_params.rbi +11 -4
  309. data/rbi/orb/models/plan_list_params.rbi +35 -27
  310. data/rbi/orb/models/plan_update_params.rbi +17 -13
  311. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
  312. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
  313. data/rbi/orb/models/price.rbi +11332 -5033
  314. data/rbi/orb/models/price_create_params.rbi +583 -245
  315. data/rbi/orb/models/price_evaluate_params.rbi +21 -17
  316. data/rbi/orb/models/price_evaluate_response.rbi +14 -6
  317. data/rbi/orb/models/price_fetch_params.rbi +11 -4
  318. data/rbi/orb/models/price_list_params.rbi +17 -6
  319. data/rbi/orb/models/price_update_params.rbi +16 -10
  320. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
  321. data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
  322. data/rbi/orb/models/subscription.rbi +668 -420
  323. data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
  324. data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
  325. data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
  326. data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
  327. data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
  328. data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
  329. data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
  330. data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
  331. data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
  332. data/rbi/orb/models/subscription_create_response.rbi +817 -438
  333. data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
  334. data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
  335. data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
  336. data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
  337. data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
  338. data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
  339. data/rbi/orb/models/subscription_list_params.rbi +42 -28
  340. data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
  341. data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
  342. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
  343. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
  344. data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
  345. data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
  346. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
  347. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
  348. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
  349. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
  350. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
  351. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
  352. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
  353. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
  354. data/rbi/orb/models/subscription_update_params.rbi +22 -16
  355. data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
  356. data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
  357. data/rbi/orb/models/subscription_usage.rbi +325 -121
  358. data/rbi/orb/models/subscriptions.rbi +19 -11
  359. data/rbi/orb/models/top_level_ping_params.rbi +11 -4
  360. data/rbi/orb/models/top_level_ping_response.rbi +10 -3
  361. data/rbi/orb/models/trial_discount.rbi +30 -20
  362. data/rbi/orb/models/usage_discount.rbi +29 -19
  363. data/rbi/orb/models.rbi +22 -11
  364. data/rbi/orb/request_options.rbi +12 -6
  365. data/rbi/orb/resources/alerts.rbi +61 -40
  366. data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
  367. data/rbi/orb/resources/coupons.rbi +33 -18
  368. data/rbi/orb/resources/credit_notes.rbi +22 -13
  369. data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
  370. data/rbi/orb/resources/customers/costs.rbi +18 -11
  371. data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
  372. data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
  373. data/rbi/orb/resources/customers/credits.rbi +16 -7
  374. data/rbi/orb/resources/customers.rbi +137 -72
  375. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
  376. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
  377. data/rbi/orb/resources/events/backfills.rbi +35 -17
  378. data/rbi/orb/resources/events/volume.rbi +7 -5
  379. data/rbi/orb/resources/events.rbi +26 -16
  380. data/rbi/orb/resources/invoice_line_items.rbi +7 -5
  381. data/rbi/orb/resources/invoices.rbi +72 -41
  382. data/rbi/orb/resources/items.rbi +40 -13
  383. data/rbi/orb/resources/metrics.rbi +25 -15
  384. data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
  385. data/rbi/orb/resources/plans.rbi +57 -47
  386. data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
  387. data/rbi/orb/resources/prices.rbi +176 -156
  388. data/rbi/orb/resources/subscription_changes.rbi +19 -11
  389. data/rbi/orb/resources/subscriptions.rbi +200 -114
  390. data/rbi/orb/resources/top_level.rbi +9 -3
  391. data/sig/orb/internal/page.rbs +0 -2
  392. data/sig/orb/internal/transport/base_client.rbs +16 -1
  393. data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
  394. data/sig/orb/internal/type/base_model.rbs +11 -5
  395. data/sig/orb/internal/type/base_page.rbs +1 -1
  396. data/sig/orb/internal/type/converter.rbs +2 -0
  397. data/sig/orb/internal/type/enum.rbs +1 -0
  398. data/sig/orb/internal/type/request_parameters.rbs +3 -1
  399. data/sig/orb/internal/type/union.rbs +1 -0
  400. data/sig/orb/internal/util.rbs +13 -0
  401. data/sig/orb/internal.rbs +2 -0
  402. data/sig/orb/models/alert.rbs +19 -31
  403. data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
  404. data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
  405. data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
  406. data/sig/orb/models/alert_disable_params.rbs +0 -2
  407. data/sig/orb/models/alert_enable_params.rbs +0 -2
  408. data/sig/orb/models/alert_list_params.rbs +0 -2
  409. data/sig/orb/models/alert_retrieve_params.rbs +0 -2
  410. data/sig/orb/models/alert_update_params.rbs +3 -7
  411. data/sig/orb/models/amount_discount.rbs +4 -6
  412. data/sig/orb/models/billable_metric.rbs +7 -9
  413. data/sig/orb/models/coupon.rbs +5 -8
  414. data/sig/orb/models/coupon_archive_params.rbs +0 -2
  415. data/sig/orb/models/coupon_create_params.rbs +3 -9
  416. data/sig/orb/models/coupon_fetch_params.rbs +0 -2
  417. data/sig/orb/models/coupon_list_params.rbs +0 -2
  418. data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
  419. data/sig/orb/models/credit_note.rbs +48 -66
  420. data/sig/orb/models/credit_note_create_params.rbs +3 -7
  421. data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
  422. data/sig/orb/models/credit_note_list_params.rbs +0 -2
  423. data/sig/orb/models/customer.rbs +43 -63
  424. data/sig/orb/models/customer_create_params.rbs +32 -52
  425. data/sig/orb/models/customer_delete_params.rbs +0 -2
  426. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
  427. data/sig/orb/models/customer_fetch_params.rbs +0 -2
  428. data/sig/orb/models/customer_list_params.rbs +0 -2
  429. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
  430. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
  431. data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
  432. data/sig/orb/models/customer_update_params.rbs +32 -52
  433. data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
  434. data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
  435. data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
  436. data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
  437. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
  438. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
  439. data/sig/orb/models/customers/cost_list_params.rbs +0 -2
  440. data/sig/orb/models/customers/cost_list_response.rbs +0 -6
  441. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
  442. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
  443. data/sig/orb/models/customers/credit_list_params.rbs +0 -2
  444. data/sig/orb/models/customers/credit_list_response.rbs +0 -2
  445. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
  446. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
  447. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
  448. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
  449. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
  450. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
  451. data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
  452. data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
  453. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
  454. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
  455. data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
  456. data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
  457. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
  458. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
  459. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
  460. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
  461. data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
  462. data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
  463. data/sig/orb/models/dimensional_price_group.rbs +0 -2
  464. data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
  465. data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
  466. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
  467. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
  468. data/sig/orb/models/dimensional_price_groups.rbs +6 -8
  469. data/sig/orb/models/discount.rbs +5 -5
  470. data/sig/orb/models/evaluate_price_group.rbs +4 -6
  471. data/sig/orb/models/event_deprecate_params.rbs +0 -2
  472. data/sig/orb/models/event_deprecate_response.rbs +0 -2
  473. data/sig/orb/models/event_ingest_params.rbs +3 -7
  474. data/sig/orb/models/event_ingest_response.rbs +0 -6
  475. data/sig/orb/models/event_search_params.rbs +0 -2
  476. data/sig/orb/models/event_search_response.rbs +0 -4
  477. data/sig/orb/models/event_update_params.rbs +0 -2
  478. data/sig/orb/models/event_update_response.rbs +0 -2
  479. data/sig/orb/models/events/backfill_close_params.rbs +0 -2
  480. data/sig/orb/models/events/backfill_close_response.rbs +0 -2
  481. data/sig/orb/models/events/backfill_create_params.rbs +0 -2
  482. data/sig/orb/models/events/backfill_create_response.rbs +0 -2
  483. data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
  484. data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
  485. data/sig/orb/models/events/backfill_list_params.rbs +0 -2
  486. data/sig/orb/models/events/backfill_list_response.rbs +0 -2
  487. data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
  488. data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
  489. data/sig/orb/models/events/event_volumes.rbs +3 -10
  490. data/sig/orb/models/events/volume_list_params.rbs +0 -2
  491. data/sig/orb/models/invoice.rbs +110 -172
  492. data/sig/orb/models/invoice_create_params.rbs +10 -16
  493. data/sig/orb/models/invoice_fetch_params.rbs +0 -2
  494. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
  495. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
  496. data/sig/orb/models/invoice_issue_params.rbs +0 -2
  497. data/sig/orb/models/invoice_level_discount.rbs +2 -4
  498. data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
  499. data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
  500. data/sig/orb/models/invoice_list_params.rbs +4 -6
  501. data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
  502. data/sig/orb/models/invoice_pay_params.rbs +0 -2
  503. data/sig/orb/models/invoice_update_params.rbs +0 -2
  504. data/sig/orb/models/invoice_void_params.rbs +0 -2
  505. data/sig/orb/models/item.rbs +7 -11
  506. data/sig/orb/models/item_create_params.rbs +0 -2
  507. data/sig/orb/models/item_fetch_params.rbs +0 -2
  508. data/sig/orb/models/item_list_params.rbs +0 -2
  509. data/sig/orb/models/item_update_params.rbs +7 -11
  510. data/sig/orb/models/metric_create_params.rbs +0 -2
  511. data/sig/orb/models/metric_fetch_params.rbs +0 -2
  512. data/sig/orb/models/metric_list_params.rbs +0 -2
  513. data/sig/orb/models/metric_update_params.rbs +0 -2
  514. data/sig/orb/models/pagination_metadata.rbs +0 -2
  515. data/sig/orb/models/percentage_discount.rbs +4 -6
  516. data/sig/orb/models/plan.rbs +45 -73
  517. data/sig/orb/models/plan_create_params.rbs +518 -696
  518. data/sig/orb/models/plan_fetch_params.rbs +0 -2
  519. data/sig/orb/models/plan_list_params.rbs +0 -2
  520. data/sig/orb/models/plan_update_params.rbs +0 -2
  521. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
  522. data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
  523. data/sig/orb/models/price.rbs +1194 -1730
  524. data/sig/orb/models/price_create_params.rbs +59 -97
  525. data/sig/orb/models/price_evaluate_params.rbs +0 -2
  526. data/sig/orb/models/price_evaluate_response.rbs +3 -6
  527. data/sig/orb/models/price_fetch_params.rbs +0 -2
  528. data/sig/orb/models/price_list_params.rbs +0 -2
  529. data/sig/orb/models/price_update_params.rbs +0 -2
  530. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
  531. data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
  532. data/sig/orb/models/subscription.rbs +56 -94
  533. data/sig/orb/models/subscription_cancel_params.rbs +0 -2
  534. data/sig/orb/models/subscription_cancel_response.rbs +20 -60
  535. data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
  536. data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
  537. data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
  538. data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
  539. data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
  540. data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
  541. data/sig/orb/models/subscription_create_params.rbs +1103 -1499
  542. data/sig/orb/models/subscription_create_response.rbs +20 -60
  543. data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
  544. data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
  545. data/sig/orb/models/subscription_fetch_params.rbs +0 -2
  546. data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
  547. data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
  548. data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
  549. data/sig/orb/models/subscription_list_params.rbs +0 -2
  550. data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
  551. data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
  552. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
  553. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
  554. data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
  555. data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
  556. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
  557. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
  558. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
  559. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
  560. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
  561. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
  562. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
  563. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
  564. data/sig/orb/models/subscription_update_params.rbs +0 -2
  565. data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
  566. data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
  567. data/sig/orb/models/subscription_usage.rbs +35 -53
  568. data/sig/orb/models/subscriptions.rbs +6 -8
  569. data/sig/orb/models/top_level_ping_params.rbs +0 -2
  570. data/sig/orb/models/top_level_ping_response.rbs +0 -2
  571. data/sig/orb/models/trial_discount.rbs +4 -6
  572. data/sig/orb/models/usage_discount.rbs +4 -6
  573. data/sig/orb/request_options.rbs +1 -1
  574. data/sig/orb/resources/alerts.rbs +12 -12
  575. data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
  576. data/sig/orb/resources/coupons.rbs +4 -4
  577. data/sig/orb/resources/credit_notes.rbs +4 -4
  578. data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
  579. data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
  580. data/sig/orb/resources/customers.rbs +24 -24
  581. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
  582. data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
  583. data/sig/orb/resources/events/volume.rbs +1 -1
  584. data/sig/orb/resources/events.rbs +1 -1
  585. data/sig/orb/resources/invoices.rbs +10 -10
  586. data/sig/orb/resources/items.rbs +5 -5
  587. data/sig/orb/resources/metrics.rbs +4 -4
  588. data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
  589. data/sig/orb/resources/plans.rbs +5 -5
  590. data/sig/orb/resources/prices.rbs +11 -11
  591. data/sig/orb/resources/subscriptions.rbs +21 -21
  592. metadata +2 -2
@@ -18,13 +18,13 @@ module Orb
18
18
 
19
19
  # @!attribute auto_collection
20
20
  #
21
- # @return [Orb::Models::Invoice::AutoCollection]
22
- required :auto_collection, -> { Orb::Models::Invoice::AutoCollection }
21
+ # @return [Orb::Invoice::AutoCollection]
22
+ required :auto_collection, -> { Orb::Invoice::AutoCollection }
23
23
 
24
24
  # @!attribute billing_address
25
25
  #
26
- # @return [Orb::Models::Invoice::BillingAddress, nil]
27
- required :billing_address, -> { Orb::Models::Invoice::BillingAddress }, nil?: true
26
+ # @return [Orb::Invoice::BillingAddress, nil]
27
+ required :billing_address, -> { Orb::Invoice::BillingAddress }, nil?: true
28
28
 
29
29
  # @!attribute created_at
30
30
  # The creation time of the resource in Orb.
@@ -35,8 +35,8 @@ module Orb
35
35
  # @!attribute credit_notes
36
36
  # A list of credit notes associated with the invoice
37
37
  #
38
- # @return [Array<Orb::Models::Invoice::CreditNote>]
39
- required :credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice::CreditNote] }
38
+ # @return [Array<Orb::Invoice::CreditNote>]
39
+ required :credit_notes, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::CreditNote] }
40
40
 
41
41
  # @!attribute currency
42
42
  # An ISO 4217 currency string or `credits`
@@ -46,14 +46,14 @@ module Orb
46
46
 
47
47
  # @!attribute customer
48
48
  #
49
- # @return [Orb::Models::Invoice::Customer]
50
- required :customer, -> { Orb::Models::Invoice::Customer }
49
+ # @return [Orb::Invoice::Customer]
50
+ required :customer, -> { Orb::Invoice::Customer }
51
51
 
52
52
  # @!attribute customer_balance_transactions
53
53
  #
54
- # @return [Array<Orb::Models::Invoice::CustomerBalanceTransaction>]
54
+ # @return [Array<Orb::Invoice::CustomerBalanceTransaction>]
55
55
  required :customer_balance_transactions,
56
- -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice::CustomerBalanceTransaction] }
56
+ -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::CustomerBalanceTransaction] }
57
57
 
58
58
  # @!attribute customer_tax_id
59
59
  # Tax IDs are commonly required to be displayed on customer invoices, which are
@@ -162,8 +162,8 @@ module Orb
162
162
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
163
163
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
164
164
  #
165
- # @return [Orb::Models::Invoice::CustomerTaxID, nil]
166
- required :customer_tax_id, -> { Orb::Models::Invoice::CustomerTaxID }, nil?: true
165
+ # @return [Orb::Invoice::CustomerTaxID, nil]
166
+ required :customer_tax_id, -> { Orb::Invoice::CustomerTaxID }, nil?: true
167
167
 
168
168
  # @!attribute discount
169
169
  # @deprecated
@@ -177,8 +177,8 @@ module Orb
177
177
 
178
178
  # @!attribute discounts
179
179
  #
180
- # @return [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
181
- required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLevelDiscount] }
180
+ # @return [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
181
+ required :discounts, -> { Orb::Internal::Type::ArrayOf[union: Orb::InvoiceLevelDiscount] }
182
182
 
183
183
  # @!attribute due_date
184
184
  # When the invoice payment is due. The due date is null if the invoice is not yet
@@ -224,8 +224,8 @@ module Orb
224
224
 
225
225
  # @!attribute invoice_source
226
226
  #
227
- # @return [Symbol, Orb::Models::Invoice::InvoiceSource]
228
- required :invoice_source, enum: -> { Orb::Models::Invoice::InvoiceSource }
227
+ # @return [Symbol, Orb::Invoice::InvoiceSource]
228
+ required :invoice_source, enum: -> { Orb::Invoice::InvoiceSource }
229
229
 
230
230
  # @!attribute issue_failed_at
231
231
  # If the invoice failed to issue, this will be the last time it failed to issue
@@ -244,13 +244,13 @@ module Orb
244
244
  # @!attribute line_items
245
245
  # The breakdown of prices in this invoice.
246
246
  #
247
- # @return [Array<Orb::Models::Invoice::LineItem>]
248
- required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice::LineItem] }
247
+ # @return [Array<Orb::Invoice::LineItem>]
248
+ required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem] }
249
249
 
250
250
  # @!attribute maximum
251
251
  #
252
- # @return [Orb::Models::Invoice::Maximum, nil]
253
- required :maximum, -> { Orb::Models::Invoice::Maximum }, nil?: true
252
+ # @return [Orb::Invoice::Maximum, nil]
253
+ required :maximum, -> { Orb::Invoice::Maximum }, nil?: true
254
254
 
255
255
  # @!attribute maximum_amount
256
256
  #
@@ -274,8 +274,8 @@ module Orb
274
274
 
275
275
  # @!attribute minimum
276
276
  #
277
- # @return [Orb::Models::Invoice::Minimum, nil]
278
- required :minimum, -> { Orb::Models::Invoice::Minimum }, nil?: true
277
+ # @return [Orb::Invoice::Minimum, nil]
278
+ required :minimum, -> { Orb::Invoice::Minimum }, nil?: true
279
279
 
280
280
  # @!attribute minimum_amount
281
281
  #
@@ -292,8 +292,8 @@ module Orb
292
292
  # @!attribute payment_attempts
293
293
  # A list of payment attempts associated with the invoice
294
294
  #
295
- # @return [Array<Orb::Models::Invoice::PaymentAttempt>]
296
- required :payment_attempts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice::PaymentAttempt] }
295
+ # @return [Array<Orb::Invoice::PaymentAttempt>]
296
+ required :payment_attempts, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::PaymentAttempt] }
297
297
 
298
298
  # @!attribute payment_failed_at
299
299
  # If payment was attempted on this invoice but failed, this will be the time of
@@ -319,18 +319,18 @@ module Orb
319
319
 
320
320
  # @!attribute shipping_address
321
321
  #
322
- # @return [Orb::Models::Invoice::ShippingAddress, nil]
323
- required :shipping_address, -> { Orb::Models::Invoice::ShippingAddress }, nil?: true
322
+ # @return [Orb::Invoice::ShippingAddress, nil]
323
+ required :shipping_address, -> { Orb::Invoice::ShippingAddress }, nil?: true
324
324
 
325
325
  # @!attribute status
326
326
  #
327
- # @return [Symbol, Orb::Models::Invoice::Status]
328
- required :status, enum: -> { Orb::Models::Invoice::Status }
327
+ # @return [Symbol, Orb::Invoice::Status]
328
+ required :status, enum: -> { Orb::Invoice::Status }
329
329
 
330
330
  # @!attribute subscription
331
331
  #
332
- # @return [Orb::Models::Invoice::Subscription, nil]
333
- required :subscription, -> { Orb::Models::Invoice::Subscription }, nil?: true
332
+ # @return [Orb::Invoice::Subscription, nil]
333
+ required :subscription, -> { Orb::Invoice::Subscription }, nil?: true
334
334
 
335
335
  # @!attribute subtotal
336
336
  # The total before any discounts and minimums are applied.
@@ -367,8 +367,8 @@ module Orb
367
367
  required :will_auto_issue, Orb::Internal::Type::Boolean
368
368
 
369
369
  # @!method initialize(id:, amount_due:, auto_collection:, billing_address:, created_at:, credit_notes:, currency:, customer:, customer_balance_transactions:, customer_tax_id:, discount:, discounts:, due_date:, eligible_to_issue_at:, hosted_invoice_url:, invoice_date:, invoice_number:, invoice_pdf:, invoice_source:, issue_failed_at:, issued_at:, line_items:, maximum:, maximum_amount:, memo:, metadata:, minimum:, minimum_amount:, paid_at:, payment_attempts:, payment_failed_at:, payment_started_at:, scheduled_issue_at:, shipping_address:, status:, subscription:, subtotal:, sync_failed_at:, total:, voided_at:, will_auto_issue:)
370
- # Some parameter documentations has been truncated, see {Orb::Models::Invoice} for
371
- # more details.
370
+ # Some parameter documentations has been truncated, see {Orb::Invoice} for more
371
+ # details.
372
372
  #
373
373
  # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
374
374
  # representing the request for payment for a single subscription. This includes a
@@ -379,104 +379,86 @@ module Orb
379
379
  # @param id [String]
380
380
  #
381
381
  # @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
382
- # ...
383
382
  #
384
- # @param auto_collection [Orb::Models::Invoice::AutoCollection]
383
+ # @param auto_collection [Orb::Invoice::AutoCollection]
385
384
  #
386
- # @param billing_address [Orb::Models::Invoice::BillingAddress, nil]
385
+ # @param billing_address [Orb::Invoice::BillingAddress, nil]
387
386
  #
388
387
  # @param created_at [Time] The creation time of the resource in Orb.
389
388
  #
390
- # @param credit_notes [Array<Orb::Models::Invoice::CreditNote>] A list of credit notes associated with the invoice
389
+ # @param credit_notes [Array<Orb::Invoice::CreditNote>] A list of credit notes associated with the invoice
391
390
  #
392
391
  # @param currency [String] An ISO 4217 currency string or `credits`
393
392
  #
394
- # @param customer [Orb::Models::Invoice::Customer]
393
+ # @param customer [Orb::Invoice::Customer]
395
394
  #
396
- # @param customer_balance_transactions [Array<Orb::Models::Invoice::CustomerBalanceTransaction>]
395
+ # @param customer_balance_transactions [Array<Orb::Invoice::CustomerBalanceTransaction>]
397
396
  #
398
- # @param customer_tax_id [Orb::Models::Invoice::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
399
- # ...
397
+ # @param customer_tax_id [Orb::Invoice::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
400
398
  #
401
399
  # @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
402
- # ...
403
400
  #
404
- # @param discounts [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
401
+ # @param discounts [Array<Orb::PercentageDiscount, Orb::AmountDiscount, Orb::TrialDiscount>]
405
402
  #
406
403
  # @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
407
- # ...
408
404
  #
409
405
  # @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
410
- # ...
411
406
  #
412
407
  # @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the
413
- # ...
414
408
  #
415
409
  # @param invoice_date [Time] The scheduled date of the invoice
416
410
  #
417
411
  # @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv
418
- # ...
419
412
  #
420
413
  # @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
421
414
  #
422
- # @param invoice_source [Symbol, Orb::Models::Invoice::InvoiceSource]
415
+ # @param invoice_source [Symbol, Orb::Invoice::InvoiceSource]
423
416
  #
424
417
  # @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
425
- # ...
426
418
  #
427
419
  # @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
428
- # ...
429
420
  #
430
- # @param line_items [Array<Orb::Models::Invoice::LineItem>] The breakdown of prices in this invoice.
421
+ # @param line_items [Array<Orb::Invoice::LineItem>] The breakdown of prices in this invoice.
431
422
  #
432
- # @param maximum [Orb::Models::Invoice::Maximum, nil]
423
+ # @param maximum [Orb::Invoice::Maximum, nil]
433
424
  #
434
425
  # @param maximum_amount [String, nil]
435
426
  #
436
427
  # @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
437
- # ...
438
428
  #
439
429
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
440
- # ...
441
430
  #
442
- # @param minimum [Orb::Models::Invoice::Minimum, nil]
431
+ # @param minimum [Orb::Invoice::Minimum, nil]
443
432
  #
444
433
  # @param minimum_amount [String, nil]
445
434
  #
446
435
  # @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
447
- # ...
448
436
  #
449
- # @param payment_attempts [Array<Orb::Models::Invoice::PaymentAttempt>] A list of payment attempts associated with the invoice
437
+ # @param payment_attempts [Array<Orb::Invoice::PaymentAttempt>] A list of payment attempts associated with the invoice
450
438
  #
451
439
  # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
452
- # ...
453
440
  #
454
441
  # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
455
- # ...
456
442
  #
457
443
  # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
458
- # ...
459
444
  #
460
- # @param shipping_address [Orb::Models::Invoice::ShippingAddress, nil]
445
+ # @param shipping_address [Orb::Invoice::ShippingAddress, nil]
461
446
  #
462
- # @param status [Symbol, Orb::Models::Invoice::Status]
447
+ # @param status [Symbol, Orb::Invoice::Status]
463
448
  #
464
- # @param subscription [Orb::Models::Invoice::Subscription, nil]
449
+ # @param subscription [Orb::Invoice::Subscription, nil]
465
450
  #
466
451
  # @param subtotal [String] The total before any discounts and minimums are applied.
467
452
  #
468
453
  # @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing
469
- # ...
470
454
  #
471
455
  # @param total [String] The total after any minimums and discounts have been applied.
472
456
  #
473
457
  # @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w
474
- # ...
475
458
  #
476
459
  # @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
477
- # ...
478
460
 
479
- # @see Orb::Models::Invoice#auto_collection
461
+ # @see Orb::Invoice#auto_collection
480
462
  class AutoCollection < Orb::Internal::Type::BaseModel
481
463
  # @!attribute enabled
482
464
  # True only if auto-collection is enabled for this invoice.
@@ -511,20 +493,18 @@ module Orb
511
493
 
512
494
  # @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
513
495
  # Some parameter documentations has been truncated, see
514
- # {Orb::Models::Invoice::AutoCollection} for more details.
496
+ # {Orb::Invoice::AutoCollection} for more details.
515
497
  #
516
498
  # @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
517
499
  #
518
500
  # @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th
519
- # ...
520
501
  #
521
502
  # @param num_attempts [Integer, nil] Number of auto-collection payment attempts.
522
503
  #
523
504
  # @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
524
- # ...
525
505
  end
526
506
 
527
- # @see Orb::Models::Invoice#billing_address
507
+ # @see Orb::Invoice#billing_address
528
508
  class BillingAddress < Orb::Internal::Type::BaseModel
529
509
  # @!attribute city
530
510
  #
@@ -605,8 +585,8 @@ module Orb
605
585
  required :voided_at, Time, nil?: true
606
586
 
607
587
  # @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
608
- # Some parameter documentations has been truncated, see
609
- # {Orb::Models::Invoice::CreditNote} for more details.
588
+ # Some parameter documentations has been truncated, see {Orb::Invoice::CreditNote}
589
+ # for more details.
610
590
  #
611
591
  # @param id [String]
612
592
  #
@@ -621,10 +601,9 @@ module Orb
621
601
  # @param type [String]
622
602
  #
623
603
  # @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
624
- # ...
625
604
  end
626
605
 
627
- # @see Orb::Models::Invoice#customer
606
+ # @see Orb::Invoice#customer
628
607
  class Customer < Orb::Internal::Type::BaseModel
629
608
  # @!attribute id
630
609
  #
@@ -650,8 +629,8 @@ module Orb
650
629
 
651
630
  # @!attribute action
652
631
  #
653
- # @return [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action]
654
- required :action, enum: -> { Orb::Models::Invoice::CustomerBalanceTransaction::Action }
632
+ # @return [Symbol, Orb::Invoice::CustomerBalanceTransaction::Action]
633
+ required :action, enum: -> { Orb::Invoice::CustomerBalanceTransaction::Action }
655
634
 
656
635
  # @!attribute amount
657
636
  # The value of the amount changed in the transaction.
@@ -667,8 +646,8 @@ module Orb
667
646
 
668
647
  # @!attribute credit_note
669
648
  #
670
- # @return [Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, nil]
671
- required :credit_note, -> { Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote }, nil?: true
649
+ # @return [Orb::Invoice::CustomerBalanceTransaction::CreditNote, nil]
650
+ required :credit_note, -> { Orb::Invoice::CustomerBalanceTransaction::CreditNote }, nil?: true
672
651
 
673
652
  # @!attribute description
674
653
  # An optional description provided for manual customer balance adjustments.
@@ -685,8 +664,8 @@ module Orb
685
664
 
686
665
  # @!attribute invoice
687
666
  #
688
- # @return [Orb::Models::Invoice::CustomerBalanceTransaction::Invoice, nil]
689
- required :invoice, -> { Orb::Models::Invoice::CustomerBalanceTransaction::Invoice }, nil?: true
667
+ # @return [Orb::Invoice::CustomerBalanceTransaction::Invoice, nil]
668
+ required :invoice, -> { Orb::Invoice::CustomerBalanceTransaction::Invoice }, nil?: true
690
669
 
691
670
  # @!attribute starting_balance
692
671
  # The original value of the customer's balance prior to the transaction, in the
@@ -697,36 +676,34 @@ module Orb
697
676
 
698
677
  # @!attribute type
699
678
  #
700
- # @return [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type]
701
- required :type, enum: -> { Orb::Models::Invoice::CustomerBalanceTransaction::Type }
679
+ # @return [Symbol, Orb::Invoice::CustomerBalanceTransaction::Type]
680
+ required :type, enum: -> { Orb::Invoice::CustomerBalanceTransaction::Type }
702
681
 
703
682
  # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
704
683
  # Some parameter documentations has been truncated, see
705
- # {Orb::Models::Invoice::CustomerBalanceTransaction} for more details.
684
+ # {Orb::Invoice::CustomerBalanceTransaction} for more details.
706
685
  #
707
686
  # @param id [String] A unique id for this transaction.
708
687
  #
709
- # @param action [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action]
688
+ # @param action [Symbol, Orb::Invoice::CustomerBalanceTransaction::Action]
710
689
  #
711
690
  # @param amount [String] The value of the amount changed in the transaction.
712
691
  #
713
692
  # @param created_at [Time] The creation time of this transaction.
714
693
  #
715
- # @param credit_note [Orb::Models::Invoice::CustomerBalanceTransaction::CreditNote, nil]
694
+ # @param credit_note [Orb::Invoice::CustomerBalanceTransaction::CreditNote, nil]
716
695
  #
717
696
  # @param description [String, nil] An optional description provided for manual customer balance adjustments.
718
697
  #
719
698
  # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
720
- # ...
721
699
  #
722
- # @param invoice [Orb::Models::Invoice::CustomerBalanceTransaction::Invoice, nil]
700
+ # @param invoice [Orb::Invoice::CustomerBalanceTransaction::Invoice, nil]
723
701
  #
724
702
  # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
725
- # ...
726
703
  #
727
- # @param type [Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type]
704
+ # @param type [Symbol, Orb::Invoice::CustomerBalanceTransaction::Type]
728
705
 
729
- # @see Orb::Models::Invoice::CustomerBalanceTransaction#action
706
+ # @see Orb::Invoice::CustomerBalanceTransaction#action
730
707
  module Action
731
708
  extend Orb::Internal::Type::Enum
732
709
 
@@ -744,7 +721,7 @@ module Orb
744
721
  # @return [Array<Symbol>]
745
722
  end
746
723
 
747
- # @see Orb::Models::Invoice::CustomerBalanceTransaction#credit_note
724
+ # @see Orb::Invoice::CustomerBalanceTransaction#credit_note
748
725
  class CreditNote < Orb::Internal::Type::BaseModel
749
726
  # @!attribute id
750
727
  # The id of the Credit note
@@ -756,7 +733,7 @@ module Orb
756
733
  # @param id [String] The id of the Credit note
757
734
  end
758
735
 
759
- # @see Orb::Models::Invoice::CustomerBalanceTransaction#invoice
736
+ # @see Orb::Invoice::CustomerBalanceTransaction#invoice
760
737
  class Invoice < Orb::Internal::Type::BaseModel
761
738
  # @!attribute id
762
739
  # The Invoice id
@@ -768,7 +745,7 @@ module Orb
768
745
  # @param id [String] The Invoice id
769
746
  end
770
747
 
771
- # @see Orb::Models::Invoice::CustomerBalanceTransaction#type
748
+ # @see Orb::Invoice::CustomerBalanceTransaction#type
772
749
  module Type
773
750
  extend Orb::Internal::Type::Enum
774
751
 
@@ -780,17 +757,17 @@ module Orb
780
757
  end
781
758
  end
782
759
 
783
- # @see Orb::Models::Invoice#customer_tax_id
760
+ # @see Orb::Invoice#customer_tax_id
784
761
  class CustomerTaxID < Orb::Internal::Type::BaseModel
785
762
  # @!attribute country
786
763
  #
787
- # @return [Symbol, Orb::Models::Invoice::CustomerTaxID::Country]
788
- required :country, enum: -> { Orb::Models::Invoice::CustomerTaxID::Country }
764
+ # @return [Symbol, Orb::Invoice::CustomerTaxID::Country]
765
+ required :country, enum: -> { Orb::Invoice::CustomerTaxID::Country }
789
766
 
790
767
  # @!attribute type
791
768
  #
792
- # @return [Symbol, Orb::Models::Invoice::CustomerTaxID::Type]
793
- required :type, enum: -> { Orb::Models::Invoice::CustomerTaxID::Type }
769
+ # @return [Symbol, Orb::Invoice::CustomerTaxID::Type]
770
+ required :type, enum: -> { Orb::Invoice::CustomerTaxID::Type }
794
771
 
795
772
  # @!attribute value
796
773
  #
@@ -904,11 +881,11 @@ module Orb
904
881
  # | Venezuela | `ve_rif` | Venezuelan RIF Number |
905
882
  # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
906
883
  #
907
- # @param country [Symbol, Orb::Models::Invoice::CustomerTaxID::Country]
908
- # @param type [Symbol, Orb::Models::Invoice::CustomerTaxID::Type]
884
+ # @param country [Symbol, Orb::Invoice::CustomerTaxID::Country]
885
+ # @param type [Symbol, Orb::Invoice::CustomerTaxID::Type]
909
886
  # @param value [String]
910
887
 
911
- # @see Orb::Models::Invoice::CustomerTaxID#country
888
+ # @see Orb::Invoice::CustomerTaxID#country
912
889
  module Country
913
890
  extend Orb::Internal::Type::Enum
914
891
 
@@ -995,7 +972,7 @@ module Orb
995
972
  # @return [Array<Symbol>]
996
973
  end
997
974
 
998
- # @see Orb::Models::Invoice::CustomerTaxID#type
975
+ # @see Orb::Invoice::CustomerTaxID#type
999
976
  module Type
1000
977
  extend Orb::Internal::Type::Enum
1001
978
 
@@ -1076,7 +1053,7 @@ module Orb
1076
1053
  end
1077
1054
  end
1078
1055
 
1079
- # @see Orb::Models::Invoice#invoice_source
1056
+ # @see Orb::Invoice#invoice_source
1080
1057
  module InvoiceSource
1081
1058
  extend Orb::Internal::Type::Enum
1082
1059
 
@@ -1107,9 +1084,8 @@ module Orb
1107
1084
  # invoice calculations (ie. usage discounts -> amount discounts -> percentage
1108
1085
  # discounts -> minimums -> maximums).
1109
1086
  #
1110
- # @return [Array<Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Models::Invoice::LineItem::Adjustment::Minimum, Orb::Models::Invoice::LineItem::Adjustment::Maximum>]
1111
- required :adjustments,
1112
- -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Invoice::LineItem::Adjustment] }
1087
+ # @return [Array<Orb::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Invoice::LineItem::Adjustment::Minimum, Orb::Invoice::LineItem::Adjustment::Maximum>]
1088
+ required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Invoice::LineItem::Adjustment] }
1113
1089
 
1114
1090
  # @!attribute amount
1115
1091
  # The final amount for a line item after all adjustments and pre paid credits have
@@ -1126,8 +1102,8 @@ module Orb
1126
1102
 
1127
1103
  # @!attribute discount
1128
1104
  #
1129
- # @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
1130
- required :discount, union: -> { Orb::Models::Discount }, nil?: true
1105
+ # @return [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
1106
+ required :discount, union: -> { Orb::Discount }, nil?: true
1131
1107
 
1132
1108
  # @!attribute end_date
1133
1109
  # The end date of the range of time applied for this line item's price.
@@ -1154,8 +1130,8 @@ module Orb
1154
1130
  #
1155
1131
  # This field is deprecated in favor of `adjustments`.
1156
1132
  #
1157
- # @return [Orb::Models::Invoice::LineItem::Maximum, nil]
1158
- required :maximum, -> { Orb::Models::Invoice::LineItem::Maximum }, nil?: true
1133
+ # @return [Orb::Invoice::LineItem::Maximum, nil]
1134
+ required :maximum, -> { Orb::Invoice::LineItem::Maximum }, nil?: true
1159
1135
 
1160
1136
  # @!attribute maximum_amount
1161
1137
  # @deprecated
@@ -1170,8 +1146,8 @@ module Orb
1170
1146
  #
1171
1147
  # This field is deprecated in favor of `adjustments`.
1172
1148
  #
1173
- # @return [Orb::Models::Invoice::LineItem::Minimum, nil]
1174
- required :minimum, -> { Orb::Models::Invoice::LineItem::Minimum }, nil?: true
1149
+ # @return [Orb::Invoice::LineItem::Minimum, nil]
1150
+ required :minimum, -> { Orb::Invoice::LineItem::Minimum }, nil?: true
1175
1151
 
1176
1152
  # @!attribute minimum_amount
1177
1153
  # @deprecated
@@ -1205,8 +1181,8 @@ module Orb
1205
1181
  # For more on the types of prices, see
1206
1182
  # [the core concepts documentation](/core-concepts#plan-and-price)
1207
1183
  #
1208
- # @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, nil]
1209
- required :price, union: -> { Orb::Models::Price }, nil?: true
1184
+ # @return [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil]
1185
+ required :price, union: -> { Orb::Price }, nil?: true
1210
1186
 
1211
1187
  # @!attribute quantity
1212
1188
  # Either the fixed fee quantity or the usage during the service period.
@@ -1224,9 +1200,11 @@ module Orb
1224
1200
  # For complex pricing structures, the line item can be broken down further in
1225
1201
  # `sub_line_items`.
1226
1202
  #
1227
- # @return [Array<Orb::Models::Invoice::LineItem::SubLineItem::Matrix, Orb::Models::Invoice::LineItem::SubLineItem::Tier, Orb::Models::Invoice::LineItem::SubLineItem::Null>]
1203
+ # @return [Array<Orb::Invoice::LineItem::SubLineItem::Matrix, Orb::Invoice::LineItem::SubLineItem::Tier, Orb::Invoice::LineItem::SubLineItem::Null>]
1228
1204
  required :sub_line_items,
1229
- -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Invoice::LineItem::SubLineItem] }
1205
+ -> {
1206
+ Orb::Internal::Type::ArrayOf[union: Orb::Invoice::LineItem::SubLineItem]
1207
+ }
1230
1208
 
1231
1209
  # @!attribute subtotal
1232
1210
  # The line amount before before any adjustments.
@@ -1238,8 +1216,8 @@ module Orb
1238
1216
  # An array of tax rates and their incurred tax amounts. Empty if no tax
1239
1217
  # integration is configured.
1240
1218
  #
1241
- # @return [Array<Orb::Models::Invoice::LineItem::TaxAmount>]
1242
- required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::Models::Invoice::LineItem::TaxAmount] }
1219
+ # @return [Array<Orb::Invoice::LineItem::TaxAmount>]
1220
+ required :tax_amounts, -> { Orb::Internal::Type::ArrayOf[Orb::Invoice::LineItem::TaxAmount] }
1243
1221
 
1244
1222
  # @!attribute usage_customer_ids
1245
1223
  # A list of customer ids that were used to calculate the usage for this line item.
@@ -1248,36 +1226,32 @@ module Orb
1248
1226
  required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
1249
1227
 
1250
1228
  # @!method initialize(id:, adjusted_subtotal:, adjustments:, amount:, credits_applied:, discount:, end_date:, filter:, grouping:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, partially_invoiced_amount:, price:, quantity:, start_date:, sub_line_items:, subtotal:, tax_amounts:, usage_customer_ids:)
1251
- # Some parameter documentations has been truncated, see
1252
- # {Orb::Models::Invoice::LineItem} for more details.
1229
+ # Some parameter documentations has been truncated, see {Orb::Invoice::LineItem}
1230
+ # for more details.
1253
1231
  #
1254
1232
  # @param id [String] A unique ID for this line item.
1255
1233
  #
1256
1234
  # @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
1257
- # ...
1258
1235
  #
1259
- # @param adjustments [Array<Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Models::Invoice::LineItem::Adjustment::Minimum, Orb::Models::Invoice::LineItem::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
1260
- # ...
1236
+ # @param adjustments [Array<Orb::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Invoice::LineItem::Adjustment::Minimum, Orb::Invoice::LineItem::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
1261
1237
  #
1262
1238
  # @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
1263
- # ...
1264
1239
  #
1265
1240
  # @param credits_applied [String] The number of prepaid credits applied.
1266
1241
  #
1267
- # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
1242
+ # @param discount [Orb::PercentageDiscount, Orb::TrialDiscount, Orb::UsageDiscount, Orb::AmountDiscount, nil]
1268
1243
  #
1269
1244
  # @param end_date [Time] The end date of the range of time applied for this line item's price.
1270
1245
  #
1271
1246
  # @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
1272
1247
  #
1273
1248
  # @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
1274
- # ...
1275
1249
  #
1276
- # @param maximum [Orb::Models::Invoice::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
1250
+ # @param maximum [Orb::Invoice::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
1277
1251
  #
1278
1252
  # @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
1279
1253
  #
1280
- # @param minimum [Orb::Models::Invoice::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`.
1254
+ # @param minimum [Orb::Invoice::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`.
1281
1255
  #
1282
1256
  # @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
1283
1257
  #
@@ -1285,38 +1259,34 @@ module Orb
1285
1259
  #
1286
1260
  # @param partially_invoiced_amount [String] Any amount applied from a partial invoice
1287
1261
  #
1288
- # @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, nil] The Price resource represents a price that can be billed on a subscription, resu
1289
- # ...
1262
+ # @param price [Orb::Price::Unit, Orb::Price::Package, Orb::Price::Matrix, Orb::Price::Tiered, Orb::Price::TieredBps, Orb::Price::Bps, Orb::Price::BulkBps, Orb::Price::Bulk, Orb::Price::ThresholdTotalAmount, Orb::Price::TieredPackage, Orb::Price::GroupedTiered, Orb::Price::TieredWithMinimum, Orb::Price::TieredPackageWithMinimum, Orb::Price::PackageWithAllocation, Orb::Price::UnitWithPercent, Orb::Price::MatrixWithAllocation, Orb::Price::TieredWithProration, Orb::Price::UnitWithProration, Orb::Price::GroupedAllocation, Orb::Price::GroupedWithProratedMinimum, Orb::Price::GroupedWithMeteredMinimum, Orb::Price::MatrixWithDisplayName, Orb::Price::BulkWithProration, Orb::Price::GroupedTieredPackage, Orb::Price::MaxGroupTieredPackage, Orb::Price::ScalableMatrixWithUnitPricing, Orb::Price::ScalableMatrixWithTieredPricing, Orb::Price::CumulativeGroupedBulk, nil] The Price resource represents a price that can be billed on a subscription, resu
1290
1263
  #
1291
1264
  # @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
1292
1265
  #
1293
1266
  # @param start_date [Time] The start date of the range of time applied for this line item's price.
1294
1267
  #
1295
- # @param sub_line_items [Array<Orb::Models::Invoice::LineItem::SubLineItem::Matrix, Orb::Models::Invoice::LineItem::SubLineItem::Tier, Orb::Models::Invoice::LineItem::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
1296
- # ...
1268
+ # @param sub_line_items [Array<Orb::Invoice::LineItem::SubLineItem::Matrix, Orb::Invoice::LineItem::SubLineItem::Tier, Orb::Invoice::LineItem::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
1297
1269
  #
1298
1270
  # @param subtotal [String] The line amount before before any adjustments.
1299
1271
  #
1300
- # @param tax_amounts [Array<Orb::Models::Invoice::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
1301
- # ...
1272
+ # @param tax_amounts [Array<Orb::Invoice::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
1302
1273
  #
1303
1274
  # @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
1304
- # ...
1305
1275
 
1306
1276
  module Adjustment
1307
1277
  extend Orb::Internal::Type::Union
1308
1278
 
1309
1279
  discriminator :adjustment_type
1310
1280
 
1311
- variant :usage_discount, -> { Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount }
1281
+ variant :usage_discount, -> { Orb::Invoice::LineItem::Adjustment::UsageDiscount }
1312
1282
 
1313
- variant :amount_discount, -> { Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount }
1283
+ variant :amount_discount, -> { Orb::Invoice::LineItem::Adjustment::AmountDiscount }
1314
1284
 
1315
- variant :percentage_discount, -> { Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount }
1285
+ variant :percentage_discount, -> { Orb::Invoice::LineItem::Adjustment::PercentageDiscount }
1316
1286
 
1317
- variant :minimum, -> { Orb::Models::Invoice::LineItem::Adjustment::Minimum }
1287
+ variant :minimum, -> { Orb::Invoice::LineItem::Adjustment::Minimum }
1318
1288
 
1319
- variant :maximum, -> { Orb::Models::Invoice::LineItem::Adjustment::Maximum }
1289
+ variant :maximum, -> { Orb::Invoice::LineItem::Adjustment::Maximum }
1320
1290
 
1321
1291
  class UsageDiscount < Orb::Internal::Type::BaseModel
1322
1292
  # @!attribute id
@@ -1363,7 +1333,7 @@ module Orb
1363
1333
 
1364
1334
  # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
1365
1335
  # Some parameter documentations has been truncated, see
1366
- # {Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount} for more details.
1336
+ # {Orb::Invoice::LineItem::Adjustment::UsageDiscount} for more details.
1367
1337
  #
1368
1338
  # @param id [String]
1369
1339
  #
@@ -1372,12 +1342,10 @@ module Orb
1372
1342
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1373
1343
  #
1374
1344
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1375
- # ...
1376
1345
  #
1377
1346
  # @param reason [String, nil] The reason for the adjustment.
1378
1347
  #
1379
1348
  # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
1380
- # ...
1381
1349
  #
1382
1350
  # @param adjustment_type [Symbol, :usage_discount]
1383
1351
  end
@@ -1427,19 +1395,17 @@ module Orb
1427
1395
 
1428
1396
  # @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
1429
1397
  # Some parameter documentations has been truncated, see
1430
- # {Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount} for more details.
1398
+ # {Orb::Invoice::LineItem::Adjustment::AmountDiscount} for more details.
1431
1399
  #
1432
1400
  # @param id [String]
1433
1401
  #
1434
1402
  # @param amount [String] The value applied by an adjustment.
1435
1403
  #
1436
1404
  # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
1437
- # ...
1438
1405
  #
1439
1406
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1440
1407
  #
1441
1408
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1442
- # ...
1443
1409
  #
1444
1410
  # @param reason [String, nil] The reason for the adjustment.
1445
1411
  #
@@ -1491,8 +1457,7 @@ module Orb
1491
1457
 
1492
1458
  # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
1493
1459
  # Some parameter documentations has been truncated, see
1494
- # {Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount} for more
1495
- # details.
1460
+ # {Orb::Invoice::LineItem::Adjustment::PercentageDiscount} for more details.
1496
1461
  #
1497
1462
  # @param id [String]
1498
1463
  #
@@ -1501,10 +1466,8 @@ module Orb
1501
1466
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1502
1467
  #
1503
1468
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1504
- # ...
1505
1469
  #
1506
1470
  # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
1507
- # ...
1508
1471
  #
1509
1472
  # @param reason [String, nil] The reason for the adjustment.
1510
1473
  #
@@ -1562,7 +1525,7 @@ module Orb
1562
1525
 
1563
1526
  # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
1564
1527
  # Some parameter documentations has been truncated, see
1565
- # {Orb::Models::Invoice::LineItem::Adjustment::Minimum} for more details.
1528
+ # {Orb::Invoice::LineItem::Adjustment::Minimum} for more details.
1566
1529
  #
1567
1530
  # @param id [String]
1568
1531
  #
@@ -1571,12 +1534,10 @@ module Orb
1571
1534
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1572
1535
  #
1573
1536
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1574
- # ...
1575
1537
  #
1576
1538
  # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
1577
1539
  #
1578
1540
  # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
1579
- # ...
1580
1541
  #
1581
1542
  # @param reason [String, nil] The reason for the adjustment.
1582
1543
  #
@@ -1628,7 +1589,7 @@ module Orb
1628
1589
 
1629
1590
  # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
1630
1591
  # Some parameter documentations has been truncated, see
1631
- # {Orb::Models::Invoice::LineItem::Adjustment::Maximum} for more details.
1592
+ # {Orb::Invoice::LineItem::Adjustment::Maximum} for more details.
1632
1593
  #
1633
1594
  # @param id [String]
1634
1595
  #
@@ -1637,10 +1598,8 @@ module Orb
1637
1598
  # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1638
1599
  #
1639
1600
  # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1640
- # ...
1641
1601
  #
1642
1602
  # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
1643
- # ...
1644
1603
  #
1645
1604
  # @param reason [String, nil] The reason for the adjustment.
1646
1605
  #
@@ -1648,12 +1607,24 @@ module Orb
1648
1607
  end
1649
1608
 
1650
1609
  # @!method self.variants
1651
- # @return [Array(Orb::Models::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Models::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Models::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Models::Invoice::LineItem::Adjustment::Minimum, Orb::Models::Invoice::LineItem::Adjustment::Maximum)]
1610
+ # @return [Array(Orb::Invoice::LineItem::Adjustment::UsageDiscount, Orb::Invoice::LineItem::Adjustment::AmountDiscount, Orb::Invoice::LineItem::Adjustment::PercentageDiscount, Orb::Invoice::LineItem::Adjustment::Minimum, Orb::Invoice::LineItem::Adjustment::Maximum)]
1611
+
1612
+ define_sorbet_constant!(:Variants) do
1613
+ T.type_alias do
1614
+ T.any(
1615
+ Orb::Invoice::LineItem::Adjustment::UsageDiscount,
1616
+ Orb::Invoice::LineItem::Adjustment::AmountDiscount,
1617
+ Orb::Invoice::LineItem::Adjustment::PercentageDiscount,
1618
+ Orb::Invoice::LineItem::Adjustment::Minimum,
1619
+ Orb::Invoice::LineItem::Adjustment::Maximum
1620
+ )
1621
+ end
1622
+ end
1652
1623
  end
1653
1624
 
1654
1625
  # @deprecated
1655
1626
  #
1656
- # @see Orb::Models::Invoice::LineItem#maximum
1627
+ # @see Orb::Invoice::LineItem#maximum
1657
1628
  class Maximum < Orb::Internal::Type::BaseModel
1658
1629
  # @!attribute applies_to_price_ids
1659
1630
  # List of price_ids that this maximum amount applies to. For plan/plan phase
@@ -1670,19 +1641,18 @@ module Orb
1670
1641
 
1671
1642
  # @!method initialize(applies_to_price_ids:, maximum_amount:)
1672
1643
  # Some parameter documentations has been truncated, see
1673
- # {Orb::Models::Invoice::LineItem::Maximum} for more details.
1644
+ # {Orb::Invoice::LineItem::Maximum} for more details.
1674
1645
  #
1675
1646
  # This field is deprecated in favor of `adjustments`.
1676
1647
  #
1677
1648
  # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
1678
- # ...
1679
1649
  #
1680
1650
  # @param maximum_amount [String] Maximum amount applied
1681
1651
  end
1682
1652
 
1683
1653
  # @deprecated
1684
1654
  #
1685
- # @see Orb::Models::Invoice::LineItem#minimum
1655
+ # @see Orb::Invoice::LineItem#minimum
1686
1656
  class Minimum < Orb::Internal::Type::BaseModel
1687
1657
  # @!attribute applies_to_price_ids
1688
1658
  # List of price_ids that this minimum amount applies to. For plan/plan phase
@@ -1699,12 +1669,11 @@ module Orb
1699
1669
 
1700
1670
  # @!method initialize(applies_to_price_ids:, minimum_amount:)
1701
1671
  # Some parameter documentations has been truncated, see
1702
- # {Orb::Models::Invoice::LineItem::Minimum} for more details.
1672
+ # {Orb::Invoice::LineItem::Minimum} for more details.
1703
1673
  #
1704
1674
  # This field is deprecated in favor of `adjustments`.
1705
1675
  #
1706
1676
  # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
1707
- # ...
1708
1677
  #
1709
1678
  # @param minimum_amount [String] Minimum amount applied
1710
1679
  end
@@ -1714,11 +1683,11 @@ module Orb
1714
1683
 
1715
1684
  discriminator :type
1716
1685
 
1717
- variant :matrix, -> { Orb::Models::Invoice::LineItem::SubLineItem::Matrix }
1686
+ variant :matrix, -> { Orb::Invoice::LineItem::SubLineItem::Matrix }
1718
1687
 
1719
- variant :tier, -> { Orb::Models::Invoice::LineItem::SubLineItem::Tier }
1688
+ variant :tier, -> { Orb::Invoice::LineItem::SubLineItem::Tier }
1720
1689
 
1721
- variant :"'null'", -> { Orb::Models::Invoice::LineItem::SubLineItem::Null }
1690
+ variant :"'null'", -> { Orb::Invoice::LineItem::SubLineItem::Null }
1722
1691
 
1723
1692
  class Matrix < Orb::Internal::Type::BaseModel
1724
1693
  # @!attribute amount
@@ -1729,13 +1698,13 @@ module Orb
1729
1698
 
1730
1699
  # @!attribute grouping
1731
1700
  #
1732
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
1733
- required :grouping, -> { Orb::Models::Invoice::LineItem::SubLineItem::Matrix::Grouping }, nil?: true
1701
+ # @return [Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
1702
+ required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping }, nil?: true
1734
1703
 
1735
1704
  # @!attribute matrix_config
1736
1705
  #
1737
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
1738
- required :matrix_config, -> { Orb::Models::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig }
1706
+ # @return [Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
1707
+ required :matrix_config, -> { Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig }
1739
1708
 
1740
1709
  # @!attribute name
1741
1710
  #
@@ -1755,9 +1724,9 @@ module Orb
1755
1724
  # @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
1756
1725
  # @param amount [String] The total amount for this sub line item.
1757
1726
  #
1758
- # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
1727
+ # @param grouping [Orb::Invoice::LineItem::SubLineItem::Matrix::Grouping, nil]
1759
1728
  #
1760
- # @param matrix_config [Orb::Models::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
1729
+ # @param matrix_config [Orb::Invoice::LineItem::SubLineItem::Matrix::MatrixConfig]
1761
1730
  #
1762
1731
  # @param name [String]
1763
1732
  #
@@ -1765,7 +1734,7 @@ module Orb
1765
1734
  #
1766
1735
  # @param type [Symbol, :matrix]
1767
1736
 
1768
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Matrix#grouping
1737
+ # @see Orb::Invoice::LineItem::SubLineItem::Matrix#grouping
1769
1738
  class Grouping < Orb::Internal::Type::BaseModel
1770
1739
  # @!attribute key
1771
1740
  #
@@ -1784,7 +1753,7 @@ module Orb
1784
1753
  # @param value [String, nil] No value indicates the default group
1785
1754
  end
1786
1755
 
1787
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Matrix#matrix_config
1756
+ # @see Orb::Invoice::LineItem::SubLineItem::Matrix#matrix_config
1788
1757
  class MatrixConfig < Orb::Internal::Type::BaseModel
1789
1758
  # @!attribute dimension_values
1790
1759
  # The ordered dimension values for this line item.
@@ -1806,8 +1775,8 @@ module Orb
1806
1775
 
1807
1776
  # @!attribute grouping
1808
1777
  #
1809
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
1810
- required :grouping, -> { Orb::Models::Invoice::LineItem::SubLineItem::Tier::Grouping }, nil?: true
1778
+ # @return [Orb::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
1779
+ required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Tier::Grouping }, nil?: true
1811
1780
 
1812
1781
  # @!attribute name
1813
1782
  #
@@ -1821,8 +1790,8 @@ module Orb
1821
1790
 
1822
1791
  # @!attribute tier_config
1823
1792
  #
1824
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Tier::TierConfig]
1825
- required :tier_config, -> { Orb::Models::Invoice::LineItem::SubLineItem::Tier::TierConfig }
1793
+ # @return [Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig]
1794
+ required :tier_config, -> { Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig }
1826
1795
 
1827
1796
  # @!attribute type
1828
1797
  #
@@ -1832,17 +1801,17 @@ module Orb
1832
1801
  # @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
1833
1802
  # @param amount [String] The total amount for this sub line item.
1834
1803
  #
1835
- # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
1804
+ # @param grouping [Orb::Invoice::LineItem::SubLineItem::Tier::Grouping, nil]
1836
1805
  #
1837
1806
  # @param name [String]
1838
1807
  #
1839
1808
  # @param quantity [Float]
1840
1809
  #
1841
- # @param tier_config [Orb::Models::Invoice::LineItem::SubLineItem::Tier::TierConfig]
1810
+ # @param tier_config [Orb::Invoice::LineItem::SubLineItem::Tier::TierConfig]
1842
1811
  #
1843
1812
  # @param type [Symbol, :tier]
1844
1813
 
1845
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Tier#grouping
1814
+ # @see Orb::Invoice::LineItem::SubLineItem::Tier#grouping
1846
1815
  class Grouping < Orb::Internal::Type::BaseModel
1847
1816
  # @!attribute key
1848
1817
  #
@@ -1861,7 +1830,7 @@ module Orb
1861
1830
  # @param value [String, nil] No value indicates the default group
1862
1831
  end
1863
1832
 
1864
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Tier#tier_config
1833
+ # @see Orb::Invoice::LineItem::SubLineItem::Tier#tier_config
1865
1834
  class TierConfig < Orb::Internal::Type::BaseModel
1866
1835
  # @!attribute first_unit
1867
1836
  #
@@ -1894,8 +1863,8 @@ module Orb
1894
1863
 
1895
1864
  # @!attribute grouping
1896
1865
  #
1897
- # @return [Orb::Models::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
1898
- required :grouping, -> { Orb::Models::Invoice::LineItem::SubLineItem::Null::Grouping }, nil?: true
1866
+ # @return [Orb::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
1867
+ required :grouping, -> { Orb::Invoice::LineItem::SubLineItem::Null::Grouping }, nil?: true
1899
1868
 
1900
1869
  # @!attribute name
1901
1870
  #
@@ -1915,7 +1884,7 @@ module Orb
1915
1884
  # @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
1916
1885
  # @param amount [String] The total amount for this sub line item.
1917
1886
  #
1918
- # @param grouping [Orb::Models::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
1887
+ # @param grouping [Orb::Invoice::LineItem::SubLineItem::Null::Grouping, nil]
1919
1888
  #
1920
1889
  # @param name [String]
1921
1890
  #
@@ -1923,7 +1892,7 @@ module Orb
1923
1892
  #
1924
1893
  # @param type [Symbol, :"'null'"]
1925
1894
 
1926
- # @see Orb::Models::Invoice::LineItem::SubLineItem::Null#grouping
1895
+ # @see Orb::Invoice::LineItem::SubLineItem::Null#grouping
1927
1896
  class Grouping < Orb::Internal::Type::BaseModel
1928
1897
  # @!attribute key
1929
1898
  #
@@ -1944,7 +1913,17 @@ module Orb
1944
1913
  end
1945
1914
 
1946
1915
  # @!method self.variants
1947
- # @return [Array(Orb::Models::Invoice::LineItem::SubLineItem::Matrix, Orb::Models::Invoice::LineItem::SubLineItem::Tier, Orb::Models::Invoice::LineItem::SubLineItem::Null)]
1916
+ # @return [Array(Orb::Invoice::LineItem::SubLineItem::Matrix, Orb::Invoice::LineItem::SubLineItem::Tier, Orb::Invoice::LineItem::SubLineItem::Null)]
1917
+
1918
+ define_sorbet_constant!(:Variants) do
1919
+ T.type_alias do
1920
+ T.any(
1921
+ Orb::Invoice::LineItem::SubLineItem::Matrix,
1922
+ Orb::Invoice::LineItem::SubLineItem::Tier,
1923
+ Orb::Invoice::LineItem::SubLineItem::Null
1924
+ )
1925
+ end
1926
+ end
1948
1927
  end
1949
1928
 
1950
1929
  class TaxAmount < Orb::Internal::Type::BaseModel
@@ -1975,7 +1954,7 @@ module Orb
1975
1954
  end
1976
1955
  end
1977
1956
 
1978
- # @see Orb::Models::Invoice#maximum
1957
+ # @see Orb::Invoice#maximum
1979
1958
  class Maximum < Orb::Internal::Type::BaseModel
1980
1959
  # @!attribute applies_to_price_ids
1981
1960
  # List of price_ids that this maximum amount applies to. For plan/plan phase
@@ -1991,16 +1970,15 @@ module Orb
1991
1970
  required :maximum_amount, String
1992
1971
 
1993
1972
  # @!method initialize(applies_to_price_ids:, maximum_amount:)
1994
- # Some parameter documentations has been truncated, see
1995
- # {Orb::Models::Invoice::Maximum} for more details.
1973
+ # Some parameter documentations has been truncated, see {Orb::Invoice::Maximum}
1974
+ # for more details.
1996
1975
  #
1997
1976
  # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
1998
- # ...
1999
1977
  #
2000
1978
  # @param maximum_amount [String] Maximum amount applied
2001
1979
  end
2002
1980
 
2003
- # @see Orb::Models::Invoice#minimum
1981
+ # @see Orb::Invoice#minimum
2004
1982
  class Minimum < Orb::Internal::Type::BaseModel
2005
1983
  # @!attribute applies_to_price_ids
2006
1984
  # List of price_ids that this minimum amount applies to. For plan/plan phase
@@ -2016,11 +1994,10 @@ module Orb
2016
1994
  required :minimum_amount, String
2017
1995
 
2018
1996
  # @!method initialize(applies_to_price_ids:, minimum_amount:)
2019
- # Some parameter documentations has been truncated, see
2020
- # {Orb::Models::Invoice::Minimum} for more details.
1997
+ # Some parameter documentations has been truncated, see {Orb::Invoice::Minimum}
1998
+ # for more details.
2021
1999
  #
2022
2000
  # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
2023
- # ...
2024
2001
  #
2025
2002
  # @param minimum_amount [String] Minimum amount applied
2026
2003
  end
@@ -2047,8 +2024,8 @@ module Orb
2047
2024
  # @!attribute payment_provider
2048
2025
  # The payment provider that attempted to collect the payment.
2049
2026
  #
2050
- # @return [Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider, nil]
2051
- required :payment_provider, enum: -> { Orb::Models::Invoice::PaymentAttempt::PaymentProvider }, nil?: true
2027
+ # @return [Symbol, Orb::Invoice::PaymentAttempt::PaymentProvider, nil]
2028
+ required :payment_provider, enum: -> { Orb::Invoice::PaymentAttempt::PaymentProvider }, nil?: true
2052
2029
 
2053
2030
  # @!attribute payment_provider_id
2054
2031
  # The ID of the payment attempt in the payment provider.
@@ -2069,7 +2046,7 @@ module Orb
2069
2046
  #
2070
2047
  # @param created_at [Time] The time at which the payment attempt was created.
2071
2048
  #
2072
- # @param payment_provider [Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
2049
+ # @param payment_provider [Symbol, Orb::Invoice::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
2073
2050
  #
2074
2051
  # @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider.
2075
2052
  #
@@ -2077,7 +2054,7 @@ module Orb
2077
2054
 
2078
2055
  # The payment provider that attempted to collect the payment.
2079
2056
  #
2080
- # @see Orb::Models::Invoice::PaymentAttempt#payment_provider
2057
+ # @see Orb::Invoice::PaymentAttempt#payment_provider
2081
2058
  module PaymentProvider
2082
2059
  extend Orb::Internal::Type::Enum
2083
2060
 
@@ -2088,7 +2065,7 @@ module Orb
2088
2065
  end
2089
2066
  end
2090
2067
 
2091
- # @see Orb::Models::Invoice#shipping_address
2068
+ # @see Orb::Invoice#shipping_address
2092
2069
  class ShippingAddress < Orb::Internal::Type::BaseModel
2093
2070
  # @!attribute city
2094
2071
  #
@@ -2129,7 +2106,7 @@ module Orb
2129
2106
  # @param state [String, nil]
2130
2107
  end
2131
2108
 
2132
- # @see Orb::Models::Invoice#status
2109
+ # @see Orb::Invoice#status
2133
2110
  module Status
2134
2111
  extend Orb::Internal::Type::Enum
2135
2112
 
@@ -2143,7 +2120,7 @@ module Orb
2143
2120
  # @return [Array<Symbol>]
2144
2121
  end
2145
2122
 
2146
- # @see Orb::Models::Invoice#subscription
2123
+ # @see Orb::Invoice#subscription
2147
2124
  class Subscription < Orb::Internal::Type::BaseModel
2148
2125
  # @!attribute id
2149
2126
  #