orb-billing 0.2.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (488) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +67 -0
  3. data/README.md +63 -53
  4. data/lib/orb/client.rb +4 -4
  5. data/lib/orb/errors.rb +9 -9
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +7 -11
  8. data/lib/orb/internal/transport/base_client.rb +10 -10
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
  10. data/lib/orb/internal/type/array_of.rb +11 -0
  11. data/lib/orb/internal/type/base_model.rb +33 -23
  12. data/lib/orb/internal/type/base_page.rb +9 -1
  13. data/lib/orb/internal/type/boolean.rb +14 -11
  14. data/lib/orb/internal/type/converter.rb +4 -1
  15. data/lib/orb/internal/type/enum.rb +19 -16
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
  17. data/lib/orb/internal/type/hash_of.rb +11 -0
  18. data/lib/orb/internal/type/request_parameters.rb +3 -10
  19. data/lib/orb/internal/type/union.rb +10 -1
  20. data/lib/orb/internal/type/unknown.rb +14 -11
  21. data/lib/orb/internal/util.rb +88 -64
  22. data/lib/orb/internal.rb +0 -1
  23. data/lib/orb/models/alert.rb +68 -71
  24. data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
  25. data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
  26. data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
  27. data/lib/orb/models/alert_disable_params.rb +5 -9
  28. data/lib/orb/models/alert_enable_params.rb +5 -9
  29. data/lib/orb/models/alert_list_params.rb +26 -36
  30. data/lib/orb/models/alert_retrieve_params.rb +3 -8
  31. data/lib/orb/models/alert_update_params.rb +14 -18
  32. data/lib/orb/models/amount_discount.rb +14 -14
  33. data/lib/orb/models/billable_metric.rb +23 -20
  34. data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
  35. data/lib/orb/models/coupon.rb +28 -21
  36. data/lib/orb/models/coupon_archive_params.rb +3 -8
  37. data/lib/orb/models/coupon_create_params.rb +29 -34
  38. data/lib/orb/models/coupon_fetch_params.rb +3 -8
  39. data/lib/orb/models/coupon_list_params.rb +17 -17
  40. data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
  41. data/lib/orb/models/credit_note.rb +100 -166
  42. data/lib/orb/models/credit_note_create_params.rb +15 -23
  43. data/lib/orb/models/credit_note_fetch_params.rb +3 -8
  44. data/lib/orb/models/credit_note_list_params.rb +20 -30
  45. data/lib/orb/models/customer.rb +224 -271
  46. data/lib/orb/models/customer_create_params.rb +216 -257
  47. data/lib/orb/models/customer_delete_params.rb +3 -8
  48. data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
  49. data/lib/orb/models/customer_fetch_params.rb +3 -8
  50. data/lib/orb/models/customer_list_params.rb +20 -30
  51. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
  52. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
  53. data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
  54. data/lib/orb/models/customer_update_params.rb +212 -255
  55. data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
  56. data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
  57. data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
  58. data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
  59. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
  60. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +23 -27
  63. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
  64. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
  65. data/lib/orb/models/customers/credit_list_params.rb +18 -22
  66. data/lib/orb/models/customers/credit_list_response.rb +10 -17
  67. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
  68. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
  69. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
  70. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
  71. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
  72. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
  75. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
  76. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
  77. data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
  78. data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
  79. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
  80. data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
  81. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
  82. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
  83. data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
  84. data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
  85. data/lib/orb/models/dimensional_price_group.rb +21 -15
  86. data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
  87. data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
  88. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
  89. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
  90. data/lib/orb/models/dimensional_price_groups.rb +3 -7
  91. data/lib/orb/models/discount.rb +2 -3
  92. data/lib/orb/models/evaluate_price_group.rb +8 -11
  93. data/lib/orb/models/event_deprecate_params.rb +3 -8
  94. data/lib/orb/models/event_deprecate_response.rb +2 -6
  95. data/lib/orb/models/event_ingest_params.rb +33 -27
  96. data/lib/orb/models/event_ingest_response.rb +23 -24
  97. data/lib/orb/models/event_search_params.rb +15 -11
  98. data/lib/orb/models/event_search_response.rb +27 -22
  99. data/lib/orb/models/event_update_params.rb +19 -13
  100. data/lib/orb/models/event_update_response.rb +2 -6
  101. data/lib/orb/models/events/backfill_close_params.rb +3 -8
  102. data/lib/orb/models/events/backfill_close_response.rb +34 -39
  103. data/lib/orb/models/events/backfill_create_params.rb +28 -32
  104. data/lib/orb/models/events/backfill_create_response.rb +34 -39
  105. data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
  106. data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
  107. data/lib/orb/models/events/backfill_list_params.rb +12 -15
  108. data/lib/orb/models/events/backfill_list_response.rb +34 -39
  109. data/lib/orb/models/events/backfill_revert_params.rb +3 -8
  110. data/lib/orb/models/events/backfill_revert_response.rb +34 -39
  111. data/lib/orb/models/events/event_volumes.rb +11 -17
  112. data/lib/orb/models/events/volume_list_params.rb +19 -22
  113. data/lib/orb/models/invoice.rb +619 -681
  114. data/lib/orb/models/invoice_create_params.rb +52 -61
  115. data/lib/orb/models/invoice_fetch_params.rb +3 -8
  116. data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
  117. data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
  118. data/lib/orb/models/invoice_issue_params.rb +10 -14
  119. data/lib/orb/models/invoice_level_discount.rb +2 -3
  120. data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
  121. data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
  122. data/lib/orb/models/invoice_list_params.rb +51 -66
  123. data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
  124. data/lib/orb/models/invoice_pay_params.rb +3 -8
  125. data/lib/orb/models/invoice_update_params.rb +9 -9
  126. data/lib/orb/models/invoice_void_params.rb +3 -8
  127. data/lib/orb/models/item.rb +14 -25
  128. data/lib/orb/models/item_create_params.rb +5 -9
  129. data/lib/orb/models/item_fetch_params.rb +3 -8
  130. data/lib/orb/models/item_list_params.rb +12 -15
  131. data/lib/orb/models/item_update_params.rb +10 -22
  132. data/lib/orb/models/metric_create_params.rb +17 -13
  133. data/lib/orb/models/metric_fetch_params.rb +3 -8
  134. data/lib/orb/models/metric_list_params.rb +20 -30
  135. data/lib/orb/models/metric_update_params.rb +9 -9
  136. data/lib/orb/models/pagination_metadata.rb +3 -7
  137. data/lib/orb/models/percentage_discount.rb +15 -14
  138. data/lib/orb/models/plan.rb +259 -291
  139. data/lib/orb/models/plan_create_params.rb +2070 -2466
  140. data/lib/orb/models/plan_fetch_params.rb +3 -8
  141. data/lib/orb/models/plan_list_params.rb +25 -42
  142. data/lib/orb/models/plan_update_params.rb +12 -10
  143. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
  144. data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
  145. data/lib/orb/models/price.rb +3842 -5005
  146. data/lib/orb/models/price_create_params.rb +203 -244
  147. data/lib/orb/models/price_evaluate_params.rb +21 -30
  148. data/lib/orb/models/price_evaluate_response.rb +2 -6
  149. data/lib/orb/models/price_fetch_params.rb +3 -8
  150. data/lib/orb/models/price_list_params.rb +12 -15
  151. data/lib/orb/models/price_update_params.rb +9 -9
  152. data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
  153. data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
  154. data/lib/orb/models/subscription.rb +360 -405
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +358 -399
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +384 -418
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
  163. data/lib/orb/models/subscription_create_params.rb +4735 -5417
  164. data/lib/orb/models/subscription_create_response.rb +358 -399
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
  167. data/lib/orb/models/subscription_fetch_params.rb +3 -8
  168. data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
  169. data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
  170. data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
  171. data/lib/orb/models/subscription_list_params.rb +28 -41
  172. data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
  173. data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
  180. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
  181. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
  182. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
  183. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
  184. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
  185. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
  186. data/lib/orb/models/subscription_update_params.rb +21 -23
  187. data/lib/orb/models/subscription_update_trial_params.rb +15 -18
  188. data/lib/orb/models/subscription_update_trial_response.rb +360 -399
  189. data/lib/orb/models/subscription_usage.rb +37 -80
  190. data/lib/orb/models/subscriptions.rb +3 -7
  191. data/lib/orb/models/top_level_ping_params.rb +3 -8
  192. data/lib/orb/models/top_level_ping_response.rb +2 -6
  193. data/lib/orb/models/trial_discount.rb +16 -24
  194. data/lib/orb/models/usage_discount.rb +15 -14
  195. data/lib/orb/models.rb +220 -0
  196. data/lib/orb/request_options.rb +4 -6
  197. data/lib/orb/resources/alerts.rb +48 -17
  198. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  199. data/lib/orb/resources/coupons.rb +26 -8
  200. data/lib/orb/resources/credit_notes.rb +17 -4
  201. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  202. data/lib/orb/resources/customers/costs.rb +26 -8
  203. data/lib/orb/resources/customers/credits/ledger.rb +112 -32
  204. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  205. data/lib/orb/resources/customers/credits.rb +28 -8
  206. data/lib/orb/resources/customers.rb +138 -39
  207. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  208. data/lib/orb/resources/events/backfills.rb +32 -9
  209. data/lib/orb/resources/events/volume.rb +14 -4
  210. data/lib/orb/resources/events.rb +40 -11
  211. data/lib/orb/resources/invoice_line_items.rb +16 -6
  212. data/lib/orb/resources/invoices.rb +77 -17
  213. data/lib/orb/resources/items.rb +10 -3
  214. data/lib/orb/resources/metrics.rb +33 -8
  215. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  216. data/lib/orb/resources/plans.rb +47 -11
  217. data/lib/orb/resources/prices/external_price_id.rb +9 -3
  218. data/lib/orb/resources/prices.rb +101 -26
  219. data/lib/orb/resources/subscription_changes.rb +5 -2
  220. data/lib/orb/resources/subscriptions.rb +292 -78
  221. data/lib/orb/version.rb +1 -1
  222. data/lib/orb.rb +2 -10
  223. data/rbi/{lib/orb → orb}/client.rbi +4 -4
  224. data/rbi/{lib/orb → orb}/errors.rbi +1 -1
  225. data/rbi/orb/file_part.rbi +34 -0
  226. data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
  227. data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
  228. data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
  229. data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
  230. data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
  231. data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
  232. data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
  233. data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
  234. data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
  235. data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
  236. data/rbi/{lib/orb → orb}/internal.rbi +0 -1
  237. data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
  238. data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
  239. data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
  240. data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
  241. data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
  242. data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
  243. data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
  244. data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
  245. data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
  246. data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
  247. data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
  248. data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
  249. data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
  250. data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
  251. data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
  252. data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
  253. data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
  254. data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
  255. data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
  256. data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
  257. data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
  258. data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
  259. data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
  260. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
  261. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
  262. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
  263. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
  264. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
  265. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
  266. data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
  267. data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
  268. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
  269. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
  270. data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
  271. data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
  272. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  273. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
  274. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  275. data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
  276. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  277. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
  278. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
  279. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
  280. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  281. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  282. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
  283. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
  284. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  285. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  286. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
  287. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
  288. data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
  289. data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
  290. data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
  291. data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
  292. data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
  293. data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
  294. data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
  295. data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
  296. data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
  297. data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
  298. data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
  299. data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
  300. data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
  301. data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
  302. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
  303. data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
  304. data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
  305. data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
  306. data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
  307. data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
  308. data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
  309. data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
  310. data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
  311. data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
  312. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
  313. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
  314. data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
  315. data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
  316. data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
  317. data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
  318. data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
  319. data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
  320. data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
  321. data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
  322. data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
  323. data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
  324. data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
  325. data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
  326. data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
  327. data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
  328. data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
  329. data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
  330. data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
  331. data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
  332. data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
  333. data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
  334. data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
  335. data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
  336. data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
  337. data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
  338. data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
  339. data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
  340. data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
  341. data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
  342. data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
  343. data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
  344. data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
  345. data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
  346. data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
  347. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
  348. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
  349. data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
  350. data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
  351. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
  352. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
  353. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
  354. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
  355. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
  356. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
  357. data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
  358. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  359. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
  360. data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
  361. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  362. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
  363. data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
  364. data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
  365. data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
  366. data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
  367. data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
  368. data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
  369. data/rbi/orb/models.rbi +220 -0
  370. data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
  371. data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
  372. data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
  373. data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
  374. data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
  375. data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
  376. data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
  377. data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
  378. data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
  379. data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
  380. data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
  381. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
  382. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
  383. data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
  384. data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
  385. data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
  386. data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
  387. data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
  388. data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
  389. data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
  390. data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
  391. data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
  392. data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
  393. data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
  394. data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
  395. data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
  396. data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
  397. data/sig/orb/file_part.rbs +21 -0
  398. data/sig/orb/internal/transport/base_client.rbs +9 -3
  399. data/sig/orb/internal/type/array_of.rbs +2 -0
  400. data/sig/orb/internal/type/base_model.rbs +4 -0
  401. data/sig/orb/internal/type/enum.rbs +2 -2
  402. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  403. data/sig/orb/internal/type/hash_of.rbs +2 -0
  404. data/sig/orb/internal/type/union.rbs +2 -0
  405. data/sig/orb/internal/util.rbs +16 -12
  406. data/sig/orb/models/coupon_create_params.rbs +9 -10
  407. data/sig/orb/models/customer_create_params.rbs +9 -10
  408. data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
  409. data/sig/orb/models/customer_update_params.rbs +9 -10
  410. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
  411. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
  412. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
  413. data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
  414. data/sig/orb/models/invoice.rbs +54 -54
  415. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
  416. data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
  417. data/sig/orb/models/plan.rbs +21 -21
  418. data/sig/orb/models/plan_create_params.rbs +653 -653
  419. data/sig/orb/models/price.rbs +1517 -1521
  420. data/sig/orb/models/subscription.rbs +34 -34
  421. data/sig/orb/models/subscription_cancel_response.rbs +34 -34
  422. data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
  423. data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
  424. data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
  425. data/sig/orb/models/subscription_create_params.rbs +1348 -1348
  426. data/sig/orb/models/subscription_create_response.rbs +34 -34
  427. data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
  428. data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
  429. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
  430. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
  431. data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
  432. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
  433. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
  434. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
  435. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
  436. data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
  437. data/sig/orb/models.rbs +215 -0
  438. metadata +230 -224
  439. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
  440. data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
  441. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
  442. data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
  443. /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
  444. /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
  445. /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
  446. /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
  447. /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
  448. /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
  449. /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
  450. /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
  451. /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
  452. /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
  453. /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
  454. /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
  455. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
  456. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
  457. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
  458. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
  459. /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
  460. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
  461. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
  462. /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
  463. /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
  464. /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
  465. /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
  466. /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
  467. /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
  468. /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
  469. /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
  470. /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
  471. /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
  472. /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
  473. /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
  474. /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
  475. /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
  476. /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
  477. /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
  478. /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
  479. /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
  480. /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
  481. /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
  482. /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
  483. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
  484. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
  485. /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
  486. /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
  487. /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
  488. /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -19,11 +19,11 @@ module Orb
19
19
  returns(
20
20
  T::Array[
21
21
  T.any(
22
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment,
23
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment,
24
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment,
25
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment,
26
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment
22
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount,
23
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount,
24
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount,
25
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum,
26
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum
27
27
  )
28
28
  ]
29
29
  )
@@ -121,34 +121,34 @@ module Orb
121
121
  returns(
122
122
  T.nilable(
123
123
  T.any(
124
- Orb::Models::Price::UnitPrice,
125
- Orb::Models::Price::PackagePrice,
126
- Orb::Models::Price::MatrixPrice,
127
- Orb::Models::Price::TieredPrice,
128
- Orb::Models::Price::TieredBpsPrice,
129
- Orb::Models::Price::BpsPrice,
130
- Orb::Models::Price::BulkBpsPrice,
131
- Orb::Models::Price::BulkPrice,
132
- Orb::Models::Price::ThresholdTotalAmountPrice,
133
- Orb::Models::Price::TieredPackagePrice,
134
- Orb::Models::Price::GroupedTieredPrice,
135
- Orb::Models::Price::TieredWithMinimumPrice,
136
- Orb::Models::Price::TieredPackageWithMinimumPrice,
137
- Orb::Models::Price::PackageWithAllocationPrice,
138
- Orb::Models::Price::UnitWithPercentPrice,
139
- Orb::Models::Price::MatrixWithAllocationPrice,
140
- Orb::Models::Price::TieredWithProrationPrice,
141
- Orb::Models::Price::UnitWithProrationPrice,
142
- Orb::Models::Price::GroupedAllocationPrice,
143
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
144
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
145
- Orb::Models::Price::MatrixWithDisplayNamePrice,
146
- Orb::Models::Price::BulkWithProrationPrice,
147
- Orb::Models::Price::GroupedTieredPackagePrice,
148
- Orb::Models::Price::MaxGroupTieredPackagePrice,
149
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
150
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
151
- Orb::Models::Price::CumulativeGroupedBulkPrice
124
+ Orb::Models::Price::Unit,
125
+ Orb::Models::Price::Package,
126
+ Orb::Models::Price::Matrix,
127
+ Orb::Models::Price::Tiered,
128
+ Orb::Models::Price::TieredBps,
129
+ Orb::Models::Price::Bps,
130
+ Orb::Models::Price::BulkBps,
131
+ Orb::Models::Price::Bulk,
132
+ Orb::Models::Price::ThresholdTotalAmount,
133
+ Orb::Models::Price::TieredPackage,
134
+ Orb::Models::Price::GroupedTiered,
135
+ Orb::Models::Price::TieredWithMinimum,
136
+ Orb::Models::Price::TieredPackageWithMinimum,
137
+ Orb::Models::Price::PackageWithAllocation,
138
+ Orb::Models::Price::UnitWithPercent,
139
+ Orb::Models::Price::MatrixWithAllocation,
140
+ Orb::Models::Price::TieredWithProration,
141
+ Orb::Models::Price::UnitWithProration,
142
+ Orb::Models::Price::GroupedAllocation,
143
+ Orb::Models::Price::GroupedWithProratedMinimum,
144
+ Orb::Models::Price::GroupedWithMeteredMinimum,
145
+ Orb::Models::Price::MatrixWithDisplayName,
146
+ Orb::Models::Price::BulkWithProration,
147
+ Orb::Models::Price::GroupedTieredPackage,
148
+ Orb::Models::Price::MaxGroupTieredPackage,
149
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
150
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
151
+ Orb::Models::Price::CumulativeGroupedBulk
152
152
  )
153
153
  )
154
154
  )
@@ -169,9 +169,9 @@ module Orb
169
169
  returns(
170
170
  T::Array[
171
171
  T.any(
172
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem,
173
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem,
174
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem
172
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix,
173
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier,
174
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null
175
175
  )
176
176
  ]
177
177
  )
@@ -197,12 +197,12 @@ module Orb
197
197
  adjusted_subtotal: String,
198
198
  adjustments: T::Array[
199
199
  T.any(
200
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment,
200
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount,
201
201
  Orb::Internal::AnyHash,
202
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment,
203
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment,
204
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment,
205
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment
202
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount,
203
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount,
204
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum,
205
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum
206
206
  )
207
207
  ],
208
208
  amount: String,
@@ -227,45 +227,45 @@ module Orb
227
227
  partially_invoiced_amount: String,
228
228
  price: T.nilable(
229
229
  T.any(
230
- Orb::Models::Price::UnitPrice,
230
+ Orb::Models::Price::Unit,
231
231
  Orb::Internal::AnyHash,
232
- Orb::Models::Price::PackagePrice,
233
- Orb::Models::Price::MatrixPrice,
234
- Orb::Models::Price::TieredPrice,
235
- Orb::Models::Price::TieredBpsPrice,
236
- Orb::Models::Price::BpsPrice,
237
- Orb::Models::Price::BulkBpsPrice,
238
- Orb::Models::Price::BulkPrice,
239
- Orb::Models::Price::ThresholdTotalAmountPrice,
240
- Orb::Models::Price::TieredPackagePrice,
241
- Orb::Models::Price::GroupedTieredPrice,
242
- Orb::Models::Price::TieredWithMinimumPrice,
243
- Orb::Models::Price::TieredPackageWithMinimumPrice,
244
- Orb::Models::Price::PackageWithAllocationPrice,
245
- Orb::Models::Price::UnitWithPercentPrice,
246
- Orb::Models::Price::MatrixWithAllocationPrice,
247
- Orb::Models::Price::TieredWithProrationPrice,
248
- Orb::Models::Price::UnitWithProrationPrice,
249
- Orb::Models::Price::GroupedAllocationPrice,
250
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
251
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
252
- Orb::Models::Price::MatrixWithDisplayNamePrice,
253
- Orb::Models::Price::BulkWithProrationPrice,
254
- Orb::Models::Price::GroupedTieredPackagePrice,
255
- Orb::Models::Price::MaxGroupTieredPackagePrice,
256
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
257
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
258
- Orb::Models::Price::CumulativeGroupedBulkPrice
232
+ Orb::Models::Price::Package,
233
+ Orb::Models::Price::Matrix,
234
+ Orb::Models::Price::Tiered,
235
+ Orb::Models::Price::TieredBps,
236
+ Orb::Models::Price::Bps,
237
+ Orb::Models::Price::BulkBps,
238
+ Orb::Models::Price::Bulk,
239
+ Orb::Models::Price::ThresholdTotalAmount,
240
+ Orb::Models::Price::TieredPackage,
241
+ Orb::Models::Price::GroupedTiered,
242
+ Orb::Models::Price::TieredWithMinimum,
243
+ Orb::Models::Price::TieredPackageWithMinimum,
244
+ Orb::Models::Price::PackageWithAllocation,
245
+ Orb::Models::Price::UnitWithPercent,
246
+ Orb::Models::Price::MatrixWithAllocation,
247
+ Orb::Models::Price::TieredWithProration,
248
+ Orb::Models::Price::UnitWithProration,
249
+ Orb::Models::Price::GroupedAllocation,
250
+ Orb::Models::Price::GroupedWithProratedMinimum,
251
+ Orb::Models::Price::GroupedWithMeteredMinimum,
252
+ Orb::Models::Price::MatrixWithDisplayName,
253
+ Orb::Models::Price::BulkWithProration,
254
+ Orb::Models::Price::GroupedTieredPackage,
255
+ Orb::Models::Price::MaxGroupTieredPackage,
256
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
257
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
258
+ Orb::Models::Price::CumulativeGroupedBulk
259
259
  )
260
260
  ),
261
261
  quantity: Float,
262
262
  start_date: Time,
263
263
  sub_line_items: T::Array[
264
264
  T.any(
265
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem,
265
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix,
266
266
  Orb::Internal::AnyHash,
267
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem,
268
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem
267
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier,
268
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null
269
269
  )
270
270
  ],
271
271
  subtotal: String,
@@ -275,27 +275,65 @@ module Orb
275
275
  .returns(T.attached_class)
276
276
  end
277
277
  def self.new(
278
+ # A unique ID for this line item.
278
279
  id:,
280
+ # The line amount after any adjustments and before overage conversion, credits and
281
+ # partial invoicing.
279
282
  adjusted_subtotal:,
283
+ # All adjustments applied to the line item in the order they were applied based on
284
+ # invoice calculations (ie. usage discounts -> amount discounts -> percentage
285
+ # discounts -> minimums -> maximums).
280
286
  adjustments:,
287
+ # The final amount for a line item after all adjustments and pre paid credits have
288
+ # been applied.
281
289
  amount:,
290
+ # The number of prepaid credits applied.
282
291
  credits_applied:,
283
292
  discount:,
293
+ # The end date of the range of time applied for this line item's price.
284
294
  end_date:,
295
+ # An additional filter that was used to calculate the usage for this line item.
285
296
  filter:,
297
+ # [DEPRECATED] For configured prices that are split by a grouping key, this will
298
+ # be populated with the key and a value. The `amount` and `subtotal` will be the
299
+ # values for this particular grouping.
286
300
  grouping:,
301
+ # This field is deprecated in favor of `adjustments`.
287
302
  maximum:,
303
+ # This field is deprecated in favor of `adjustments`.
288
304
  maximum_amount:,
305
+ # This field is deprecated in favor of `adjustments`.
289
306
  minimum:,
307
+ # This field is deprecated in favor of `adjustments`.
290
308
  minimum_amount:,
309
+ # The name of the price associated with this line item.
291
310
  name:,
311
+ # Any amount applied from a partial invoice
292
312
  partially_invoiced_amount:,
313
+ # The Price resource represents a price that can be billed on a subscription,
314
+ # resulting in a charge on an invoice in the form of an invoice line item. Prices
315
+ # take a quantity and determine an amount to bill.
316
+ #
317
+ # Orb supports a few different pricing models out of the box. Each of these models
318
+ # is serialized differently in a given Price object. The model_type field
319
+ # determines the key for the configuration object that is present.
320
+ #
321
+ # For more on the types of prices, see
322
+ # [the core concepts documentation](/core-concepts#plan-and-price)
293
323
  price:,
324
+ # Either the fixed fee quantity or the usage during the service period.
294
325
  quantity:,
326
+ # The start date of the range of time applied for this line item's price.
295
327
  start_date:,
328
+ # For complex pricing structures, the line item can be broken down further in
329
+ # `sub_line_items`.
296
330
  sub_line_items:,
331
+ # The line amount before before any adjustments.
297
332
  subtotal:,
333
+ # An array of tax rates and their incurred tax amounts. Empty if no tax
334
+ # integration is configured.
298
335
  tax_amounts:,
336
+ # A list of customer ids that were used to calculate the usage for this line item.
299
337
  usage_customer_ids:
300
338
  ); end
301
339
  sig do
@@ -306,11 +344,11 @@ module Orb
306
344
  adjusted_subtotal: String,
307
345
  adjustments: T::Array[
308
346
  T.any(
309
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment,
310
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment,
311
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment,
312
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment,
313
- Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment
347
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount,
348
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount,
349
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount,
350
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum,
351
+ Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum
314
352
  )
315
353
  ],
316
354
  amount: String,
@@ -334,43 +372,43 @@ module Orb
334
372
  partially_invoiced_amount: String,
335
373
  price: T.nilable(
336
374
  T.any(
337
- Orb::Models::Price::UnitPrice,
338
- Orb::Models::Price::PackagePrice,
339
- Orb::Models::Price::MatrixPrice,
340
- Orb::Models::Price::TieredPrice,
341
- Orb::Models::Price::TieredBpsPrice,
342
- Orb::Models::Price::BpsPrice,
343
- Orb::Models::Price::BulkBpsPrice,
344
- Orb::Models::Price::BulkPrice,
345
- Orb::Models::Price::ThresholdTotalAmountPrice,
346
- Orb::Models::Price::TieredPackagePrice,
347
- Orb::Models::Price::GroupedTieredPrice,
348
- Orb::Models::Price::TieredWithMinimumPrice,
349
- Orb::Models::Price::TieredPackageWithMinimumPrice,
350
- Orb::Models::Price::PackageWithAllocationPrice,
351
- Orb::Models::Price::UnitWithPercentPrice,
352
- Orb::Models::Price::MatrixWithAllocationPrice,
353
- Orb::Models::Price::TieredWithProrationPrice,
354
- Orb::Models::Price::UnitWithProrationPrice,
355
- Orb::Models::Price::GroupedAllocationPrice,
356
- Orb::Models::Price::GroupedWithProratedMinimumPrice,
357
- Orb::Models::Price::GroupedWithMeteredMinimumPrice,
358
- Orb::Models::Price::MatrixWithDisplayNamePrice,
359
- Orb::Models::Price::BulkWithProrationPrice,
360
- Orb::Models::Price::GroupedTieredPackagePrice,
361
- Orb::Models::Price::MaxGroupTieredPackagePrice,
362
- Orb::Models::Price::ScalableMatrixWithUnitPricingPrice,
363
- Orb::Models::Price::ScalableMatrixWithTieredPricingPrice,
364
- Orb::Models::Price::CumulativeGroupedBulkPrice
375
+ Orb::Models::Price::Unit,
376
+ Orb::Models::Price::Package,
377
+ Orb::Models::Price::Matrix,
378
+ Orb::Models::Price::Tiered,
379
+ Orb::Models::Price::TieredBps,
380
+ Orb::Models::Price::Bps,
381
+ Orb::Models::Price::BulkBps,
382
+ Orb::Models::Price::Bulk,
383
+ Orb::Models::Price::ThresholdTotalAmount,
384
+ Orb::Models::Price::TieredPackage,
385
+ Orb::Models::Price::GroupedTiered,
386
+ Orb::Models::Price::TieredWithMinimum,
387
+ Orb::Models::Price::TieredPackageWithMinimum,
388
+ Orb::Models::Price::PackageWithAllocation,
389
+ Orb::Models::Price::UnitWithPercent,
390
+ Orb::Models::Price::MatrixWithAllocation,
391
+ Orb::Models::Price::TieredWithProration,
392
+ Orb::Models::Price::UnitWithProration,
393
+ Orb::Models::Price::GroupedAllocation,
394
+ Orb::Models::Price::GroupedWithProratedMinimum,
395
+ Orb::Models::Price::GroupedWithMeteredMinimum,
396
+ Orb::Models::Price::MatrixWithDisplayName,
397
+ Orb::Models::Price::BulkWithProration,
398
+ Orb::Models::Price::GroupedTieredPackage,
399
+ Orb::Models::Price::MaxGroupTieredPackage,
400
+ Orb::Models::Price::ScalableMatrixWithUnitPricing,
401
+ Orb::Models::Price::ScalableMatrixWithTieredPricing,
402
+ Orb::Models::Price::CumulativeGroupedBulk
365
403
  )
366
404
  ),
367
405
  quantity: Float,
368
406
  start_date: Time,
369
407
  sub_line_items: T::Array[
370
408
  T.any(
371
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem,
372
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem,
373
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem
409
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix,
410
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier,
411
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null
374
412
  )
375
413
  ],
376
414
  subtotal: String,
@@ -384,7 +422,7 @@ module Orb
384
422
  module Adjustment
385
423
  extend Orb::Internal::Type::Union
386
424
 
387
- class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
425
+ class UsageDiscount < Orb::Internal::Type::BaseModel
388
426
  sig { returns(String) }
389
427
  attr_accessor :id
390
428
 
@@ -427,10 +465,17 @@ module Orb
427
465
  end
428
466
  def self.new(
429
467
  id:,
468
+ # The value applied by an adjustment.
430
469
  amount:,
470
+ # The price IDs that this adjustment applies to.
431
471
  applies_to_price_ids:,
472
+ # True for adjustments that apply to an entire invocice, false for adjustments
473
+ # that apply to only one price.
432
474
  is_invoice_level:,
475
+ # The reason for the adjustment.
433
476
  reason:,
477
+ # The number of usage units by which to discount the price this adjustment applies
478
+ # to in a given billing period.
434
479
  usage_discount:,
435
480
  adjustment_type: :usage_discount
436
481
  ); end
@@ -451,7 +496,7 @@ module Orb
451
496
  def to_hash; end
452
497
  end
453
498
 
454
- class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
499
+ class AmountDiscount < Orb::Internal::Type::BaseModel
455
500
  sig { returns(String) }
456
501
  attr_accessor :id
457
502
 
@@ -494,10 +539,17 @@ module Orb
494
539
  end
495
540
  def self.new(
496
541
  id:,
542
+ # The value applied by an adjustment.
497
543
  amount:,
544
+ # The amount by which to discount the prices this adjustment applies to in a given
545
+ # billing period.
498
546
  amount_discount:,
547
+ # The price IDs that this adjustment applies to.
499
548
  applies_to_price_ids:,
549
+ # True for adjustments that apply to an entire invocice, false for adjustments
550
+ # that apply to only one price.
500
551
  is_invoice_level:,
552
+ # The reason for the adjustment.
501
553
  reason:,
502
554
  adjustment_type: :amount_discount
503
555
  ); end
@@ -518,7 +570,7 @@ module Orb
518
570
  def to_hash; end
519
571
  end
520
572
 
521
- class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
573
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
522
574
  sig { returns(String) }
523
575
  attr_accessor :id
524
576
 
@@ -561,10 +613,17 @@ module Orb
561
613
  end
562
614
  def self.new(
563
615
  id:,
616
+ # The value applied by an adjustment.
564
617
  amount:,
618
+ # The price IDs that this adjustment applies to.
565
619
  applies_to_price_ids:,
620
+ # True for adjustments that apply to an entire invocice, false for adjustments
621
+ # that apply to only one price.
566
622
  is_invoice_level:,
623
+ # The percentage (as a value between 0 and 1) by which to discount the price
624
+ # intervals this adjustment applies to in a given billing period.
567
625
  percentage_discount:,
626
+ # The reason for the adjustment.
568
627
  reason:,
569
628
  adjustment_type: :percentage_discount
570
629
  ); end
@@ -585,7 +644,7 @@ module Orb
585
644
  def to_hash; end
586
645
  end
587
646
 
588
- class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel
647
+ class Minimum < Orb::Internal::Type::BaseModel
589
648
  sig { returns(String) }
590
649
  attr_accessor :id
591
650
 
@@ -633,11 +692,19 @@ module Orb
633
692
  end
634
693
  def self.new(
635
694
  id:,
695
+ # The value applied by an adjustment.
636
696
  amount:,
697
+ # The price IDs that this adjustment applies to.
637
698
  applies_to_price_ids:,
699
+ # True for adjustments that apply to an entire invocice, false for adjustments
700
+ # that apply to only one price.
638
701
  is_invoice_level:,
702
+ # The item ID that revenue from this minimum will be attributed to.
639
703
  item_id:,
704
+ # The minimum amount to charge in a given billing period for the prices this
705
+ # adjustment applies to.
640
706
  minimum_amount:,
707
+ # The reason for the adjustment.
641
708
  reason:,
642
709
  adjustment_type: :minimum
643
710
  ); end
@@ -659,7 +726,7 @@ module Orb
659
726
  def to_hash; end
660
727
  end
661
728
 
662
- class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel
729
+ class Maximum < Orb::Internal::Type::BaseModel
663
730
  sig { returns(String) }
664
731
  attr_accessor :id
665
732
 
@@ -702,10 +769,17 @@ module Orb
702
769
  end
703
770
  def self.new(
704
771
  id:,
772
+ # The value applied by an adjustment.
705
773
  amount:,
774
+ # The price IDs that this adjustment applies to.
706
775
  applies_to_price_ids:,
776
+ # True for adjustments that apply to an entire invocice, false for adjustments
777
+ # that apply to only one price.
707
778
  is_invoice_level:,
779
+ # The maximum amount to charge in a given billing period for the prices this
780
+ # adjustment applies to.
708
781
  maximum_amount:,
782
+ # The reason for the adjustment.
709
783
  reason:,
710
784
  adjustment_type: :maximum
711
785
  ); end
@@ -729,7 +803,7 @@ module Orb
729
803
  sig do
730
804
  override
731
805
  .returns(
732
- [Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::MonetaryMaximumAdjustment]
806
+ [Orb::Models::InvoiceLineItemCreateResponse::Adjustment::UsageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::AmountDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::PercentageDiscount, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Minimum, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::Maximum]
733
807
  )
734
808
  end
735
809
  def self.variants; end
@@ -749,8 +823,13 @@ module Orb
749
823
  sig do
750
824
  params(applies_to_price_ids: T::Array[String], maximum_amount: String).returns(T.attached_class)
751
825
  end
752
- def self.new(applies_to_price_ids:, maximum_amount:); end
753
-
826
+ def self.new(
827
+ # List of price_ids that this maximum amount applies to. For plan/plan phase
828
+ # maximums, this can be a subset of prices.
829
+ applies_to_price_ids:,
830
+ # Maximum amount applied
831
+ maximum_amount:
832
+ ); end
754
833
  sig { override.returns({applies_to_price_ids: T::Array[String], maximum_amount: String}) }
755
834
  def to_hash; end
756
835
  end
@@ -769,8 +848,13 @@ module Orb
769
848
  sig do
770
849
  params(applies_to_price_ids: T::Array[String], minimum_amount: String).returns(T.attached_class)
771
850
  end
772
- def self.new(applies_to_price_ids:, minimum_amount:); end
773
-
851
+ def self.new(
852
+ # List of price_ids that this minimum amount applies to. For plan/plan phase
853
+ # minimums, this can be a subset of prices.
854
+ applies_to_price_ids:,
855
+ # Minimum amount applied
856
+ minimum_amount:
857
+ ); end
774
858
  sig { override.returns({applies_to_price_ids: T::Array[String], minimum_amount: String}) }
775
859
  def to_hash; end
776
860
  end
@@ -778,34 +862,31 @@ module Orb
778
862
  module SubLineItem
779
863
  extend Orb::Internal::Type::Union
780
864
 
781
- class MatrixSubLineItem < Orb::Internal::Type::BaseModel
865
+ class Matrix < Orb::Internal::Type::BaseModel
782
866
  # The total amount for this sub line item.
783
867
  sig { returns(String) }
784
868
  attr_accessor :amount
785
869
 
786
- sig { returns(T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping)) }
870
+ sig { returns(T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping)) }
787
871
  attr_reader :grouping
788
872
 
789
873
  sig do
790
874
  params(
791
875
  grouping: T.nilable(
792
- T.any(
793
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping,
794
- Orb::Internal::AnyHash
795
- )
876
+ T.any(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping, Orb::Internal::AnyHash)
796
877
  )
797
878
  )
798
879
  .void
799
880
  end
800
881
  attr_writer :grouping
801
882
 
802
- sig { returns(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig) }
883
+ sig { returns(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig) }
803
884
  attr_reader :matrix_config
804
885
 
805
886
  sig do
806
887
  params(
807
888
  matrix_config: T.any(
808
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig,
889
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig,
809
890
  Orb::Internal::AnyHash
810
891
  )
811
892
  )
@@ -826,13 +907,10 @@ module Orb
826
907
  params(
827
908
  amount: String,
828
909
  grouping: T.nilable(
829
- T.any(
830
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping,
831
- Orb::Internal::AnyHash
832
- )
910
+ T.any(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping, Orb::Internal::AnyHash)
833
911
  ),
834
912
  matrix_config: T.any(
835
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig,
913
+ Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig,
836
914
  Orb::Internal::AnyHash
837
915
  ),
838
916
  name: String,
@@ -841,15 +919,22 @@ module Orb
841
919
  )
842
920
  .returns(T.attached_class)
843
921
  end
844
- def self.new(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix); end
845
-
922
+ def self.new(
923
+ # The total amount for this sub line item.
924
+ amount:,
925
+ grouping:,
926
+ matrix_config:,
927
+ name:,
928
+ quantity:,
929
+ type: :matrix
930
+ ); end
846
931
  sig do
847
932
  override
848
933
  .returns(
849
934
  {
850
935
  amount: String,
851
- grouping: T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::Grouping),
852
- matrix_config: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem::MatrixConfig,
936
+ grouping: T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::Grouping),
937
+ matrix_config: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix::MatrixConfig,
853
938
  name: String,
854
939
  quantity: Float,
855
940
  type: Symbol
@@ -867,8 +952,11 @@ module Orb
867
952
  attr_accessor :value
868
953
 
869
954
  sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
870
- def self.new(key:, value:); end
871
-
955
+ def self.new(
956
+ key:,
957
+ # No value indicates the default group
958
+ value:
959
+ ); end
872
960
  sig { override.returns({key: String, value: T.nilable(String)}) }
873
961
  def to_hash; end
874
962
  end
@@ -879,28 +967,27 @@ module Orb
879
967
  attr_accessor :dimension_values
880
968
 
881
969
  sig { params(dimension_values: T::Array[T.nilable(String)]).returns(T.attached_class) }
882
- def self.new(dimension_values:); end
883
-
970
+ def self.new(
971
+ # The ordered dimension values for this line item.
972
+ dimension_values:
973
+ ); end
884
974
  sig { override.returns({dimension_values: T::Array[T.nilable(String)]}) }
885
975
  def to_hash; end
886
976
  end
887
977
  end
888
978
 
889
- class TierSubLineItem < Orb::Internal::Type::BaseModel
979
+ class Tier < Orb::Internal::Type::BaseModel
890
980
  # The total amount for this sub line item.
891
981
  sig { returns(String) }
892
982
  attr_accessor :amount
893
983
 
894
- sig { returns(T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping)) }
984
+ sig { returns(T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping)) }
895
985
  attr_reader :grouping
896
986
 
897
987
  sig do
898
988
  params(
899
989
  grouping: T.nilable(
900
- T.any(
901
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping,
902
- Orb::Internal::AnyHash
903
- )
990
+ T.any(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping, Orb::Internal::AnyHash)
904
991
  )
905
992
  )
906
993
  .void
@@ -913,15 +1000,12 @@ module Orb
913
1000
  sig { returns(Float) }
914
1001
  attr_accessor :quantity
915
1002
 
916
- sig { returns(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig) }
1003
+ sig { returns(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig) }
917
1004
  attr_reader :tier_config
918
1005
 
919
1006
  sig do
920
1007
  params(
921
- tier_config: T.any(
922
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig,
923
- Orb::Internal::AnyHash
924
- )
1008
+ tier_config: T.any(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig, Orb::Internal::AnyHash)
925
1009
  )
926
1010
  .void
927
1011
  end
@@ -934,32 +1018,33 @@ module Orb
934
1018
  params(
935
1019
  amount: String,
936
1020
  grouping: T.nilable(
937
- T.any(
938
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping,
939
- Orb::Internal::AnyHash
940
- )
1021
+ T.any(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping, Orb::Internal::AnyHash)
941
1022
  ),
942
1023
  name: String,
943
1024
  quantity: Float,
944
- tier_config: T.any(
945
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig,
946
- Orb::Internal::AnyHash
947
- ),
1025
+ tier_config: T.any(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig, Orb::Internal::AnyHash),
948
1026
  type: Symbol
949
1027
  )
950
1028
  .returns(T.attached_class)
951
1029
  end
952
- def self.new(amount:, grouping:, name:, quantity:, tier_config:, type: :tier); end
953
-
1030
+ def self.new(
1031
+ # The total amount for this sub line item.
1032
+ amount:,
1033
+ grouping:,
1034
+ name:,
1035
+ quantity:,
1036
+ tier_config:,
1037
+ type: :tier
1038
+ ); end
954
1039
  sig do
955
1040
  override
956
1041
  .returns(
957
1042
  {
958
1043
  amount: String,
959
- grouping: T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::Grouping),
1044
+ grouping: T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::Grouping),
960
1045
  name: String,
961
1046
  quantity: Float,
962
- tier_config: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem::TierConfig,
1047
+ tier_config: Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier::TierConfig,
963
1048
  type: Symbol
964
1049
  }
965
1050
  )
@@ -975,8 +1060,11 @@ module Orb
975
1060
  attr_accessor :value
976
1061
 
977
1062
  sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
978
- def self.new(key:, value:); end
979
-
1063
+ def self.new(
1064
+ key:,
1065
+ # No value indicates the default group
1066
+ value:
1067
+ ); end
980
1068
  sig { override.returns({key: String, value: T.nilable(String)}) }
981
1069
  def to_hash; end
982
1070
  end
@@ -1005,21 +1093,18 @@ module Orb
1005
1093
  end
1006
1094
  end
1007
1095
 
1008
- class OtherSubLineItem < Orb::Internal::Type::BaseModel
1096
+ class Null < Orb::Internal::Type::BaseModel
1009
1097
  # The total amount for this sub line item.
1010
1098
  sig { returns(String) }
1011
1099
  attr_accessor :amount
1012
1100
 
1013
- sig { returns(T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping)) }
1101
+ sig { returns(T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping)) }
1014
1102
  attr_reader :grouping
1015
1103
 
1016
1104
  sig do
1017
1105
  params(
1018
1106
  grouping: T.nilable(
1019
- T.any(
1020
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping,
1021
- Orb::Internal::AnyHash
1022
- )
1107
+ T.any(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping, Orb::Internal::AnyHash)
1023
1108
  )
1024
1109
  )
1025
1110
  .void
@@ -1039,10 +1124,7 @@ module Orb
1039
1124
  params(
1040
1125
  amount: String,
1041
1126
  grouping: T.nilable(
1042
- T.any(
1043
- Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping,
1044
- Orb::Internal::AnyHash
1045
- )
1127
+ T.any(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping, Orb::Internal::AnyHash)
1046
1128
  ),
1047
1129
  name: String,
1048
1130
  quantity: Float,
@@ -1050,14 +1132,20 @@ module Orb
1050
1132
  )
1051
1133
  .returns(T.attached_class)
1052
1134
  end
1053
- def self.new(amount:, grouping:, name:, quantity:, type: :"'null'"); end
1054
-
1135
+ def self.new(
1136
+ # The total amount for this sub line item.
1137
+ amount:,
1138
+ grouping:,
1139
+ name:,
1140
+ quantity:,
1141
+ type: :"'null'"
1142
+ ); end
1055
1143
  sig do
1056
1144
  override
1057
1145
  .returns(
1058
1146
  {
1059
1147
  amount: String,
1060
- grouping: T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem::Grouping),
1148
+ grouping: T.nilable(Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null::Grouping),
1061
1149
  name: String,
1062
1150
  quantity: Float,
1063
1151
  type: Symbol
@@ -1075,8 +1163,11 @@ module Orb
1075
1163
  attr_accessor :value
1076
1164
 
1077
1165
  sig { params(key: String, value: T.nilable(String)).returns(T.attached_class) }
1078
- def self.new(key:, value:); end
1079
-
1166
+ def self.new(
1167
+ key:,
1168
+ # No value indicates the default group
1169
+ value:
1170
+ ); end
1080
1171
  sig { override.returns({key: String, value: T.nilable(String)}) }
1081
1172
  def to_hash; end
1082
1173
  end
@@ -1085,7 +1176,7 @@ module Orb
1085
1176
  sig do
1086
1177
  override
1087
1178
  .returns(
1088
- [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::TierSubLineItem, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::OtherSubLineItem]
1179
+ [Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Matrix, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Tier, Orb::Models::InvoiceLineItemCreateResponse::SubLineItem::Null]
1089
1180
  )
1090
1181
  end
1091
1182
  def self.variants; end
@@ -1108,8 +1199,14 @@ module Orb
1108
1199
  params(amount: String, tax_rate_description: String, tax_rate_percentage: T.nilable(String))
1109
1200
  .returns(T.attached_class)
1110
1201
  end
1111
- def self.new(amount:, tax_rate_description:, tax_rate_percentage:); end
1112
-
1202
+ def self.new(
1203
+ # The amount of additional tax incurred by this tax rate.
1204
+ amount:,
1205
+ # The human-readable description of the applied tax rate.
1206
+ tax_rate_description:,
1207
+ # The tax rate percentage, out of 100.
1208
+ tax_rate_percentage:
1209
+ ); end
1113
1210
  sig do
1114
1211
  override.returns(
1115
1212
  {