orb-billing 0.2.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (488) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +67 -0
  3. data/README.md +63 -53
  4. data/lib/orb/client.rb +4 -4
  5. data/lib/orb/errors.rb +9 -9
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +7 -11
  8. data/lib/orb/internal/transport/base_client.rb +10 -10
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +2 -2
  10. data/lib/orb/internal/type/array_of.rb +11 -0
  11. data/lib/orb/internal/type/base_model.rb +33 -23
  12. data/lib/orb/internal/type/base_page.rb +9 -1
  13. data/lib/orb/internal/type/boolean.rb +14 -11
  14. data/lib/orb/internal/type/converter.rb +4 -1
  15. data/lib/orb/internal/type/enum.rb +19 -16
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +33 -15
  17. data/lib/orb/internal/type/hash_of.rb +11 -0
  18. data/lib/orb/internal/type/request_parameters.rb +3 -10
  19. data/lib/orb/internal/type/union.rb +10 -1
  20. data/lib/orb/internal/type/unknown.rb +14 -11
  21. data/lib/orb/internal/util.rb +88 -64
  22. data/lib/orb/internal.rb +0 -1
  23. data/lib/orb/models/alert.rb +68 -71
  24. data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
  25. data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
  26. data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
  27. data/lib/orb/models/alert_disable_params.rb +5 -9
  28. data/lib/orb/models/alert_enable_params.rb +5 -9
  29. data/lib/orb/models/alert_list_params.rb +26 -36
  30. data/lib/orb/models/alert_retrieve_params.rb +3 -8
  31. data/lib/orb/models/alert_update_params.rb +14 -18
  32. data/lib/orb/models/amount_discount.rb +14 -14
  33. data/lib/orb/models/billable_metric.rb +23 -20
  34. data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
  35. data/lib/orb/models/coupon.rb +28 -21
  36. data/lib/orb/models/coupon_archive_params.rb +3 -8
  37. data/lib/orb/models/coupon_create_params.rb +29 -34
  38. data/lib/orb/models/coupon_fetch_params.rb +3 -8
  39. data/lib/orb/models/coupon_list_params.rb +17 -17
  40. data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
  41. data/lib/orb/models/credit_note.rb +100 -166
  42. data/lib/orb/models/credit_note_create_params.rb +15 -23
  43. data/lib/orb/models/credit_note_fetch_params.rb +3 -8
  44. data/lib/orb/models/credit_note_list_params.rb +20 -30
  45. data/lib/orb/models/customer.rb +224 -271
  46. data/lib/orb/models/customer_create_params.rb +216 -257
  47. data/lib/orb/models/customer_delete_params.rb +3 -8
  48. data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
  49. data/lib/orb/models/customer_fetch_params.rb +3 -8
  50. data/lib/orb/models/customer_list_params.rb +20 -30
  51. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
  52. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
  53. data/lib/orb/models/customer_update_by_external_id_params.rb +212 -257
  54. data/lib/orb/models/customer_update_params.rb +212 -255
  55. data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
  56. data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
  57. data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
  58. data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
  59. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
  60. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +23 -27
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +23 -27
  63. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
  64. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
  65. data/lib/orb/models/customers/credit_list_params.rb +18 -22
  66. data/lib/orb/models/customers/credit_list_response.rb +10 -17
  67. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
  68. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +384 -491
  69. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
  70. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +384 -498
  71. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
  72. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +384 -494
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +383 -501
  75. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
  76. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
  77. data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
  78. data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
  79. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
  80. data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
  81. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
  82. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
  83. data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
  84. data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
  85. data/lib/orb/models/dimensional_price_group.rb +21 -15
  86. data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
  87. data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
  88. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
  89. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
  90. data/lib/orb/models/dimensional_price_groups.rb +3 -7
  91. data/lib/orb/models/discount.rb +2 -3
  92. data/lib/orb/models/evaluate_price_group.rb +8 -11
  93. data/lib/orb/models/event_deprecate_params.rb +3 -8
  94. data/lib/orb/models/event_deprecate_response.rb +2 -6
  95. data/lib/orb/models/event_ingest_params.rb +33 -27
  96. data/lib/orb/models/event_ingest_response.rb +23 -24
  97. data/lib/orb/models/event_search_params.rb +15 -11
  98. data/lib/orb/models/event_search_response.rb +27 -22
  99. data/lib/orb/models/event_update_params.rb +19 -13
  100. data/lib/orb/models/event_update_response.rb +2 -6
  101. data/lib/orb/models/events/backfill_close_params.rb +3 -8
  102. data/lib/orb/models/events/backfill_close_response.rb +34 -39
  103. data/lib/orb/models/events/backfill_create_params.rb +28 -32
  104. data/lib/orb/models/events/backfill_create_response.rb +34 -39
  105. data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
  106. data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
  107. data/lib/orb/models/events/backfill_list_params.rb +12 -15
  108. data/lib/orb/models/events/backfill_list_response.rb +34 -39
  109. data/lib/orb/models/events/backfill_revert_params.rb +3 -8
  110. data/lib/orb/models/events/backfill_revert_response.rb +34 -39
  111. data/lib/orb/models/events/event_volumes.rb +11 -17
  112. data/lib/orb/models/events/volume_list_params.rb +19 -22
  113. data/lib/orb/models/invoice.rb +619 -681
  114. data/lib/orb/models/invoice_create_params.rb +52 -61
  115. data/lib/orb/models/invoice_fetch_params.rb +3 -8
  116. data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
  117. data/lib/orb/models/invoice_fetch_upcoming_response.rb +618 -669
  118. data/lib/orb/models/invoice_issue_params.rb +10 -14
  119. data/lib/orb/models/invoice_level_discount.rb +2 -3
  120. data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
  121. data/lib/orb/models/invoice_line_item_create_response.rb +281 -306
  122. data/lib/orb/models/invoice_list_params.rb +51 -66
  123. data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
  124. data/lib/orb/models/invoice_pay_params.rb +3 -8
  125. data/lib/orb/models/invoice_update_params.rb +9 -9
  126. data/lib/orb/models/invoice_void_params.rb +3 -8
  127. data/lib/orb/models/item.rb +14 -25
  128. data/lib/orb/models/item_create_params.rb +5 -9
  129. data/lib/orb/models/item_fetch_params.rb +3 -8
  130. data/lib/orb/models/item_list_params.rb +12 -15
  131. data/lib/orb/models/item_update_params.rb +10 -22
  132. data/lib/orb/models/metric_create_params.rb +17 -13
  133. data/lib/orb/models/metric_fetch_params.rb +3 -8
  134. data/lib/orb/models/metric_list_params.rb +20 -30
  135. data/lib/orb/models/metric_update_params.rb +9 -9
  136. data/lib/orb/models/pagination_metadata.rb +3 -7
  137. data/lib/orb/models/percentage_discount.rb +15 -14
  138. data/lib/orb/models/plan.rb +259 -291
  139. data/lib/orb/models/plan_create_params.rb +2070 -2466
  140. data/lib/orb/models/plan_fetch_params.rb +3 -8
  141. data/lib/orb/models/plan_list_params.rb +25 -42
  142. data/lib/orb/models/plan_update_params.rb +12 -10
  143. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
  144. data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
  145. data/lib/orb/models/price.rb +3842 -5005
  146. data/lib/orb/models/price_create_params.rb +203 -244
  147. data/lib/orb/models/price_evaluate_params.rb +21 -30
  148. data/lib/orb/models/price_evaluate_response.rb +2 -6
  149. data/lib/orb/models/price_fetch_params.rb +3 -8
  150. data/lib/orb/models/price_list_params.rb +12 -15
  151. data/lib/orb/models/price_update_params.rb +9 -9
  152. data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
  153. data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
  154. data/lib/orb/models/subscription.rb +360 -405
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +358 -399
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +384 -418
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +384 -417
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +385 -417
  163. data/lib/orb/models/subscription_create_params.rb +4735 -5417
  164. data/lib/orb/models/subscription_create_response.rb +358 -399
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +23 -27
  167. data/lib/orb/models/subscription_fetch_params.rb +3 -8
  168. data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
  169. data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
  170. data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
  171. data/lib/orb/models/subscription_list_params.rb +28 -41
  172. data/lib/orb/models/subscription_price_intervals_params.rb +2560 -3040
  173. data/lib/orb/models/subscription_price_intervals_response.rb +361 -399
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +4728 -5411
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +361 -398
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +360 -399
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +361 -398
  180. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
  181. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +362 -396
  182. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
  183. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +362 -396
  184. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
  185. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +361 -398
  186. data/lib/orb/models/subscription_update_params.rb +21 -23
  187. data/lib/orb/models/subscription_update_trial_params.rb +15 -18
  188. data/lib/orb/models/subscription_update_trial_response.rb +360 -399
  189. data/lib/orb/models/subscription_usage.rb +37 -80
  190. data/lib/orb/models/subscriptions.rb +3 -7
  191. data/lib/orb/models/top_level_ping_params.rb +3 -8
  192. data/lib/orb/models/top_level_ping_response.rb +2 -6
  193. data/lib/orb/models/trial_discount.rb +16 -24
  194. data/lib/orb/models/usage_discount.rb +15 -14
  195. data/lib/orb/models.rb +220 -0
  196. data/lib/orb/request_options.rb +4 -6
  197. data/lib/orb/resources/alerts.rb +48 -17
  198. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  199. data/lib/orb/resources/coupons.rb +26 -8
  200. data/lib/orb/resources/credit_notes.rb +17 -4
  201. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  202. data/lib/orb/resources/customers/costs.rb +26 -8
  203. data/lib/orb/resources/customers/credits/ledger.rb +112 -32
  204. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  205. data/lib/orb/resources/customers/credits.rb +28 -8
  206. data/lib/orb/resources/customers.rb +138 -39
  207. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  208. data/lib/orb/resources/events/backfills.rb +32 -9
  209. data/lib/orb/resources/events/volume.rb +14 -4
  210. data/lib/orb/resources/events.rb +40 -11
  211. data/lib/orb/resources/invoice_line_items.rb +16 -6
  212. data/lib/orb/resources/invoices.rb +77 -17
  213. data/lib/orb/resources/items.rb +10 -3
  214. data/lib/orb/resources/metrics.rb +33 -8
  215. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  216. data/lib/orb/resources/plans.rb +47 -11
  217. data/lib/orb/resources/prices/external_price_id.rb +9 -3
  218. data/lib/orb/resources/prices.rb +101 -26
  219. data/lib/orb/resources/subscription_changes.rb +5 -2
  220. data/lib/orb/resources/subscriptions.rb +292 -78
  221. data/lib/orb/version.rb +1 -1
  222. data/lib/orb.rb +2 -10
  223. data/rbi/{lib/orb → orb}/client.rbi +4 -4
  224. data/rbi/{lib/orb → orb}/errors.rbi +1 -1
  225. data/rbi/orb/file_part.rbi +34 -0
  226. data/rbi/{lib/orb → orb}/internal/transport/base_client.rbi +19 -5
  227. data/rbi/{lib/orb → orb}/internal/type/array_of.rbi +3 -0
  228. data/rbi/{lib/orb → orb}/internal/type/base_model.rbi +7 -1
  229. data/rbi/{lib/orb → orb}/internal/type/base_page.rbi +2 -0
  230. data/rbi/{lib/orb → orb}/internal/type/enum.rbi +3 -6
  231. data/rbi/{lib/orb/internal/type/io_like.rbi → orb/internal/type/file_input.rbi} +5 -2
  232. data/rbi/{lib/orb → orb}/internal/type/hash_of.rbi +3 -0
  233. data/rbi/{lib/orb → orb}/internal/type/request_parameters.rbi +1 -1
  234. data/rbi/{lib/orb → orb}/internal/type/union.rbi +3 -0
  235. data/rbi/{lib/orb → orb}/internal/util.rbi +28 -19
  236. data/rbi/{lib/orb → orb}/internal.rbi +0 -1
  237. data/rbi/{lib/orb → orb}/models/alert.rbi +28 -8
  238. data/rbi/{lib/orb → orb}/models/alert_create_for_customer_params.rbi +16 -6
  239. data/rbi/{lib/orb → orb}/models/alert_create_for_external_customer_params.rbi +16 -6
  240. data/rbi/{lib/orb → orb}/models/alert_create_for_subscription_params.rbi +16 -6
  241. data/rbi/{lib/orb → orb}/models/alert_disable_params.rbi +5 -2
  242. data/rbi/{lib/orb → orb}/models/alert_enable_params.rbi +5 -2
  243. data/rbi/{lib/orb → orb}/models/alert_list_params.rbi +6 -0
  244. data/rbi/{lib/orb → orb}/models/alert_update_params.rbi +11 -4
  245. data/rbi/{lib/orb → orb}/models/amount_discount.rbi +10 -4
  246. data/rbi/{lib/orb → orb}/models/billable_metric.rbi +16 -3
  247. data/rbi/{lib/orb → orb}/models/billing_cycle_relative_date.rbi +1 -1
  248. data/rbi/{lib/orb → orb}/models/coupon.rbi +10 -3
  249. data/rbi/{lib/orb → orb}/models/coupon_create_params.rbi +15 -12
  250. data/rbi/{lib/orb → orb}/models/coupon_list_params.rbi +13 -3
  251. data/rbi/{lib/orb → orb}/models/coupons/subscription_list_params.rbi +8 -2
  252. data/rbi/{lib/orb → orb}/models/credit_note.rbi +44 -12
  253. data/rbi/{lib/orb → orb}/models/credit_note_create_params.rbi +15 -6
  254. data/rbi/{lib/orb → orb}/models/credit_note_list_params.rbi +3 -0
  255. data/rbi/{lib/orb → orb}/models/customer.rbi +130 -11
  256. data/rbi/{lib/orb → orb}/models/customer_create_params.rbi +151 -17
  257. data/rbi/{lib/orb → orb}/models/customer_list_params.rbi +3 -0
  258. data/rbi/{lib/orb → orb}/models/customer_update_by_external_id_params.rbi +149 -17
  259. data/rbi/{lib/orb → orb}/models/customer_update_params.rbi +149 -17
  260. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_params.rbi +8 -4
  261. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_create_response.rbi +18 -8
  262. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_params.rbi +3 -0
  263. data/rbi/{lib/orb → orb}/models/customers/balance_transaction_list_response.rbi +18 -8
  264. data/rbi/{lib/orb → orb}/models/customers/cost_list_by_external_id_params.rbi +9 -5
  265. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +225 -0
  266. data/rbi/{lib/orb → orb}/models/customers/cost_list_params.rbi +9 -5
  267. data/rbi/orb/models/customers/cost_list_response.rbi +223 -0
  268. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_params.rbi +13 -3
  269. data/rbi/{lib/orb → orb}/models/customers/credit_list_by_external_id_response.rbi +1 -2
  270. data/rbi/{lib/orb → orb}/models/customers/credit_list_params.rbi +13 -3
  271. data/rbi/{lib/orb → orb}/models/customers/credit_list_response.rbi +1 -2
  272. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  273. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_response.rbi → orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi} +157 -170
  274. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  275. data/rbi/{lib/orb/models/customers/credits/ledger_list_response.rbi → orb/models/customers/credits/ledger_create_entry_response.rbi} +149 -196
  276. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  277. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_by_external_id_response.rbi +148 -229
  278. data/rbi/{lib/orb → orb}/models/customers/credits/ledger_list_params.rbi +6 -4
  279. data/rbi/{lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi → orb/models/customers/credits/ledger_list_response.rbi} +149 -343
  280. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  281. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  282. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_params.rbi +27 -4
  283. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_create_response.rbi +25 -10
  284. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  285. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  286. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_params.rbi +8 -2
  287. data/rbi/{lib/orb → orb}/models/customers/credits/top_up_list_response.rbi +25 -4
  288. data/rbi/{lib/orb → orb}/models/dimensional_price_group.rbi +11 -3
  289. data/rbi/{lib/orb → orb}/models/dimensional_price_group_create_params.rbi +4 -0
  290. data/rbi/{lib/orb → orb}/models/dimensional_price_group_list_params.rbi +8 -2
  291. data/rbi/{lib/orb → orb}/models/evaluate_price_group.rbi +8 -2
  292. data/rbi/{lib/orb → orb}/models/event_deprecate_response.rbi +4 -2
  293. data/rbi/{lib/orb → orb}/models/event_ingest_params.rbi +22 -5
  294. data/rbi/{lib/orb → orb}/models/event_ingest_response.rbi +15 -4
  295. data/rbi/{lib/orb → orb}/models/event_search_params.rbi +14 -2
  296. data/rbi/{lib/orb → orb}/models/event_search_response.rbi +14 -3
  297. data/rbi/{lib/orb → orb}/models/event_update_params.rbi +10 -3
  298. data/rbi/{lib/orb → orb}/models/event_update_response.rbi +4 -2
  299. data/rbi/{lib/orb → orb}/models/events/backfill_close_response.rbi +14 -2
  300. data/rbi/{lib/orb → orb}/models/events/backfill_create_params.rbi +18 -0
  301. data/rbi/{lib/orb → orb}/models/events/backfill_create_response.rbi +14 -2
  302. data/rbi/{lib/orb → orb}/models/events/backfill_fetch_response.rbi +14 -2
  303. data/rbi/{lib/orb → orb}/models/events/backfill_list_params.rbi +8 -2
  304. data/rbi/{lib/orb → orb}/models/events/backfill_list_response.rbi +14 -2
  305. data/rbi/{lib/orb → orb}/models/events/backfill_revert_response.rbi +14 -2
  306. data/rbi/{lib/orb → orb}/models/events/event_volumes.rbi +8 -4
  307. data/rbi/{lib/orb → orb}/models/events/volume_list_params.rbi +18 -2
  308. data/rbi/{lib/orb → orb}/models/invoice.rbi +513 -202
  309. data/rbi/{lib/orb → orb}/models/invoice_create_params.rbi +38 -6
  310. data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_response.rbi +513 -216
  311. data/rbi/{lib/orb → orb}/models/invoice_issue_params.rbi +9 -2
  312. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_params.rbi +16 -2
  313. data/rbi/{lib/orb → orb}/models/invoice_line_item_create_response.rbi +279 -182
  314. data/rbi/{lib/orb → orb}/models/invoice_list_params.rbi +9 -2
  315. data/rbi/{lib/orb → orb}/models/invoice_mark_paid_params.rbi +9 -2
  316. data/rbi/{lib/orb → orb}/models/invoice_update_params.rbi +7 -2
  317. data/rbi/{lib/orb → orb}/models/item.rbi +1 -2
  318. data/rbi/{lib/orb → orb}/models/item_create_params.rbi +5 -2
  319. data/rbi/{lib/orb → orb}/models/item_list_params.rbi +8 -2
  320. data/rbi/{lib/orb → orb}/models/item_update_params.rbi +1 -8
  321. data/rbi/{lib/orb → orb}/models/metric_create_params.rbi +15 -2
  322. data/rbi/{lib/orb → orb}/models/metric_list_params.rbi +3 -0
  323. data/rbi/{lib/orb → orb}/models/metric_update_params.rbi +7 -2
  324. data/rbi/{lib/orb → orb}/models/percentage_discount.rbi +11 -4
  325. data/rbi/{lib/orb → orb}/models/plan.rbi +207 -120
  326. data/rbi/{lib/orb → orb}/models/plan_create_params.rbi +1971 -2414
  327. data/rbi/{lib/orb → orb}/models/plan_list_params.rbi +5 -1
  328. data/rbi/{lib/orb → orb}/models/plan_update_params.rbi +11 -2
  329. data/rbi/{lib/orb → orb}/models/plans/external_plan_id_update_params.rbi +11 -2
  330. data/rbi/{lib/orb → orb}/models/price.rbi +2594 -2957
  331. data/rbi/{lib/orb → orb}/models/price_create_params.rbi +137 -53
  332. data/rbi/{lib/orb → orb}/models/price_evaluate_params.rbi +10 -0
  333. data/rbi/{lib/orb → orb}/models/price_list_params.rbi +8 -2
  334. data/rbi/{lib/orb → orb}/models/price_update_params.rbi +7 -2
  335. data/rbi/{lib/orb → orb}/models/prices/external_price_id_update_params.rbi +7 -2
  336. data/rbi/{lib/orb → orb}/models/subscription.rbi +292 -129
  337. data/rbi/{lib/orb → orb}/models/subscription_cancel_params.rbi +8 -5
  338. data/rbi/{lib/orb → orb}/models/subscription_cancel_response.rbi +305 -132
  339. data/rbi/{lib/orb → orb}/models/subscription_change_apply_params.rbi +7 -2
  340. data/rbi/{lib/orb → orb}/models/subscription_change_apply_response.rbi +317 -136
  341. data/rbi/{lib/orb → orb}/models/subscription_change_cancel_response.rbi +317 -136
  342. data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_response.rbi +317 -136
  343. data/rbi/{lib/orb → orb}/models/subscription_create_params.rbi +4271 -4270
  344. data/rbi/{lib/orb → orb}/models/subscription_create_response.rbi +305 -132
  345. data/rbi/{lib/orb → orb}/models/subscription_fetch_costs_params.rbi +9 -5
  346. data/rbi/orb/models/subscription_fetch_costs_response.rbi +221 -0
  347. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_params.rbi +3 -0
  348. data/rbi/{lib/orb → orb}/models/subscription_fetch_schedule_response.rbi +8 -2
  349. data/rbi/{lib/orb → orb}/models/subscription_fetch_usage_params.rbi +13 -4
  350. data/rbi/{lib/orb → orb}/models/subscription_list_params.rbi +4 -2
  351. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_params.rbi +2354 -2317
  352. data/rbi/{lib/orb → orb}/models/subscription_price_intervals_response.rbi +305 -132
  353. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_params.rbi +4280 -3758
  354. data/rbi/{lib/orb → orb}/models/subscription_schedule_plan_change_response.rbi +305 -132
  355. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_params.rbi +10 -2
  356. data/rbi/{lib/orb → orb}/models/subscription_trigger_phase_response.rbi +305 -132
  357. data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_response.rbi +305 -132
  358. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  359. data/rbi/{lib/orb → orb}/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +305 -138
  360. data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_response.rbi +305 -132
  361. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  362. data/rbi/{lib/orb → orb}/models/subscription_update_fixed_fee_quantity_response.rbi +305 -132
  363. data/rbi/{lib/orb → orb}/models/subscription_update_params.rbi +15 -0
  364. data/rbi/{lib/orb → orb}/models/subscription_update_trial_params.rbi +11 -5
  365. data/rbi/{lib/orb → orb}/models/subscription_update_trial_response.rbi +305 -132
  366. data/rbi/{lib/orb → orb}/models/subscription_usage.rbi +2 -16
  367. data/rbi/{lib/orb → orb}/models/trial_discount.rbi +5 -1
  368. data/rbi/{lib/orb → orb}/models/usage_discount.rbi +11 -3
  369. data/rbi/orb/models.rbi +220 -0
  370. data/rbi/{lib/orb → orb}/request_options.rbi +2 -0
  371. data/rbi/{lib/orb → orb}/resources/alerts.rbi +8 -14
  372. data/rbi/{lib/orb → orb}/resources/coupons/subscriptions.rbi +1 -1
  373. data/rbi/{lib/orb → orb}/resources/coupons.rbi +6 -18
  374. data/rbi/{lib/orb → orb}/resources/credit_notes.rbi +3 -9
  375. data/rbi/{lib/orb → orb}/resources/customers/balance_transactions.rbi +2 -2
  376. data/rbi/{lib/orb → orb}/resources/customers/costs.rbi +2 -2
  377. data/rbi/{lib/orb → orb}/resources/customers/credits/ledger.rbi +32 -32
  378. data/rbi/{lib/orb → orb}/resources/customers/credits/top_ups.rbi +6 -18
  379. data/rbi/{lib/orb → orb}/resources/customers/credits.rbi +2 -2
  380. data/rbi/{lib/orb → orb}/resources/customers.rbi +15 -45
  381. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +1 -4
  382. data/rbi/{lib/orb → orb}/resources/dimensional_price_groups.rbi +3 -10
  383. data/rbi/{lib/orb → orb}/resources/events/backfills.rbi +5 -18
  384. data/rbi/{lib/orb → orb}/resources/events/volume.rbi +1 -1
  385. data/rbi/{lib/orb → orb}/resources/events.rbi +4 -10
  386. data/rbi/{lib/orb → orb}/resources/invoice_line_items.rbi +1 -1
  387. data/rbi/{lib/orb → orb}/resources/invoices.rbi +9 -34
  388. data/rbi/{lib/orb → orb}/resources/items.rbi +4 -17
  389. data/rbi/{lib/orb → orb}/resources/metrics.rbi +4 -10
  390. data/rbi/{lib/orb → orb}/resources/plans/external_plan_id.rbi +2 -8
  391. data/rbi/{lib/orb → orb}/resources/plans.rbi +29 -35
  392. data/rbi/orb/resources/prices/external_price_id.rbi +103 -0
  393. data/rbi/{lib/orb → orb}/resources/prices.rbi +117 -124
  394. data/rbi/{lib/orb → orb}/resources/subscription_changes.rbi +3 -9
  395. data/rbi/{lib/orb → orb}/resources/subscriptions.rbi +16 -32
  396. data/rbi/{lib/orb → orb}/resources/top_level.rbi +1 -4
  397. data/sig/orb/file_part.rbs +21 -0
  398. data/sig/orb/internal/transport/base_client.rbs +9 -3
  399. data/sig/orb/internal/type/array_of.rbs +2 -0
  400. data/sig/orb/internal/type/base_model.rbs +4 -0
  401. data/sig/orb/internal/type/enum.rbs +2 -2
  402. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  403. data/sig/orb/internal/type/hash_of.rbs +2 -0
  404. data/sig/orb/internal/type/union.rbs +2 -0
  405. data/sig/orb/internal/util.rbs +16 -12
  406. data/sig/orb/models/coupon_create_params.rbs +9 -10
  407. data/sig/orb/models/customer_create_params.rbs +9 -10
  408. data/sig/orb/models/customer_update_by_external_id_params.rbs +9 -10
  409. data/sig/orb/models/customer_update_params.rbs +9 -10
  410. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +113 -113
  411. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +113 -113
  412. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +113 -113
  413. data/sig/orb/models/customers/credits/ledger_list_response.rbs +113 -113
  414. data/sig/orb/models/invoice.rbs +54 -54
  415. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +54 -54
  416. data/sig/orb/models/invoice_line_item_create_response.rbs +54 -54
  417. data/sig/orb/models/plan.rbs +21 -21
  418. data/sig/orb/models/plan_create_params.rbs +653 -653
  419. data/sig/orb/models/price.rbs +1517 -1521
  420. data/sig/orb/models/subscription.rbs +34 -34
  421. data/sig/orb/models/subscription_cancel_response.rbs +34 -34
  422. data/sig/orb/models/subscription_change_apply_response.rbs +34 -34
  423. data/sig/orb/models/subscription_change_cancel_response.rbs +34 -34
  424. data/sig/orb/models/subscription_change_retrieve_response.rbs +34 -34
  425. data/sig/orb/models/subscription_create_params.rbs +1348 -1348
  426. data/sig/orb/models/subscription_create_response.rbs +34 -34
  427. data/sig/orb/models/subscription_price_intervals_params.rbs +767 -769
  428. data/sig/orb/models/subscription_price_intervals_response.rbs +34 -34
  429. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1348 -1348
  430. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +34 -34
  431. data/sig/orb/models/subscription_trigger_phase_response.rbs +34 -34
  432. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +34 -34
  433. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +34 -34
  434. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +34 -34
  435. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +34 -34
  436. data/sig/orb/models/subscription_update_trial_response.rbs +34 -34
  437. data/sig/orb/models.rbs +215 -0
  438. metadata +230 -224
  439. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +0 -208
  440. data/rbi/lib/orb/models/customers/cost_list_response.rbi +0 -206
  441. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +0 -204
  442. data/rbi/lib/orb/resources/prices/external_price_id.rbi +0 -106
  443. /data/rbi/{lib/orb → orb}/internal/page.rbi +0 -0
  444. /data/rbi/{lib/orb → orb}/internal/transport/pooled_net_requester.rbi +0 -0
  445. /data/rbi/{lib/orb → orb}/internal/type/boolean.rbi +0 -0
  446. /data/rbi/{lib/orb → orb}/internal/type/converter.rbi +0 -0
  447. /data/rbi/{lib/orb → orb}/internal/type/unknown.rbi +0 -0
  448. /data/rbi/{lib/orb → orb}/models/alert_retrieve_params.rbi +0 -0
  449. /data/rbi/{lib/orb → orb}/models/coupon_archive_params.rbi +0 -0
  450. /data/rbi/{lib/orb → orb}/models/coupon_fetch_params.rbi +0 -0
  451. /data/rbi/{lib/orb → orb}/models/credit_note_fetch_params.rbi +0 -0
  452. /data/rbi/{lib/orb → orb}/models/customer_delete_params.rbi +0 -0
  453. /data/rbi/{lib/orb → orb}/models/customer_fetch_by_external_id_params.rbi +0 -0
  454. /data/rbi/{lib/orb → orb}/models/customer_fetch_params.rbi +0 -0
  455. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +0 -0
  456. /data/rbi/{lib/orb → orb}/models/customer_sync_payment_methods_from_gateway_params.rbi +0 -0
  457. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_by_external_id_params.rbi +0 -0
  458. /data/rbi/{lib/orb → orb}/models/customers/credits/top_up_delete_params.rbi +0 -0
  459. /data/rbi/{lib/orb → orb}/models/dimensional_price_group_retrieve_params.rbi +0 -0
  460. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +0 -0
  461. /data/rbi/{lib/orb → orb}/models/dimensional_price_groups.rbi +0 -0
  462. /data/rbi/{lib/orb → orb}/models/discount.rbi +0 -0
  463. /data/rbi/{lib/orb → orb}/models/event_deprecate_params.rbi +0 -0
  464. /data/rbi/{lib/orb → orb}/models/events/backfill_close_params.rbi +0 -0
  465. /data/rbi/{lib/orb → orb}/models/events/backfill_fetch_params.rbi +0 -0
  466. /data/rbi/{lib/orb → orb}/models/events/backfill_revert_params.rbi +0 -0
  467. /data/rbi/{lib/orb → orb}/models/invoice_fetch_params.rbi +0 -0
  468. /data/rbi/{lib/orb → orb}/models/invoice_fetch_upcoming_params.rbi +0 -0
  469. /data/rbi/{lib/orb → orb}/models/invoice_level_discount.rbi +0 -0
  470. /data/rbi/{lib/orb → orb}/models/invoice_pay_params.rbi +0 -0
  471. /data/rbi/{lib/orb → orb}/models/invoice_void_params.rbi +0 -0
  472. /data/rbi/{lib/orb → orb}/models/item_fetch_params.rbi +0 -0
  473. /data/rbi/{lib/orb → orb}/models/metric_fetch_params.rbi +0 -0
  474. /data/rbi/{lib/orb → orb}/models/pagination_metadata.rbi +0 -0
  475. /data/rbi/{lib/orb → orb}/models/plan_fetch_params.rbi +0 -0
  476. /data/rbi/{lib/orb → orb}/models/plans/external_plan_id_fetch_params.rbi +0 -0
  477. /data/rbi/{lib/orb → orb}/models/price_evaluate_response.rbi +0 -0
  478. /data/rbi/{lib/orb → orb}/models/price_fetch_params.rbi +0 -0
  479. /data/rbi/{lib/orb → orb}/models/prices/external_price_id_fetch_params.rbi +0 -0
  480. /data/rbi/{lib/orb → orb}/models/subscription_change_cancel_params.rbi +0 -0
  481. /data/rbi/{lib/orb → orb}/models/subscription_change_retrieve_params.rbi +0 -0
  482. /data/rbi/{lib/orb → orb}/models/subscription_fetch_params.rbi +0 -0
  483. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_cancellation_params.rbi +0 -0
  484. /data/rbi/{lib/orb → orb}/models/subscription_unschedule_pending_plan_changes_params.rbi +0 -0
  485. /data/rbi/{lib/orb → orb}/models/subscriptions.rbi +0 -0
  486. /data/rbi/{lib/orb → orb}/models/top_level_ping_params.rbi +0 -0
  487. /data/rbi/{lib/orb → orb}/models/top_level_ping_response.rbi +0 -0
  488. /data/rbi/{lib/orb → orb}/version.rbi +0 -0
@@ -27,7 +27,9 @@ module Orb
27
27
  # @overload update(alert_configuration_id, thresholds:, request_options: {})
28
28
  #
29
29
  # @param alert_configuration_id [String]
30
- # @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>]
30
+ #
31
+ # @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
32
+ #
31
33
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
32
34
  #
33
35
  # @return [Orb::Models::Alert]
@@ -44,6 +46,9 @@ module Orb
44
46
  )
45
47
  end
46
48
 
49
+ # Some parameter documentations has been truncated, see
50
+ # {Orb::Models::AlertListParams} for more details.
51
+ #
47
52
  # This endpoint returns a list of alerts within Orb.
48
53
  #
49
54
  # The request must specify one of `customer_id`, `external_customer_id`, or
@@ -59,14 +64,24 @@ module Orb
59
64
  # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {})
60
65
  #
61
66
  # @param created_at_gt [Time, nil]
67
+ #
62
68
  # @param created_at_gte [Time, nil]
69
+ #
63
70
  # @param created_at_lt [Time, nil]
71
+ #
64
72
  # @param created_at_lte [Time, nil]
65
- # @param cursor [String, nil]
66
- # @param customer_id [String, nil]
67
- # @param external_customer_id [String, nil]
68
- # @param limit [Integer]
69
- # @param subscription_id [String, nil]
73
+ #
74
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
75
+ # ...
76
+ #
77
+ # @param customer_id [String, nil] Fetch alerts scoped to this customer_id
78
+ #
79
+ # @param external_customer_id [String, nil] Fetch alerts scoped to this external_customer_id
80
+ #
81
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
82
+ #
83
+ # @param subscription_id [String, nil] Fetch alerts scoped to this subscription_id
84
+ #
70
85
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
71
86
  #
72
87
  # @return [Orb::Internal::Page<Orb::Models::Alert>]
@@ -101,9 +116,13 @@ module Orb
101
116
  # @overload create_for_customer(customer_id, currency:, type:, thresholds: nil, request_options: {})
102
117
  #
103
118
  # @param customer_id [String]
104
- # @param currency [String]
105
- # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type]
106
- # @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil]
119
+ #
120
+ # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
121
+ #
122
+ # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
123
+ #
124
+ # @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
125
+ #
107
126
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
108
127
  #
109
128
  # @return [Orb::Models::Alert]
@@ -132,9 +151,13 @@ module Orb
132
151
  # @overload create_for_external_customer(external_customer_id, currency:, type:, thresholds: nil, request_options: {})
133
152
  #
134
153
  # @param external_customer_id [String]
135
- # @param currency [String]
136
- # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type]
137
- # @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil]
154
+ #
155
+ # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
156
+ #
157
+ # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
158
+ #
159
+ # @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
160
+ #
138
161
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
139
162
  #
140
163
  # @return [Orb::Models::Alert]
@@ -166,9 +189,13 @@ module Orb
166
189
  # @overload create_for_subscription(subscription_id, thresholds:, type:, metric_id: nil, request_options: {})
167
190
  #
168
191
  # @param subscription_id [String]
169
- # @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>]
170
- # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type]
171
- # @param metric_id [String, nil]
192
+ #
193
+ # @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
194
+ #
195
+ # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
196
+ #
197
+ # @param metric_id [String, nil] The metric to track usage for.
198
+ #
172
199
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
173
200
  #
174
201
  # @return [Orb::Models::Alert]
@@ -192,7 +219,9 @@ module Orb
192
219
  # @overload disable(alert_configuration_id, subscription_id: nil, request_options: {})
193
220
  #
194
221
  # @param alert_configuration_id [String]
195
- # @param subscription_id [String, nil]
222
+ #
223
+ # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
224
+ #
196
225
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
197
226
  #
198
227
  # @return [Orb::Models::Alert]
@@ -216,7 +245,9 @@ module Orb
216
245
  # @overload enable(alert_configuration_id, subscription_id: nil, request_options: {})
217
246
  #
218
247
  # @param alert_configuration_id [String]
219
- # @param subscription_id [String, nil]
248
+ #
249
+ # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
250
+ #
220
251
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
221
252
  #
222
253
  # @return [Orb::Models::Alert]
@@ -4,6 +4,9 @@ module Orb
4
4
  module Resources
5
5
  class Coupons
6
6
  class Subscriptions
7
+ # Some parameter documentations has been truncated, see
8
+ # {Orb::Models::Coupons::SubscriptionListParams} for more details.
9
+ #
7
10
  # This endpoint returns a list of all subscriptions that have redeemed a given
8
11
  # coupon as a [paginated](/api-reference/pagination) list, ordered starting from
9
12
  # the most recently created subscription. For a full discussion of the
@@ -12,8 +15,12 @@ module Orb
12
15
  # @overload list(coupon_id, cursor: nil, limit: nil, request_options: {})
13
16
  #
14
17
  # @param coupon_id [String]
15
- # @param cursor [String, nil]
16
- # @param limit [Integer]
18
+ #
19
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
20
+ # ...
21
+ #
22
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
23
+ #
17
24
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
18
25
  #
19
26
  # @return [Orb::Internal::Page<Orb::Models::Subscription>]
@@ -6,15 +6,24 @@ module Orb
6
6
  # @return [Orb::Resources::Coupons::Subscriptions]
7
7
  attr_reader :subscriptions
8
8
 
9
+ # Some parameter documentations has been truncated, see
10
+ # {Orb::Models::CouponCreateParams} for more details.
11
+ #
9
12
  # This endpoint allows the creation of coupons, which can then be redeemed at
10
13
  # subscription creation or plan change.
11
14
  #
12
15
  # @overload create(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {})
13
16
  #
14
- # @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
15
- # @param redemption_code [String]
16
- # @param duration_in_months [Integer, nil]
17
- # @param max_redemptions [Integer, nil]
17
+ # @param discount [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
18
+ #
19
+ # @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
20
+ #
21
+ # @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m
22
+ # ...
23
+ #
24
+ # @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted
25
+ # ...
26
+ #
18
27
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
19
28
  #
20
29
  # @return [Orb::Models::Coupon]
@@ -31,6 +40,9 @@ module Orb
31
40
  )
32
41
  end
33
42
 
43
+ # Some parameter documentations has been truncated, see
44
+ # {Orb::Models::CouponListParams} for more details.
45
+ #
34
46
  # This endpoint returns a list of all coupons for an account in a list format.
35
47
  #
36
48
  # The list of coupons is ordered starting from the most recently created coupon.
@@ -40,10 +52,16 @@ module Orb
40
52
  #
41
53
  # @overload list(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {})
42
54
  #
43
- # @param cursor [String, nil]
44
- # @param limit [Integer]
45
- # @param redemption_code [String, nil]
46
- # @param show_archived [Boolean, nil]
55
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
56
+ # ...
57
+ #
58
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
59
+ #
60
+ # @param redemption_code [String, nil] Filter to coupons matching this redemption code.
61
+ #
62
+ # @param show_archived [Boolean, nil] Show archived coupons as well (by default, this endpoint only returns active cou
63
+ # ...
64
+ #
47
65
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
48
66
  #
49
67
  # @return [Orb::Internal::Page<Orb::Models::Coupon>]
@@ -9,8 +9,11 @@ module Orb
9
9
  # @overload create(line_items:, memo: nil, reason: nil, request_options: {})
10
10
  #
11
11
  # @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
12
- # @param memo [String, nil]
13
- # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil]
12
+ #
13
+ # @param memo [String, nil] An optional memo to attach to the credit note.
14
+ #
15
+ # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
16
+ #
14
17
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
15
18
  #
16
19
  # @return [Orb::Models::CreditNote]
@@ -27,6 +30,9 @@ module Orb
27
30
  )
28
31
  end
29
32
 
33
+ # Some parameter documentations has been truncated, see
34
+ # {Orb::Models::CreditNoteListParams} for more details.
35
+ #
30
36
  # Get a paginated list of CreditNotes. Users can also filter by customer_id,
31
37
  # subscription_id, or external_customer_id. The credit notes will be returned in
32
38
  # reverse chronological order by `creation_time`.
@@ -34,11 +40,18 @@ module Orb
34
40
  # @overload list(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
35
41
  #
36
42
  # @param created_at_gt [Time, nil]
43
+ #
37
44
  # @param created_at_gte [Time, nil]
45
+ #
38
46
  # @param created_at_lt [Time, nil]
47
+ #
39
48
  # @param created_at_lte [Time, nil]
40
- # @param cursor [String, nil]
41
- # @param limit [Integer]
49
+ #
50
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
51
+ # ...
52
+ #
53
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
54
+ #
42
55
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
43
56
  #
44
57
  # @return [Orb::Internal::Page<Orb::Models::CreditNote>]
@@ -10,9 +10,13 @@ module Orb
10
10
  # @overload create(customer_id, amount:, type:, description: nil, request_options: {})
11
11
  #
12
12
  # @param customer_id [String]
13
+ #
13
14
  # @param amount [String]
15
+ #
14
16
  # @param type [Symbol, Orb::Models::Customers::BalanceTransactionCreateParams::Type]
15
- # @param description [String, nil]
17
+ #
18
+ # @param description [String, nil] An optional description that can be specified around this entry.
19
+ #
16
20
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
17
21
  #
18
22
  # @return [Orb::Models::Customers::BalanceTransactionCreateResponse]
@@ -29,6 +33,9 @@ module Orb
29
33
  )
30
34
  end
31
35
 
36
+ # Some parameter documentations has been truncated, see
37
+ # {Orb::Models::Customers::BalanceTransactionListParams} for more details.
38
+ #
32
39
  # ## The customer balance
33
40
  #
34
41
  # The customer balance is an amount in the customer's currency, which Orb
@@ -61,12 +68,20 @@ module Orb
61
68
  # @overload list(customer_id, cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {})
62
69
  #
63
70
  # @param customer_id [String]
64
- # @param cursor [String, nil]
65
- # @param limit [Integer]
71
+ #
72
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
73
+ # ...
74
+ #
75
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
76
+ #
66
77
  # @param operation_time_gt [Time, nil]
78
+ #
67
79
  # @param operation_time_gte [Time, nil]
80
+ #
68
81
  # @param operation_time_lt [Time, nil]
82
+ #
69
83
  # @param operation_time_lte [Time, nil]
84
+ #
70
85
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
71
86
  #
72
87
  # @return [Orb::Internal::Page<Orb::Models::Customers::BalanceTransactionListResponse>]
@@ -4,6 +4,9 @@ module Orb
4
4
  module Resources
5
5
  class Customers
6
6
  class Costs
7
+ # Some parameter documentations has been truncated, see
8
+ # {Orb::Models::Customers::CostListParams} for more details.
9
+ #
7
10
  # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
8
11
  # Orb, calculated by applying pricing information to the underlying usage (see the
9
12
  # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
@@ -125,10 +128,16 @@ module Orb
125
128
  # @overload list(customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
126
129
  #
127
130
  # @param customer_id [String]
128
- # @param currency [String, nil]
129
- # @param timeframe_end [Time, nil]
130
- # @param timeframe_start [Time, nil]
131
- # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil]
131
+ #
132
+ # @param currency [String, nil] The currency or custom pricing unit to use.
133
+ #
134
+ # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
135
+ #
136
+ # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
137
+ #
138
+ # @param view_mode [Symbol, Orb::Models::Customers::CostListParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
139
+ # ...
140
+ #
132
141
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
133
142
  #
134
143
  # @return [Orb::Models::Customers::CostListResponse]
@@ -145,6 +154,9 @@ module Orb
145
154
  )
146
155
  end
147
156
 
157
+ # Some parameter documentations has been truncated, see
158
+ # {Orb::Models::Customers::CostListByExternalIDParams} for more details.
159
+ #
148
160
  # This endpoint is used to fetch a day-by-day snapshot of a customer's costs in
149
161
  # Orb, calculated by applying pricing information to the underlying usage (see the
150
162
  # [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)
@@ -266,10 +278,16 @@ module Orb
266
278
  # @overload list_by_external_id(external_customer_id, currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
267
279
  #
268
280
  # @param external_customer_id [String]
269
- # @param currency [String, nil]
270
- # @param timeframe_end [Time, nil]
271
- # @param timeframe_start [Time, nil]
272
- # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil]
281
+ #
282
+ # @param currency [String, nil] The currency or custom pricing unit to use.
283
+ #
284
+ # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
285
+ #
286
+ # @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
287
+ #
288
+ # @param view_mode [Symbol, Orb::Models::Customers::CostListByExternalIDParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
289
+ # ...
290
+ #
273
291
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
274
292
  #
275
293
  # @return [Orb::Models::Customers::CostListByExternalIDResponse]
@@ -5,6 +5,9 @@ module Orb
5
5
  class Customers
6
6
  class Credits
7
7
  class Ledger
8
+ # Some parameter documentations has been truncated, see
9
+ # {Orb::Models::Customers::Credits::LedgerListParams} for more details.
10
+ #
8
11
  # The credits ledger provides _auditing_ functionality over Orb's credits system
9
12
  # with a list of actions that have taken place to modify a customer's credit
10
13
  # balance. This [paginated endpoint](/api-reference/pagination) lists these
@@ -90,19 +93,31 @@ module Orb
90
93
  # @overload list(customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
91
94
  #
92
95
  # @param customer_id [String]
96
+ #
93
97
  # @param created_at_gt [Time, nil]
98
+ #
94
99
  # @param created_at_gte [Time, nil]
100
+ #
95
101
  # @param created_at_lt [Time, nil]
102
+ #
96
103
  # @param created_at_lte [Time, nil]
97
- # @param currency [String, nil]
98
- # @param cursor [String, nil]
104
+ #
105
+ # @param currency [String, nil] The ledger currency or custom pricing unit to use.
106
+ #
107
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
108
+ # ...
109
+ #
99
110
  # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryStatus, nil]
111
+ #
100
112
  # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListParams::EntryType, nil]
101
- # @param limit [Integer]
113
+ #
114
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
115
+ #
102
116
  # @param minimum_amount [String, nil]
117
+ #
103
118
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
104
119
  #
105
- # @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListResponse::AmendmentLedgerEntry>]
120
+ # @return [Orb::Internal::Page<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>]
106
121
  #
107
122
  # @see Orb::Models::Customers::Credits::LedgerListParams
108
123
  def list(customer_id, params = {})
@@ -122,6 +137,9 @@ module Orb
122
137
  )
123
138
  end
124
139
 
140
+ # Some parameter documentations has been truncated, see
141
+ # {Orb::Models::Customers::Credits::LedgerCreateEntryParams} for more details.
142
+ #
125
143
  # This endpoint allows you to create a new ledger entry for a specified customer's
126
144
  # balance. This can be used to increment balance, deduct credits, and change the
127
145
  # expiry date of existing credits.
@@ -236,21 +254,42 @@ module Orb
236
254
  # @overload create_entry(customer_id, 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: {})
237
255
  #
238
256
  # @param customer_id [String]
239
- # @param amount [Float]
257
+ #
258
+ # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
259
+ # ...
260
+ #
240
261
  # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::EntryType]
241
- # @param expiry_date [Time, nil]
242
- # @param target_expiry_date [Date]
243
- # @param block_id [String]
244
- # @param currency [String, nil]
245
- # @param description [String, nil]
246
- # @param effective_date [Time, nil]
247
- # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil]
248
- # @param metadata [Hash{Symbol=>String, nil}, nil]
249
- # @param per_unit_cost_basis [String, nil]
250
- # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil]
262
+ #
263
+ # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
264
+ #
265
+ # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
266
+ # ...
267
+ #
268
+ # @param block_id [String] The ID of the block to reverse a decrement from.
269
+ #
270
+ # @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
271
+ # ...
272
+ #
273
+ # @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
274
+ # ...
275
+ #
276
+ # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
277
+ # ...
278
+ #
279
+ # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
280
+ # ...
281
+ #
282
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
283
+ # ...
284
+ #
285
+ # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
286
+ # ...
287
+ #
288
+ # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
289
+ #
251
290
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
252
291
  #
253
- # @return [Orb::Models::Customers::Credits::LedgerCreateEntryResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerCreateEntryResponse::AmendmentLedgerEntry]
292
+ # @return [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]
254
293
  #
255
294
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryParams
256
295
  def create_entry(customer_id, params)
@@ -264,6 +303,10 @@ module Orb
264
303
  )
265
304
  end
266
305
 
306
+ # Some parameter documentations has been truncated, see
307
+ # {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams} for more
308
+ # details.
309
+ #
267
310
  # This endpoint allows you to create a new ledger entry for a specified customer's
268
311
  # balance. This can be used to increment balance, deduct credits, and change the
269
312
  # expiry date of existing credits.
@@ -378,21 +421,42 @@ module Orb
378
421
  # @overload create_entry_by_external_id(external_customer_id, 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: {})
379
422
  #
380
423
  # @param external_customer_id [String]
381
- # @param amount [Float]
424
+ #
425
+ # @param amount [Float] The number of credits to effect. Note that this is required for increment, decre
426
+ # ...
427
+ #
382
428
  # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::EntryType]
383
- # @param expiry_date [Time, nil]
384
- # @param target_expiry_date [Date]
385
- # @param block_id [String]
386
- # @param currency [String, nil]
387
- # @param description [String, nil]
388
- # @param effective_date [Time, nil]
389
- # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil]
390
- # @param metadata [Hash{Symbol=>String, nil}, nil]
391
- # @param per_unit_cost_basis [String, nil]
392
- # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil]
429
+ #
430
+ # @param expiry_date [Time, nil] An ISO 8601 format date that identifies the origination credit block to expire
431
+ #
432
+ # @param target_expiry_date [Date] A future date (specified in YYYY-MM-DD format) used for expiration change, denot
433
+ # ...
434
+ #
435
+ # @param block_id [String] The ID of the block to reverse a decrement from.
436
+ #
437
+ # @param currency [String, nil] The currency or custom pricing unit to use for this ledger entry. If this is a r
438
+ # ...
439
+ #
440
+ # @param description [String, nil] Optional metadata that can be specified when adding ledger results via the API.
441
+ # ...
442
+ #
443
+ # @param effective_date [Time, nil] An ISO 8601 format date that denotes when this credit balance should become avai
444
+ # ...
445
+ #
446
+ # @param invoice_settings [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings, nil] Passing `invoice_settings` automatically generates an invoice for the newly adde
447
+ # ...
448
+ #
449
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
450
+ # ...
451
+ #
452
+ # @param per_unit_cost_basis [String, nil] Can only be specified when entry_type=increment. How much, in the customer's cur
453
+ # ...
454
+ #
455
+ # @param void_reason [Symbol, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::VoidReason, nil] Can only be specified when `entry_type=void`. The reason for the void.
456
+ #
393
457
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
394
458
  #
395
- # @return [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]
459
+ # @return [Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Increment, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Decrement, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::ExpirationChange, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::CreditBlockExpiry, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Void, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::VoidInitiated, Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDResponse::Amendment]
396
460
  #
397
461
  # @see Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams
398
462
  def create_entry_by_external_id(external_customer_id, params)
@@ -407,6 +471,10 @@ module Orb
407
471
  )
408
472
  end
409
473
 
474
+ # Some parameter documentations has been truncated, see
475
+ # {Orb::Models::Customers::Credits::LedgerListByExternalIDParams} for more
476
+ # details.
477
+ #
410
478
  # The credits ledger provides _auditing_ functionality over Orb's credits system
411
479
  # with a list of actions that have taken place to modify a customer's credit
412
480
  # balance. This [paginated endpoint](/api-reference/pagination) lists these
@@ -492,19 +560,31 @@ module Orb
492
560
  # @overload list_by_external_id(external_customer_id, created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, currency: nil, cursor: nil, entry_status: nil, entry_type: nil, limit: nil, minimum_amount: nil, request_options: {})
493
561
  #
494
562
  # @param external_customer_id [String]
563
+ #
495
564
  # @param created_at_gt [Time, nil]
565
+ #
496
566
  # @param created_at_gte [Time, nil]
567
+ #
497
568
  # @param created_at_lt [Time, nil]
569
+ #
498
570
  # @param created_at_lte [Time, nil]
499
- # @param currency [String, nil]
500
- # @param cursor [String, nil]
571
+ #
572
+ # @param currency [String, nil] The ledger currency or custom pricing unit to use.
573
+ #
574
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
575
+ # ...
576
+ #
501
577
  # @param entry_status [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryStatus, nil]
578
+ #
502
579
  # @param entry_type [Symbol, Orb::Models::Customers::Credits::LedgerListByExternalIDParams::EntryType, nil]
503
- # @param limit [Integer]
580
+ #
581
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
582
+ #
504
583
  # @param minimum_amount [String, nil]
584
+ #
505
585
  # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
506
586
  #
507
- # @return [Orb::Internal::Page<Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::IncrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::DecrementLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::ExpirationChangeLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::CreditBlockExpiryLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::VoidInitiatedLedgerEntry, Orb::Models::Customers::Credits::LedgerListByExternalIDResponse::AmendmentLedgerEntry>]
587
+ # @return [Orb::Internal::Page<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>]
508
588
  #
509
589
  # @see Orb::Models::Customers::Credits::LedgerListByExternalIDParams
510
590
  def list_by_external_id(external_customer_id, params = {})