orb-billing 0.3.1 → 0.4.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 (592) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +3 -3
  4. data/lib/orb/errors.rb +1 -1
  5. data/lib/orb/file_part.rb +2 -2
  6. data/lib/orb/internal/transport/base_client.rb +74 -5
  7. data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
  8. data/lib/orb/internal/type/array_of.rb +1 -1
  9. data/lib/orb/internal/type/base_model.rb +62 -30
  10. data/lib/orb/internal/type/converter.rb +18 -0
  11. data/lib/orb/internal/type/enum.rb +4 -3
  12. data/lib/orb/internal/type/hash_of.rb +1 -1
  13. data/lib/orb/internal/type/request_parameters.rb +4 -4
  14. data/lib/orb/internal/type/union.rb +5 -4
  15. data/lib/orb/internal/util.rb +57 -1
  16. data/lib/orb/internal.rb +6 -0
  17. data/lib/orb/models/alert.rb +29 -32
  18. data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
  19. data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
  20. data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
  21. data/lib/orb/models/alert_list_params.rb +0 -1
  22. data/lib/orb/models/alert_update_params.rb +4 -5
  23. data/lib/orb/models/amount_discount.rb +6 -7
  24. data/lib/orb/models/billable_metric.rb +9 -11
  25. data/lib/orb/models/coupon.rb +13 -12
  26. data/lib/orb/models/coupon_create_params.rb +12 -8
  27. data/lib/orb/models/coupon_list_params.rb +0 -2
  28. data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
  29. data/lib/orb/models/credit_note.rb +48 -46
  30. data/lib/orb/models/credit_note_create_params.rb +6 -6
  31. data/lib/orb/models/credit_note_list_params.rb +0 -1
  32. data/lib/orb/models/customer.rb +54 -61
  33. data/lib/orb/models/customer_create_params.rb +50 -53
  34. data/lib/orb/models/customer_list_params.rb +0 -1
  35. data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
  36. data/lib/orb/models/customer_update_params.rb +50 -51
  37. data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
  38. data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
  39. data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
  40. data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
  41. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
  42. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
  43. data/lib/orb/models/customers/cost_list_params.rb +3 -4
  44. data/lib/orb/models/customers/cost_list_response.rb +3 -3
  45. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
  46. data/lib/orb/models/customers/credit_list_params.rb +0 -2
  47. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
  48. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +14 -7
  49. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
  50. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -7
  51. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
  52. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +14 -7
  53. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
  54. data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -7
  55. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
  56. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
  57. data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
  58. data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
  59. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
  60. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
  61. data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
  62. data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
  63. data/lib/orb/models/dimensional_price_group.rb +1 -3
  64. data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
  65. data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
  66. data/lib/orb/models/dimensional_price_groups.rb +6 -6
  67. data/lib/orb/models/discount.rb +11 -5
  68. data/lib/orb/models/evaluate_price_group.rb +5 -1
  69. data/lib/orb/models/event_ingest_params.rb +4 -9
  70. data/lib/orb/models/event_ingest_response.rb +0 -3
  71. data/lib/orb/models/event_search_params.rb +0 -3
  72. data/lib/orb/models/event_search_response.rb +0 -4
  73. data/lib/orb/models/event_update_params.rb +0 -3
  74. data/lib/orb/models/events/backfill_close_response.rb +0 -4
  75. data/lib/orb/models/events/backfill_create_params.rb +0 -7
  76. data/lib/orb/models/events/backfill_create_response.rb +0 -4
  77. data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
  78. data/lib/orb/models/events/backfill_list_params.rb +0 -1
  79. data/lib/orb/models/events/backfill_list_response.rb +0 -4
  80. data/lib/orb/models/events/backfill_revert_response.rb +0 -4
  81. data/lib/orb/models/events/event_volumes.rb +3 -3
  82. data/lib/orb/models/events/volume_list_params.rb +0 -3
  83. data/lib/orb/models/invoice.rb +179 -202
  84. data/lib/orb/models/invoice_create_params.rb +14 -21
  85. data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
  86. data/lib/orb/models/invoice_issue_params.rb +0 -1
  87. data/lib/orb/models/invoice_level_discount.rb +8 -4
  88. data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
  89. data/lib/orb/models/invoice_line_item_create_response.rb +28 -26
  90. data/lib/orb/models/invoice_list_params.rb +6 -10
  91. data/lib/orb/models/invoice_update_params.rb +0 -1
  92. data/lib/orb/models/item.rb +7 -8
  93. data/lib/orb/models/item_list_params.rb +0 -1
  94. data/lib/orb/models/item_update_params.rb +7 -7
  95. data/lib/orb/models/metric_create_params.rb +0 -1
  96. data/lib/orb/models/metric_list_params.rb +0 -1
  97. data/lib/orb/models/metric_update_params.rb +0 -1
  98. data/lib/orb/models/percentage_discount.rb +6 -8
  99. data/lib/orb/models/plan.rb +90 -103
  100. data/lib/orb/models/plan_create_params.rb +759 -800
  101. data/lib/orb/models/plan_list_params.rb +3 -4
  102. data/lib/orb/models/plan_update_params.rb +0 -2
  103. data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
  104. data/lib/orb/models/price.rb +1706 -1724
  105. data/lib/orb/models/price_create_params.rb +75 -84
  106. data/lib/orb/models/price_evaluate_params.rb +0 -2
  107. data/lib/orb/models/price_evaluate_response.rb +3 -3
  108. data/lib/orb/models/price_list_params.rb +0 -1
  109. data/lib/orb/models/price_update_params.rb +0 -1
  110. data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
  111. data/lib/orb/models/subscription.rb +108 -122
  112. data/lib/orb/models/subscription_cancel_params.rb +3 -5
  113. data/lib/orb/models/subscription_cancel_response.rb +43 -57
  114. data/lib/orb/models/subscription_change_apply_response.rb +43 -58
  115. data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
  116. data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
  117. data/lib/orb/models/subscription_create_params.rb +1953 -1815
  118. data/lib/orb/models/subscription_create_response.rb +43 -57
  119. data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
  120. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
  121. data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
  122. data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
  123. data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
  124. data/lib/orb/models/subscription_list_params.rb +3 -4
  125. data/lib/orb/models/subscription_price_intervals_params.rb +1194 -1017
  126. data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
  127. data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
  128. data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
  129. data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
  130. data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
  131. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
  132. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
  133. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -57
  134. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
  135. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +43 -57
  136. data/lib/orb/models/subscription_update_params.rb +0 -5
  137. data/lib/orb/models/subscription_update_trial_params.rb +8 -6
  138. data/lib/orb/models/subscription_update_trial_response.rb +43 -57
  139. data/lib/orb/models/subscription_usage.rb +55 -39
  140. data/lib/orb/models/subscriptions.rb +6 -6
  141. data/lib/orb/models/trial_discount.rb +6 -7
  142. data/lib/orb/models/usage_discount.rb +6 -8
  143. data/lib/orb/models.rb +24 -0
  144. data/lib/orb/request_options.rb +4 -0
  145. data/lib/orb/resources/alerts.rb +30 -31
  146. data/lib/orb/resources/coupons/subscriptions.rb +3 -4
  147. data/lib/orb/resources/coupons.rb +11 -21
  148. data/lib/orb/resources/credit_notes.rb +10 -11
  149. data/lib/orb/resources/customers/balance_transactions.rb +3 -4
  150. data/lib/orb/resources/customers/costs.rb +4 -6
  151. data/lib/orb/resources/customers/credits/ledger.rb +14 -33
  152. data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
  153. data/lib/orb/resources/customers/credits.rb +2 -6
  154. data/lib/orb/resources/customers.rb +40 -67
  155. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
  156. data/lib/orb/resources/dimensional_price_groups.rb +8 -10
  157. data/lib/orb/resources/events/backfills.rb +2 -10
  158. data/lib/orb/resources/events/volume.rb +3 -6
  159. data/lib/orb/resources/events.rb +4 -12
  160. data/lib/orb/resources/invoice_line_items.rb +1 -2
  161. data/lib/orb/resources/invoices.rb +26 -43
  162. data/lib/orb/resources/items.rb +12 -13
  163. data/lib/orb/resources/metrics.rb +11 -14
  164. data/lib/orb/resources/plans/external_plan_id.rb +5 -7
  165. data/lib/orb/resources/plans.rb +14 -23
  166. data/lib/orb/resources/prices/external_price_id.rb +5 -6
  167. data/lib/orb/resources/prices.rb +25 -35
  168. data/lib/orb/resources/subscription_changes.rb +1 -1
  169. data/lib/orb/resources/subscriptions.rb +49 -107
  170. data/lib/orb/version.rb +1 -1
  171. data/lib/orb.rb +3 -0
  172. data/rbi/orb/client.rbi +5 -4
  173. data/rbi/orb/errors.rbi +59 -28
  174. data/rbi/orb/file_part.rbi +9 -6
  175. data/rbi/orb/internal/page.rbi +20 -6
  176. data/rbi/orb/internal/transport/base_client.rbi +159 -78
  177. data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
  178. data/rbi/orb/internal/type/array_of.rbi +42 -34
  179. data/rbi/orb/internal/type/base_model.rbi +144 -69
  180. data/rbi/orb/internal/type/base_page.rbi +12 -8
  181. data/rbi/orb/internal/type/boolean.rbi +16 -10
  182. data/rbi/orb/internal/type/converter.rbi +68 -31
  183. data/rbi/orb/internal/type/enum.rbi +28 -15
  184. data/rbi/orb/internal/type/file_input.rbi +12 -10
  185. data/rbi/orb/internal/type/hash_of.rbi +34 -24
  186. data/rbi/orb/internal/type/request_parameters.rbi +12 -4
  187. data/rbi/orb/internal/type/union.rbi +61 -25
  188. data/rbi/orb/internal/type/unknown.rbi +20 -12
  189. data/rbi/orb/internal/util.rbi +232 -90
  190. data/rbi/orb/internal.rbi +2 -0
  191. data/rbi/orb/models/alert.rbi +114 -70
  192. data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
  193. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
  194. data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
  195. data/rbi/orb/models/alert_disable_params.rbi +18 -6
  196. data/rbi/orb/models/alert_enable_params.rbi +18 -6
  197. data/rbi/orb/models/alert_list_params.rbi +24 -20
  198. data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
  199. data/rbi/orb/models/alert_update_params.rbi +29 -14
  200. data/rbi/orb/models/amount_discount.rbi +29 -19
  201. data/rbi/orb/models/billable_metric.rbi +34 -26
  202. data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
  203. data/rbi/orb/models/coupon.rbi +28 -20
  204. data/rbi/orb/models/coupon_archive_params.rbi +11 -4
  205. data/rbi/orb/models/coupon_create_params.rbi +85 -38
  206. data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
  207. data/rbi/orb/models/coupon_list_params.rbi +19 -15
  208. data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
  209. data/rbi/orb/models/credit_note.rbi +329 -158
  210. data/rbi/orb/models/credit_note_create_params.rbi +64 -29
  211. data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
  212. data/rbi/orb/models/credit_note_list_params.rbi +23 -17
  213. data/rbi/orb/models/customer.rbi +461 -329
  214. data/rbi/orb/models/customer_create_params.rbi +713 -325
  215. data/rbi/orb/models/customer_delete_params.rbi +13 -4
  216. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
  217. data/rbi/orb/models/customer_fetch_params.rbi +11 -4
  218. data/rbi/orb/models/customer_list_params.rbi +21 -17
  219. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
  220. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
  221. data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
  222. data/rbi/orb/models/customer_update_params.rbi +712 -324
  223. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
  224. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
  225. data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
  226. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
  227. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
  228. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
  229. data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
  230. data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
  231. data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
  232. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
  233. data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
  234. data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
  235. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
  236. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
  237. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
  238. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
  239. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
  240. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
  241. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
  242. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
  243. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
  244. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
  245. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
  246. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
  247. data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
  248. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
  249. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
  250. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
  251. data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
  252. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
  253. data/rbi/orb/models/dimensional_price_group.rbi +21 -15
  254. data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
  255. data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
  256. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
  257. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
  258. data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
  259. data/rbi/orb/models/discount.rbi +11 -5
  260. data/rbi/orb/models/evaluate_price_group.rbi +29 -12
  261. data/rbi/orb/models/event_deprecate_params.rbi +13 -4
  262. data/rbi/orb/models/event_deprecate_response.rbi +11 -3
  263. data/rbi/orb/models/event_ingest_params.rbi +41 -31
  264. data/rbi/orb/models/event_ingest_response.rbi +78 -23
  265. data/rbi/orb/models/event_search_params.rbi +18 -14
  266. data/rbi/orb/models/event_search_response.rbi +42 -21
  267. data/rbi/orb/models/event_update_params.rbi +20 -16
  268. data/rbi/orb/models/event_update_response.rbi +11 -3
  269. data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
  270. data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
  271. data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
  272. data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
  273. data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
  274. data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
  275. data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
  276. data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
  277. data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
  278. data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
  279. data/rbi/orb/models/events/event_volumes.rbi +38 -10
  280. data/rbi/orb/models/events/volume_list_params.rbi +21 -15
  281. data/rbi/orb/models/invoice.rbi +1411 -805
  282. data/rbi/orb/models/invoice_create_params.rbi +107 -69
  283. data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
  284. data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
  285. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
  286. data/rbi/orb/models/invoice_issue_params.rbi +17 -5
  287. data/rbi/orb/models/invoice_level_discount.rbi +11 -4
  288. data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
  289. data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
  290. data/rbi/orb/models/invoice_list_params.rbi +68 -47
  291. data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
  292. data/rbi/orb/models/invoice_pay_params.rbi +11 -4
  293. data/rbi/orb/models/invoice_update_params.rbi +16 -10
  294. data/rbi/orb/models/invoice_void_params.rbi +11 -4
  295. data/rbi/orb/models/item.rbi +90 -39
  296. data/rbi/orb/models/item_create_params.rbi +15 -5
  297. data/rbi/orb/models/item_fetch_params.rbi +11 -4
  298. data/rbi/orb/models/item_list_params.rbi +17 -6
  299. data/rbi/orb/models/item_update_params.rbi +86 -39
  300. data/rbi/orb/models/metric_create_params.rbi +20 -16
  301. data/rbi/orb/models/metric_fetch_params.rbi +11 -4
  302. data/rbi/orb/models/metric_list_params.rbi +21 -17
  303. data/rbi/orb/models/metric_update_params.rbi +16 -10
  304. data/rbi/orb/models/pagination_metadata.rbi +17 -4
  305. data/rbi/orb/models/percentage_discount.rbi +33 -19
  306. data/rbi/orb/models/plan.rbi +532 -365
  307. data/rbi/orb/models/plan_create_params.rbi +5295 -2870
  308. data/rbi/orb/models/plan_fetch_params.rbi +11 -4
  309. data/rbi/orb/models/plan_list_params.rbi +35 -27
  310. data/rbi/orb/models/plan_update_params.rbi +17 -13
  311. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
  312. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
  313. data/rbi/orb/models/price.rbi +11332 -5033
  314. data/rbi/orb/models/price_create_params.rbi +583 -245
  315. data/rbi/orb/models/price_evaluate_params.rbi +21 -17
  316. data/rbi/orb/models/price_evaluate_response.rbi +14 -6
  317. data/rbi/orb/models/price_fetch_params.rbi +11 -4
  318. data/rbi/orb/models/price_list_params.rbi +17 -6
  319. data/rbi/orb/models/price_update_params.rbi +16 -10
  320. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
  321. data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
  322. data/rbi/orb/models/subscription.rbi +668 -420
  323. data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
  324. data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
  325. data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
  326. data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
  327. data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
  328. data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
  329. data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
  330. data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
  331. data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
  332. data/rbi/orb/models/subscription_create_response.rbi +817 -438
  333. data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
  334. data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
  335. data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
  336. data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
  337. data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
  338. data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
  339. data/rbi/orb/models/subscription_list_params.rbi +42 -28
  340. data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
  341. data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
  342. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
  343. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
  344. data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
  345. data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
  346. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
  347. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
  348. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
  349. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
  350. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
  351. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
  352. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
  353. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
  354. data/rbi/orb/models/subscription_update_params.rbi +22 -16
  355. data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
  356. data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
  357. data/rbi/orb/models/subscription_usage.rbi +325 -121
  358. data/rbi/orb/models/subscriptions.rbi +19 -11
  359. data/rbi/orb/models/top_level_ping_params.rbi +11 -4
  360. data/rbi/orb/models/top_level_ping_response.rbi +10 -3
  361. data/rbi/orb/models/trial_discount.rbi +30 -20
  362. data/rbi/orb/models/usage_discount.rbi +29 -19
  363. data/rbi/orb/models.rbi +22 -11
  364. data/rbi/orb/request_options.rbi +12 -6
  365. data/rbi/orb/resources/alerts.rbi +61 -40
  366. data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
  367. data/rbi/orb/resources/coupons.rbi +33 -18
  368. data/rbi/orb/resources/credit_notes.rbi +22 -13
  369. data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
  370. data/rbi/orb/resources/customers/costs.rbi +18 -11
  371. data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
  372. data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
  373. data/rbi/orb/resources/customers/credits.rbi +16 -7
  374. data/rbi/orb/resources/customers.rbi +137 -72
  375. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
  376. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
  377. data/rbi/orb/resources/events/backfills.rbi +35 -17
  378. data/rbi/orb/resources/events/volume.rbi +7 -5
  379. data/rbi/orb/resources/events.rbi +26 -16
  380. data/rbi/orb/resources/invoice_line_items.rbi +7 -5
  381. data/rbi/orb/resources/invoices.rbi +72 -41
  382. data/rbi/orb/resources/items.rbi +40 -13
  383. data/rbi/orb/resources/metrics.rbi +25 -15
  384. data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
  385. data/rbi/orb/resources/plans.rbi +57 -47
  386. data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
  387. data/rbi/orb/resources/prices.rbi +176 -156
  388. data/rbi/orb/resources/subscription_changes.rbi +19 -11
  389. data/rbi/orb/resources/subscriptions.rbi +200 -114
  390. data/rbi/orb/resources/top_level.rbi +9 -3
  391. data/sig/orb/internal/page.rbs +0 -2
  392. data/sig/orb/internal/transport/base_client.rbs +16 -1
  393. data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
  394. data/sig/orb/internal/type/base_model.rbs +11 -5
  395. data/sig/orb/internal/type/base_page.rbs +1 -1
  396. data/sig/orb/internal/type/converter.rbs +2 -0
  397. data/sig/orb/internal/type/enum.rbs +1 -0
  398. data/sig/orb/internal/type/request_parameters.rbs +3 -1
  399. data/sig/orb/internal/type/union.rbs +1 -0
  400. data/sig/orb/internal/util.rbs +13 -0
  401. data/sig/orb/internal.rbs +2 -0
  402. data/sig/orb/models/alert.rbs +19 -31
  403. data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
  404. data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
  405. data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
  406. data/sig/orb/models/alert_disable_params.rbs +0 -2
  407. data/sig/orb/models/alert_enable_params.rbs +0 -2
  408. data/sig/orb/models/alert_list_params.rbs +0 -2
  409. data/sig/orb/models/alert_retrieve_params.rbs +0 -2
  410. data/sig/orb/models/alert_update_params.rbs +3 -7
  411. data/sig/orb/models/amount_discount.rbs +4 -6
  412. data/sig/orb/models/billable_metric.rbs +7 -9
  413. data/sig/orb/models/coupon.rbs +5 -8
  414. data/sig/orb/models/coupon_archive_params.rbs +0 -2
  415. data/sig/orb/models/coupon_create_params.rbs +3 -9
  416. data/sig/orb/models/coupon_fetch_params.rbs +0 -2
  417. data/sig/orb/models/coupon_list_params.rbs +0 -2
  418. data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
  419. data/sig/orb/models/credit_note.rbs +48 -66
  420. data/sig/orb/models/credit_note_create_params.rbs +3 -7
  421. data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
  422. data/sig/orb/models/credit_note_list_params.rbs +0 -2
  423. data/sig/orb/models/customer.rbs +43 -63
  424. data/sig/orb/models/customer_create_params.rbs +32 -52
  425. data/sig/orb/models/customer_delete_params.rbs +0 -2
  426. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
  427. data/sig/orb/models/customer_fetch_params.rbs +0 -2
  428. data/sig/orb/models/customer_list_params.rbs +0 -2
  429. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
  430. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
  431. data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
  432. data/sig/orb/models/customer_update_params.rbs +32 -52
  433. data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
  434. data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
  435. data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
  436. data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
  437. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
  438. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
  439. data/sig/orb/models/customers/cost_list_params.rbs +0 -2
  440. data/sig/orb/models/customers/cost_list_response.rbs +0 -6
  441. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
  442. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
  443. data/sig/orb/models/customers/credit_list_params.rbs +0 -2
  444. data/sig/orb/models/customers/credit_list_response.rbs +0 -2
  445. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
  446. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
  447. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
  448. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
  449. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
  450. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
  451. data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
  452. data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
  453. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
  454. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
  455. data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
  456. data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
  457. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
  458. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
  459. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
  460. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
  461. data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
  462. data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
  463. data/sig/orb/models/dimensional_price_group.rbs +0 -2
  464. data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
  465. data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
  466. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
  467. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
  468. data/sig/orb/models/dimensional_price_groups.rbs +6 -8
  469. data/sig/orb/models/discount.rbs +5 -5
  470. data/sig/orb/models/evaluate_price_group.rbs +4 -6
  471. data/sig/orb/models/event_deprecate_params.rbs +0 -2
  472. data/sig/orb/models/event_deprecate_response.rbs +0 -2
  473. data/sig/orb/models/event_ingest_params.rbs +3 -7
  474. data/sig/orb/models/event_ingest_response.rbs +0 -6
  475. data/sig/orb/models/event_search_params.rbs +0 -2
  476. data/sig/orb/models/event_search_response.rbs +0 -4
  477. data/sig/orb/models/event_update_params.rbs +0 -2
  478. data/sig/orb/models/event_update_response.rbs +0 -2
  479. data/sig/orb/models/events/backfill_close_params.rbs +0 -2
  480. data/sig/orb/models/events/backfill_close_response.rbs +0 -2
  481. data/sig/orb/models/events/backfill_create_params.rbs +0 -2
  482. data/sig/orb/models/events/backfill_create_response.rbs +0 -2
  483. data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
  484. data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
  485. data/sig/orb/models/events/backfill_list_params.rbs +0 -2
  486. data/sig/orb/models/events/backfill_list_response.rbs +0 -2
  487. data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
  488. data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
  489. data/sig/orb/models/events/event_volumes.rbs +3 -10
  490. data/sig/orb/models/events/volume_list_params.rbs +0 -2
  491. data/sig/orb/models/invoice.rbs +110 -172
  492. data/sig/orb/models/invoice_create_params.rbs +10 -16
  493. data/sig/orb/models/invoice_fetch_params.rbs +0 -2
  494. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
  495. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
  496. data/sig/orb/models/invoice_issue_params.rbs +0 -2
  497. data/sig/orb/models/invoice_level_discount.rbs +2 -4
  498. data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
  499. data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
  500. data/sig/orb/models/invoice_list_params.rbs +4 -6
  501. data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
  502. data/sig/orb/models/invoice_pay_params.rbs +0 -2
  503. data/sig/orb/models/invoice_update_params.rbs +0 -2
  504. data/sig/orb/models/invoice_void_params.rbs +0 -2
  505. data/sig/orb/models/item.rbs +7 -11
  506. data/sig/orb/models/item_create_params.rbs +0 -2
  507. data/sig/orb/models/item_fetch_params.rbs +0 -2
  508. data/sig/orb/models/item_list_params.rbs +0 -2
  509. data/sig/orb/models/item_update_params.rbs +7 -11
  510. data/sig/orb/models/metric_create_params.rbs +0 -2
  511. data/sig/orb/models/metric_fetch_params.rbs +0 -2
  512. data/sig/orb/models/metric_list_params.rbs +0 -2
  513. data/sig/orb/models/metric_update_params.rbs +0 -2
  514. data/sig/orb/models/pagination_metadata.rbs +0 -2
  515. data/sig/orb/models/percentage_discount.rbs +4 -6
  516. data/sig/orb/models/plan.rbs +45 -73
  517. data/sig/orb/models/plan_create_params.rbs +518 -696
  518. data/sig/orb/models/plan_fetch_params.rbs +0 -2
  519. data/sig/orb/models/plan_list_params.rbs +0 -2
  520. data/sig/orb/models/plan_update_params.rbs +0 -2
  521. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
  522. data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
  523. data/sig/orb/models/price.rbs +1194 -1730
  524. data/sig/orb/models/price_create_params.rbs +59 -97
  525. data/sig/orb/models/price_evaluate_params.rbs +0 -2
  526. data/sig/orb/models/price_evaluate_response.rbs +3 -6
  527. data/sig/orb/models/price_fetch_params.rbs +0 -2
  528. data/sig/orb/models/price_list_params.rbs +0 -2
  529. data/sig/orb/models/price_update_params.rbs +0 -2
  530. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
  531. data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
  532. data/sig/orb/models/subscription.rbs +56 -94
  533. data/sig/orb/models/subscription_cancel_params.rbs +0 -2
  534. data/sig/orb/models/subscription_cancel_response.rbs +20 -60
  535. data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
  536. data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
  537. data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
  538. data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
  539. data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
  540. data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
  541. data/sig/orb/models/subscription_create_params.rbs +1103 -1499
  542. data/sig/orb/models/subscription_create_response.rbs +20 -60
  543. data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
  544. data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
  545. data/sig/orb/models/subscription_fetch_params.rbs +0 -2
  546. data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
  547. data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
  548. data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
  549. data/sig/orb/models/subscription_list_params.rbs +0 -2
  550. data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
  551. data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
  552. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
  553. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
  554. data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
  555. data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
  556. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
  557. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
  558. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
  559. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
  560. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
  561. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
  562. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
  563. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
  564. data/sig/orb/models/subscription_update_params.rbs +0 -2
  565. data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
  566. data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
  567. data/sig/orb/models/subscription_usage.rbs +35 -53
  568. data/sig/orb/models/subscriptions.rbs +6 -8
  569. data/sig/orb/models/top_level_ping_params.rbs +0 -2
  570. data/sig/orb/models/top_level_ping_response.rbs +0 -2
  571. data/sig/orb/models/trial_discount.rbs +4 -6
  572. data/sig/orb/models/usage_discount.rbs +4 -6
  573. data/sig/orb/request_options.rbs +1 -1
  574. data/sig/orb/resources/alerts.rbs +12 -12
  575. data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
  576. data/sig/orb/resources/coupons.rbs +4 -4
  577. data/sig/orb/resources/credit_notes.rbs +4 -4
  578. data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
  579. data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
  580. data/sig/orb/resources/customers.rbs +24 -24
  581. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
  582. data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
  583. data/sig/orb/resources/events/volume.rbs +1 -1
  584. data/sig/orb/resources/events.rbs +1 -1
  585. data/sig/orb/resources/invoices.rbs +10 -10
  586. data/sig/orb/resources/items.rbs +5 -5
  587. data/sig/orb/resources/metrics.rbs +4 -4
  588. data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
  589. data/sig/orb/resources/plans.rbs +5 -5
  590. data/sig/orb/resources/prices.rbs +11 -11
  591. data/sig/orb/resources/subscriptions.rbs +21 -21
  592. metadata +2 -2
@@ -18,8 +18,8 @@ module Orb
18
18
 
19
19
  # @!attribute entry_type
20
20
  #
21
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType]
22
- required :entry_type, enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType }
21
+ # @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::EntryType]
22
+ required :entry_type, enum: -> { Orb::Customers::Credits::LedgerCreateEntryParams::EntryType }
23
23
 
24
24
  # @!attribute currency
25
25
  # The currency or custom pricing unit to use for this ledger entry. If this is a
@@ -55,9 +55,9 @@ module Orb
55
55
  # per_unit_cost_basis, as the calculation of the invoice total is done on that
56
56
  # basis.
57
57
  #
58
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil]
58
+ # @return [Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil]
59
59
  optional :invoice_settings,
60
- -> { Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings },
60
+ -> { Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings },
61
61
  nil?: true
62
62
 
63
63
  # @!attribute metadata
@@ -92,9 +92,9 @@ module Orb
92
92
  # @!attribute void_reason
93
93
  # Can only be specified when `entry_type=void`. The reason for the void.
94
94
  #
95
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil]
95
+ # @return [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil]
96
96
  optional :void_reason,
97
- enum: -> { Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason },
97
+ enum: -> { Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason },
98
98
  nil?: true
99
99
 
100
100
  # @!method initialize(amount:, entry_type:, expiry_date:, target_expiry_date:, block_id:, currency: nil, description: nil, effective_date: nil, invoice_settings: nil, metadata: nil, per_unit_cost_basis: nil, void_reason: nil, request_options: {})
@@ -102,36 +102,28 @@ module Orb
102
102
  # {Orb::Models::Customers::Credits::LedgerCreateEntryParams} for more details.
103
103
  #
104
104
  # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
105
- # ...
106
105
  #
107
- # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType]
106
+ # @param entry_type [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::EntryType]
108
107
  #
109
108
  # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
110
109
  #
111
110
  # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
112
- # ...
113
111
  #
114
112
  # @param block_id [String] The ID of the block to reverse a decrement from.
115
113
  #
116
114
  # @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
117
- # ...
118
115
  #
119
116
  # @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
120
- # ...
121
117
  #
122
118
  # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
123
- # ...
124
119
  #
125
- # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
126
- # ...
120
+ # @param invoice_settings [Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
127
121
  #
128
122
  # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
129
- # ...
130
123
  #
131
124
  # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
132
- # ...
133
125
  #
134
- # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
126
+ # @param void_reason [Symbol, Orb::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
135
127
  #
136
128
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
137
129
 
@@ -175,8 +167,8 @@ module Orb
175
167
 
176
168
  # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
177
169
  # Some parameter documentations has been truncated, see
178
- # {Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings} for
179
- # more details.
170
+ # {Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings} for more
171
+ # details.
180
172
  #
181
173
  # Passing `invoice_settings` automatically generates an invoice for the newly
182
174
  # added credits. If `invoice_settings` is passed, you must specify
@@ -184,15 +176,12 @@ module Orb
184
176
  # basis.
185
177
  #
186
178
  # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
187
- # ...
188
179
  #
189
180
  # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
190
- # ...
191
181
  #
192
182
  # @param memo [String, nil] An optional memo to display on the invoice.
193
183
  #
194
184
  # @param require_successful_payment [Boolean] If true, the new credit block will require that the corresponding invoice is pai
195
- # ...
196
185
  end
197
186
 
198
187
  # Can only be specified when `entry_type=void`. The reason for the void.
@@ -127,7 +127,6 @@ module Orb
127
127
  # @param ledger_sequence_number [Integer]
128
128
  #
129
129
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
130
- # ...
131
130
  #
132
131
  # @param starting_balance [Float]
133
132
  #
@@ -298,7 +297,6 @@ module Orb
298
297
  # @param ledger_sequence_number [Integer]
299
298
  #
300
299
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
301
- # ...
302
300
  #
303
301
  # @param starting_balance [Float]
304
302
  #
@@ -466,7 +464,6 @@ module Orb
466
464
  # @param ledger_sequence_number [Integer]
467
465
  #
468
466
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
469
- # ...
470
467
  #
471
468
  # @param new_block_expiry_date [Time, nil]
472
469
  #
@@ -625,7 +622,6 @@ module Orb
625
622
  # @param ledger_sequence_number [Integer]
626
623
  #
627
624
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
628
- # ...
629
625
  #
630
626
  # @param starting_balance [Float]
631
627
  #
@@ -791,7 +787,6 @@ module Orb
791
787
  # @param ledger_sequence_number [Integer]
792
788
  #
793
789
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
794
- # ...
795
790
  #
796
791
  # @param starting_balance [Float]
797
792
  #
@@ -967,7 +962,6 @@ module Orb
967
962
  # @param ledger_sequence_number [Integer]
968
963
  #
969
964
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
970
- # ...
971
965
  #
972
966
  # @param new_block_expiry_date [Time]
973
967
  #
@@ -1129,7 +1123,6 @@ module Orb
1129
1123
  # @param ledger_sequence_number [Integer]
1130
1124
  #
1131
1125
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
1132
- # ...
1133
1126
  #
1134
1127
  # @param starting_balance [Float]
1135
1128
  #
@@ -1189,6 +1182,20 @@ module Orb
1189
1182
 
1190
1183
  # @!method self.variants
1191
1184
  # @return [Array(Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment)]
1185
+
1186
+ define_sorbet_constant!(:Variants) do
1187
+ T.type_alias do
1188
+ T.any(
1189
+ Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Increment,
1190
+ Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Decrement,
1191
+ Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChange,
1192
+ Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiry,
1193
+ Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Void,
1194
+ Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiated,
1195
+ Orb::Models::Customers::Credits::LedgerCreateEntryResponse::Amendment
1196
+ )
1197
+ end
1198
+ end
1192
1199
  end
1193
1200
  end
1194
1201
  end
@@ -44,16 +44,16 @@ module Orb
44
44
 
45
45
  # @!attribute entry_status
46
46
  #
47
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
47
+ # @return [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
48
48
  optional :entry_status,
49
- enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus },
49
+ enum: -> { Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus },
50
50
  nil?: true
51
51
 
52
52
  # @!attribute entry_type
53
53
  #
54
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
54
+ # @return [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
55
55
  optional :entry_type,
56
- enum: -> { Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType },
56
+ enum: -> { Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType },
57
57
  nil?: true
58
58
 
59
59
  # @!attribute limit
@@ -83,11 +83,10 @@ module Orb
83
83
  # @param currency [String, nil] The ledger currency or custom pricing unit to use.
84
84
  #
85
85
  # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
86
- # ...
87
86
  #
88
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
87
+ # @param entry_status [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
89
88
  #
90
- # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
89
+ # @param entry_type [Symbol, Orb::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
91
90
  #
92
91
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
93
92
  #
@@ -129,7 +129,6 @@ module Orb
129
129
  # @param ledger_sequence_number [Integer]
130
130
  #
131
131
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
132
- # ...
133
132
  #
134
133
  # @param starting_balance [Float]
135
134
  #
@@ -301,7 +300,6 @@ module Orb
301
300
  # @param ledger_sequence_number [Integer]
302
301
  #
303
302
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
304
- # ...
305
303
  #
306
304
  # @param starting_balance [Float]
307
305
  #
@@ -469,7 +467,6 @@ module Orb
469
467
  # @param ledger_sequence_number [Integer]
470
468
  #
471
469
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
472
- # ...
473
470
  #
474
471
  # @param new_block_expiry_date [Time, nil]
475
472
  #
@@ -628,7 +625,6 @@ module Orb
628
625
  # @param ledger_sequence_number [Integer]
629
626
  #
630
627
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
631
- # ...
632
628
  #
633
629
  # @param starting_balance [Float]
634
630
  #
@@ -794,7 +790,6 @@ module Orb
794
790
  # @param ledger_sequence_number [Integer]
795
791
  #
796
792
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
797
- # ...
798
793
  #
799
794
  # @param starting_balance [Float]
800
795
  #
@@ -970,7 +965,6 @@ module Orb
970
965
  # @param ledger_sequence_number [Integer]
971
966
  #
972
967
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
973
- # ...
974
968
  #
975
969
  # @param new_block_expiry_date [Time]
976
970
  #
@@ -1133,7 +1127,6 @@ module Orb
1133
1127
  # @param ledger_sequence_number [Integer]
1134
1128
  #
1135
1129
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
1136
- # ...
1137
1130
  #
1138
1131
  # @param starting_balance [Float]
1139
1132
  #
@@ -1193,6 +1186,20 @@ module Orb
1193
1186
 
1194
1187
  # @!method self.variants
1195
1188
  # @return [Array(Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment)]
1189
+
1190
+ define_sorbet_constant!(:Variants) do
1191
+ T.type_alias do
1192
+ T.any(
1193
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Increment,
1194
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Decrement,
1195
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChange,
1196
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiry,
1197
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Void,
1198
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiated,
1199
+ Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::Amendment
1200
+ )
1201
+ end
1202
+ end
1196
1203
  end
1197
1204
  end
1198
1205
  end
@@ -44,17 +44,17 @@ module Orb
44
44
 
45
45
  # @!attribute entry_status
46
46
  #
47
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil]
47
+ # @return [Symbol, Orb::Customers::Credits::LedgerListParams::EntryStatus, nil]
48
48
  optional :entry_status,
49
- enum: -> { Orb::Models::Customers::Credits::LedgerListParams::EntryStatus },
49
+ enum: -> {
50
+ Orb::Customers::Credits::LedgerListParams::EntryStatus
51
+ },
50
52
  nil?: true
51
53
 
52
54
  # @!attribute entry_type
53
55
  #
54
- # @return [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil]
55
- optional :entry_type,
56
- enum: -> { Orb::Models::Customers::Credits::LedgerListParams::EntryType },
57
- nil?: true
56
+ # @return [Symbol, Orb::Customers::Credits::LedgerListParams::EntryType, nil]
57
+ optional :entry_type, enum: -> { Orb::Customers::Credits::LedgerListParams::EntryType }, nil?: true
58
58
 
59
59
  # @!attribute limit
60
60
  # The number of items to fetch. Defaults to 20.
@@ -82,11 +82,10 @@ module Orb
82
82
  # @param currency [String, nil] The ledger currency or custom pricing unit to use.
83
83
  #
84
84
  # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
85
- # ...
86
85
  #
87
- # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil]
86
+ # @param entry_status [Symbol, Orb::Customers::Credits::LedgerListParams::EntryStatus, nil]
88
87
  #
89
- # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil]
88
+ # @param entry_type [Symbol, Orb::Customers::Credits::LedgerListParams::EntryType, nil]
90
89
  #
91
90
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
92
91
  #
@@ -125,7 +125,6 @@ module Orb
125
125
  # @param ledger_sequence_number [Integer]
126
126
  #
127
127
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
128
- # ...
129
128
  #
130
129
  # @param starting_balance [Float]
131
130
  #
@@ -295,7 +294,6 @@ module Orb
295
294
  # @param ledger_sequence_number [Integer]
296
295
  #
297
296
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
298
- # ...
299
297
  #
300
298
  # @param starting_balance [Float]
301
299
  #
@@ -462,7 +460,6 @@ module Orb
462
460
  # @param ledger_sequence_number [Integer]
463
461
  #
464
462
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
465
- # ...
466
463
  #
467
464
  # @param new_block_expiry_date [Time, nil]
468
465
  #
@@ -621,7 +618,6 @@ module Orb
621
618
  # @param ledger_sequence_number [Integer]
622
619
  #
623
620
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
624
- # ...
625
621
  #
626
622
  # @param starting_balance [Float]
627
623
  #
@@ -785,7 +781,6 @@ module Orb
785
781
  # @param ledger_sequence_number [Integer]
786
782
  #
787
783
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
788
- # ...
789
784
  #
790
785
  # @param starting_balance [Float]
791
786
  #
@@ -960,7 +955,6 @@ module Orb
960
955
  # @param ledger_sequence_number [Integer]
961
956
  #
962
957
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
963
- # ...
964
958
  #
965
959
  # @param new_block_expiry_date [Time]
966
960
  #
@@ -1121,7 +1115,6 @@ module Orb
1121
1115
  # @param ledger_sequence_number [Integer]
1122
1116
  #
1123
1117
  # @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
1124
- # ...
1125
1118
  #
1126
1119
  # @param starting_balance [Float]
1127
1120
  #
@@ -1181,6 +1174,20 @@ module Orb
1181
1174
 
1182
1175
  # @!method self.variants
1183
1176
  # @return [Array(Orb::Models::Customers::Credits::LedgerListResponse::Increment, Orb::Models::Customers::Credits::LedgerListResponse::Decrement, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerListResponse::Void, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerListResponse::Amendment)]
1177
+
1178
+ define_sorbet_constant!(:Variants) do
1179
+ T.type_alias do
1180
+ T.any(
1181
+ Orb::Models::Customers::Credits::LedgerListResponse::Increment,
1182
+ Orb::Models::Customers::Credits::LedgerListResponse::Decrement,
1183
+ Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChange,
1184
+ Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiry,
1185
+ Orb::Models::Customers::Credits::LedgerListResponse::Void,
1186
+ Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiated,
1187
+ Orb::Models::Customers::Credits::LedgerListResponse::Amendment
1188
+ )
1189
+ end
1190
+ end
1184
1191
  end
1185
1192
  end
1186
1193
  end
@@ -25,9 +25,11 @@ module Orb
25
25
  # @!attribute invoice_settings
26
26
  # Settings for invoices generated by triggered top-ups.
27
27
  #
28
- # @return [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings]
28
+ # @return [Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings]
29
29
  required :invoice_settings,
30
- -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings }
30
+ -> {
31
+ Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings
32
+ }
31
33
 
32
34
  # @!attribute per_unit_cost_basis
33
35
  # How much, in the customer's currency, to charge for each unit.
@@ -59,9 +61,9 @@ module Orb
59
61
  # @!attribute expires_after_unit
60
62
  # The unit of expires_after.
61
63
  #
62
- # @return [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil]
64
+ # @return [Symbol, Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil]
63
65
  optional :expires_after_unit,
64
- enum: -> { Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit },
66
+ enum: -> { Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit },
65
67
  nil?: true
66
68
 
67
69
  # @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
@@ -72,22 +74,18 @@ module Orb
72
74
  # @param amount [String] The amount to increment when the threshold is reached.
73
75
  #
74
76
  # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
75
- # ...
76
77
  #
77
- # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
78
+ # @param invoice_settings [Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
78
79
  #
79
80
  # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
80
81
  #
81
82
  # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
82
- # ...
83
83
  #
84
84
  # @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
85
- # ...
86
85
  #
87
86
  # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
88
- # ...
89
87
  #
90
- # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
88
+ # @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateByExternalIDParams::ExpiresAfterUnit, nil] The unit of expires_after.
91
89
  #
92
90
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
93
91
 
@@ -122,21 +120,18 @@ module Orb
122
120
 
123
121
  # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
124
122
  # Some parameter documentations has been truncated, see
125
- # {Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings}
126
- # for more details.
123
+ # {Orb::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings} for
124
+ # more details.
127
125
  #
128
126
  # Settings for invoices generated by triggered top-ups.
129
127
  #
130
128
  # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
131
- # ...
132
129
  #
133
130
  # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
134
- # ...
135
131
  #
136
132
  # @param memo [String, nil] An optional memo to display on the invoice.
137
133
  #
138
134
  # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
139
- # ...
140
135
  end
141
136
 
142
137
  # The unit of expires_after.
@@ -69,17 +69,14 @@ module Orb
69
69
  # @param amount [String] The amount to increment when the threshold is reached.
70
70
  #
71
71
  # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
72
- # ...
73
72
  #
74
73
  # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
75
74
  #
76
75
  # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
77
76
  #
78
77
  # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
79
- # ...
80
78
  #
81
79
  # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
82
- # ...
83
80
  #
84
81
  # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse::ExpiresAfterUnit, nil] The unit of expires_after.
85
82
 
@@ -121,15 +118,12 @@ module Orb
121
118
  # Settings for invoices generated by triggered top-ups.
122
119
  #
123
120
  # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
124
- # ...
125
121
  #
126
122
  # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
127
- # ...
128
123
  #
129
124
  # @param memo [String, nil] An optional memo to display on the invoice.
130
125
  #
131
126
  # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
132
- # ...
133
127
  end
134
128
 
135
129
  # The unit of expires_after.
@@ -25,8 +25,8 @@ module Orb
25
25
  # @!attribute invoice_settings
26
26
  # Settings for invoices generated by triggered top-ups.
27
27
  #
28
- # @return [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings]
29
- required :invoice_settings, -> { Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings }
28
+ # @return [Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings]
29
+ required :invoice_settings, -> { Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings }
30
30
 
31
31
  # @!attribute per_unit_cost_basis
32
32
  # How much, in the customer's currency, to charge for each unit.
@@ -58,9 +58,9 @@ module Orb
58
58
  # @!attribute expires_after_unit
59
59
  # The unit of expires_after.
60
60
  #
61
- # @return [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil]
61
+ # @return [Symbol, Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil]
62
62
  optional :expires_after_unit,
63
- enum: -> { Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit },
63
+ enum: -> { Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit },
64
64
  nil?: true
65
65
 
66
66
  # @!method initialize(amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, active_from: nil, expires_after: nil, expires_after_unit: nil, request_options: {})
@@ -70,22 +70,18 @@ module Orb
70
70
  # @param amount [String] The amount to increment when the threshold is reached.
71
71
  #
72
72
  # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
73
- # ...
74
73
  #
75
- # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
74
+ # @param invoice_settings [Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings] Settings for invoices generated by triggered top-ups.
76
75
  #
77
76
  # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
78
77
  #
79
78
  # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
80
- # ...
81
79
  #
82
80
  # @param active_from [Time, nil] The date from which the top-up is active. If unspecified, the top-up is active i
83
- # ...
84
81
  #
85
82
  # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
86
- # ...
87
83
  #
88
- # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
84
+ # @param expires_after_unit [Symbol, Orb::Customers::Credits::TopUpCreateParams::ExpiresAfterUnit, nil] The unit of expires_after.
89
85
  #
90
86
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
91
87
 
@@ -120,21 +116,17 @@ module Orb
120
116
 
121
117
  # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
122
118
  # Some parameter documentations has been truncated, see
123
- # {Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings} for more
124
- # details.
119
+ # {Orb::Customers::Credits::TopUpCreateParams::InvoiceSettings} for more details.
125
120
  #
126
121
  # Settings for invoices generated by triggered top-ups.
127
122
  #
128
123
  # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
129
- # ...
130
124
  #
131
125
  # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
132
- # ...
133
126
  #
134
127
  # @param memo [String, nil] An optional memo to display on the invoice.
135
128
  #
136
129
  # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
137
- # ...
138
130
  end
139
131
 
140
132
  # The unit of expires_after.
@@ -67,17 +67,14 @@ module Orb
67
67
  # @param amount [String] The amount to increment when the threshold is reached.
68
68
  #
69
69
  # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
70
- # ...
71
70
  #
72
71
  # @param invoice_settings [Orb::Models::Customers::Credits::TopUpCreateResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
73
72
  #
74
73
  # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
75
74
  #
76
75
  # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
77
- # ...
78
76
  #
79
77
  # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
80
- # ...
81
78
  #
82
79
  # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpCreateResponse::ExpiresAfterUnit, nil] The unit of expires_after.
83
80
 
@@ -119,15 +116,12 @@ module Orb
119
116
  # Settings for invoices generated by triggered top-ups.
120
117
  #
121
118
  # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
122
- # ...
123
119
  #
124
120
  # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
125
- # ...
126
121
  #
127
122
  # @param memo [String, nil] An optional memo to display on the invoice.
128
123
  #
129
124
  # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
130
- # ...
131
125
  end
132
126
 
133
127
  # The unit of expires_after.
@@ -27,7 +27,6 @@ module Orb
27
27
  # {Orb::Models::Customers::Credits::TopUpListByExternalIDParams} for more details.
28
28
  #
29
29
  # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
30
- # ...
31
30
  #
32
31
  # @param limit [Integer] The number of items to fetch. Defaults to 20.
33
32
  #
@@ -69,17 +69,14 @@ module Orb
69
69
  # @param amount [String] The amount to increment when the threshold is reached.
70
70
  #
71
71
  # @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
72
- # ...
73
72
  #
74
73
  # @param invoice_settings [Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
75
74
  #
76
75
  # @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
77
76
  #
78
77
  # @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
79
- # ...
80
78
  #
81
79
  # @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
82
- # ...
83
80
  #
84
81
  # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit, nil] The unit of expires_after.
85
82
 
@@ -121,15 +118,12 @@ module Orb
121
118
  # Settings for invoices generated by triggered top-ups.
122
119
  #
123
120
  # @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
124
- # ...
125
121
  #
126
122
  # @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
127
- # ...
128
123
  #
129
124
  # @param memo [String, nil] An optional memo to display on the invoice.
130
125
  #
131
126
  # @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
132
- # ...
133
127
  end
134
128
 
135
129
  # The unit of expires_after.