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
@@ -167,6 +167,8 @@ module Orb
167
167
  required :customer_tax_id, -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID }, nil?: true
168
168
 
169
169
  # @!attribute discount
170
+ # @deprecated
171
+ #
170
172
  # This field is deprecated in favor of `discounts`. If a `discounts` list is
171
173
  # provided, the first discount in the list will be returned. If the list is empty,
172
174
  # `None` will be returned.
@@ -367,97 +369,109 @@ module Orb
367
369
  # @return [Boolean]
368
370
  required :will_auto_issue, Orb::Internal::Type::Boolean
369
371
 
370
- # @!parse
371
- # # @param id [String]
372
- # # @param amount_due [String]
373
- # # @param auto_collection [Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection]
374
- # # @param billing_address [Orb::Models::InvoiceFetchUpcomingResponse::BillingAddress, nil]
375
- # # @param created_at [Time]
376
- # # @param credit_notes [Array<Orb::Models::InvoiceFetchUpcomingResponse::CreditNote>]
377
- # # @param currency [String]
378
- # # @param customer [Orb::Models::InvoiceFetchUpcomingResponse::Customer]
379
- # # @param customer_balance_transactions [Array<Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction>]
380
- # # @param customer_tax_id [Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, nil]
381
- # # @param discount [Object]
382
- # # @param discounts [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
383
- # # @param due_date [Time, nil]
384
- # # @param eligible_to_issue_at [Time, nil]
385
- # # @param hosted_invoice_url [String, nil]
386
- # # @param invoice_number [String]
387
- # # @param invoice_pdf [String, nil]
388
- # # @param invoice_source [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource]
389
- # # @param issue_failed_at [Time, nil]
390
- # # @param issued_at [Time, nil]
391
- # # @param line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem>]
392
- # # @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::Maximum, nil]
393
- # # @param maximum_amount [String, nil]
394
- # # @param memo [String, nil]
395
- # # @param metadata [Hash{Symbol=>String}]
396
- # # @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::Minimum, nil]
397
- # # @param minimum_amount [String, nil]
398
- # # @param paid_at [Time, nil]
399
- # # @param payment_attempts [Array<Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt>]
400
- # # @param payment_failed_at [Time, nil]
401
- # # @param payment_started_at [Time, nil]
402
- # # @param scheduled_issue_at [Time, nil]
403
- # # @param shipping_address [Orb::Models::InvoiceFetchUpcomingResponse::ShippingAddress, nil]
404
- # # @param status [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status]
405
- # # @param subscription [Orb::Models::InvoiceFetchUpcomingResponse::Subscription, nil]
406
- # # @param subtotal [String]
407
- # # @param sync_failed_at [Time, nil]
408
- # # @param target_date [Time]
409
- # # @param total [String]
410
- # # @param voided_at [Time, nil]
411
- # # @param will_auto_issue [Boolean]
412
- # #
413
- # def initialize(
414
- # id:,
415
- # amount_due:,
416
- # auto_collection:,
417
- # billing_address:,
418
- # created_at:,
419
- # credit_notes:,
420
- # currency:,
421
- # customer:,
422
- # customer_balance_transactions:,
423
- # customer_tax_id:,
424
- # discount:,
425
- # discounts:,
426
- # due_date:,
427
- # eligible_to_issue_at:,
428
- # hosted_invoice_url:,
429
- # invoice_number:,
430
- # invoice_pdf:,
431
- # invoice_source:,
432
- # issue_failed_at:,
433
- # issued_at:,
434
- # line_items:,
435
- # maximum:,
436
- # maximum_amount:,
437
- # memo:,
438
- # metadata:,
439
- # minimum:,
440
- # minimum_amount:,
441
- # paid_at:,
442
- # payment_attempts:,
443
- # payment_failed_at:,
444
- # payment_started_at:,
445
- # scheduled_issue_at:,
446
- # shipping_address:,
447
- # status:,
448
- # subscription:,
449
- # subtotal:,
450
- # sync_failed_at:,
451
- # target_date:,
452
- # total:,
453
- # voided_at:,
454
- # will_auto_issue:,
455
- # **
456
- # )
457
- # super
458
- # end
459
-
460
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
372
+ # @!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_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:, target_date:, total:, voided_at:, will_auto_issue:)
373
+ # Some parameter documentations has been truncated, see
374
+ # {Orb::Models::InvoiceFetchUpcomingResponse} for more details.
375
+ #
376
+ # @param id [String]
377
+ #
378
+ # @param amount_due [String] This is the final amount required to be charged to the customer and reflects the
379
+ # ...
380
+ #
381
+ # @param auto_collection [Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection]
382
+ #
383
+ # @param billing_address [Orb::Models::InvoiceFetchUpcomingResponse::BillingAddress, nil]
384
+ #
385
+ # @param created_at [Time] The creation time of the resource in Orb.
386
+ #
387
+ # @param credit_notes [Array<Orb::Models::InvoiceFetchUpcomingResponse::CreditNote>] A list of credit notes associated with the invoice
388
+ #
389
+ # @param currency [String] An ISO 4217 currency string or `credits`
390
+ #
391
+ # @param customer [Orb::Models::InvoiceFetchUpcomingResponse::Customer]
392
+ #
393
+ # @param customer_balance_transactions [Array<Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction>]
394
+ #
395
+ # @param customer_tax_id [Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
396
+ # ...
397
+ #
398
+ # @param discount [Object] This field is deprecated in favor of `discounts`. If a `discounts` list is provi
399
+ # ...
400
+ #
401
+ # @param discounts [Array<Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount, Orb::Models::TrialDiscount>]
402
+ #
403
+ # @param due_date [Time, nil] When the invoice payment is due. The due date is null if the invoice is not yet
404
+ # ...
405
+ #
406
+ # @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
407
+ # ...
408
+ #
409
+ # @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the
410
+ # ...
411
+ #
412
+ # @param invoice_number [String] Automatically generated invoice number to help track and reconcile invoices. Inv
413
+ # ...
414
+ #
415
+ # @param invoice_pdf [String, nil] The link to download the PDF representation of the `Invoice`.
416
+ #
417
+ # @param invoice_source [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::InvoiceSource]
418
+ #
419
+ # @param issue_failed_at [Time, nil] If the invoice failed to issue, this will be the last time it failed to issue (e
420
+ # ...
421
+ #
422
+ # @param issued_at [Time, nil] If the invoice has been issued, this will be the time it transitioned to `issued
423
+ # ...
424
+ #
425
+ # @param line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem>] The breakdown of prices in this invoice.
426
+ #
427
+ # @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::Maximum, nil]
428
+ #
429
+ # @param maximum_amount [String, nil]
430
+ #
431
+ # @param memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
432
+ # ...
433
+ #
434
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
435
+ # ...
436
+ #
437
+ # @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::Minimum, nil]
438
+ #
439
+ # @param minimum_amount [String, nil]
440
+ #
441
+ # @param paid_at [Time, nil] If the invoice has a status of `paid`, this gives a timestamp when the invoice w
442
+ # ...
443
+ #
444
+ # @param payment_attempts [Array<Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt>] A list of payment attempts associated with the invoice
445
+ #
446
+ # @param payment_failed_at [Time, nil] If payment was attempted on this invoice but failed, this will be the time of th
447
+ # ...
448
+ #
449
+ # @param payment_started_at [Time, nil] If payment was attempted on this invoice, this will be the start time of the mos
450
+ # ...
451
+ #
452
+ # @param scheduled_issue_at [Time, nil] If the invoice is in draft, this timestamp will reflect when the invoice is sche
453
+ # ...
454
+ #
455
+ # @param shipping_address [Orb::Models::InvoiceFetchUpcomingResponse::ShippingAddress, nil]
456
+ #
457
+ # @param status [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::Status]
458
+ #
459
+ # @param subscription [Orb::Models::InvoiceFetchUpcomingResponse::Subscription, nil]
460
+ #
461
+ # @param subtotal [String] The total before any discounts and minimums are applied.
462
+ #
463
+ # @param sync_failed_at [Time, nil] If the invoice failed to sync, this will be the last time an external invoicing
464
+ # ...
465
+ #
466
+ # @param target_date [Time] The scheduled date of the invoice
467
+ #
468
+ # @param total [String] The total after any minimums and discounts have been applied.
469
+ #
470
+ # @param voided_at [Time, nil] If the invoice has a status of `void`, this gives a timestamp when the invoice w
471
+ # ...
472
+ #
473
+ # @param will_auto_issue [Boolean] This is true if the invoice will be automatically issued in the future, and fals
474
+ # ...
461
475
 
462
476
  # @see Orb::Models::InvoiceFetchUpcomingResponse#auto_collection
463
477
  class AutoCollection < Orb::Internal::Type::BaseModel
@@ -492,15 +506,19 @@ module Orb
492
506
  # @return [Time, nil]
493
507
  required :previously_attempted_at, Time, nil?: true
494
508
 
495
- # @!parse
496
- # # @param enabled [Boolean, nil]
497
- # # @param next_attempt_at [Time, nil]
498
- # # @param num_attempts [Integer, nil]
499
- # # @param previously_attempted_at [Time, nil]
500
- # #
501
- # def initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:, **) = super
502
-
503
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
509
+ # @!method initialize(enabled:, next_attempt_at:, num_attempts:, previously_attempted_at:)
510
+ # Some parameter documentations has been truncated, see
511
+ # {Orb::Models::InvoiceFetchUpcomingResponse::AutoCollection} for more details.
512
+ #
513
+ # @param enabled [Boolean, nil] True only if auto-collection is enabled for this invoice.
514
+ #
515
+ # @param next_attempt_at [Time, nil] If the invoice is scheduled for auto-collection, this field will reflect when th
516
+ # ...
517
+ #
518
+ # @param num_attempts [Integer, nil] Number of auto-collection payment attempts.
519
+ #
520
+ # @param previously_attempted_at [Time, nil] If Orb has ever attempted payment auto-collection for this invoice, this field w
521
+ # ...
504
522
  end
505
523
 
506
524
  # @see Orb::Models::InvoiceFetchUpcomingResponse#billing_address
@@ -535,17 +553,13 @@ module Orb
535
553
  # @return [String, nil]
536
554
  required :state, String, nil?: true
537
555
 
538
- # @!parse
539
- # # @param city [String, nil]
540
- # # @param country [String, nil]
541
- # # @param line1 [String, nil]
542
- # # @param line2 [String, nil]
543
- # # @param postal_code [String, nil]
544
- # # @param state [String, nil]
545
- # #
546
- # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
547
-
548
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
556
+ # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
557
+ # @param city [String, nil]
558
+ # @param country [String, nil]
559
+ # @param line1 [String, nil]
560
+ # @param line2 [String, nil]
561
+ # @param postal_code [String, nil]
562
+ # @param state [String, nil]
549
563
  end
550
564
 
551
565
  class CreditNote < Orb::Internal::Type::BaseModel
@@ -587,18 +601,24 @@ module Orb
587
601
  # @return [Time, nil]
588
602
  required :voided_at, Time, nil?: true
589
603
 
590
- # @!parse
591
- # # @param id [String]
592
- # # @param credit_note_number [String]
593
- # # @param memo [String, nil]
594
- # # @param reason [String]
595
- # # @param total [String]
596
- # # @param type [String]
597
- # # @param voided_at [Time, nil]
598
- # #
599
- # def initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:, **) = super
600
-
601
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
604
+ # @!method initialize(id:, credit_note_number:, memo:, reason:, total:, type:, voided_at:)
605
+ # Some parameter documentations has been truncated, see
606
+ # {Orb::Models::InvoiceFetchUpcomingResponse::CreditNote} for more details.
607
+ #
608
+ # @param id [String]
609
+ #
610
+ # @param credit_note_number [String]
611
+ #
612
+ # @param memo [String, nil] An optional memo supplied on the credit note.
613
+ #
614
+ # @param reason [String]
615
+ #
616
+ # @param total [String]
617
+ #
618
+ # @param type [String]
619
+ #
620
+ # @param voided_at [Time, nil] If the credit note has a status of `void`, this gives a timestamp when the credi
621
+ # ...
602
622
  end
603
623
 
604
624
  # @see Orb::Models::InvoiceFetchUpcomingResponse#customer
@@ -613,13 +633,9 @@ module Orb
613
633
  # @return [String, nil]
614
634
  required :external_customer_id, String, nil?: true
615
635
 
616
- # @!parse
617
- # # @param id [String]
618
- # # @param external_customer_id [String, nil]
619
- # #
620
- # def initialize(id:, external_customer_id:, **) = super
621
-
622
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
636
+ # @!method initialize(id:, external_customer_id:)
637
+ # @param id [String]
638
+ # @param external_customer_id [String, nil]
623
639
  end
624
640
 
625
641
  class CustomerBalanceTransaction < Orb::Internal::Type::BaseModel
@@ -686,35 +702,32 @@ module Orb
686
702
  # @return [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type]
687
703
  required :type, enum: -> { Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type }
688
704
 
689
- # @!parse
690
- # # @param id [String]
691
- # # @param action [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action]
692
- # # @param amount [String]
693
- # # @param created_at [Time]
694
- # # @param credit_note [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::CreditNote, nil]
695
- # # @param description [String, nil]
696
- # # @param ending_balance [String]
697
- # # @param invoice [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Invoice, nil]
698
- # # @param starting_balance [String]
699
- # # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type]
700
- # #
701
- # def initialize(
702
- # id:,
703
- # action:,
704
- # amount:,
705
- # created_at:,
706
- # credit_note:,
707
- # description:,
708
- # ending_balance:,
709
- # invoice:,
710
- # starting_balance:,
711
- # type:,
712
- # **
713
- # )
714
- # super
715
- # end
716
-
717
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
705
+ # @!method initialize(id:, action:, amount:, created_at:, credit_note:, description:, ending_balance:, invoice:, starting_balance:, type:)
706
+ # Some parameter documentations has been truncated, see
707
+ # {Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction} for more
708
+ # details.
709
+ #
710
+ # @param id [String] A unique id for this transaction.
711
+ #
712
+ # @param action [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action]
713
+ #
714
+ # @param amount [String] The value of the amount changed in the transaction.
715
+ #
716
+ # @param created_at [Time] The creation time of this transaction.
717
+ #
718
+ # @param credit_note [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::CreditNote, nil]
719
+ #
720
+ # @param description [String, nil] An optional description provided for manual customer balance adjustments.
721
+ #
722
+ # @param ending_balance [String] The new value of the customer's balance prior to the transaction, in the custome
723
+ # ...
724
+ #
725
+ # @param invoice [Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Invoice, nil]
726
+ #
727
+ # @param starting_balance [String] The original value of the customer's balance prior to the transaction, in the cu
728
+ # ...
729
+ #
730
+ # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type]
718
731
 
719
732
  # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#action
720
733
  module Action
@@ -730,11 +743,8 @@ module Orb
730
743
  OVERPAYMENT_REFUND = :overpayment_refund
731
744
  EXTERNAL_PAYMENT = :external_payment
732
745
 
733
- finalize!
734
-
735
- # @!parse
736
- # # @return [Array<Symbol>]
737
- # def self.values; end
746
+ # @!method self.values
747
+ # @return [Array<Symbol>]
738
748
  end
739
749
 
740
750
  # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#credit_note
@@ -745,12 +755,8 @@ module Orb
745
755
  # @return [String]
746
756
  required :id, String
747
757
 
748
- # @!parse
749
- # # @param id [String]
750
- # #
751
- # def initialize(id:, **) = super
752
-
753
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
758
+ # @!method initialize(id:)
759
+ # @param id [String] The id of the Credit note
754
760
  end
755
761
 
756
762
  # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#invoice
@@ -761,12 +767,8 @@ module Orb
761
767
  # @return [String]
762
768
  required :id, String
763
769
 
764
- # @!parse
765
- # # @param id [String]
766
- # #
767
- # def initialize(id:, **) = super
768
-
769
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
770
+ # @!method initialize(id:)
771
+ # @param id [String] The Invoice id
770
772
  end
771
773
 
772
774
  # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction#type
@@ -776,11 +778,8 @@ module Orb
776
778
  INCREMENT = :increment
777
779
  DECREMENT = :decrement
778
780
 
779
- finalize!
780
-
781
- # @!parse
782
- # # @return [Array<Symbol>]
783
- # def self.values; end
781
+ # @!method self.values
782
+ # @return [Array<Symbol>]
784
783
  end
785
784
  end
786
785
 
@@ -801,120 +800,116 @@ module Orb
801
800
  # @return [String]
802
801
  required :value, String
803
802
 
804
- # @!parse
805
- # # Tax IDs are commonly required to be displayed on customer invoices, which are
806
- # # added to the headers of invoices.
807
- # #
808
- # # ### Supported Tax ID Countries and Types
809
- # #
810
- # # | Country | Type | Description |
811
- # # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
812
- # # | Andorra | `ad_nrt` | Andorran NRT Number |
813
- # # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
814
- # # | Australia | `au_abn` | Australian Business Number (AU ABN) |
815
- # # | Australia | `au_arn` | Australian Taxation Office Reference Number |
816
- # # | Austria | `eu_vat` | European VAT Number |
817
- # # | Bahrain | `bh_vat` | Bahraini VAT Number |
818
- # # | Belgium | `eu_vat` | European VAT Number |
819
- # # | Bolivia | `bo_tin` | Bolivian Tax ID |
820
- # # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
821
- # # | Brazil | `br_cpf` | Brazilian CPF Number |
822
- # # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
823
- # # | Bulgaria | `eu_vat` | European VAT Number |
824
- # # | Canada | `ca_bn` | Canadian BN |
825
- # # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
826
- # # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
827
- # # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
828
- # # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
829
- # # | Canada | `ca_qst` | Canadian QST Number (Québec) |
830
- # # | Chile | `cl_tin` | Chilean TIN |
831
- # # | China | `cn_tin` | Chinese Tax ID |
832
- # # | Colombia | `co_nit` | Colombian NIT Number |
833
- # # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
834
- # # | Croatia | `eu_vat` | European VAT Number |
835
- # # | Cyprus | `eu_vat` | European VAT Number |
836
- # # | Czech Republic | `eu_vat` | European VAT Number |
837
- # # | Denmark | `eu_vat` | European VAT Number |
838
- # # | Dominican Republic | `do_rcn` | Dominican RCN Number |
839
- # # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
840
- # # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
841
- # # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
842
- # # | Estonia | `eu_vat` | European VAT Number |
843
- # # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
844
- # # | Finland | `eu_vat` | European VAT Number |
845
- # # | France | `eu_vat` | European VAT Number |
846
- # # | Georgia | `ge_vat` | Georgian VAT |
847
- # # | Germany | `eu_vat` | European VAT Number |
848
- # # | Greece | `eu_vat` | European VAT Number |
849
- # # | Hong Kong | `hk_br` | Hong Kong BR Number |
850
- # # | Hungary | `eu_vat` | European VAT Number |
851
- # # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
852
- # # | Iceland | `is_vat` | Icelandic VAT |
853
- # # | India | `in_gst` | Indian GST Number |
854
- # # | Indonesia | `id_npwp` | Indonesian NPWP Number |
855
- # # | Ireland | `eu_vat` | European VAT Number |
856
- # # | Israel | `il_vat` | Israel VAT |
857
- # # | Italy | `eu_vat` | European VAT Number |
858
- # # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
859
- # # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
860
- # # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
861
- # # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
862
- # # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
863
- # # | Latvia | `eu_vat` | European VAT Number |
864
- # # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
865
- # # | Lithuania | `eu_vat` | European VAT Number |
866
- # # | Luxembourg | `eu_vat` | European VAT Number |
867
- # # | Malaysia | `my_frp` | Malaysian FRP Number |
868
- # # | Malaysia | `my_itn` | Malaysian ITN |
869
- # # | Malaysia | `my_sst` | Malaysian SST Number |
870
- # # | Malta | `eu_vat ` | European VAT Number |
871
- # # | Mexico | `mx_rfc` | Mexican RFC Number |
872
- # # | Netherlands | `eu_vat` | European VAT Number |
873
- # # | New Zealand | `nz_gst` | New Zealand GST Number |
874
- # # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
875
- # # | Norway | `no_vat` | Norwegian VAT Number |
876
- # # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
877
- # # | Oman | `om_vat` | Omani VAT Number |
878
- # # | Peru | `pe_ruc` | Peruvian RUC Number |
879
- # # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
880
- # # | Poland | `eu_vat` | European VAT Number |
881
- # # | Portugal | `eu_vat` | European VAT Number |
882
- # # | Romania | `eu_vat` | European VAT Number |
883
- # # | Romania | `ro_tin` | Romanian Tax ID Number |
884
- # # | Russia | `ru_inn` | Russian INN |
885
- # # | Russia | `ru_kpp` | Russian KPP |
886
- # # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
887
- # # | Serbia | `rs_pib` | Serbian PIB Number |
888
- # # | Singapore | `sg_gst` | Singaporean GST |
889
- # # | Singapore | `sg_uen` | Singaporean UEN |
890
- # # | Slovakia | `eu_vat` | European VAT Number |
891
- # # | Slovenia | `eu_vat` | European VAT Number |
892
- # # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
893
- # # | South Africa | `za_vat` | South African VAT Number |
894
- # # | South Korea | `kr_brn` | Korean BRN |
895
- # # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
896
- # # | Spain | `eu_vat` | European VAT Number |
897
- # # | Sweden | `eu_vat` | European VAT Number |
898
- # # | Switzerland | `ch_vat` | Switzerland VAT Number |
899
- # # | Taiwan | `tw_vat` | Taiwanese VAT |
900
- # # | Thailand | `th_vat` | Thai VAT |
901
- # # | Turkey | `tr_tin` | Turkish Tax Identification Number |
902
- # # | Ukraine | `ua_vat` | Ukrainian VAT |
903
- # # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
904
- # # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
905
- # # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
906
- # # | United States | `us_ein` | United States EIN |
907
- # # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
908
- # # | Venezuela | `ve_rif` | Venezuelan RIF Number |
909
- # # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
910
- # #
911
- # # @param country [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country]
912
- # # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type]
913
- # # @param value [String]
914
- # #
915
- # def initialize(country:, type:, value:, **) = super
916
-
917
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
803
+ # @!method initialize(country:, type:, value:)
804
+ # Tax IDs are commonly required to be displayed on customer invoices, which are
805
+ # added to the headers of invoices.
806
+ #
807
+ # ### Supported Tax ID Countries and Types
808
+ #
809
+ # | Country | Type | Description |
810
+ # | -------------------- | ------------ | ------------------------------------------------------------------------------------------------------- |
811
+ # | Andorra | `ad_nrt` | Andorran NRT Number |
812
+ # | Argentina | `ar_cuit` | Argentinian Tax ID Number |
813
+ # | Australia | `au_abn` | Australian Business Number (AU ABN) |
814
+ # | Australia | `au_arn` | Australian Taxation Office Reference Number |
815
+ # | Austria | `eu_vat` | European VAT Number |
816
+ # | Bahrain | `bh_vat` | Bahraini VAT Number |
817
+ # | Belgium | `eu_vat` | European VAT Number |
818
+ # | Bolivia | `bo_tin` | Bolivian Tax ID |
819
+ # | Brazil | `br_cnpj` | Brazilian CNPJ Number |
820
+ # | Brazil | `br_cpf` | Brazilian CPF Number |
821
+ # | Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |
822
+ # | Bulgaria | `eu_vat` | European VAT Number |
823
+ # | Canada | `ca_bn` | Canadian BN |
824
+ # | Canada | `ca_gst_hst` | Canadian GST/HST Number |
825
+ # | Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |
826
+ # | Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |
827
+ # | Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |
828
+ # | Canada | `ca_qst` | Canadian QST Number (Québec) |
829
+ # | Chile | `cl_tin` | Chilean TIN |
830
+ # | China | `cn_tin` | Chinese Tax ID |
831
+ # | Colombia | `co_nit` | Colombian NIT Number |
832
+ # | Costa Rica | `cr_tin` | Costa Rican Tax ID |
833
+ # | Croatia | `eu_vat` | European VAT Number |
834
+ # | Cyprus | `eu_vat` | European VAT Number |
835
+ # | Czech Republic | `eu_vat` | European VAT Number |
836
+ # | Denmark | `eu_vat` | European VAT Number |
837
+ # | Dominican Republic | `do_rcn` | Dominican RCN Number |
838
+ # | Ecuador | `ec_ruc` | Ecuadorian RUC Number |
839
+ # | Egypt | `eg_tin` | Egyptian Tax Identification Number |
840
+ # | El Salvador | `sv_nit` | El Salvadorian NIT Number |
841
+ # | Estonia | `eu_vat` | European VAT Number |
842
+ # | EU | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |
843
+ # | Finland | `eu_vat` | European VAT Number |
844
+ # | France | `eu_vat` | European VAT Number |
845
+ # | Georgia | `ge_vat` | Georgian VAT |
846
+ # | Germany | `eu_vat` | European VAT Number |
847
+ # | Greece | `eu_vat` | European VAT Number |
848
+ # | Hong Kong | `hk_br` | Hong Kong BR Number |
849
+ # | Hungary | `eu_vat` | European VAT Number |
850
+ # | Hungary | `hu_tin` | Hungary Tax Number (adószám) |
851
+ # | Iceland | `is_vat` | Icelandic VAT |
852
+ # | India | `in_gst` | Indian GST Number |
853
+ # | Indonesia | `id_npwp` | Indonesian NPWP Number |
854
+ # | Ireland | `eu_vat` | European VAT Number |
855
+ # | Israel | `il_vat` | Israel VAT |
856
+ # | Italy | `eu_vat` | European VAT Number |
857
+ # | Japan | `jp_cn` | Japanese Corporate Number (_Hōjin Bangō_) |
858
+ # | Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
859
+ # | Japan | `jp_trn` | Japanese Tax Registration Number (_Tōroku Bangō_) |
860
+ # | Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |
861
+ # | Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |
862
+ # | Latvia | `eu_vat` | European VAT Number |
863
+ # | Liechtenstein | `li_uid` | Liechtensteinian UID Number |
864
+ # | Lithuania | `eu_vat` | European VAT Number |
865
+ # | Luxembourg | `eu_vat` | European VAT Number |
866
+ # | Malaysia | `my_frp` | Malaysian FRP Number |
867
+ # | Malaysia | `my_itn` | Malaysian ITN |
868
+ # | Malaysia | `my_sst` | Malaysian SST Number |
869
+ # | Malta | `eu_vat ` | European VAT Number |
870
+ # | Mexico | `mx_rfc` | Mexican RFC Number |
871
+ # | Netherlands | `eu_vat` | European VAT Number |
872
+ # | New Zealand | `nz_gst` | New Zealand GST Number |
873
+ # | Nigeria | `ng_tin` | Nigerian Tax Identification Number |
874
+ # | Norway | `no_vat` | Norwegian VAT Number |
875
+ # | Norway | `no_voec` | Norwegian VAT on e-commerce Number |
876
+ # | Oman | `om_vat` | Omani VAT Number |
877
+ # | Peru | `pe_ruc` | Peruvian RUC Number |
878
+ # | Philippines | `ph_tin ` | Philippines Tax Identification Number |
879
+ # | Poland | `eu_vat` | European VAT Number |
880
+ # | Portugal | `eu_vat` | European VAT Number |
881
+ # | Romania | `eu_vat` | European VAT Number |
882
+ # | Romania | `ro_tin` | Romanian Tax ID Number |
883
+ # | Russia | `ru_inn` | Russian INN |
884
+ # | Russia | `ru_kpp` | Russian KPP |
885
+ # | Saudi Arabia | `sa_vat` | Saudi Arabia VAT |
886
+ # | Serbia | `rs_pib` | Serbian PIB Number |
887
+ # | Singapore | `sg_gst` | Singaporean GST |
888
+ # | Singapore | `sg_uen` | Singaporean UEN |
889
+ # | Slovakia | `eu_vat` | European VAT Number |
890
+ # | Slovenia | `eu_vat` | European VAT Number |
891
+ # | Slovenia | `si_tin` | Slovenia Tax Number (davčna številka) |
892
+ # | South Africa | `za_vat` | South African VAT Number |
893
+ # | South Korea | `kr_brn` | Korean BRN |
894
+ # | Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |
895
+ # | Spain | `eu_vat` | European VAT Number |
896
+ # | Sweden | `eu_vat` | European VAT Number |
897
+ # | Switzerland | `ch_vat` | Switzerland VAT Number |
898
+ # | Taiwan | `tw_vat` | Taiwanese VAT |
899
+ # | Thailand | `th_vat` | Thai VAT |
900
+ # | Turkey | `tr_tin` | Turkish Tax Identification Number |
901
+ # | Ukraine | `ua_vat` | Ukrainian VAT |
902
+ # | United Arab Emirates | `ae_trn` | United Arab Emirates TRN |
903
+ # | United Kingdom | `eu_vat` | Northern Ireland VAT Number |
904
+ # | United Kingdom | `gb_vat` | United Kingdom VAT Number |
905
+ # | United States | `us_ein` | United States EIN |
906
+ # | Uruguay | `uy_ruc` | Uruguayan RUC Number |
907
+ # | Venezuela | `ve_rif` | Venezuelan RIF Number |
908
+ # | Vietnam | `vn_tin` | Vietnamese Tax ID Number |
909
+ #
910
+ # @param country [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Country]
911
+ # @param type [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID::Type]
912
+ # @param value [String]
918
913
 
919
914
  # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#country
920
915
  module Country
@@ -999,11 +994,8 @@ module Orb
999
994
  VN = :VN
1000
995
  ZA = :ZA
1001
996
 
1002
- finalize!
1003
-
1004
- # @!parse
1005
- # # @return [Array<Symbol>]
1006
- # def self.values; end
997
+ # @!method self.values
998
+ # @return [Array<Symbol>]
1007
999
  end
1008
1000
 
1009
1001
  # @see Orb::Models::InvoiceFetchUpcomingResponse::CustomerTaxID#type
@@ -1082,11 +1074,8 @@ module Orb
1082
1074
  VN_TIN = :vn_tin
1083
1075
  ZA_VAT = :za_vat
1084
1076
 
1085
- finalize!
1086
-
1087
- # @!parse
1088
- # # @return [Array<Symbol>]
1089
- # def self.values; end
1077
+ # @!method self.values
1078
+ # @return [Array<Symbol>]
1090
1079
  end
1091
1080
  end
1092
1081
 
@@ -1098,11 +1087,8 @@ module Orb
1098
1087
  PARTIAL = :partial
1099
1088
  ONE_OFF = :one_off
1100
1089
 
1101
- finalize!
1102
-
1103
- # @!parse
1104
- # # @return [Array<Symbol>]
1105
- # def self.values; end
1090
+ # @!method self.values
1091
+ # @return [Array<Symbol>]
1106
1092
  end
1107
1093
 
1108
1094
  class LineItem < Orb::Internal::Type::BaseModel
@@ -1124,7 +1110,7 @@ module Orb
1124
1110
  # invoice calculations (ie. usage discounts -> amount discounts -> percentage
1125
1111
  # discounts -> minimums -> maximums).
1126
1112
  #
1127
- # @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment>]
1113
+ # @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum>]
1128
1114
  required :adjustments,
1129
1115
  -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment] }
1130
1116
 
@@ -1167,24 +1153,32 @@ module Orb
1167
1153
  required :grouping, String, nil?: true
1168
1154
 
1169
1155
  # @!attribute maximum
1156
+ # @deprecated
1157
+ #
1170
1158
  # This field is deprecated in favor of `adjustments`.
1171
1159
  #
1172
1160
  # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil]
1173
1161
  required :maximum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum }, nil?: true
1174
1162
 
1175
1163
  # @!attribute maximum_amount
1164
+ # @deprecated
1165
+ #
1176
1166
  # This field is deprecated in favor of `adjustments`.
1177
1167
  #
1178
1168
  # @return [String, nil]
1179
1169
  required :maximum_amount, String, nil?: true
1180
1170
 
1181
1171
  # @!attribute minimum
1172
+ # @deprecated
1173
+ #
1182
1174
  # This field is deprecated in favor of `adjustments`.
1183
1175
  #
1184
1176
  # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum, nil]
1185
1177
  required :minimum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum }, nil?: true
1186
1178
 
1187
1179
  # @!attribute minimum_amount
1180
+ # @deprecated
1181
+ #
1188
1182
  # This field is deprecated in favor of `adjustments`.
1189
1183
  #
1190
1184
  # @return [String, nil]
@@ -1214,7 +1208,7 @@ module Orb
1214
1208
  # For more on the types of prices, see
1215
1209
  # [the core concepts documentation](/core-concepts#plan-and-price)
1216
1210
  #
1217
- # @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil]
1211
+ # @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]
1218
1212
  required :price, union: -> { Orb::Models::Price }, nil?: true
1219
1213
 
1220
1214
  # @!attribute quantity
@@ -1233,7 +1227,7 @@ module Orb
1233
1227
  # For complex pricing structures, the line item can be broken down further in
1234
1228
  # `sub_line_items`.
1235
1229
  #
1236
- # @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem>]
1230
+ # @return [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null>]
1237
1231
  required :sub_line_items,
1238
1232
  -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem] }
1239
1233
 
@@ -1257,59 +1251,61 @@ module Orb
1257
1251
  # @return [Array<String>, nil]
1258
1252
  required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
1259
1253
 
1260
- # @!parse
1261
- # # @param id [String]
1262
- # # @param adjusted_subtotal [String]
1263
- # # @param adjustments [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment>]
1264
- # # @param amount [String]
1265
- # # @param credits_applied [String]
1266
- # # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
1267
- # # @param end_date [Time]
1268
- # # @param filter [String, nil]
1269
- # # @param grouping [String, nil]
1270
- # # @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil]
1271
- # # @param maximum_amount [String, nil]
1272
- # # @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum, nil]
1273
- # # @param minimum_amount [String, nil]
1274
- # # @param name [String]
1275
- # # @param partially_invoiced_amount [String]
1276
- # # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice, nil]
1277
- # # @param quantity [Float]
1278
- # # @param start_date [Time]
1279
- # # @param sub_line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem>]
1280
- # # @param subtotal [String]
1281
- # # @param tax_amounts [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount>]
1282
- # # @param usage_customer_ids [Array<String>, nil]
1283
- # #
1284
- # def initialize(
1285
- # id:,
1286
- # adjusted_subtotal:,
1287
- # adjustments:,
1288
- # amount:,
1289
- # credits_applied:,
1290
- # discount:,
1291
- # end_date:,
1292
- # filter:,
1293
- # grouping:,
1294
- # maximum:,
1295
- # maximum_amount:,
1296
- # minimum:,
1297
- # minimum_amount:,
1298
- # name:,
1299
- # partially_invoiced_amount:,
1300
- # price:,
1301
- # quantity:,
1302
- # start_date:,
1303
- # sub_line_items:,
1304
- # subtotal:,
1305
- # tax_amounts:,
1306
- # usage_customer_ids:,
1307
- # **
1308
- # )
1309
- # super
1310
- # end
1311
-
1312
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1254
+ # @!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:)
1255
+ # Some parameter documentations has been truncated, see
1256
+ # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem} for more details.
1257
+ #
1258
+ # @param id [String] A unique ID for this line item.
1259
+ #
1260
+ # @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
1261
+ # ...
1262
+ #
1263
+ # @param adjustments [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum>] All adjustments applied to the line item in the order they were applied based on
1264
+ # ...
1265
+ #
1266
+ # @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
1267
+ # ...
1268
+ #
1269
+ # @param credits_applied [String] The number of prepaid credits applied.
1270
+ #
1271
+ # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
1272
+ #
1273
+ # @param end_date [Time] The end date of the range of time applied for this line item's price.
1274
+ #
1275
+ # @param filter [String, nil] An additional filter that was used to calculate the usage for this line item.
1276
+ #
1277
+ # @param grouping [String, nil] [DEPRECATED] For configured prices that are split by a grouping key, this will b
1278
+ # ...
1279
+ #
1280
+ # @param maximum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum, nil] This field is deprecated in favor of `adjustments`.
1281
+ #
1282
+ # @param maximum_amount [String, nil] This field is deprecated in favor of `adjustments`.
1283
+ #
1284
+ # @param minimum [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum, nil] This field is deprecated in favor of `adjustments`.
1285
+ #
1286
+ # @param minimum_amount [String, nil] This field is deprecated in favor of `adjustments`.
1287
+ #
1288
+ # @param name [String] The name of the price associated with this line item.
1289
+ #
1290
+ # @param partially_invoiced_amount [String] Any amount applied from a partial invoice
1291
+ #
1292
+ # @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
1293
+ # ...
1294
+ #
1295
+ # @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
1296
+ #
1297
+ # @param start_date [Time] The start date of the range of time applied for this line item's price.
1298
+ #
1299
+ # @param sub_line_items [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null>] For complex pricing structures, the line item can be broken down further in `sub
1300
+ # ...
1301
+ #
1302
+ # @param subtotal [String] The line amount before before any adjustments.
1303
+ #
1304
+ # @param tax_amounts [Array<Orb::Models::InvoiceFetchUpcomingResponse::LineItem::TaxAmount>] An array of tax rates and their incurred tax amounts. Empty if no tax integratio
1305
+ # ...
1306
+ #
1307
+ # @param usage_customer_ids [Array<String>, nil] A list of customer ids that were used to calculate the usage for this line item.
1308
+ # ...
1313
1309
 
1314
1310
  module Adjustment
1315
1311
  extend Orb::Internal::Type::Union
@@ -1317,21 +1313,19 @@ module Orb
1317
1313
  discriminator :adjustment_type
1318
1314
 
1319
1315
  variant :usage_discount,
1320
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment }
1316
+ -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount }
1321
1317
 
1322
1318
  variant :amount_discount,
1323
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment }
1319
+ -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount }
1324
1320
 
1325
1321
  variant :percentage_discount,
1326
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment }
1322
+ -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount }
1327
1323
 
1328
- variant :minimum,
1329
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment }
1324
+ variant :minimum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum }
1330
1325
 
1331
- variant :maximum,
1332
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment }
1326
+ variant :maximum, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum }
1333
1327
 
1334
- class MonetaryUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
1328
+ class UsageDiscount < Orb::Internal::Type::BaseModel
1335
1329
  # @!attribute id
1336
1330
  #
1337
1331
  # @return [String]
@@ -1374,32 +1368,29 @@ module Orb
1374
1368
  # @return [Float]
1375
1369
  required :usage_discount, Float
1376
1370
 
1377
- # @!parse
1378
- # # @param id [String]
1379
- # # @param amount [String]
1380
- # # @param applies_to_price_ids [Array<String>]
1381
- # # @param is_invoice_level [Boolean]
1382
- # # @param reason [String, nil]
1383
- # # @param usage_discount [Float]
1384
- # # @param adjustment_type [Symbol, :usage_discount]
1385
- # #
1386
- # def initialize(
1387
- # id:,
1388
- # amount:,
1389
- # applies_to_price_ids:,
1390
- # is_invoice_level:,
1391
- # reason:,
1392
- # usage_discount:,
1393
- # adjustment_type: :usage_discount,
1394
- # **
1395
- # )
1396
- # super
1397
- # end
1398
-
1399
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1371
+ # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, reason:, usage_discount:, adjustment_type: :usage_discount)
1372
+ # Some parameter documentations has been truncated, see
1373
+ # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount}
1374
+ # for more details.
1375
+ #
1376
+ # @param id [String]
1377
+ #
1378
+ # @param amount [String] The value applied by an adjustment.
1379
+ #
1380
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1381
+ #
1382
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1383
+ # ...
1384
+ #
1385
+ # @param reason [String, nil] The reason for the adjustment.
1386
+ #
1387
+ # @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
1388
+ # ...
1389
+ #
1390
+ # @param adjustment_type [Symbol, :usage_discount]
1400
1391
  end
1401
1392
 
1402
- class MonetaryAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
1393
+ class AmountDiscount < Orb::Internal::Type::BaseModel
1403
1394
  # @!attribute id
1404
1395
  #
1405
1396
  # @return [String]
@@ -1442,32 +1433,29 @@ module Orb
1442
1433
  # @return [String, nil]
1443
1434
  required :reason, String, nil?: true
1444
1435
 
1445
- # @!parse
1446
- # # @param id [String]
1447
- # # @param amount [String]
1448
- # # @param amount_discount [String]
1449
- # # @param applies_to_price_ids [Array<String>]
1450
- # # @param is_invoice_level [Boolean]
1451
- # # @param reason [String, nil]
1452
- # # @param adjustment_type [Symbol, :amount_discount]
1453
- # #
1454
- # def initialize(
1455
- # id:,
1456
- # amount:,
1457
- # amount_discount:,
1458
- # applies_to_price_ids:,
1459
- # is_invoice_level:,
1460
- # reason:,
1461
- # adjustment_type: :amount_discount,
1462
- # **
1463
- # )
1464
- # super
1465
- # end
1466
-
1467
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1436
+ # @!method initialize(id:, amount:, amount_discount:, applies_to_price_ids:, is_invoice_level:, reason:, adjustment_type: :amount_discount)
1437
+ # Some parameter documentations has been truncated, see
1438
+ # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount}
1439
+ # for more details.
1440
+ #
1441
+ # @param id [String]
1442
+ #
1443
+ # @param amount [String] The value applied by an adjustment.
1444
+ #
1445
+ # @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
1446
+ # ...
1447
+ #
1448
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1449
+ #
1450
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1451
+ # ...
1452
+ #
1453
+ # @param reason [String, nil] The reason for the adjustment.
1454
+ #
1455
+ # @param adjustment_type [Symbol, :amount_discount]
1468
1456
  end
1469
1457
 
1470
- class MonetaryPercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
1458
+ class PercentageDiscount < Orb::Internal::Type::BaseModel
1471
1459
  # @!attribute id
1472
1460
  #
1473
1461
  # @return [String]
@@ -1510,32 +1498,29 @@ module Orb
1510
1498
  # @return [String, nil]
1511
1499
  required :reason, String, nil?: true
1512
1500
 
1513
- # @!parse
1514
- # # @param id [String]
1515
- # # @param amount [String]
1516
- # # @param applies_to_price_ids [Array<String>]
1517
- # # @param is_invoice_level [Boolean]
1518
- # # @param percentage_discount [Float]
1519
- # # @param reason [String, nil]
1520
- # # @param adjustment_type [Symbol, :percentage_discount]
1521
- # #
1522
- # def initialize(
1523
- # id:,
1524
- # amount:,
1525
- # applies_to_price_ids:,
1526
- # is_invoice_level:,
1527
- # percentage_discount:,
1528
- # reason:,
1529
- # adjustment_type: :percentage_discount,
1530
- # **
1531
- # )
1532
- # super
1533
- # end
1534
-
1535
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1501
+ # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, reason:, adjustment_type: :percentage_discount)
1502
+ # Some parameter documentations has been truncated, see
1503
+ # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount}
1504
+ # for more details.
1505
+ #
1506
+ # @param id [String]
1507
+ #
1508
+ # @param amount [String] The value applied by an adjustment.
1509
+ #
1510
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1511
+ #
1512
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1513
+ # ...
1514
+ #
1515
+ # @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
1516
+ # ...
1517
+ #
1518
+ # @param reason [String, nil] The reason for the adjustment.
1519
+ #
1520
+ # @param adjustment_type [Symbol, :percentage_discount]
1536
1521
  end
1537
1522
 
1538
- class MonetaryMinimumAdjustment < Orb::Internal::Type::BaseModel
1523
+ class Minimum < Orb::Internal::Type::BaseModel
1539
1524
  # @!attribute id
1540
1525
  #
1541
1526
  # @return [String]
@@ -1584,34 +1569,31 @@ module Orb
1584
1569
  # @return [String, nil]
1585
1570
  required :reason, String, nil?: true
1586
1571
 
1587
- # @!parse
1588
- # # @param id [String]
1589
- # # @param amount [String]
1590
- # # @param applies_to_price_ids [Array<String>]
1591
- # # @param is_invoice_level [Boolean]
1592
- # # @param item_id [String]
1593
- # # @param minimum_amount [String]
1594
- # # @param reason [String, nil]
1595
- # # @param adjustment_type [Symbol, :minimum]
1596
- # #
1597
- # def initialize(
1598
- # id:,
1599
- # amount:,
1600
- # applies_to_price_ids:,
1601
- # is_invoice_level:,
1602
- # item_id:,
1603
- # minimum_amount:,
1604
- # reason:,
1605
- # adjustment_type: :minimum,
1606
- # **
1607
- # )
1608
- # super
1609
- # end
1610
-
1611
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1572
+ # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, reason:, adjustment_type: :minimum)
1573
+ # Some parameter documentations has been truncated, see
1574
+ # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum} for
1575
+ # more details.
1576
+ #
1577
+ # @param id [String]
1578
+ #
1579
+ # @param amount [String] The value applied by an adjustment.
1580
+ #
1581
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1582
+ #
1583
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1584
+ # ...
1585
+ #
1586
+ # @param item_id [String] The item ID that revenue from this minimum will be attributed to.
1587
+ #
1588
+ # @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
1589
+ # ...
1590
+ #
1591
+ # @param reason [String, nil] The reason for the adjustment.
1592
+ #
1593
+ # @param adjustment_type [Symbol, :minimum]
1612
1594
  end
1613
1595
 
1614
- class MonetaryMaximumAdjustment < Orb::Internal::Type::BaseModel
1596
+ class Maximum < Orb::Internal::Type::BaseModel
1615
1597
  # @!attribute id
1616
1598
  #
1617
1599
  # @return [String]
@@ -1654,34 +1636,30 @@ module Orb
1654
1636
  # @return [String, nil]
1655
1637
  required :reason, String, nil?: true
1656
1638
 
1657
- # @!parse
1658
- # # @param id [String]
1659
- # # @param amount [String]
1660
- # # @param applies_to_price_ids [Array<String>]
1661
- # # @param is_invoice_level [Boolean]
1662
- # # @param maximum_amount [String]
1663
- # # @param reason [String, nil]
1664
- # # @param adjustment_type [Symbol, :maximum]
1665
- # #
1666
- # def initialize(
1667
- # id:,
1668
- # amount:,
1669
- # applies_to_price_ids:,
1670
- # is_invoice_level:,
1671
- # maximum_amount:,
1672
- # reason:,
1673
- # adjustment_type: :maximum,
1674
- # **
1675
- # )
1676
- # super
1677
- # end
1678
-
1679
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1639
+ # @!method initialize(id:, amount:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, reason:, adjustment_type: :maximum)
1640
+ # Some parameter documentations has been truncated, see
1641
+ # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum} for
1642
+ # more details.
1643
+ #
1644
+ # @param id [String]
1645
+ #
1646
+ # @param amount [String] The value applied by an adjustment.
1647
+ #
1648
+ # @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
1649
+ #
1650
+ # @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
1651
+ # ...
1652
+ #
1653
+ # @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
1654
+ # ...
1655
+ #
1656
+ # @param reason [String, nil] The reason for the adjustment.
1657
+ #
1658
+ # @param adjustment_type [Symbol, :maximum]
1680
1659
  end
1681
1660
 
1682
- # @!parse
1683
- # # @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryUsageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryAmountDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMinimumAdjustment, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::MonetaryMaximumAdjustment)]
1684
- # def self.variants; end
1661
+ # @!method self.variants
1662
+ # @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::UsageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::AmountDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::PercentageDiscount, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Minimum, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Adjustment::Maximum)]
1685
1663
  end
1686
1664
 
1687
1665
  # @deprecated
@@ -1701,15 +1679,16 @@ module Orb
1701
1679
  # @return [String]
1702
1680
  required :maximum_amount, String
1703
1681
 
1704
- # @!parse
1705
- # # This field is deprecated in favor of `adjustments`.
1706
- # #
1707
- # # @param applies_to_price_ids [Array<String>]
1708
- # # @param maximum_amount [String]
1709
- # #
1710
- # def initialize(applies_to_price_ids:, maximum_amount:, **) = super
1711
-
1712
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1682
+ # @!method initialize(applies_to_price_ids:, maximum_amount:)
1683
+ # Some parameter documentations has been truncated, see
1684
+ # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Maximum} for more details.
1685
+ #
1686
+ # This field is deprecated in favor of `adjustments`.
1687
+ #
1688
+ # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
1689
+ # ...
1690
+ #
1691
+ # @param maximum_amount [String] Maximum amount applied
1713
1692
  end
1714
1693
 
1715
1694
  # @deprecated
@@ -1729,15 +1708,16 @@ module Orb
1729
1708
  # @return [String]
1730
1709
  required :minimum_amount, String
1731
1710
 
1732
- # @!parse
1733
- # # This field is deprecated in favor of `adjustments`.
1734
- # #
1735
- # # @param applies_to_price_ids [Array<String>]
1736
- # # @param minimum_amount [String]
1737
- # #
1738
- # def initialize(applies_to_price_ids:, minimum_amount:, **) = super
1739
-
1740
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1711
+ # @!method initialize(applies_to_price_ids:, minimum_amount:)
1712
+ # Some parameter documentations has been truncated, see
1713
+ # {Orb::Models::InvoiceFetchUpcomingResponse::LineItem::Minimum} for more details.
1714
+ #
1715
+ # This field is deprecated in favor of `adjustments`.
1716
+ #
1717
+ # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
1718
+ # ...
1719
+ #
1720
+ # @param minimum_amount [String] Minimum amount applied
1741
1721
  end
1742
1722
 
1743
1723
  module SubLineItem
@@ -1745,15 +1725,13 @@ module Orb
1745
1725
 
1746
1726
  discriminator :type
1747
1727
 
1748
- variant :matrix,
1749
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem }
1728
+ variant :matrix, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix }
1750
1729
 
1751
- variant :tier, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem }
1730
+ variant :tier, -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier }
1752
1731
 
1753
- variant :"'null'",
1754
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem }
1732
+ variant :"'null'", -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null }
1755
1733
 
1756
- class MatrixSubLineItem < Orb::Internal::Type::BaseModel
1734
+ class Matrix < Orb::Internal::Type::BaseModel
1757
1735
  # @!attribute amount
1758
1736
  # The total amount for this sub line item.
1759
1737
  #
@@ -1762,16 +1740,16 @@ module Orb
1762
1740
 
1763
1741
  # @!attribute grouping
1764
1742
  #
1765
- # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping, nil]
1743
+ # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping, nil]
1766
1744
  required :grouping,
1767
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping },
1745
+ -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping },
1768
1746
  nil?: true
1769
1747
 
1770
1748
  # @!attribute matrix_config
1771
1749
  #
1772
- # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig]
1750
+ # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig]
1773
1751
  required :matrix_config,
1774
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig }
1752
+ -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig }
1775
1753
 
1776
1754
  # @!attribute name
1777
1755
  #
@@ -1788,19 +1766,20 @@ module Orb
1788
1766
  # @return [Symbol, :matrix]
1789
1767
  required :type, const: :matrix
1790
1768
 
1791
- # @!parse
1792
- # # @param amount [String]
1793
- # # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::Grouping, nil]
1794
- # # @param matrix_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem::MatrixConfig]
1795
- # # @param name [String]
1796
- # # @param quantity [Float]
1797
- # # @param type [Symbol, :matrix]
1798
- # #
1799
- # def initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix, **) = super
1800
-
1801
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1769
+ # @!method initialize(amount:, grouping:, matrix_config:, name:, quantity:, type: :matrix)
1770
+ # @param amount [String] The total amount for this sub line item.
1771
+ #
1772
+ # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::Grouping, nil]
1773
+ #
1774
+ # @param matrix_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix::MatrixConfig]
1775
+ #
1776
+ # @param name [String]
1777
+ #
1778
+ # @param quantity [Float]
1779
+ #
1780
+ # @param type [Symbol, :matrix]
1802
1781
 
1803
- # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem#grouping
1782
+ # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix#grouping
1804
1783
  class Grouping < Orb::Internal::Type::BaseModel
1805
1784
  # @!attribute key
1806
1785
  #
@@ -1813,16 +1792,13 @@ module Orb
1813
1792
  # @return [String, nil]
1814
1793
  required :value, String, nil?: true
1815
1794
 
1816
- # @!parse
1817
- # # @param key [String]
1818
- # # @param value [String, nil]
1819
- # #
1820
- # def initialize(key:, value:, **) = super
1821
-
1822
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1795
+ # @!method initialize(key:, value:)
1796
+ # @param key [String]
1797
+ #
1798
+ # @param value [String, nil] No value indicates the default group
1823
1799
  end
1824
1800
 
1825
- # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem#matrix_config
1801
+ # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix#matrix_config
1826
1802
  class MatrixConfig < Orb::Internal::Type::BaseModel
1827
1803
  # @!attribute dimension_values
1828
1804
  # The ordered dimension values for this line item.
@@ -1830,16 +1806,12 @@ module Orb
1830
1806
  # @return [Array<String, nil>]
1831
1807
  required :dimension_values, Orb::Internal::Type::ArrayOf[String, nil?: true]
1832
1808
 
1833
- # @!parse
1834
- # # @param dimension_values [Array<String, nil>]
1835
- # #
1836
- # def initialize(dimension_values:, **) = super
1837
-
1838
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1809
+ # @!method initialize(dimension_values:)
1810
+ # @param dimension_values [Array<String, nil>] The ordered dimension values for this line item.
1839
1811
  end
1840
1812
  end
1841
1813
 
1842
- class TierSubLineItem < Orb::Internal::Type::BaseModel
1814
+ class Tier < Orb::Internal::Type::BaseModel
1843
1815
  # @!attribute amount
1844
1816
  # The total amount for this sub line item.
1845
1817
  #
@@ -1848,9 +1820,9 @@ module Orb
1848
1820
 
1849
1821
  # @!attribute grouping
1850
1822
  #
1851
- # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping, nil]
1823
+ # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping, nil]
1852
1824
  required :grouping,
1853
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping },
1825
+ -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping },
1854
1826
  nil?: true
1855
1827
 
1856
1828
  # @!attribute name
@@ -1865,28 +1837,29 @@ module Orb
1865
1837
 
1866
1838
  # @!attribute tier_config
1867
1839
  #
1868
- # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig]
1840
+ # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig]
1869
1841
  required :tier_config,
1870
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig }
1842
+ -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig }
1871
1843
 
1872
1844
  # @!attribute type
1873
1845
  #
1874
1846
  # @return [Symbol, :tier]
1875
1847
  required :type, const: :tier
1876
1848
 
1877
- # @!parse
1878
- # # @param amount [String]
1879
- # # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::Grouping, nil]
1880
- # # @param name [String]
1881
- # # @param quantity [Float]
1882
- # # @param tier_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem::TierConfig]
1883
- # # @param type [Symbol, :tier]
1884
- # #
1885
- # def initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier, **) = super
1886
-
1887
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1849
+ # @!method initialize(amount:, grouping:, name:, quantity:, tier_config:, type: :tier)
1850
+ # @param amount [String] The total amount for this sub line item.
1851
+ #
1852
+ # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::Grouping, nil]
1853
+ #
1854
+ # @param name [String]
1855
+ #
1856
+ # @param quantity [Float]
1857
+ #
1858
+ # @param tier_config [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier::TierConfig]
1859
+ #
1860
+ # @param type [Symbol, :tier]
1888
1861
 
1889
- # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem#grouping
1862
+ # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier#grouping
1890
1863
  class Grouping < Orb::Internal::Type::BaseModel
1891
1864
  # @!attribute key
1892
1865
  #
@@ -1899,16 +1872,13 @@ module Orb
1899
1872
  # @return [String, nil]
1900
1873
  required :value, String, nil?: true
1901
1874
 
1902
- # @!parse
1903
- # # @param key [String]
1904
- # # @param value [String, nil]
1905
- # #
1906
- # def initialize(key:, value:, **) = super
1907
-
1908
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1875
+ # @!method initialize(key:, value:)
1876
+ # @param key [String]
1877
+ #
1878
+ # @param value [String, nil] No value indicates the default group
1909
1879
  end
1910
1880
 
1911
- # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem#tier_config
1881
+ # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier#tier_config
1912
1882
  class TierConfig < Orb::Internal::Type::BaseModel
1913
1883
  # @!attribute first_unit
1914
1884
  #
@@ -1925,18 +1895,14 @@ module Orb
1925
1895
  # @return [String]
1926
1896
  required :unit_amount, String
1927
1897
 
1928
- # @!parse
1929
- # # @param first_unit [Float]
1930
- # # @param last_unit [Float, nil]
1931
- # # @param unit_amount [String]
1932
- # #
1933
- # def initialize(first_unit:, last_unit:, unit_amount:, **) = super
1934
-
1935
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1898
+ # @!method initialize(first_unit:, last_unit:, unit_amount:)
1899
+ # @param first_unit [Float]
1900
+ # @param last_unit [Float, nil]
1901
+ # @param unit_amount [String]
1936
1902
  end
1937
1903
  end
1938
1904
 
1939
- class OtherSubLineItem < Orb::Internal::Type::BaseModel
1905
+ class Null < Orb::Internal::Type::BaseModel
1940
1906
  # @!attribute amount
1941
1907
  # The total amount for this sub line item.
1942
1908
  #
@@ -1945,9 +1911,9 @@ module Orb
1945
1911
 
1946
1912
  # @!attribute grouping
1947
1913
  #
1948
- # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping, nil]
1914
+ # @return [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping, nil]
1949
1915
  required :grouping,
1950
- -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping },
1916
+ -> { Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping },
1951
1917
  nil?: true
1952
1918
 
1953
1919
  # @!attribute name
@@ -1965,18 +1931,18 @@ module Orb
1965
1931
  # @return [Symbol, :"'null'"]
1966
1932
  required :type, const: :"'null'"
1967
1933
 
1968
- # @!parse
1969
- # # @param amount [String]
1970
- # # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem::Grouping, nil]
1971
- # # @param name [String]
1972
- # # @param quantity [Float]
1973
- # # @param type [Symbol, :"'null'"]
1974
- # #
1975
- # def initialize(amount:, grouping:, name:, quantity:, type: :"'null'", **) = super
1976
-
1977
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1934
+ # @!method initialize(amount:, grouping:, name:, quantity:, type: :"'null'")
1935
+ # @param amount [String] The total amount for this sub line item.
1936
+ #
1937
+ # @param grouping [Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null::Grouping, nil]
1938
+ #
1939
+ # @param name [String]
1940
+ #
1941
+ # @param quantity [Float]
1942
+ #
1943
+ # @param type [Symbol, :"'null'"]
1978
1944
 
1979
- # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem#grouping
1945
+ # @see Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null#grouping
1980
1946
  class Grouping < Orb::Internal::Type::BaseModel
1981
1947
  # @!attribute key
1982
1948
  #
@@ -1989,19 +1955,15 @@ module Orb
1989
1955
  # @return [String, nil]
1990
1956
  required :value, String, nil?: true
1991
1957
 
1992
- # @!parse
1993
- # # @param key [String]
1994
- # # @param value [String, nil]
1995
- # #
1996
- # def initialize(key:, value:, **) = super
1997
-
1998
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1958
+ # @!method initialize(key:, value:)
1959
+ # @param key [String]
1960
+ #
1961
+ # @param value [String, nil] No value indicates the default group
1999
1962
  end
2000
1963
  end
2001
1964
 
2002
- # @!parse
2003
- # # @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::MatrixSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::TierSubLineItem, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::OtherSubLineItem)]
2004
- # def self.variants; end
1965
+ # @!method self.variants
1966
+ # @return [Array(Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Matrix, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Tier, Orb::Models::InvoiceFetchUpcomingResponse::LineItem::SubLineItem::Null)]
2005
1967
  end
2006
1968
 
2007
1969
  class TaxAmount < Orb::Internal::Type::BaseModel
@@ -2023,14 +1985,12 @@ module Orb
2023
1985
  # @return [String, nil]
2024
1986
  required :tax_rate_percentage, String, nil?: true
2025
1987
 
2026
- # @!parse
2027
- # # @param amount [String]
2028
- # # @param tax_rate_description [String]
2029
- # # @param tax_rate_percentage [String, nil]
2030
- # #
2031
- # def initialize(amount:, tax_rate_description:, tax_rate_percentage:, **) = super
2032
-
2033
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1988
+ # @!method initialize(amount:, tax_rate_description:, tax_rate_percentage:)
1989
+ # @param amount [String] The amount of additional tax incurred by this tax rate.
1990
+ #
1991
+ # @param tax_rate_description [String] The human-readable description of the applied tax rate.
1992
+ #
1993
+ # @param tax_rate_percentage [String, nil] The tax rate percentage, out of 100.
2034
1994
  end
2035
1995
  end
2036
1996
 
@@ -2049,13 +2009,14 @@ module Orb
2049
2009
  # @return [String]
2050
2010
  required :maximum_amount, String
2051
2011
 
2052
- # @!parse
2053
- # # @param applies_to_price_ids [Array<String>]
2054
- # # @param maximum_amount [String]
2055
- # #
2056
- # def initialize(applies_to_price_ids:, maximum_amount:, **) = super
2057
-
2058
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
2012
+ # @!method initialize(applies_to_price_ids:, maximum_amount:)
2013
+ # Some parameter documentations has been truncated, see
2014
+ # {Orb::Models::InvoiceFetchUpcomingResponse::Maximum} for more details.
2015
+ #
2016
+ # @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
2017
+ # ...
2018
+ #
2019
+ # @param maximum_amount [String] Maximum amount applied
2059
2020
  end
2060
2021
 
2061
2022
  # @see Orb::Models::InvoiceFetchUpcomingResponse#minimum
@@ -2073,13 +2034,14 @@ module Orb
2073
2034
  # @return [String]
2074
2035
  required :minimum_amount, String
2075
2036
 
2076
- # @!parse
2077
- # # @param applies_to_price_ids [Array<String>]
2078
- # # @param minimum_amount [String]
2079
- # #
2080
- # def initialize(applies_to_price_ids:, minimum_amount:, **) = super
2081
-
2082
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
2037
+ # @!method initialize(applies_to_price_ids:, minimum_amount:)
2038
+ # Some parameter documentations has been truncated, see
2039
+ # {Orb::Models::InvoiceFetchUpcomingResponse::Minimum} for more details.
2040
+ #
2041
+ # @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
2042
+ # ...
2043
+ #
2044
+ # @param minimum_amount [String] Minimum amount applied
2083
2045
  end
2084
2046
 
2085
2047
  class PaymentAttempt < Orb::Internal::Type::BaseModel
@@ -2121,17 +2083,18 @@ module Orb
2121
2083
  # @return [Boolean]
2122
2084
  required :succeeded, Orb::Internal::Type::Boolean
2123
2085
 
2124
- # @!parse
2125
- # # @param id [String]
2126
- # # @param amount [String]
2127
- # # @param created_at [Time]
2128
- # # @param payment_provider [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider, nil]
2129
- # # @param payment_provider_id [String, nil]
2130
- # # @param succeeded [Boolean]
2131
- # #
2132
- # def initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:, **) = super
2133
-
2134
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
2086
+ # @!method initialize(id:, amount:, created_at:, payment_provider:, payment_provider_id:, succeeded:)
2087
+ # @param id [String] The ID of the payment attempt.
2088
+ #
2089
+ # @param amount [String] The amount of the payment attempt.
2090
+ #
2091
+ # @param created_at [Time] The time at which the payment attempt was created.
2092
+ #
2093
+ # @param payment_provider [Symbol, Orb::Models::InvoiceFetchUpcomingResponse::PaymentAttempt::PaymentProvider, nil] The payment provider that attempted to collect the payment.
2094
+ #
2095
+ # @param payment_provider_id [String, nil] The ID of the payment attempt in the payment provider.
2096
+ #
2097
+ # @param succeeded [Boolean] Whether the payment attempt succeeded.
2135
2098
 
2136
2099
  # The payment provider that attempted to collect the payment.
2137
2100
  #
@@ -2141,11 +2104,8 @@ module Orb
2141
2104
 
2142
2105
  STRIPE = :stripe
2143
2106
 
2144
- finalize!
2145
-
2146
- # @!parse
2147
- # # @return [Array<Symbol>]
2148
- # def self.values; end
2107
+ # @!method self.values
2108
+ # @return [Array<Symbol>]
2149
2109
  end
2150
2110
  end
2151
2111
 
@@ -2181,17 +2141,13 @@ module Orb
2181
2141
  # @return [String, nil]
2182
2142
  required :state, String, nil?: true
2183
2143
 
2184
- # @!parse
2185
- # # @param city [String, nil]
2186
- # # @param country [String, nil]
2187
- # # @param line1 [String, nil]
2188
- # # @param line2 [String, nil]
2189
- # # @param postal_code [String, nil]
2190
- # # @param state [String, nil]
2191
- # #
2192
- # def initialize(city:, country:, line1:, line2:, postal_code:, state:, **) = super
2193
-
2194
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
2144
+ # @!method initialize(city:, country:, line1:, line2:, postal_code:, state:)
2145
+ # @param city [String, nil]
2146
+ # @param country [String, nil]
2147
+ # @param line1 [String, nil]
2148
+ # @param line2 [String, nil]
2149
+ # @param postal_code [String, nil]
2150
+ # @param state [String, nil]
2195
2151
  end
2196
2152
 
2197
2153
  # @see Orb::Models::InvoiceFetchUpcomingResponse#status
@@ -2204,11 +2160,8 @@ module Orb
2204
2160
  VOID = :void
2205
2161
  DRAFT = :draft
2206
2162
 
2207
- finalize!
2208
-
2209
- # @!parse
2210
- # # @return [Array<Symbol>]
2211
- # def self.values; end
2163
+ # @!method self.values
2164
+ # @return [Array<Symbol>]
2212
2165
  end
2213
2166
 
2214
2167
  # @see Orb::Models::InvoiceFetchUpcomingResponse#subscription
@@ -2218,12 +2171,8 @@ module Orb
2218
2171
  # @return [String]
2219
2172
  required :id, String
2220
2173
 
2221
- # @!parse
2222
- # # @param id [String]
2223
- # #
2224
- # def initialize(id:, **) = super
2225
-
2226
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
2174
+ # @!method initialize(id:)
2175
+ # @param id [String]
2227
2176
  end
2228
2177
  end
2229
2178
  end