orb-billing 0.1.3 → 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 (381) hide show
  1. checksums.yaml +4 -4
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +65 -0
  4. data/README.md +61 -51
  5. data/lib/orb/client.rb +7 -6
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +37 -39
  8. data/lib/orb/internal/transport/base_client.rb +21 -11
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
  10. data/lib/orb/internal/type/array_of.rb +28 -2
  11. data/lib/orb/internal/type/base_model.rb +83 -21
  12. data/lib/orb/internal/type/base_page.rb +10 -1
  13. data/lib/orb/internal/type/boolean.rb +6 -0
  14. data/lib/orb/internal/type/converter.rb +28 -1
  15. data/lib/orb/internal/type/enum.rb +28 -8
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
  17. data/lib/orb/internal/type/hash_of.rb +28 -2
  18. data/lib/orb/internal/type/request_parameters.rb +1 -2
  19. data/lib/orb/internal/type/union.rb +27 -4
  20. data/lib/orb/internal/type/unknown.rb +6 -0
  21. data/lib/orb/internal/util.rb +105 -70
  22. data/lib/orb/internal.rb +5 -2
  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 +24 -29
  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 +211 -252
  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 +207 -250
  54. data/lib/orb/models/customer_update_params.rb +207 -250
  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 +22 -26
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +22 -26
  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 +300 -406
  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 +300 -406
  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 +300 -406
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
  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 +589 -637
  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 +584 -631
  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 +247 -269
  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 +250 -279
  139. data/lib/orb/models/plan_create_params.rb +1623 -1984
  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 +2709 -3820
  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 +343 -382
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +339 -377
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +365 -398
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
  163. data/lib/orb/models/subscription_create_params.rb +3771 -4402
  164. data/lib/orb/models/subscription_create_response.rb +339 -377
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
  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 +2018 -2472
  173. data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
  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 +343 -377
  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 +343 -377
  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 +342 -377
  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 +341 -377
  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/request_options.rb +3 -4
  196. data/lib/orb/resources/alerts.rb +48 -17
  197. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  198. data/lib/orb/resources/coupons.rb +25 -7
  199. data/lib/orb/resources/credit_notes.rb +17 -4
  200. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  201. data/lib/orb/resources/customers/costs.rb +26 -8
  202. data/lib/orb/resources/customers/credits/ledger.rb +108 -28
  203. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  204. data/lib/orb/resources/customers/credits.rb +28 -8
  205. data/lib/orb/resources/customers.rb +135 -36
  206. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  207. data/lib/orb/resources/events/backfills.rb +32 -9
  208. data/lib/orb/resources/events/volume.rb +14 -4
  209. data/lib/orb/resources/events.rb +40 -11
  210. data/lib/orb/resources/invoice_line_items.rb +16 -6
  211. data/lib/orb/resources/invoices.rb +77 -17
  212. data/lib/orb/resources/items.rb +10 -3
  213. data/lib/orb/resources/metrics.rb +33 -8
  214. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  215. data/lib/orb/resources/plans.rb +47 -11
  216. data/lib/orb/resources/prices/external_price_id.rb +7 -1
  217. data/lib/orb/resources/prices.rb +97 -22
  218. data/lib/orb/resources/subscription_changes.rb +5 -2
  219. data/lib/orb/resources/subscriptions.rb +292 -78
  220. data/lib/orb/version.rb +1 -1
  221. data/lib/orb.rb +2 -10
  222. data/rbi/lib/orb/client.rbi +7 -6
  223. data/rbi/lib/orb/file_part.rbi +34 -0
  224. data/rbi/lib/orb/internal/page.rbi +1 -0
  225. data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
  226. data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
  227. data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
  228. data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
  229. data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
  230. data/rbi/lib/orb/internal/type/converter.rbi +8 -0
  231. data/rbi/lib/orb/internal/type/enum.rbi +7 -6
  232. data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
  233. data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
  234. data/rbi/lib/orb/internal/type/union.rbi +7 -0
  235. data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
  236. data/rbi/lib/orb/internal/util.rbi +39 -19
  237. data/rbi/lib/orb/internal.rbi +1 -2
  238. data/rbi/lib/orb/models/alert.rbi +28 -8
  239. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
  240. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
  241. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
  242. data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
  243. data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
  244. data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
  245. data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
  246. data/rbi/lib/orb/models/amount_discount.rbi +10 -4
  247. data/rbi/lib/orb/models/billable_metric.rbi +16 -3
  248. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
  249. data/rbi/lib/orb/models/coupon.rbi +10 -3
  250. data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
  251. data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
  252. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
  253. data/rbi/lib/orb/models/credit_note.rbi +44 -12
  254. data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
  255. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
  256. data/rbi/lib/orb/models/customer.rbi +130 -11
  257. data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
  258. data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
  259. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
  260. data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
  261. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
  262. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
  263. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
  264. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
  265. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
  266. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
  267. data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
  268. data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
  269. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
  270. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
  271. data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
  272. data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
  273. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  274. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
  275. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  276. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
  277. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  278. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
  279. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
  280. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
  281. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  282. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  283. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
  284. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
  285. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  286. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  287. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
  288. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
  289. data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
  290. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
  291. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
  292. data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
  293. data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
  294. data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
  295. data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
  296. data/rbi/lib/orb/models/event_search_params.rbi +14 -2
  297. data/rbi/lib/orb/models/event_search_response.rbi +14 -3
  298. data/rbi/lib/orb/models/event_update_params.rbi +10 -3
  299. data/rbi/lib/orb/models/event_update_response.rbi +4 -2
  300. data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
  301. data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
  302. data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
  303. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
  304. data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
  305. data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
  306. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
  307. data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
  308. data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
  309. data/rbi/lib/orb/models/invoice.rbi +375 -46
  310. data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
  311. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
  312. data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
  313. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
  314. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
  315. data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
  316. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
  317. data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
  318. data/rbi/lib/orb/models/item.rbi +1 -2
  319. data/rbi/lib/orb/models/item_create_params.rbi +5 -2
  320. data/rbi/lib/orb/models/item_list_params.rbi +8 -2
  321. data/rbi/lib/orb/models/item_update_params.rbi +1 -8
  322. data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
  323. data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
  324. data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
  325. data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
  326. data/rbi/lib/orb/models/plan.rbi +102 -15
  327. data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
  328. data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
  329. data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
  330. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
  331. data/rbi/lib/orb/models/price.rbi +717 -688
  332. data/rbi/lib/orb/models/price_create_params.rbi +137 -53
  333. data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
  334. data/rbi/lib/orb/models/price_list_params.rbi +8 -2
  335. data/rbi/lib/orb/models/price_update_params.rbi +7 -2
  336. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
  337. data/rbi/lib/orb/models/subscription.rbi +174 -11
  338. data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
  339. data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
  340. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
  341. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
  342. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
  343. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
  344. data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
  345. data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
  346. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
  347. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
  348. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
  349. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
  350. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
  351. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
  352. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
  353. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
  354. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
  355. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
  356. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
  357. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
  358. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
  359. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  360. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
  361. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
  362. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  363. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
  364. data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
  365. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
  366. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
  367. data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
  368. data/rbi/lib/orb/models/trial_discount.rbi +5 -1
  369. data/rbi/lib/orb/models/usage_discount.rbi +11 -3
  370. data/sig/orb/file_part.rbs +21 -0
  371. data/sig/orb/internal/transport/base_client.rbs +9 -3
  372. data/sig/orb/internal/type/array_of.rbs +4 -0
  373. data/sig/orb/internal/type/base_model.rbs +12 -0
  374. data/sig/orb/internal/type/converter.rbs +4 -0
  375. data/sig/orb/internal/type/enum.rbs +4 -2
  376. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  377. data/sig/orb/internal/type/hash_of.rbs +4 -0
  378. data/sig/orb/internal/type/union.rbs +4 -0
  379. data/sig/orb/internal/util.rbs +16 -12
  380. data/sig/orb/internal.rbs +1 -1
  381. metadata +9 -5
@@ -106,41 +106,37 @@ module Orb
106
106
  # @return [Float]
107
107
  required :starting_balance, Float
108
108
 
109
- # @!parse
110
- # # @param id [String]
111
- # # @param amount [Float]
112
- # # @param created_at [Time]
113
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock]
114
- # # @param currency [String]
115
- # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer]
116
- # # @param description [String, nil]
117
- # # @param ending_balance [Float]
118
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus]
119
- # # @param ledger_sequence_number [Integer]
120
- # # @param metadata [Hash{Symbol=>String}]
121
- # # @param starting_balance [Float]
122
- # # @param entry_type [Symbol, :increment]
123
- # #
124
- # def initialize(
125
- # id:,
126
- # amount:,
127
- # created_at:,
128
- # credit_block:,
129
- # currency:,
130
- # customer:,
131
- # description:,
132
- # ending_balance:,
133
- # entry_status:,
134
- # ledger_sequence_number:,
135
- # metadata:,
136
- # starting_balance:,
137
- # entry_type: :increment,
138
- # **
139
- # )
140
- # super
141
- # end
142
-
143
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
109
+ # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
110
+ # Some parameter documentations has been truncated, see
111
+ # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry}
112
+ # for more details.
113
+ #
114
+ # @param id [String]
115
+ #
116
+ # @param amount [Float]
117
+ #
118
+ # @param created_at [Time]
119
+ #
120
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::CreditBlock]
121
+ #
122
+ # @param currency [String]
123
+ #
124
+ # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::Customer]
125
+ #
126
+ # @param description [String, nil]
127
+ #
128
+ # @param ending_balance [Float]
129
+ #
130
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry::EntryStatus]
131
+ #
132
+ # @param ledger_sequence_number [Integer]
133
+ #
134
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
135
+ # ...
136
+ #
137
+ # @param starting_balance [Float]
138
+ #
139
+ # @param entry_type [Symbol, :increment]
144
140
 
145
141
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#credit_block
146
142
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -159,14 +155,10 @@ module Orb
159
155
  # @return [String, nil]
160
156
  required :per_unit_cost_basis, String, nil?: true
161
157
 
162
- # @!parse
163
- # # @param id [String]
164
- # # @param expiry_date [Time, nil]
165
- # # @param per_unit_cost_basis [String, nil]
166
- # #
167
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
168
-
169
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
158
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
159
+ # @param id [String]
160
+ # @param expiry_date [Time, nil]
161
+ # @param per_unit_cost_basis [String, nil]
170
162
  end
171
163
 
172
164
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#customer
@@ -181,13 +173,9 @@ module Orb
181
173
  # @return [String, nil]
182
174
  required :external_customer_id, String, nil?: true
183
175
 
184
- # @!parse
185
- # # @param id [String]
186
- # # @param external_customer_id [String, nil]
187
- # #
188
- # def initialize(id:, external_customer_id:, **) = super
189
-
190
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
176
+ # @!method initialize(id:, external_customer_id:)
177
+ # @param id [String]
178
+ # @param external_customer_id [String, nil]
191
179
  end
192
180
 
193
181
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry#entry_status
@@ -197,11 +185,8 @@ module Orb
197
185
  COMMITTED = :committed
198
186
  PENDING = :pending
199
187
 
200
- finalize!
201
-
202
- # @!parse
203
- # # @return [Array<Symbol>]
204
- # def self.values; end
188
+ # @!method self.values
189
+ # @return [Array<Symbol>]
205
190
  end
206
191
  end
207
192
 
@@ -293,47 +278,43 @@ module Orb
293
278
  # @return [String, nil]
294
279
  optional :price_id, String, nil?: true
295
280
 
296
- # @!parse
297
- # # @param id [String]
298
- # # @param amount [Float]
299
- # # @param created_at [Time]
300
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock]
301
- # # @param currency [String]
302
- # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer]
303
- # # @param description [String, nil]
304
- # # @param ending_balance [Float]
305
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus]
306
- # # @param ledger_sequence_number [Integer]
307
- # # @param metadata [Hash{Symbol=>String}]
308
- # # @param starting_balance [Float]
309
- # # @param event_id [String, nil]
310
- # # @param invoice_id [String, nil]
311
- # # @param price_id [String, nil]
312
- # # @param entry_type [Symbol, :decrement]
313
- # #
314
- # def initialize(
315
- # id:,
316
- # amount:,
317
- # created_at:,
318
- # credit_block:,
319
- # currency:,
320
- # customer:,
321
- # description:,
322
- # ending_balance:,
323
- # entry_status:,
324
- # ledger_sequence_number:,
325
- # metadata:,
326
- # starting_balance:,
327
- # event_id: nil,
328
- # invoice_id: nil,
329
- # price_id: nil,
330
- # entry_type: :decrement,
331
- # **
332
- # )
333
- # super
334
- # end
335
-
336
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
281
+ # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil, entry_type: :decrement)
282
+ # Some parameter documentations has been truncated, see
283
+ # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry}
284
+ # for more details.
285
+ #
286
+ # @param id [String]
287
+ #
288
+ # @param amount [Float]
289
+ #
290
+ # @param created_at [Time]
291
+ #
292
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::CreditBlock]
293
+ #
294
+ # @param currency [String]
295
+ #
296
+ # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::Customer]
297
+ #
298
+ # @param description [String, nil]
299
+ #
300
+ # @param ending_balance [Float]
301
+ #
302
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry::EntryStatus]
303
+ #
304
+ # @param ledger_sequence_number [Integer]
305
+ #
306
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
307
+ # ...
308
+ #
309
+ # @param starting_balance [Float]
310
+ #
311
+ # @param event_id [String, nil]
312
+ #
313
+ # @param invoice_id [String, nil]
314
+ #
315
+ # @param price_id [String, nil]
316
+ #
317
+ # @param entry_type [Symbol, :decrement]
337
318
 
338
319
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#credit_block
339
320
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -352,14 +333,10 @@ module Orb
352
333
  # @return [String, nil]
353
334
  required :per_unit_cost_basis, String, nil?: true
354
335
 
355
- # @!parse
356
- # # @param id [String]
357
- # # @param expiry_date [Time, nil]
358
- # # @param per_unit_cost_basis [String, nil]
359
- # #
360
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
361
-
362
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
336
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
337
+ # @param id [String]
338
+ # @param expiry_date [Time, nil]
339
+ # @param per_unit_cost_basis [String, nil]
363
340
  end
364
341
 
365
342
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#customer
@@ -374,13 +351,9 @@ module Orb
374
351
  # @return [String, nil]
375
352
  required :external_customer_id, String, nil?: true
376
353
 
377
- # @!parse
378
- # # @param id [String]
379
- # # @param external_customer_id [String, nil]
380
- # #
381
- # def initialize(id:, external_customer_id:, **) = super
382
-
383
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
354
+ # @!method initialize(id:, external_customer_id:)
355
+ # @param id [String]
356
+ # @param external_customer_id [String, nil]
384
357
  end
385
358
 
386
359
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry#entry_status
@@ -390,11 +363,8 @@ module Orb
390
363
  COMMITTED = :committed
391
364
  PENDING = :pending
392
365
 
393
- finalize!
394
-
395
- # @!parse
396
- # # @return [Array<Symbol>]
397
- # def self.values; end
366
+ # @!method self.values
367
+ # @return [Array<Symbol>]
398
368
  end
399
369
  end
400
370
 
@@ -476,43 +446,39 @@ module Orb
476
446
  # @return [Float]
477
447
  required :starting_balance, Float
478
448
 
479
- # @!parse
480
- # # @param id [String]
481
- # # @param amount [Float]
482
- # # @param created_at [Time]
483
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock]
484
- # # @param currency [String]
485
- # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer]
486
- # # @param description [String, nil]
487
- # # @param ending_balance [Float]
488
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus]
489
- # # @param ledger_sequence_number [Integer]
490
- # # @param metadata [Hash{Symbol=>String}]
491
- # # @param new_block_expiry_date [Time, nil]
492
- # # @param starting_balance [Float]
493
- # # @param entry_type [Symbol, :expiration_change]
494
- # #
495
- # def initialize(
496
- # id:,
497
- # amount:,
498
- # created_at:,
499
- # credit_block:,
500
- # currency:,
501
- # customer:,
502
- # description:,
503
- # ending_balance:,
504
- # entry_status:,
505
- # ledger_sequence_number:,
506
- # metadata:,
507
- # new_block_expiry_date:,
508
- # starting_balance:,
509
- # entry_type: :expiration_change,
510
- # **
511
- # )
512
- # super
513
- # end
514
-
515
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
449
+ # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, entry_type: :expiration_change)
450
+ # Some parameter documentations has been truncated, see
451
+ # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry}
452
+ # for more details.
453
+ #
454
+ # @param id [String]
455
+ #
456
+ # @param amount [Float]
457
+ #
458
+ # @param created_at [Time]
459
+ #
460
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock]
461
+ #
462
+ # @param currency [String]
463
+ #
464
+ # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::Customer]
465
+ #
466
+ # @param description [String, nil]
467
+ #
468
+ # @param ending_balance [Float]
469
+ #
470
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus]
471
+ #
472
+ # @param ledger_sequence_number [Integer]
473
+ #
474
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
475
+ # ...
476
+ #
477
+ # @param new_block_expiry_date [Time, nil]
478
+ #
479
+ # @param starting_balance [Float]
480
+ #
481
+ # @param entry_type [Symbol, :expiration_change]
516
482
 
517
483
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#credit_block
518
484
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -531,14 +497,10 @@ module Orb
531
497
  # @return [String, nil]
532
498
  required :per_unit_cost_basis, String, nil?: true
533
499
 
534
- # @!parse
535
- # # @param id [String]
536
- # # @param expiry_date [Time, nil]
537
- # # @param per_unit_cost_basis [String, nil]
538
- # #
539
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
540
-
541
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
500
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
501
+ # @param id [String]
502
+ # @param expiry_date [Time, nil]
503
+ # @param per_unit_cost_basis [String, nil]
542
504
  end
543
505
 
544
506
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#customer
@@ -553,13 +515,9 @@ module Orb
553
515
  # @return [String, nil]
554
516
  required :external_customer_id, String, nil?: true
555
517
 
556
- # @!parse
557
- # # @param id [String]
558
- # # @param external_customer_id [String, nil]
559
- # #
560
- # def initialize(id:, external_customer_id:, **) = super
561
-
562
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
518
+ # @!method initialize(id:, external_customer_id:)
519
+ # @param id [String]
520
+ # @param external_customer_id [String, nil]
563
521
  end
564
522
 
565
523
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry#entry_status
@@ -569,11 +527,8 @@ module Orb
569
527
  COMMITTED = :committed
570
528
  PENDING = :pending
571
529
 
572
- finalize!
573
-
574
- # @!parse
575
- # # @return [Array<Symbol>]
576
- # def self.values; end
530
+ # @!method self.values
531
+ # @return [Array<Symbol>]
577
532
  end
578
533
  end
579
534
 
@@ -650,41 +605,37 @@ module Orb
650
605
  # @return [Float]
651
606
  required :starting_balance, Float
652
607
 
653
- # @!parse
654
- # # @param id [String]
655
- # # @param amount [Float]
656
- # # @param created_at [Time]
657
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock]
658
- # # @param currency [String]
659
- # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer]
660
- # # @param description [String, nil]
661
- # # @param ending_balance [Float]
662
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus]
663
- # # @param ledger_sequence_number [Integer]
664
- # # @param metadata [Hash{Symbol=>String}]
665
- # # @param starting_balance [Float]
666
- # # @param entry_type [Symbol, :credit_block_expiry]
667
- # #
668
- # def initialize(
669
- # id:,
670
- # amount:,
671
- # created_at:,
672
- # credit_block:,
673
- # currency:,
674
- # customer:,
675
- # description:,
676
- # ending_balance:,
677
- # entry_status:,
678
- # ledger_sequence_number:,
679
- # metadata:,
680
- # starting_balance:,
681
- # entry_type: :credit_block_expiry,
682
- # **
683
- # )
684
- # super
685
- # end
686
-
687
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
608
+ # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :credit_block_expiry)
609
+ # Some parameter documentations has been truncated, see
610
+ # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry}
611
+ # for more details.
612
+ #
613
+ # @param id [String]
614
+ #
615
+ # @param amount [Float]
616
+ #
617
+ # @param created_at [Time]
618
+ #
619
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock]
620
+ #
621
+ # @param currency [String]
622
+ #
623
+ # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer]
624
+ #
625
+ # @param description [String, nil]
626
+ #
627
+ # @param ending_balance [Float]
628
+ #
629
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus]
630
+ #
631
+ # @param ledger_sequence_number [Integer]
632
+ #
633
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
634
+ # ...
635
+ #
636
+ # @param starting_balance [Float]
637
+ #
638
+ # @param entry_type [Symbol, :credit_block_expiry]
688
639
 
689
640
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#credit_block
690
641
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -703,14 +654,10 @@ module Orb
703
654
  # @return [String, nil]
704
655
  required :per_unit_cost_basis, String, nil?: true
705
656
 
706
- # @!parse
707
- # # @param id [String]
708
- # # @param expiry_date [Time, nil]
709
- # # @param per_unit_cost_basis [String, nil]
710
- # #
711
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
712
-
713
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
657
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
658
+ # @param id [String]
659
+ # @param expiry_date [Time, nil]
660
+ # @param per_unit_cost_basis [String, nil]
714
661
  end
715
662
 
716
663
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#customer
@@ -725,13 +672,9 @@ module Orb
725
672
  # @return [String, nil]
726
673
  required :external_customer_id, String, nil?: true
727
674
 
728
- # @!parse
729
- # # @param id [String]
730
- # # @param external_customer_id [String, nil]
731
- # #
732
- # def initialize(id:, external_customer_id:, **) = super
733
-
734
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
675
+ # @!method initialize(id:, external_customer_id:)
676
+ # @param id [String]
677
+ # @param external_customer_id [String, nil]
735
678
  end
736
679
 
737
680
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry#entry_status
@@ -741,11 +684,8 @@ module Orb
741
684
  COMMITTED = :committed
742
685
  PENDING = :pending
743
686
 
744
- finalize!
745
-
746
- # @!parse
747
- # # @return [Array<Symbol>]
748
- # def self.values; end
687
+ # @!method self.values
688
+ # @return [Array<Symbol>]
749
689
  end
750
690
  end
751
691
 
@@ -832,45 +772,41 @@ module Orb
832
772
  # @return [String, nil]
833
773
  required :void_reason, String, nil?: true
834
774
 
835
- # @!parse
836
- # # @param id [String]
837
- # # @param amount [Float]
838
- # # @param created_at [Time]
839
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock]
840
- # # @param currency [String]
841
- # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer]
842
- # # @param description [String, nil]
843
- # # @param ending_balance [Float]
844
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus]
845
- # # @param ledger_sequence_number [Integer]
846
- # # @param metadata [Hash{Symbol=>String}]
847
- # # @param starting_balance [Float]
848
- # # @param void_amount [Float]
849
- # # @param void_reason [String, nil]
850
- # # @param entry_type [Symbol, :void]
851
- # #
852
- # def initialize(
853
- # id:,
854
- # amount:,
855
- # created_at:,
856
- # credit_block:,
857
- # currency:,
858
- # customer:,
859
- # description:,
860
- # ending_balance:,
861
- # entry_status:,
862
- # ledger_sequence_number:,
863
- # metadata:,
864
- # starting_balance:,
865
- # void_amount:,
866
- # void_reason:,
867
- # entry_type: :void,
868
- # **
869
- # )
870
- # super
871
- # end
872
-
873
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
775
+ # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, void_amount:, void_reason:, entry_type: :void)
776
+ # Some parameter documentations has been truncated, see
777
+ # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry}
778
+ # for more details.
779
+ #
780
+ # @param id [String]
781
+ #
782
+ # @param amount [Float]
783
+ #
784
+ # @param created_at [Time]
785
+ #
786
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::CreditBlock]
787
+ #
788
+ # @param currency [String]
789
+ #
790
+ # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::Customer]
791
+ #
792
+ # @param description [String, nil]
793
+ #
794
+ # @param ending_balance [Float]
795
+ #
796
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry::EntryStatus]
797
+ #
798
+ # @param ledger_sequence_number [Integer]
799
+ #
800
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
801
+ # ...
802
+ #
803
+ # @param starting_balance [Float]
804
+ #
805
+ # @param void_amount [Float]
806
+ #
807
+ # @param void_reason [String, nil]
808
+ #
809
+ # @param entry_type [Symbol, :void]
874
810
 
875
811
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#credit_block
876
812
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -889,14 +825,10 @@ module Orb
889
825
  # @return [String, nil]
890
826
  required :per_unit_cost_basis, String, nil?: true
891
827
 
892
- # @!parse
893
- # # @param id [String]
894
- # # @param expiry_date [Time, nil]
895
- # # @param per_unit_cost_basis [String, nil]
896
- # #
897
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
898
-
899
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
828
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
829
+ # @param id [String]
830
+ # @param expiry_date [Time, nil]
831
+ # @param per_unit_cost_basis [String, nil]
900
832
  end
901
833
 
902
834
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#customer
@@ -911,13 +843,9 @@ module Orb
911
843
  # @return [String, nil]
912
844
  required :external_customer_id, String, nil?: true
913
845
 
914
- # @!parse
915
- # # @param id [String]
916
- # # @param external_customer_id [String, nil]
917
- # #
918
- # def initialize(id:, external_customer_id:, **) = super
919
-
920
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
846
+ # @!method initialize(id:, external_customer_id:)
847
+ # @param id [String]
848
+ # @param external_customer_id [String, nil]
921
849
  end
922
850
 
923
851
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry#entry_status
@@ -927,11 +855,8 @@ module Orb
927
855
  COMMITTED = :committed
928
856
  PENDING = :pending
929
857
 
930
- finalize!
931
-
932
- # @!parse
933
- # # @return [Array<Symbol>]
934
- # def self.values; end
858
+ # @!method self.values
859
+ # @return [Array<Symbol>]
935
860
  end
936
861
  end
937
862
 
@@ -1023,47 +948,43 @@ module Orb
1023
948
  # @return [String, nil]
1024
949
  required :void_reason, String, nil?: true
1025
950
 
1026
- # @!parse
1027
- # # @param id [String]
1028
- # # @param amount [Float]
1029
- # # @param created_at [Time]
1030
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock]
1031
- # # @param currency [String]
1032
- # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer]
1033
- # # @param description [String, nil]
1034
- # # @param ending_balance [Float]
1035
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus]
1036
- # # @param ledger_sequence_number [Integer]
1037
- # # @param metadata [Hash{Symbol=>String}]
1038
- # # @param new_block_expiry_date [Time]
1039
- # # @param starting_balance [Float]
1040
- # # @param void_amount [Float]
1041
- # # @param void_reason [String, nil]
1042
- # # @param entry_type [Symbol, :void_initiated]
1043
- # #
1044
- # def initialize(
1045
- # id:,
1046
- # amount:,
1047
- # created_at:,
1048
- # credit_block:,
1049
- # currency:,
1050
- # customer:,
1051
- # description:,
1052
- # ending_balance:,
1053
- # entry_status:,
1054
- # ledger_sequence_number:,
1055
- # metadata:,
1056
- # new_block_expiry_date:,
1057
- # starting_balance:,
1058
- # void_amount:,
1059
- # void_reason:,
1060
- # entry_type: :void_initiated,
1061
- # **
1062
- # )
1063
- # super
1064
- # end
1065
-
1066
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
951
+ # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, new_block_expiry_date:, starting_balance:, void_amount:, void_reason:, entry_type: :void_initiated)
952
+ # Some parameter documentations has been truncated, see
953
+ # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry}
954
+ # for more details.
955
+ #
956
+ # @param id [String]
957
+ #
958
+ # @param amount [Float]
959
+ #
960
+ # @param created_at [Time]
961
+ #
962
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock]
963
+ #
964
+ # @param currency [String]
965
+ #
966
+ # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::Customer]
967
+ #
968
+ # @param description [String, nil]
969
+ #
970
+ # @param ending_balance [Float]
971
+ #
972
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus]
973
+ #
974
+ # @param ledger_sequence_number [Integer]
975
+ #
976
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
977
+ # ...
978
+ #
979
+ # @param new_block_expiry_date [Time]
980
+ #
981
+ # @param starting_balance [Float]
982
+ #
983
+ # @param void_amount [Float]
984
+ #
985
+ # @param void_reason [String, nil]
986
+ #
987
+ # @param entry_type [Symbol, :void_initiated]
1067
988
 
1068
989
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#credit_block
1069
990
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -1082,14 +1003,10 @@ module Orb
1082
1003
  # @return [String, nil]
1083
1004
  required :per_unit_cost_basis, String, nil?: true
1084
1005
 
1085
- # @!parse
1086
- # # @param id [String]
1087
- # # @param expiry_date [Time, nil]
1088
- # # @param per_unit_cost_basis [String, nil]
1089
- # #
1090
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
1091
-
1092
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1006
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
1007
+ # @param id [String]
1008
+ # @param expiry_date [Time, nil]
1009
+ # @param per_unit_cost_basis [String, nil]
1093
1010
  end
1094
1011
 
1095
1012
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#customer
@@ -1104,13 +1021,9 @@ module Orb
1104
1021
  # @return [String, nil]
1105
1022
  required :external_customer_id, String, nil?: true
1106
1023
 
1107
- # @!parse
1108
- # # @param id [String]
1109
- # # @param external_customer_id [String, nil]
1110
- # #
1111
- # def initialize(id:, external_customer_id:, **) = super
1112
-
1113
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1024
+ # @!method initialize(id:, external_customer_id:)
1025
+ # @param id [String]
1026
+ # @param external_customer_id [String, nil]
1114
1027
  end
1115
1028
 
1116
1029
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry#entry_status
@@ -1120,11 +1033,8 @@ module Orb
1120
1033
  COMMITTED = :committed
1121
1034
  PENDING = :pending
1122
1035
 
1123
- finalize!
1124
-
1125
- # @!parse
1126
- # # @return [Array<Symbol>]
1127
- # def self.values; end
1036
+ # @!method self.values
1037
+ # @return [Array<Symbol>]
1128
1038
  end
1129
1039
  end
1130
1040
 
@@ -1201,41 +1111,37 @@ module Orb
1201
1111
  # @return [Float]
1202
1112
  required :starting_balance, Float
1203
1113
 
1204
- # @!parse
1205
- # # @param id [String]
1206
- # # @param amount [Float]
1207
- # # @param created_at [Time]
1208
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock]
1209
- # # @param currency [String]
1210
- # # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer]
1211
- # # @param description [String, nil]
1212
- # # @param ending_balance [Float]
1213
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus]
1214
- # # @param ledger_sequence_number [Integer]
1215
- # # @param metadata [Hash{Symbol=>String}]
1216
- # # @param starting_balance [Float]
1217
- # # @param entry_type [Symbol, :amendment]
1218
- # #
1219
- # def initialize(
1220
- # id:,
1221
- # amount:,
1222
- # created_at:,
1223
- # credit_block:,
1224
- # currency:,
1225
- # customer:,
1226
- # description:,
1227
- # ending_balance:,
1228
- # entry_status:,
1229
- # ledger_sequence_number:,
1230
- # metadata:,
1231
- # starting_balance:,
1232
- # entry_type: :amendment,
1233
- # **
1234
- # )
1235
- # super
1236
- # end
1237
-
1238
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1114
+ # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment)
1115
+ # Some parameter documentations has been truncated, see
1116
+ # {Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry}
1117
+ # for more details.
1118
+ #
1119
+ # @param id [String]
1120
+ #
1121
+ # @param amount [Float]
1122
+ #
1123
+ # @param created_at [Time]
1124
+ #
1125
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::CreditBlock]
1126
+ #
1127
+ # @param currency [String]
1128
+ #
1129
+ # @param customer [Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::Customer]
1130
+ #
1131
+ # @param description [String, nil]
1132
+ #
1133
+ # @param ending_balance [Float]
1134
+ #
1135
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry::EntryStatus]
1136
+ #
1137
+ # @param ledger_sequence_number [Integer]
1138
+ #
1139
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
1140
+ # ...
1141
+ #
1142
+ # @param starting_balance [Float]
1143
+ #
1144
+ # @param entry_type [Symbol, :amendment]
1239
1145
 
1240
1146
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#credit_block
1241
1147
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -1254,14 +1160,10 @@ module Orb
1254
1160
  # @return [String, nil]
1255
1161
  required :per_unit_cost_basis, String, nil?: true
1256
1162
 
1257
- # @!parse
1258
- # # @param id [String]
1259
- # # @param expiry_date [Time, nil]
1260
- # # @param per_unit_cost_basis [String, nil]
1261
- # #
1262
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
1263
-
1264
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1163
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
1164
+ # @param id [String]
1165
+ # @param expiry_date [Time, nil]
1166
+ # @param per_unit_cost_basis [String, nil]
1265
1167
  end
1266
1168
 
1267
1169
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#customer
@@ -1276,13 +1178,9 @@ module Orb
1276
1178
  # @return [String, nil]
1277
1179
  required :external_customer_id, String, nil?: true
1278
1180
 
1279
- # @!parse
1280
- # # @param id [String]
1281
- # # @param external_customer_id [String, nil]
1282
- # #
1283
- # def initialize(id:, external_customer_id:, **) = super
1284
-
1285
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1181
+ # @!method initialize(id:, external_customer_id:)
1182
+ # @param id [String]
1183
+ # @param external_customer_id [String, nil]
1286
1184
  end
1287
1185
 
1288
1186
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry#entry_status
@@ -1292,17 +1190,13 @@ module Orb
1292
1190
  COMMITTED = :committed
1293
1191
  PENDING = :pending
1294
1192
 
1295
- finalize!
1296
-
1297
- # @!parse
1298
- # # @return [Array<Symbol>]
1299
- # def self.values; end
1193
+ # @!method self.values
1194
+ # @return [Array<Symbol>]
1300
1195
  end
1301
1196
  end
1302
1197
 
1303
- # @!parse
1304
- # # @return [Array(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry)]
1305
- # def self.variants; end
1198
+ # @!method self.variants
1199
+ # @return [Array(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry)]
1306
1200
  end
1307
1201
  end
1308
1202
  end