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