orb-billing 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (374) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +34 -0
  3. data/README.md +59 -49
  4. data/lib/orb/client.rb +4 -4
  5. data/lib/orb/file_part.rb +55 -0
  6. data/lib/orb/internal/page.rb +4 -8
  7. data/lib/orb/internal/transport/base_client.rb +7 -7
  8. data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
  9. data/lib/orb/internal/type/array_of.rb +11 -0
  10. data/lib/orb/internal/type/base_model.rb +32 -14
  11. data/lib/orb/internal/type/base_page.rb +9 -1
  12. data/lib/orb/internal/type/boolean.rb +4 -0
  13. data/lib/orb/internal/type/converter.rb +4 -1
  14. data/lib/orb/internal/type/enum.rb +9 -5
  15. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
  16. data/lib/orb/internal/type/hash_of.rb +11 -0
  17. data/lib/orb/internal/type/request_parameters.rb +1 -2
  18. data/lib/orb/internal/type/union.rb +10 -1
  19. data/lib/orb/internal/type/unknown.rb +4 -0
  20. data/lib/orb/internal/util.rb +69 -61
  21. data/lib/orb/internal.rb +0 -1
  22. data/lib/orb/models/alert.rb +68 -71
  23. data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
  24. data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
  25. data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
  26. data/lib/orb/models/alert_disable_params.rb +5 -9
  27. data/lib/orb/models/alert_enable_params.rb +5 -9
  28. data/lib/orb/models/alert_list_params.rb +26 -36
  29. data/lib/orb/models/alert_retrieve_params.rb +3 -8
  30. data/lib/orb/models/alert_update_params.rb +14 -18
  31. data/lib/orb/models/amount_discount.rb +14 -14
  32. data/lib/orb/models/billable_metric.rb +23 -20
  33. data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
  34. data/lib/orb/models/coupon.rb +28 -21
  35. data/lib/orb/models/coupon_archive_params.rb +3 -8
  36. data/lib/orb/models/coupon_create_params.rb +24 -29
  37. data/lib/orb/models/coupon_fetch_params.rb +3 -8
  38. data/lib/orb/models/coupon_list_params.rb +17 -17
  39. data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
  40. data/lib/orb/models/credit_note.rb +100 -166
  41. data/lib/orb/models/credit_note_create_params.rb +15 -23
  42. data/lib/orb/models/credit_note_fetch_params.rb +3 -8
  43. data/lib/orb/models/credit_note_list_params.rb +20 -30
  44. data/lib/orb/models/customer.rb +224 -271
  45. data/lib/orb/models/customer_create_params.rb +211 -252
  46. data/lib/orb/models/customer_delete_params.rb +3 -8
  47. data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
  48. data/lib/orb/models/customer_fetch_params.rb +3 -8
  49. data/lib/orb/models/customer_list_params.rb +20 -30
  50. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
  51. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
  52. data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
  53. data/lib/orb/models/customer_update_params.rb +207 -250
  54. data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
  55. data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
  56. data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
  57. data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
  58. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
  59. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
  60. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  61. data/lib/orb/models/customers/cost_list_response.rb +22 -26
  62. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
  63. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
  64. data/lib/orb/models/customers/credit_list_params.rb +18 -22
  65. data/lib/orb/models/customers/credit_list_response.rb +10 -17
  66. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
  67. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
  68. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
  69. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
  70. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
  71. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
  72. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  73. data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
  74. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
  75. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
  76. data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
  77. data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
  78. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
  79. data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
  80. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
  81. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
  82. data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
  83. data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
  84. data/lib/orb/models/dimensional_price_group.rb +21 -15
  85. data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
  86. data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
  87. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
  88. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
  89. data/lib/orb/models/dimensional_price_groups.rb +3 -7
  90. data/lib/orb/models/discount.rb +2 -3
  91. data/lib/orb/models/evaluate_price_group.rb +8 -11
  92. data/lib/orb/models/event_deprecate_params.rb +3 -8
  93. data/lib/orb/models/event_deprecate_response.rb +2 -6
  94. data/lib/orb/models/event_ingest_params.rb +33 -27
  95. data/lib/orb/models/event_ingest_response.rb +23 -24
  96. data/lib/orb/models/event_search_params.rb +15 -11
  97. data/lib/orb/models/event_search_response.rb +27 -22
  98. data/lib/orb/models/event_update_params.rb +19 -13
  99. data/lib/orb/models/event_update_response.rb +2 -6
  100. data/lib/orb/models/events/backfill_close_params.rb +3 -8
  101. data/lib/orb/models/events/backfill_close_response.rb +34 -39
  102. data/lib/orb/models/events/backfill_create_params.rb +28 -32
  103. data/lib/orb/models/events/backfill_create_response.rb +34 -39
  104. data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
  105. data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
  106. data/lib/orb/models/events/backfill_list_params.rb +12 -15
  107. data/lib/orb/models/events/backfill_list_response.rb +34 -39
  108. data/lib/orb/models/events/backfill_revert_params.rb +3 -8
  109. data/lib/orb/models/events/backfill_revert_response.rb +34 -39
  110. data/lib/orb/models/events/event_volumes.rb +11 -17
  111. data/lib/orb/models/events/volume_list_params.rb +19 -22
  112. data/lib/orb/models/invoice.rb +589 -637
  113. data/lib/orb/models/invoice_create_params.rb +52 -61
  114. data/lib/orb/models/invoice_fetch_params.rb +3 -8
  115. data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
  116. data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
  117. data/lib/orb/models/invoice_issue_params.rb +10 -14
  118. data/lib/orb/models/invoice_level_discount.rb +2 -3
  119. data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
  120. data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
  121. data/lib/orb/models/invoice_list_params.rb +51 -66
  122. data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
  123. data/lib/orb/models/invoice_pay_params.rb +3 -8
  124. data/lib/orb/models/invoice_update_params.rb +9 -9
  125. data/lib/orb/models/invoice_void_params.rb +3 -8
  126. data/lib/orb/models/item.rb +14 -25
  127. data/lib/orb/models/item_create_params.rb +5 -9
  128. data/lib/orb/models/item_fetch_params.rb +3 -8
  129. data/lib/orb/models/item_list_params.rb +12 -15
  130. data/lib/orb/models/item_update_params.rb +10 -22
  131. data/lib/orb/models/metric_create_params.rb +17 -13
  132. data/lib/orb/models/metric_fetch_params.rb +3 -8
  133. data/lib/orb/models/metric_list_params.rb +20 -30
  134. data/lib/orb/models/metric_update_params.rb +9 -9
  135. data/lib/orb/models/pagination_metadata.rb +3 -7
  136. data/lib/orb/models/percentage_discount.rb +15 -14
  137. data/lib/orb/models/plan.rb +250 -279
  138. data/lib/orb/models/plan_create_params.rb +1623 -1984
  139. data/lib/orb/models/plan_fetch_params.rb +3 -8
  140. data/lib/orb/models/plan_list_params.rb +25 -42
  141. data/lib/orb/models/plan_update_params.rb +12 -10
  142. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
  143. data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
  144. data/lib/orb/models/price.rb +2709 -3820
  145. data/lib/orb/models/price_create_params.rb +203 -244
  146. data/lib/orb/models/price_evaluate_params.rb +21 -30
  147. data/lib/orb/models/price_evaluate_response.rb +2 -6
  148. data/lib/orb/models/price_fetch_params.rb +3 -8
  149. data/lib/orb/models/price_list_params.rb +12 -15
  150. data/lib/orb/models/price_update_params.rb +9 -9
  151. data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
  152. data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
  153. data/lib/orb/models/subscription.rb +343 -382
  154. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  155. data/lib/orb/models/subscription_cancel_response.rb +339 -377
  156. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  157. data/lib/orb/models/subscription_change_apply_response.rb +365 -398
  158. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  159. data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
  160. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  161. data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
  162. data/lib/orb/models/subscription_create_params.rb +3771 -4402
  163. data/lib/orb/models/subscription_create_response.rb +339 -377
  164. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  165. data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
  166. data/lib/orb/models/subscription_fetch_params.rb +3 -8
  167. data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
  168. data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
  169. data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
  170. data/lib/orb/models/subscription_list_params.rb +28 -41
  171. data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
  172. data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
  173. data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
  174. data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
  175. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  176. data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
  177. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  178. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
  179. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
  180. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
  181. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
  182. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
  183. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
  184. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
  185. data/lib/orb/models/subscription_update_params.rb +21 -23
  186. data/lib/orb/models/subscription_update_trial_params.rb +15 -18
  187. data/lib/orb/models/subscription_update_trial_response.rb +341 -377
  188. data/lib/orb/models/subscription_usage.rb +37 -80
  189. data/lib/orb/models/subscriptions.rb +3 -7
  190. data/lib/orb/models/top_level_ping_params.rb +3 -8
  191. data/lib/orb/models/top_level_ping_response.rb +2 -6
  192. data/lib/orb/models/trial_discount.rb +16 -24
  193. data/lib/orb/models/usage_discount.rb +15 -14
  194. data/lib/orb/request_options.rb +3 -4
  195. data/lib/orb/resources/alerts.rb +48 -17
  196. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  197. data/lib/orb/resources/coupons.rb +25 -7
  198. data/lib/orb/resources/credit_notes.rb +17 -4
  199. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  200. data/lib/orb/resources/customers/costs.rb +26 -8
  201. data/lib/orb/resources/customers/credits/ledger.rb +108 -28
  202. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  203. data/lib/orb/resources/customers/credits.rb +28 -8
  204. data/lib/orb/resources/customers.rb +135 -36
  205. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  206. data/lib/orb/resources/events/backfills.rb +32 -9
  207. data/lib/orb/resources/events/volume.rb +14 -4
  208. data/lib/orb/resources/events.rb +40 -11
  209. data/lib/orb/resources/invoice_line_items.rb +16 -6
  210. data/lib/orb/resources/invoices.rb +77 -17
  211. data/lib/orb/resources/items.rb +10 -3
  212. data/lib/orb/resources/metrics.rb +33 -8
  213. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  214. data/lib/orb/resources/plans.rb +47 -11
  215. data/lib/orb/resources/prices/external_price_id.rb +7 -1
  216. data/lib/orb/resources/prices.rb +97 -22
  217. data/lib/orb/resources/subscription_changes.rb +5 -2
  218. data/lib/orb/resources/subscriptions.rb +292 -78
  219. data/lib/orb/version.rb +1 -1
  220. data/lib/orb.rb +2 -10
  221. data/rbi/lib/orb/client.rbi +4 -4
  222. data/rbi/lib/orb/file_part.rbi +34 -0
  223. data/rbi/lib/orb/internal/transport/base_client.rbi +17 -3
  224. data/rbi/lib/orb/internal/type/array_of.rbi +3 -0
  225. data/rbi/lib/orb/internal/type/base_model.rbi +7 -1
  226. data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
  227. data/rbi/lib/orb/internal/type/enum.rbi +3 -6
  228. data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +5 -2
  229. data/rbi/lib/orb/internal/type/hash_of.rbi +3 -0
  230. data/rbi/lib/orb/internal/type/union.rbi +3 -0
  231. data/rbi/lib/orb/internal/util.rbi +24 -19
  232. data/rbi/lib/orb/internal.rbi +0 -1
  233. data/rbi/lib/orb/models/alert.rbi +28 -8
  234. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
  235. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
  236. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
  237. data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
  238. data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
  239. data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
  240. data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
  241. data/rbi/lib/orb/models/amount_discount.rbi +10 -4
  242. data/rbi/lib/orb/models/billable_metric.rbi +16 -3
  243. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
  244. data/rbi/lib/orb/models/coupon.rbi +10 -3
  245. data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
  246. data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
  247. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
  248. data/rbi/lib/orb/models/credit_note.rbi +44 -12
  249. data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
  250. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
  251. data/rbi/lib/orb/models/customer.rbi +130 -11
  252. data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
  253. data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
  254. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
  255. data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
  256. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
  257. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
  258. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
  259. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
  260. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
  261. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
  262. data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
  263. data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
  264. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
  265. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
  266. data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
  267. data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
  268. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  269. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
  270. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  271. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
  272. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  273. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
  274. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
  275. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
  276. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  277. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  278. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
  279. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
  280. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  281. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  282. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
  283. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
  284. data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
  285. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
  286. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
  287. data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
  288. data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
  289. data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
  290. data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
  291. data/rbi/lib/orb/models/event_search_params.rbi +14 -2
  292. data/rbi/lib/orb/models/event_search_response.rbi +14 -3
  293. data/rbi/lib/orb/models/event_update_params.rbi +10 -3
  294. data/rbi/lib/orb/models/event_update_response.rbi +4 -2
  295. data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
  296. data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
  297. data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
  298. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
  299. data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
  300. data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
  301. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
  302. data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
  303. data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
  304. data/rbi/lib/orb/models/invoice.rbi +375 -46
  305. data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
  306. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
  307. data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
  308. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
  309. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
  310. data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
  311. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
  312. data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
  313. data/rbi/lib/orb/models/item.rbi +1 -2
  314. data/rbi/lib/orb/models/item_create_params.rbi +5 -2
  315. data/rbi/lib/orb/models/item_list_params.rbi +8 -2
  316. data/rbi/lib/orb/models/item_update_params.rbi +1 -8
  317. data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
  318. data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
  319. data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
  320. data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
  321. data/rbi/lib/orb/models/plan.rbi +102 -15
  322. data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
  323. data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
  324. data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
  325. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
  326. data/rbi/lib/orb/models/price.rbi +717 -688
  327. data/rbi/lib/orb/models/price_create_params.rbi +137 -53
  328. data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
  329. data/rbi/lib/orb/models/price_list_params.rbi +8 -2
  330. data/rbi/lib/orb/models/price_update_params.rbi +7 -2
  331. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
  332. data/rbi/lib/orb/models/subscription.rbi +174 -11
  333. data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
  334. data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
  335. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
  336. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
  337. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
  338. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
  339. data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
  340. data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
  341. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
  342. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
  343. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
  344. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
  345. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
  346. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
  347. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
  348. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
  349. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
  350. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
  351. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
  352. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
  353. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
  354. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  355. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
  356. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
  357. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  358. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
  359. data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
  360. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
  361. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
  362. data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
  363. data/rbi/lib/orb/models/trial_discount.rbi +5 -1
  364. data/rbi/lib/orb/models/usage_discount.rbi +11 -3
  365. data/sig/orb/file_part.rbs +21 -0
  366. data/sig/orb/internal/transport/base_client.rbs +9 -3
  367. data/sig/orb/internal/type/array_of.rbs +2 -0
  368. data/sig/orb/internal/type/base_model.rbs +4 -0
  369. data/sig/orb/internal/type/enum.rbs +2 -2
  370. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  371. data/sig/orb/internal/type/hash_of.rbs +2 -0
  372. data/sig/orb/internal/type/union.rbs +2 -0
  373. data/sig/orb/internal/util.rbs +14 -12
  374. metadata +8 -5
@@ -114,6 +114,10 @@ module Orb
114
114
  ending_balance:,
115
115
  entry_status:,
116
116
  ledger_sequence_number:,
117
+ # User specified key-value pairs for the resource. If not present, this defaults
118
+ # to an empty dictionary. Individual keys can be removed by setting the value to
119
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
120
+ # `null`.
117
121
  metadata:,
118
122
  starting_balance:,
119
123
  entry_type: :increment
@@ -189,14 +193,7 @@ module Orb
189
193
  T.type_alias do
190
194
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus)
191
195
  end
192
- OrSymbol =
193
- T.type_alias do
194
- T.any(
195
- Symbol,
196
- String,
197
- Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol
198
- )
199
- end
196
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
200
197
 
201
198
  COMMITTED =
202
199
  T.let(
@@ -338,6 +335,10 @@ module Orb
338
335
  ending_balance:,
339
336
  entry_status:,
340
337
  ledger_sequence_number:,
338
+ # User specified key-value pairs for the resource. If not present, this defaults
339
+ # to an empty dictionary. Individual keys can be removed by setting the value to
340
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
341
+ # `null`.
341
342
  metadata:,
342
343
  starting_balance:,
343
344
  event_id: nil,
@@ -419,14 +420,7 @@ module Orb
419
420
  T.type_alias do
420
421
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus)
421
422
  end
422
- OrSymbol =
423
- T.type_alias do
424
- T.any(
425
- Symbol,
426
- String,
427
- Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol
428
- )
429
- end
423
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
430
424
 
431
425
  COMMITTED =
432
426
  T.let(
@@ -564,6 +558,10 @@ module Orb
564
558
  ending_balance:,
565
559
  entry_status:,
566
560
  ledger_sequence_number:,
561
+ # User specified key-value pairs for the resource. If not present, this defaults
562
+ # to an empty dictionary. Individual keys can be removed by setting the value to
563
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
564
+ # `null`.
567
565
  metadata:,
568
566
  new_block_expiry_date:,
569
567
  starting_balance:,
@@ -641,14 +639,7 @@ module Orb
641
639
  T.type_alias do
642
640
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus)
643
641
  end
644
- OrSymbol =
645
- T.type_alias do
646
- T.any(
647
- Symbol,
648
- String,
649
- Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol
650
- )
651
- end
642
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
652
643
 
653
644
  COMMITTED =
654
645
  T.let(
@@ -786,6 +777,10 @@ module Orb
786
777
  ending_balance:,
787
778
  entry_status:,
788
779
  ledger_sequence_number:,
780
+ # User specified key-value pairs for the resource. If not present, this defaults
781
+ # to an empty dictionary. Individual keys can be removed by setting the value to
782
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
783
+ # `null`.
789
784
  metadata:,
790
785
  starting_balance:,
791
786
  entry_type: :credit_block_expiry
@@ -861,14 +856,7 @@ module Orb
861
856
  T.type_alias do
862
857
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus)
863
858
  end
864
- OrSymbol =
865
- T.type_alias do
866
- T.any(
867
- Symbol,
868
- String,
869
- Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol
870
- )
871
- end
859
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
872
860
 
873
861
  COMMITTED =
874
862
  T.let(
@@ -1006,6 +994,10 @@ module Orb
1006
994
  ending_balance:,
1007
995
  entry_status:,
1008
996
  ledger_sequence_number:,
997
+ # User specified key-value pairs for the resource. If not present, this defaults
998
+ # to an empty dictionary. Individual keys can be removed by setting the value to
999
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1000
+ # `null`.
1009
1001
  metadata:,
1010
1002
  starting_balance:,
1011
1003
  void_amount:,
@@ -1083,14 +1075,7 @@ module Orb
1083
1075
 
1084
1076
  TaggedSymbol =
1085
1077
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::EntryStatus) }
1086
- OrSymbol =
1087
- T.type_alias do
1088
- T.any(
1089
- Symbol,
1090
- String,
1091
- Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol
1092
- )
1093
- end
1078
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1094
1079
 
1095
1080
  COMMITTED =
1096
1081
  T.let(
@@ -1230,6 +1215,10 @@ module Orb
1230
1215
  ending_balance:,
1231
1216
  entry_status:,
1232
1217
  ledger_sequence_number:,
1218
+ # User specified key-value pairs for the resource. If not present, this defaults
1219
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1220
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1221
+ # `null`.
1233
1222
  metadata:,
1234
1223
  new_block_expiry_date:,
1235
1224
  starting_balance:,
@@ -1311,14 +1300,7 @@ module Orb
1311
1300
  T.type_alias do
1312
1301
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus)
1313
1302
  end
1314
- OrSymbol =
1315
- T.type_alias do
1316
- T.any(
1317
- Symbol,
1318
- String,
1319
- Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol
1320
- )
1321
- end
1303
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1322
1304
 
1323
1305
  COMMITTED =
1324
1306
  T.let(
@@ -1448,6 +1430,10 @@ module Orb
1448
1430
  ending_balance:,
1449
1431
  entry_status:,
1450
1432
  ledger_sequence_number:,
1433
+ # User specified key-value pairs for the resource. If not present, this defaults
1434
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1435
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1436
+ # `null`.
1451
1437
  metadata:,
1452
1438
  starting_balance:,
1453
1439
  entry_type: :amendment
@@ -1523,14 +1509,7 @@ module Orb
1523
1509
  T.type_alias do
1524
1510
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus)
1525
1511
  end
1526
- OrSymbol =
1527
- T.type_alias do
1528
- T.any(
1529
- Symbol,
1530
- String,
1531
- Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol
1532
- )
1533
- end
1512
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1534
1513
 
1535
1514
  COMMITTED =
1536
1515
  T.let(
@@ -66,10 +66,14 @@ module Orb
66
66
  created_at_gte: nil,
67
67
  created_at_lt: nil,
68
68
  created_at_lte: nil,
69
+ # The ledger currency or custom pricing unit to use.
69
70
  currency: nil,
71
+ # Cursor for pagination. This can be populated by the `next_cursor` value returned
72
+ # from the initial request.
70
73
  cursor: nil,
71
74
  entry_status: nil,
72
75
  entry_type: nil,
76
+ # The number of items to fetch. Defaults to 20.
73
77
  limit: nil,
74
78
  minimum_amount: nil,
75
79
  request_options: {}
@@ -99,14 +103,7 @@ module Orb
99
103
 
100
104
  TaggedSymbol =
101
105
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus) }
102
- OrSymbol =
103
- T.type_alias do
104
- T.any(
105
- Symbol,
106
- String,
107
- Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus::TaggedSymbol
108
- )
109
- end
106
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
110
107
 
111
108
  COMMITTED =
112
109
  T.let(
@@ -130,14 +127,7 @@ module Orb
130
127
 
131
128
  TaggedSymbol =
132
129
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType) }
133
- OrSymbol =
134
- T.type_alias do
135
- T.any(
136
- Symbol,
137
- String,
138
- Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType::TaggedSymbol
139
- )
140
- end
130
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
141
131
 
142
132
  INCREMENT =
143
133
  T.let(:increment, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType::TaggedSymbol)
@@ -118,6 +118,10 @@ module Orb
118
118
  ending_balance:,
119
119
  entry_status:,
120
120
  ledger_sequence_number:,
121
+ # User specified key-value pairs for the resource. If not present, this defaults
122
+ # to an empty dictionary. Individual keys can be removed by setting the value to
123
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
124
+ # `null`.
121
125
  metadata:,
122
126
  starting_balance:,
123
127
  entry_type: :increment
@@ -193,14 +197,7 @@ module Orb
193
197
  T.type_alias do
194
198
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus)
195
199
  end
196
- OrSymbol =
197
- T.type_alias do
198
- T.any(
199
- Symbol,
200
- String,
201
- Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol
202
- )
203
- end
200
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
204
201
 
205
202
  COMMITTED =
206
203
  T.let(
@@ -346,6 +343,10 @@ module Orb
346
343
  ending_balance:,
347
344
  entry_status:,
348
345
  ledger_sequence_number:,
346
+ # User specified key-value pairs for the resource. If not present, this defaults
347
+ # to an empty dictionary. Individual keys can be removed by setting the value to
348
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
349
+ # `null`.
349
350
  metadata:,
350
351
  starting_balance:,
351
352
  event_id: nil,
@@ -427,14 +428,7 @@ module Orb
427
428
  T.type_alias do
428
429
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus)
429
430
  end
430
- OrSymbol =
431
- T.type_alias do
432
- T.any(
433
- Symbol,
434
- String,
435
- Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol
436
- )
437
- end
431
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
438
432
 
439
433
  COMMITTED =
440
434
  T.let(
@@ -576,6 +570,10 @@ module Orb
576
570
  ending_balance:,
577
571
  entry_status:,
578
572
  ledger_sequence_number:,
573
+ # User specified key-value pairs for the resource. If not present, this defaults
574
+ # to an empty dictionary. Individual keys can be removed by setting the value to
575
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
576
+ # `null`.
579
577
  metadata:,
580
578
  new_block_expiry_date:,
581
579
  starting_balance:,
@@ -653,14 +651,7 @@ module Orb
653
651
  T.type_alias do
654
652
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus)
655
653
  end
656
- OrSymbol =
657
- T.type_alias do
658
- T.any(
659
- Symbol,
660
- String,
661
- Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol
662
- )
663
- end
654
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
664
655
 
665
656
  COMMITTED =
666
657
  T.let(
@@ -798,6 +789,10 @@ module Orb
798
789
  ending_balance:,
799
790
  entry_status:,
800
791
  ledger_sequence_number:,
792
+ # User specified key-value pairs for the resource. If not present, this defaults
793
+ # to an empty dictionary. Individual keys can be removed by setting the value to
794
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
795
+ # `null`.
801
796
  metadata:,
802
797
  starting_balance:,
803
798
  entry_type: :credit_block_expiry
@@ -873,14 +868,7 @@ module Orb
873
868
  T.type_alias do
874
869
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus)
875
870
  end
876
- OrSymbol =
877
- T.type_alias do
878
- T.any(
879
- Symbol,
880
- String,
881
- Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol
882
- )
883
- end
871
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
884
872
 
885
873
  COMMITTED =
886
874
  T.let(
@@ -1018,6 +1006,10 @@ module Orb
1018
1006
  ending_balance:,
1019
1007
  entry_status:,
1020
1008
  ledger_sequence_number:,
1009
+ # User specified key-value pairs for the resource. If not present, this defaults
1010
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1011
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1012
+ # `null`.
1021
1013
  metadata:,
1022
1014
  starting_balance:,
1023
1015
  void_amount:,
@@ -1097,14 +1089,7 @@ module Orb
1097
1089
  T.type_alias do
1098
1090
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus)
1099
1091
  end
1100
- OrSymbol =
1101
- T.type_alias do
1102
- T.any(
1103
- Symbol,
1104
- String,
1105
- Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol
1106
- )
1107
- end
1092
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1108
1093
 
1109
1094
  COMMITTED =
1110
1095
  T.let(
@@ -1254,6 +1239,10 @@ module Orb
1254
1239
  ending_balance:,
1255
1240
  entry_status:,
1256
1241
  ledger_sequence_number:,
1242
+ # User specified key-value pairs for the resource. If not present, this defaults
1243
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1244
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1245
+ # `null`.
1257
1246
  metadata:,
1258
1247
  new_block_expiry_date:,
1259
1248
  starting_balance:,
@@ -1335,14 +1324,7 @@ module Orb
1335
1324
  T.type_alias do
1336
1325
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus)
1337
1326
  end
1338
- OrSymbol =
1339
- T.type_alias do
1340
- T.any(
1341
- Symbol,
1342
- String,
1343
- Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol
1344
- )
1345
- end
1327
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1346
1328
 
1347
1329
  COMMITTED =
1348
1330
  T.let(
@@ -1476,6 +1458,10 @@ module Orb
1476
1458
  ending_balance:,
1477
1459
  entry_status:,
1478
1460
  ledger_sequence_number:,
1461
+ # User specified key-value pairs for the resource. If not present, this defaults
1462
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1463
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1464
+ # `null`.
1479
1465
  metadata:,
1480
1466
  starting_balance:,
1481
1467
  entry_type: :amendment
@@ -1551,14 +1537,7 @@ module Orb
1551
1537
  T.type_alias do
1552
1538
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus)
1553
1539
  end
1554
- OrSymbol =
1555
- T.type_alias do
1556
- T.any(
1557
- Symbol,
1558
- String,
1559
- Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol
1560
- )
1561
- end
1540
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1562
1541
 
1563
1542
  COMMITTED =
1564
1543
  T.let(
@@ -66,10 +66,14 @@ module Orb
66
66
  created_at_gte: nil,
67
67
  created_at_lt: nil,
68
68
  created_at_lte: nil,
69
+ # The ledger currency or custom pricing unit to use.
69
70
  currency: nil,
71
+ # Cursor for pagination. This can be populated by the `next_cursor` value returned
72
+ # from the initial request.
70
73
  cursor: nil,
71
74
  entry_status: nil,
72
75
  entry_type: nil,
76
+ # The number of items to fetch. Defaults to 20.
73
77
  limit: nil,
74
78
  minimum_amount: nil,
75
79
  request_options: {}
@@ -99,8 +103,7 @@ module Orb
99
103
 
100
104
  TaggedSymbol =
101
105
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus) }
102
- OrSymbol =
103
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus::TaggedSymbol) }
106
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
104
107
 
105
108
  COMMITTED =
106
109
  T.let(:committed, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus::TaggedSymbol)
@@ -115,8 +118,7 @@ module Orb
115
118
 
116
119
  TaggedSymbol =
117
120
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType) }
118
- OrSymbol =
119
- T.type_alias { T.any(Symbol, String, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol) }
121
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
120
122
 
121
123
  INCREMENT = T.let(:increment, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol)
122
124
  DECREMENT = T.let(:decrement, Orb::Models::Customers::Credits::LedgerListParams::EntryType::TaggedSymbol)
@@ -114,6 +114,10 @@ module Orb
114
114
  ending_balance:,
115
115
  entry_status:,
116
116
  ledger_sequence_number:,
117
+ # User specified key-value pairs for the resource. If not present, this defaults
118
+ # to an empty dictionary. Individual keys can be removed by setting the value to
119
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
120
+ # `null`.
117
121
  metadata:,
118
122
  starting_balance:,
119
123
  entry_type: :increment
@@ -187,14 +191,7 @@ module Orb
187
191
 
188
192
  TaggedSymbol =
189
193
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::EntryStatus) }
190
- OrSymbol =
191
- T.type_alias do
192
- T.any(
193
- Symbol,
194
- String,
195
- Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry::EntryStatus::TaggedSymbol
196
- )
197
- end
194
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
198
195
 
199
196
  COMMITTED =
200
197
  T.let(
@@ -334,6 +331,10 @@ module Orb
334
331
  ending_balance:,
335
332
  entry_status:,
336
333
  ledger_sequence_number:,
334
+ # User specified key-value pairs for the resource. If not present, this defaults
335
+ # to an empty dictionary. Individual keys can be removed by setting the value to
336
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
337
+ # `null`.
337
338
  metadata:,
338
339
  starting_balance:,
339
340
  event_id: nil,
@@ -413,14 +414,7 @@ module Orb
413
414
 
414
415
  TaggedSymbol =
415
416
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::EntryStatus) }
416
- OrSymbol =
417
- T.type_alias do
418
- T.any(
419
- Symbol,
420
- String,
421
- Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry::EntryStatus::TaggedSymbol
422
- )
423
- end
417
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
424
418
 
425
419
  COMMITTED =
426
420
  T.let(
@@ -552,6 +546,10 @@ module Orb
552
546
  ending_balance:,
553
547
  entry_status:,
554
548
  ledger_sequence_number:,
549
+ # User specified key-value pairs for the resource. If not present, this defaults
550
+ # to an empty dictionary. Individual keys can be removed by setting the value to
551
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
552
+ # `null`.
555
553
  metadata:,
556
554
  new_block_expiry_date:,
557
555
  starting_balance:,
@@ -629,14 +627,7 @@ module Orb
629
627
  T.type_alias do
630
628
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus)
631
629
  end
632
- OrSymbol =
633
- T.type_alias do
634
- T.any(
635
- Symbol,
636
- String,
637
- Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry::EntryStatus::TaggedSymbol
638
- )
639
- end
630
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
640
631
 
641
632
  COMMITTED =
642
633
  T.let(
@@ -766,6 +757,10 @@ module Orb
766
757
  ending_balance:,
767
758
  entry_status:,
768
759
  ledger_sequence_number:,
760
+ # User specified key-value pairs for the resource. If not present, this defaults
761
+ # to an empty dictionary. Individual keys can be removed by setting the value to
762
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
763
+ # `null`.
769
764
  metadata:,
770
765
  starting_balance:,
771
766
  entry_type: :credit_block_expiry
@@ -841,14 +836,7 @@ module Orb
841
836
  T.type_alias do
842
837
  T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus)
843
838
  end
844
- OrSymbol =
845
- T.type_alias do
846
- T.any(
847
- Symbol,
848
- String,
849
- Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry::EntryStatus::TaggedSymbol
850
- )
851
- end
839
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
852
840
 
853
841
  COMMITTED =
854
842
  T.let(
@@ -982,6 +970,10 @@ module Orb
982
970
  ending_balance:,
983
971
  entry_status:,
984
972
  ledger_sequence_number:,
973
+ # User specified key-value pairs for the resource. If not present, this defaults
974
+ # to an empty dictionary. Individual keys can be removed by setting the value to
975
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
976
+ # `null`.
985
977
  metadata:,
986
978
  starting_balance:,
987
979
  void_amount:,
@@ -1059,14 +1051,7 @@ module Orb
1059
1051
 
1060
1052
  TaggedSymbol =
1061
1053
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::EntryStatus) }
1062
- OrSymbol =
1063
- T.type_alias do
1064
- T.any(
1065
- Symbol,
1066
- String,
1067
- Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry::EntryStatus::TaggedSymbol
1068
- )
1069
- end
1054
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1070
1055
 
1071
1056
  COMMITTED =
1072
1057
  T.let(
@@ -1206,6 +1191,10 @@ module Orb
1206
1191
  ending_balance:,
1207
1192
  entry_status:,
1208
1193
  ledger_sequence_number:,
1194
+ # User specified key-value pairs for the resource. If not present, this defaults
1195
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1196
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1197
+ # `null`.
1209
1198
  metadata:,
1210
1199
  new_block_expiry_date:,
1211
1200
  starting_balance:,
@@ -1285,14 +1274,7 @@ module Orb
1285
1274
 
1286
1275
  TaggedSymbol =
1287
1276
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::EntryStatus) }
1288
- OrSymbol =
1289
- T.type_alias do
1290
- T.any(
1291
- Symbol,
1292
- String,
1293
- Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry::EntryStatus::TaggedSymbol
1294
- )
1295
- end
1277
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1296
1278
 
1297
1279
  COMMITTED =
1298
1280
  T.let(
@@ -1420,6 +1402,10 @@ module Orb
1420
1402
  ending_balance:,
1421
1403
  entry_status:,
1422
1404
  ledger_sequence_number:,
1405
+ # User specified key-value pairs for the resource. If not present, this defaults
1406
+ # to an empty dictionary. Individual keys can be removed by setting the value to
1407
+ # `null`, and the entire metadata mapping can be cleared by setting `metadata` to
1408
+ # `null`.
1423
1409
  metadata:,
1424
1410
  starting_balance:,
1425
1411
  entry_type: :amendment
@@ -1493,14 +1479,7 @@ module Orb
1493
1479
 
1494
1480
  TaggedSymbol =
1495
1481
  T.type_alias { T.all(Symbol, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::EntryStatus) }
1496
- OrSymbol =
1497
- T.type_alias do
1498
- T.any(
1499
- Symbol,
1500
- String,
1501
- Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry::EntryStatus::TaggedSymbol
1502
- )
1503
- end
1482
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1504
1483
 
1505
1484
  COMMITTED =
1506
1485
  T.let(