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
@@ -107,41 +107,37 @@ module Orb
107
107
  # @return [Float]
108
108
  required :starting_balance, Float
109
109
 
110
- # @!parse
111
- # # @param id [String]
112
- # # @param amount [Float]
113
- # # @param created_at [Time]
114
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::CreditBlock]
115
- # # @param currency [String]
116
- # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::Customer]
117
- # # @param description [String, nil]
118
- # # @param ending_balance [Float]
119
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus]
120
- # # @param ledger_sequence_number [Integer]
121
- # # @param metadata [Hash{Symbol=>String}]
122
- # # @param starting_balance [Float]
123
- # # @param entry_type [Symbol, :increment]
124
- # #
125
- # def initialize(
126
- # id:,
127
- # amount:,
128
- # created_at:,
129
- # credit_block:,
130
- # currency:,
131
- # customer:,
132
- # description:,
133
- # ending_balance:,
134
- # entry_status:,
135
- # ledger_sequence_number:,
136
- # metadata:,
137
- # starting_balance:,
138
- # entry_type: :increment,
139
- # **
140
- # )
141
- # super
142
- # end
143
-
144
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
110
+ # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :increment)
111
+ # Some parameter documentations has been truncated, see
112
+ # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry}
113
+ # for more details.
114
+ #
115
+ # @param id [String]
116
+ #
117
+ # @param amount [Float]
118
+ #
119
+ # @param created_at [Time]
120
+ #
121
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::CreditBlock]
122
+ #
123
+ # @param currency [String]
124
+ #
125
+ # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::Customer]
126
+ #
127
+ # @param description [String, nil]
128
+ #
129
+ # @param ending_balance [Float]
130
+ #
131
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry::EntryStatus]
132
+ #
133
+ # @param ledger_sequence_number [Integer]
134
+ #
135
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
136
+ # ...
137
+ #
138
+ # @param starting_balance [Float]
139
+ #
140
+ # @param entry_type [Symbol, :increment]
145
141
 
146
142
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#credit_block
147
143
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -160,14 +156,10 @@ module Orb
160
156
  # @return [String, nil]
161
157
  required :per_unit_cost_basis, String, nil?: true
162
158
 
163
- # @!parse
164
- # # @param id [String]
165
- # # @param expiry_date [Time, nil]
166
- # # @param per_unit_cost_basis [String, nil]
167
- # #
168
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
169
-
170
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
159
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
160
+ # @param id [String]
161
+ # @param expiry_date [Time, nil]
162
+ # @param per_unit_cost_basis [String, nil]
171
163
  end
172
164
 
173
165
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#customer
@@ -182,13 +174,9 @@ module Orb
182
174
  # @return [String, nil]
183
175
  required :external_customer_id, String, nil?: true
184
176
 
185
- # @!parse
186
- # # @param id [String]
187
- # # @param external_customer_id [String, nil]
188
- # #
189
- # def initialize(id:, external_customer_id:, **) = super
190
-
191
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
177
+ # @!method initialize(id:, external_customer_id:)
178
+ # @param id [String]
179
+ # @param external_customer_id [String, nil]
192
180
  end
193
181
 
194
182
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry#entry_status
@@ -198,11 +186,8 @@ module Orb
198
186
  COMMITTED = :committed
199
187
  PENDING = :pending
200
188
 
201
- finalize!
202
-
203
- # @!parse
204
- # # @return [Array<Symbol>]
205
- # def self.values; end
189
+ # @!method self.values
190
+ # @return [Array<Symbol>]
206
191
  end
207
192
  end
208
193
 
@@ -294,47 +279,43 @@ module Orb
294
279
  # @return [String, nil]
295
280
  optional :price_id, String, nil?: true
296
281
 
297
- # @!parse
298
- # # @param id [String]
299
- # # @param amount [Float]
300
- # # @param created_at [Time]
301
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::CreditBlock]
302
- # # @param currency [String]
303
- # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::Customer]
304
- # # @param description [String, nil]
305
- # # @param ending_balance [Float]
306
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus]
307
- # # @param ledger_sequence_number [Integer]
308
- # # @param metadata [Hash{Symbol=>String}]
309
- # # @param starting_balance [Float]
310
- # # @param event_id [String, nil]
311
- # # @param invoice_id [String, nil]
312
- # # @param price_id [String, nil]
313
- # # @param entry_type [Symbol, :decrement]
314
- # #
315
- # def initialize(
316
- # id:,
317
- # amount:,
318
- # created_at:,
319
- # credit_block:,
320
- # currency:,
321
- # customer:,
322
- # description:,
323
- # ending_balance:,
324
- # entry_status:,
325
- # ledger_sequence_number:,
326
- # metadata:,
327
- # starting_balance:,
328
- # event_id: nil,
329
- # invoice_id: nil,
330
- # price_id: nil,
331
- # entry_type: :decrement,
332
- # **
333
- # )
334
- # super
335
- # end
336
-
337
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
282
+ # @!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)
283
+ # Some parameter documentations has been truncated, see
284
+ # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry}
285
+ # for more details.
286
+ #
287
+ # @param id [String]
288
+ #
289
+ # @param amount [Float]
290
+ #
291
+ # @param created_at [Time]
292
+ #
293
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::CreditBlock]
294
+ #
295
+ # @param currency [String]
296
+ #
297
+ # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::Customer]
298
+ #
299
+ # @param description [String, nil]
300
+ #
301
+ # @param ending_balance [Float]
302
+ #
303
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry::EntryStatus]
304
+ #
305
+ # @param ledger_sequence_number [Integer]
306
+ #
307
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
308
+ # ...
309
+ #
310
+ # @param starting_balance [Float]
311
+ #
312
+ # @param event_id [String, nil]
313
+ #
314
+ # @param invoice_id [String, nil]
315
+ #
316
+ # @param price_id [String, nil]
317
+ #
318
+ # @param entry_type [Symbol, :decrement]
338
319
 
339
320
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#credit_block
340
321
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -353,14 +334,10 @@ module Orb
353
334
  # @return [String, nil]
354
335
  required :per_unit_cost_basis, String, nil?: true
355
336
 
356
- # @!parse
357
- # # @param id [String]
358
- # # @param expiry_date [Time, nil]
359
- # # @param per_unit_cost_basis [String, nil]
360
- # #
361
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
362
-
363
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
337
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
338
+ # @param id [String]
339
+ # @param expiry_date [Time, nil]
340
+ # @param per_unit_cost_basis [String, nil]
364
341
  end
365
342
 
366
343
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#customer
@@ -375,13 +352,9 @@ module Orb
375
352
  # @return [String, nil]
376
353
  required :external_customer_id, String, nil?: true
377
354
 
378
- # @!parse
379
- # # @param id [String]
380
- # # @param external_customer_id [String, nil]
381
- # #
382
- # def initialize(id:, external_customer_id:, **) = super
383
-
384
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
355
+ # @!method initialize(id:, external_customer_id:)
356
+ # @param id [String]
357
+ # @param external_customer_id [String, nil]
385
358
  end
386
359
 
387
360
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry#entry_status
@@ -391,11 +364,8 @@ module Orb
391
364
  COMMITTED = :committed
392
365
  PENDING = :pending
393
366
 
394
- finalize!
395
-
396
- # @!parse
397
- # # @return [Array<Symbol>]
398
- # def self.values; end
367
+ # @!method self.values
368
+ # @return [Array<Symbol>]
399
369
  end
400
370
  end
401
371
 
@@ -477,43 +447,39 @@ module Orb
477
447
  # @return [Float]
478
448
  required :starting_balance, Float
479
449
 
480
- # @!parse
481
- # # @param id [String]
482
- # # @param amount [Float]
483
- # # @param created_at [Time]
484
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock]
485
- # # @param currency [String]
486
- # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::Customer]
487
- # # @param description [String, nil]
488
- # # @param ending_balance [Float]
489
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus]
490
- # # @param ledger_sequence_number [Integer]
491
- # # @param metadata [Hash{Symbol=>String}]
492
- # # @param new_block_expiry_date [Time, nil]
493
- # # @param starting_balance [Float]
494
- # # @param entry_type [Symbol, :expiration_change]
495
- # #
496
- # def initialize(
497
- # id:,
498
- # amount:,
499
- # created_at:,
500
- # credit_block:,
501
- # currency:,
502
- # customer:,
503
- # description:,
504
- # ending_balance:,
505
- # entry_status:,
506
- # ledger_sequence_number:,
507
- # metadata:,
508
- # new_block_expiry_date:,
509
- # starting_balance:,
510
- # entry_type: :expiration_change,
511
- # **
512
- # )
513
- # super
514
- # end
515
-
516
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
450
+ # @!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)
451
+ # Some parameter documentations has been truncated, see
452
+ # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry}
453
+ # for more details.
454
+ #
455
+ # @param id [String]
456
+ #
457
+ # @param amount [Float]
458
+ #
459
+ # @param created_at [Time]
460
+ #
461
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::CreditBlock]
462
+ #
463
+ # @param currency [String]
464
+ #
465
+ # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::Customer]
466
+ #
467
+ # @param description [String, nil]
468
+ #
469
+ # @param ending_balance [Float]
470
+ #
471
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry::EntryStatus]
472
+ #
473
+ # @param ledger_sequence_number [Integer]
474
+ #
475
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
476
+ # ...
477
+ #
478
+ # @param new_block_expiry_date [Time, nil]
479
+ #
480
+ # @param starting_balance [Float]
481
+ #
482
+ # @param entry_type [Symbol, :expiration_change]
517
483
 
518
484
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#credit_block
519
485
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -532,14 +498,10 @@ module Orb
532
498
  # @return [String, nil]
533
499
  required :per_unit_cost_basis, String, nil?: true
534
500
 
535
- # @!parse
536
- # # @param id [String]
537
- # # @param expiry_date [Time, nil]
538
- # # @param per_unit_cost_basis [String, nil]
539
- # #
540
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
541
-
542
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
501
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
502
+ # @param id [String]
503
+ # @param expiry_date [Time, nil]
504
+ # @param per_unit_cost_basis [String, nil]
543
505
  end
544
506
 
545
507
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#customer
@@ -554,13 +516,9 @@ module Orb
554
516
  # @return [String, nil]
555
517
  required :external_customer_id, String, nil?: true
556
518
 
557
- # @!parse
558
- # # @param id [String]
559
- # # @param external_customer_id [String, nil]
560
- # #
561
- # def initialize(id:, external_customer_id:, **) = super
562
-
563
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
519
+ # @!method initialize(id:, external_customer_id:)
520
+ # @param id [String]
521
+ # @param external_customer_id [String, nil]
564
522
  end
565
523
 
566
524
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry#entry_status
@@ -570,11 +528,8 @@ module Orb
570
528
  COMMITTED = :committed
571
529
  PENDING = :pending
572
530
 
573
- finalize!
574
-
575
- # @!parse
576
- # # @return [Array<Symbol>]
577
- # def self.values; end
531
+ # @!method self.values
532
+ # @return [Array<Symbol>]
578
533
  end
579
534
  end
580
535
 
@@ -651,41 +606,37 @@ module Orb
651
606
  # @return [Float]
652
607
  required :starting_balance, Float
653
608
 
654
- # @!parse
655
- # # @param id [String]
656
- # # @param amount [Float]
657
- # # @param created_at [Time]
658
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock]
659
- # # @param currency [String]
660
- # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer]
661
- # # @param description [String, nil]
662
- # # @param ending_balance [Float]
663
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus]
664
- # # @param ledger_sequence_number [Integer]
665
- # # @param metadata [Hash{Symbol=>String}]
666
- # # @param starting_balance [Float]
667
- # # @param entry_type [Symbol, :credit_block_expiry]
668
- # #
669
- # def initialize(
670
- # id:,
671
- # amount:,
672
- # created_at:,
673
- # credit_block:,
674
- # currency:,
675
- # customer:,
676
- # description:,
677
- # ending_balance:,
678
- # entry_status:,
679
- # ledger_sequence_number:,
680
- # metadata:,
681
- # starting_balance:,
682
- # entry_type: :credit_block_expiry,
683
- # **
684
- # )
685
- # super
686
- # end
687
-
688
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
609
+ # @!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)
610
+ # Some parameter documentations has been truncated, see
611
+ # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry}
612
+ # for more details.
613
+ #
614
+ # @param id [String]
615
+ #
616
+ # @param amount [Float]
617
+ #
618
+ # @param created_at [Time]
619
+ #
620
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::CreditBlock]
621
+ #
622
+ # @param currency [String]
623
+ #
624
+ # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::Customer]
625
+ #
626
+ # @param description [String, nil]
627
+ #
628
+ # @param ending_balance [Float]
629
+ #
630
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry::EntryStatus]
631
+ #
632
+ # @param ledger_sequence_number [Integer]
633
+ #
634
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
635
+ # ...
636
+ #
637
+ # @param starting_balance [Float]
638
+ #
639
+ # @param entry_type [Symbol, :credit_block_expiry]
689
640
 
690
641
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#credit_block
691
642
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -704,14 +655,10 @@ module Orb
704
655
  # @return [String, nil]
705
656
  required :per_unit_cost_basis, String, nil?: true
706
657
 
707
- # @!parse
708
- # # @param id [String]
709
- # # @param expiry_date [Time, nil]
710
- # # @param per_unit_cost_basis [String, nil]
711
- # #
712
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
713
-
714
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
658
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
659
+ # @param id [String]
660
+ # @param expiry_date [Time, nil]
661
+ # @param per_unit_cost_basis [String, nil]
715
662
  end
716
663
 
717
664
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#customer
@@ -726,13 +673,9 @@ module Orb
726
673
  # @return [String, nil]
727
674
  required :external_customer_id, String, nil?: true
728
675
 
729
- # @!parse
730
- # # @param id [String]
731
- # # @param external_customer_id [String, nil]
732
- # #
733
- # def initialize(id:, external_customer_id:, **) = super
734
-
735
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
676
+ # @!method initialize(id:, external_customer_id:)
677
+ # @param id [String]
678
+ # @param external_customer_id [String, nil]
736
679
  end
737
680
 
738
681
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry#entry_status
@@ -742,11 +685,8 @@ module Orb
742
685
  COMMITTED = :committed
743
686
  PENDING = :pending
744
687
 
745
- finalize!
746
-
747
- # @!parse
748
- # # @return [Array<Symbol>]
749
- # def self.values; end
688
+ # @!method self.values
689
+ # @return [Array<Symbol>]
750
690
  end
751
691
  end
752
692
 
@@ -833,45 +773,41 @@ module Orb
833
773
  # @return [String, nil]
834
774
  required :void_reason, String, nil?: true
835
775
 
836
- # @!parse
837
- # # @param id [String]
838
- # # @param amount [Float]
839
- # # @param created_at [Time]
840
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::CreditBlock]
841
- # # @param currency [String]
842
- # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::Customer]
843
- # # @param description [String, nil]
844
- # # @param ending_balance [Float]
845
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus]
846
- # # @param ledger_sequence_number [Integer]
847
- # # @param metadata [Hash{Symbol=>String}]
848
- # # @param starting_balance [Float]
849
- # # @param void_amount [Float]
850
- # # @param void_reason [String, nil]
851
- # # @param entry_type [Symbol, :void]
852
- # #
853
- # def initialize(
854
- # id:,
855
- # amount:,
856
- # created_at:,
857
- # credit_block:,
858
- # currency:,
859
- # customer:,
860
- # description:,
861
- # ending_balance:,
862
- # entry_status:,
863
- # ledger_sequence_number:,
864
- # metadata:,
865
- # starting_balance:,
866
- # void_amount:,
867
- # void_reason:,
868
- # entry_type: :void,
869
- # **
870
- # )
871
- # super
872
- # end
873
-
874
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
776
+ # @!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)
777
+ # Some parameter documentations has been truncated, see
778
+ # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry}
779
+ # for more details.
780
+ #
781
+ # @param id [String]
782
+ #
783
+ # @param amount [Float]
784
+ #
785
+ # @param created_at [Time]
786
+ #
787
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::CreditBlock]
788
+ #
789
+ # @param currency [String]
790
+ #
791
+ # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::Customer]
792
+ #
793
+ # @param description [String, nil]
794
+ #
795
+ # @param ending_balance [Float]
796
+ #
797
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry::EntryStatus]
798
+ #
799
+ # @param ledger_sequence_number [Integer]
800
+ #
801
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
802
+ # ...
803
+ #
804
+ # @param starting_balance [Float]
805
+ #
806
+ # @param void_amount [Float]
807
+ #
808
+ # @param void_reason [String, nil]
809
+ #
810
+ # @param entry_type [Symbol, :void]
875
811
 
876
812
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#credit_block
877
813
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -890,14 +826,10 @@ module Orb
890
826
  # @return [String, nil]
891
827
  required :per_unit_cost_basis, String, nil?: true
892
828
 
893
- # @!parse
894
- # # @param id [String]
895
- # # @param expiry_date [Time, nil]
896
- # # @param per_unit_cost_basis [String, nil]
897
- # #
898
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
899
-
900
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
829
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
830
+ # @param id [String]
831
+ # @param expiry_date [Time, nil]
832
+ # @param per_unit_cost_basis [String, nil]
901
833
  end
902
834
 
903
835
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#customer
@@ -912,13 +844,9 @@ module Orb
912
844
  # @return [String, nil]
913
845
  required :external_customer_id, String, nil?: true
914
846
 
915
- # @!parse
916
- # # @param id [String]
917
- # # @param external_customer_id [String, nil]
918
- # #
919
- # def initialize(id:, external_customer_id:, **) = super
920
-
921
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
847
+ # @!method initialize(id:, external_customer_id:)
848
+ # @param id [String]
849
+ # @param external_customer_id [String, nil]
922
850
  end
923
851
 
924
852
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry#entry_status
@@ -928,11 +856,8 @@ module Orb
928
856
  COMMITTED = :committed
929
857
  PENDING = :pending
930
858
 
931
- finalize!
932
-
933
- # @!parse
934
- # # @return [Array<Symbol>]
935
- # def self.values; end
859
+ # @!method self.values
860
+ # @return [Array<Symbol>]
936
861
  end
937
862
  end
938
863
 
@@ -1024,47 +949,43 @@ module Orb
1024
949
  # @return [String, nil]
1025
950
  required :void_reason, String, nil?: true
1026
951
 
1027
- # @!parse
1028
- # # @param id [String]
1029
- # # @param amount [Float]
1030
- # # @param created_at [Time]
1031
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock]
1032
- # # @param currency [String]
1033
- # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::Customer]
1034
- # # @param description [String, nil]
1035
- # # @param ending_balance [Float]
1036
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus]
1037
- # # @param ledger_sequence_number [Integer]
1038
- # # @param metadata [Hash{Symbol=>String}]
1039
- # # @param new_block_expiry_date [Time]
1040
- # # @param starting_balance [Float]
1041
- # # @param void_amount [Float]
1042
- # # @param void_reason [String, nil]
1043
- # # @param entry_type [Symbol, :void_initiated]
1044
- # #
1045
- # def initialize(
1046
- # id:,
1047
- # amount:,
1048
- # created_at:,
1049
- # credit_block:,
1050
- # currency:,
1051
- # customer:,
1052
- # description:,
1053
- # ending_balance:,
1054
- # entry_status:,
1055
- # ledger_sequence_number:,
1056
- # metadata:,
1057
- # new_block_expiry_date:,
1058
- # starting_balance:,
1059
- # void_amount:,
1060
- # void_reason:,
1061
- # entry_type: :void_initiated,
1062
- # **
1063
- # )
1064
- # super
1065
- # end
1066
-
1067
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
952
+ # @!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)
953
+ # Some parameter documentations has been truncated, see
954
+ # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry}
955
+ # for more details.
956
+ #
957
+ # @param id [String]
958
+ #
959
+ # @param amount [Float]
960
+ #
961
+ # @param created_at [Time]
962
+ #
963
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::CreditBlock]
964
+ #
965
+ # @param currency [String]
966
+ #
967
+ # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::Customer]
968
+ #
969
+ # @param description [String, nil]
970
+ #
971
+ # @param ending_balance [Float]
972
+ #
973
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry::EntryStatus]
974
+ #
975
+ # @param ledger_sequence_number [Integer]
976
+ #
977
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
978
+ # ...
979
+ #
980
+ # @param new_block_expiry_date [Time]
981
+ #
982
+ # @param starting_balance [Float]
983
+ #
984
+ # @param void_amount [Float]
985
+ #
986
+ # @param void_reason [String, nil]
987
+ #
988
+ # @param entry_type [Symbol, :void_initiated]
1068
989
 
1069
990
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#credit_block
1070
991
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -1083,14 +1004,10 @@ module Orb
1083
1004
  # @return [String, nil]
1084
1005
  required :per_unit_cost_basis, String, nil?: true
1085
1006
 
1086
- # @!parse
1087
- # # @param id [String]
1088
- # # @param expiry_date [Time, nil]
1089
- # # @param per_unit_cost_basis [String, nil]
1090
- # #
1091
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
1092
-
1093
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1007
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
1008
+ # @param id [String]
1009
+ # @param expiry_date [Time, nil]
1010
+ # @param per_unit_cost_basis [String, nil]
1094
1011
  end
1095
1012
 
1096
1013
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#customer
@@ -1105,13 +1022,9 @@ module Orb
1105
1022
  # @return [String, nil]
1106
1023
  required :external_customer_id, String, nil?: true
1107
1024
 
1108
- # @!parse
1109
- # # @param id [String]
1110
- # # @param external_customer_id [String, nil]
1111
- # #
1112
- # def initialize(id:, external_customer_id:, **) = super
1113
-
1114
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1025
+ # @!method initialize(id:, external_customer_id:)
1026
+ # @param id [String]
1027
+ # @param external_customer_id [String, nil]
1115
1028
  end
1116
1029
 
1117
1030
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry#entry_status
@@ -1121,11 +1034,8 @@ module Orb
1121
1034
  COMMITTED = :committed
1122
1035
  PENDING = :pending
1123
1036
 
1124
- finalize!
1125
-
1126
- # @!parse
1127
- # # @return [Array<Symbol>]
1128
- # def self.values; end
1037
+ # @!method self.values
1038
+ # @return [Array<Symbol>]
1129
1039
  end
1130
1040
  end
1131
1041
 
@@ -1202,41 +1112,37 @@ module Orb
1202
1112
  # @return [Float]
1203
1113
  required :starting_balance, Float
1204
1114
 
1205
- # @!parse
1206
- # # @param id [String]
1207
- # # @param amount [Float]
1208
- # # @param created_at [Time]
1209
- # # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::CreditBlock]
1210
- # # @param currency [String]
1211
- # # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::Customer]
1212
- # # @param description [String, nil]
1213
- # # @param ending_balance [Float]
1214
- # # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus]
1215
- # # @param ledger_sequence_number [Integer]
1216
- # # @param metadata [Hash{Symbol=>String}]
1217
- # # @param starting_balance [Float]
1218
- # # @param entry_type [Symbol, :amendment]
1219
- # #
1220
- # def initialize(
1221
- # id:,
1222
- # amount:,
1223
- # created_at:,
1224
- # credit_block:,
1225
- # currency:,
1226
- # customer:,
1227
- # description:,
1228
- # ending_balance:,
1229
- # entry_status:,
1230
- # ledger_sequence_number:,
1231
- # metadata:,
1232
- # starting_balance:,
1233
- # entry_type: :amendment,
1234
- # **
1235
- # )
1236
- # super
1237
- # end
1238
-
1239
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1115
+ # @!method initialize(id:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, ledger_sequence_number:, metadata:, starting_balance:, entry_type: :amendment)
1116
+ # Some parameter documentations has been truncated, see
1117
+ # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry}
1118
+ # for more details.
1119
+ #
1120
+ # @param id [String]
1121
+ #
1122
+ # @param amount [Float]
1123
+ #
1124
+ # @param created_at [Time]
1125
+ #
1126
+ # @param credit_block [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::CreditBlock]
1127
+ #
1128
+ # @param currency [String]
1129
+ #
1130
+ # @param customer [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::Customer]
1131
+ #
1132
+ # @param description [String, nil]
1133
+ #
1134
+ # @param ending_balance [Float]
1135
+ #
1136
+ # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry::EntryStatus]
1137
+ #
1138
+ # @param ledger_sequence_number [Integer]
1139
+ #
1140
+ # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
1141
+ # ...
1142
+ #
1143
+ # @param starting_balance [Float]
1144
+ #
1145
+ # @param entry_type [Symbol, :amendment]
1240
1146
 
1241
1147
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#credit_block
1242
1148
  class CreditBlock < Orb::Internal::Type::BaseModel
@@ -1255,14 +1161,10 @@ module Orb
1255
1161
  # @return [String, nil]
1256
1162
  required :per_unit_cost_basis, String, nil?: true
1257
1163
 
1258
- # @!parse
1259
- # # @param id [String]
1260
- # # @param expiry_date [Time, nil]
1261
- # # @param per_unit_cost_basis [String, nil]
1262
- # #
1263
- # def initialize(id:, expiry_date:, per_unit_cost_basis:, **) = super
1264
-
1265
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1164
+ # @!method initialize(id:, expiry_date:, per_unit_cost_basis:)
1165
+ # @param id [String]
1166
+ # @param expiry_date [Time, nil]
1167
+ # @param per_unit_cost_basis [String, nil]
1266
1168
  end
1267
1169
 
1268
1170
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#customer
@@ -1277,13 +1179,9 @@ module Orb
1277
1179
  # @return [String, nil]
1278
1180
  required :external_customer_id, String, nil?: true
1279
1181
 
1280
- # @!parse
1281
- # # @param id [String]
1282
- # # @param external_customer_id [String, nil]
1283
- # #
1284
- # def initialize(id:, external_customer_id:, **) = super
1285
-
1286
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
1182
+ # @!method initialize(id:, external_customer_id:)
1183
+ # @param id [String]
1184
+ # @param external_customer_id [String, nil]
1287
1185
  end
1288
1186
 
1289
1187
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry#entry_status
@@ -1293,17 +1191,13 @@ module Orb
1293
1191
  COMMITTED = :committed
1294
1192
  PENDING = :pending
1295
1193
 
1296
- finalize!
1297
-
1298
- # @!parse
1299
- # # @return [Array<Symbol>]
1300
- # def self.values; end
1194
+ # @!method self.values
1195
+ # @return [Array<Symbol>]
1301
1196
  end
1302
1197
  end
1303
1198
 
1304
- # @!parse
1305
- # # @return [Array(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry)]
1306
- # def self.variants; end
1199
+ # @!method self.variants
1200
+ # @return [Array(Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::AmendmentLedgerEntry)]
1307
1201
  end
1308
1202
  end
1309
1203
  end