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
@@ -65,27 +65,36 @@ module Orb
65
65
  # @return [Symbol, Orb::Models::Alert::Type]
66
66
  required :type, enum: -> { Orb::Models::Alert::Type }
67
67
 
68
- # @!parse
69
- # # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
70
- # # usage, or credit balance and trigger webhooks when a threshold is exceeded.
71
- # #
72
- # # Alerts created through the API can be scoped to either customers or
73
- # # subscriptions.
74
- # #
75
- # # @param id [String]
76
- # # @param created_at [Time]
77
- # # @param currency [String, nil]
78
- # # @param customer [Orb::Models::Alert::Customer, nil]
79
- # # @param enabled [Boolean]
80
- # # @param metric [Orb::Models::Alert::Metric, nil]
81
- # # @param plan [Orb::Models::Alert::Plan, nil]
82
- # # @param subscription [Orb::Models::Alert::Subscription, nil]
83
- # # @param thresholds [Array<Orb::Models::Alert::Threshold>, nil]
84
- # # @param type [Symbol, Orb::Models::Alert::Type]
85
- # #
86
- # def initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:, **) = super
87
-
88
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
68
+ # @!method initialize(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:)
69
+ # Some parameter documentations has been truncated, see {Orb::Models::Alert} for
70
+ # more details.
71
+ #
72
+ # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
73
+ # usage, or credit balance and trigger webhooks when a threshold is exceeded.
74
+ #
75
+ # Alerts created through the API can be scoped to either customers or
76
+ # subscriptions.
77
+ #
78
+ # @param id [String] Also referred to as alert_id in this documentation.
79
+ #
80
+ # @param created_at [Time] The creation time of the resource in Orb.
81
+ #
82
+ # @param currency [String, nil] The name of the currency the credit balance or invoice cost is denominated in.
83
+ #
84
+ # @param customer [Orb::Models::Alert::Customer, nil] The customer the alert applies to.
85
+ #
86
+ # @param enabled [Boolean] Whether the alert is enabled or disabled.
87
+ #
88
+ # @param metric [Orb::Models::Alert::Metric, nil] The metric the alert applies to.
89
+ #
90
+ # @param plan [Orb::Models::Alert::Plan, nil] The plan the alert applies to.
91
+ #
92
+ # @param subscription [Orb::Models::Alert::Subscription, nil] The subscription the alert applies to.
93
+ #
94
+ # @param thresholds [Array<Orb::Models::Alert::Threshold>, nil] The thresholds that define the conditions under which the alert will be triggere
95
+ # ...
96
+ #
97
+ # @param type [Symbol, Orb::Models::Alert::Type] The type of alert. This must be a valid alert type.
89
98
 
90
99
  # @see Orb::Models::Alert#customer
91
100
  class Customer < Orb::Internal::Type::BaseModel
@@ -99,15 +108,11 @@ module Orb
99
108
  # @return [String, nil]
100
109
  required :external_customer_id, String, nil?: true
101
110
 
102
- # @!parse
103
- # # The customer the alert applies to.
104
- # #
105
- # # @param id [String]
106
- # # @param external_customer_id [String, nil]
107
- # #
108
- # def initialize(id:, external_customer_id:, **) = super
109
-
110
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
111
+ # @!method initialize(id:, external_customer_id:)
112
+ # The customer the alert applies to.
113
+ #
114
+ # @param id [String]
115
+ # @param external_customer_id [String, nil]
111
116
  end
112
117
 
113
118
  # @see Orb::Models::Alert#metric
@@ -117,14 +122,10 @@ module Orb
117
122
  # @return [String]
118
123
  required :id, String
119
124
 
120
- # @!parse
121
- # # The metric the alert applies to.
122
- # #
123
- # # @param id [String]
124
- # #
125
- # def initialize(id:, **) = super
126
-
127
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
125
+ # @!method initialize(id:)
126
+ # The metric the alert applies to.
127
+ #
128
+ # @param id [String]
128
129
  end
129
130
 
130
131
  # @see Orb::Models::Alert#plan
@@ -152,17 +153,20 @@ module Orb
152
153
  # @return [String]
153
154
  required :plan_version, String
154
155
 
155
- # @!parse
156
- # # The plan the alert applies to.
157
- # #
158
- # # @param id [String, nil]
159
- # # @param external_plan_id [String, nil]
160
- # # @param name [String, nil]
161
- # # @param plan_version [String]
162
- # #
163
- # def initialize(id:, external_plan_id:, name:, plan_version:, **) = super
164
-
165
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
156
+ # @!method initialize(id:, external_plan_id:, name:, plan_version:)
157
+ # Some parameter documentations has been truncated, see {Orb::Models::Alert::Plan}
158
+ # for more details.
159
+ #
160
+ # The plan the alert applies to.
161
+ #
162
+ # @param id [String, nil]
163
+ #
164
+ # @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
165
+ # ...
166
+ #
167
+ # @param name [String, nil]
168
+ #
169
+ # @param plan_version [String]
166
170
  end
167
171
 
168
172
  # @see Orb::Models::Alert#subscription
@@ -172,14 +176,10 @@ module Orb
172
176
  # @return [String]
173
177
  required :id, String
174
178
 
175
- # @!parse
176
- # # The subscription the alert applies to.
177
- # #
178
- # # @param id [String]
179
- # #
180
- # def initialize(id:, **) = super
181
-
182
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
179
+ # @!method initialize(id:)
180
+ # The subscription the alert applies to.
181
+ #
182
+ # @param id [String]
183
183
  end
184
184
 
185
185
  class Threshold < Orb::Internal::Type::BaseModel
@@ -191,15 +191,15 @@ module Orb
191
191
  # @return [Float]
192
192
  required :value, Float
193
193
 
194
- # @!parse
195
- # # Thresholds are used to define the conditions under which an alert will be
196
- # # triggered.
197
- # #
198
- # # @param value [Float]
199
- # #
200
- # def initialize(value:, **) = super
201
-
202
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
194
+ # @!method initialize(value:)
195
+ # Some parameter documentations has been truncated, see
196
+ # {Orb::Models::Alert::Threshold} for more details.
197
+ #
198
+ # Thresholds are used to define the conditions under which an alert will be
199
+ # triggered.
200
+ #
201
+ # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
202
+ # ...
203
203
  end
204
204
 
205
205
  # The type of alert. This must be a valid alert type.
@@ -214,11 +214,8 @@ module Orb
214
214
  USAGE_EXCEEDED = :usage_exceeded
215
215
  COST_EXCEEDED = :cost_exceeded
216
216
 
217
- finalize!
218
-
219
- # @!parse
220
- # # @return [Array<Symbol>]
221
- # def self.values; end
217
+ # @!method self.values
218
+ # @return [Array<Symbol>]
222
219
  end
223
220
  end
224
221
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Alerts#create_for_customer
6
6
  class AlertCreateForCustomerParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute currency
@@ -28,15 +27,14 @@ module Orb
28
27
  -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertCreateForCustomerParams::Threshold] },
29
28
  nil?: true
30
29
 
31
- # @!parse
32
- # # @param currency [String]
33
- # # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type]
34
- # # @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil]
35
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
36
- # #
37
- # def initialize(currency:, type:, thresholds: nil, request_options: {}, **) = super
38
-
39
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
30
+ # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
31
+ # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
32
+ #
33
+ # @param type [Symbol, Orb::Models::AlertCreateForCustomerParams::Type] The type of alert to create. This must be a valid alert type.
34
+ #
35
+ # @param thresholds [Array<Orb::Models::AlertCreateForCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
36
+ #
37
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
40
38
 
41
39
  # The type of alert to create. This must be a valid alert type.
42
40
  module Type
@@ -46,11 +44,8 @@ module Orb
46
44
  CREDIT_BALANCE_DROPPED = :credit_balance_dropped
47
45
  CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
48
46
 
49
- finalize!
50
-
51
- # @!parse
52
- # # @return [Array<Symbol>]
53
- # def self.values; end
47
+ # @!method self.values
48
+ # @return [Array<Symbol>]
54
49
  end
55
50
 
56
51
  class Threshold < Orb::Internal::Type::BaseModel
@@ -62,15 +57,15 @@ module Orb
62
57
  # @return [Float]
63
58
  required :value, Float
64
59
 
65
- # @!parse
66
- # # Thresholds are used to define the conditions under which an alert will be
67
- # # triggered.
68
- # #
69
- # # @param value [Float]
70
- # #
71
- # def initialize(value:, **) = super
72
-
73
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
60
+ # @!method initialize(value:)
61
+ # Some parameter documentations has been truncated, see
62
+ # {Orb::Models::AlertCreateForCustomerParams::Threshold} for more details.
63
+ #
64
+ # Thresholds are used to define the conditions under which an alert will be
65
+ # triggered.
66
+ #
67
+ # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
68
+ # ...
74
69
  end
75
70
  end
76
71
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Alerts#create_for_external_customer
6
6
  class AlertCreateForExternalCustomerParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute currency
@@ -28,15 +27,14 @@ module Orb
28
27
  -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertCreateForExternalCustomerParams::Threshold] },
29
28
  nil?: true
30
29
 
31
- # @!parse
32
- # # @param currency [String]
33
- # # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type]
34
- # # @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil]
35
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
36
- # #
37
- # def initialize(currency:, type:, thresholds: nil, request_options: {}, **) = super
38
-
39
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
30
+ # @!method initialize(currency:, type:, thresholds: nil, request_options: {})
31
+ # @param currency [String] The case sensitive currency or custom pricing unit to use for this alert.
32
+ #
33
+ # @param type [Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type] The type of alert to create. This must be a valid alert type.
34
+ #
35
+ # @param thresholds [Array<Orb::Models::AlertCreateForExternalCustomerParams::Threshold>, nil] The thresholds that define the values at which the alert will be triggered.
36
+ #
37
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
40
38
 
41
39
  # The type of alert to create. This must be a valid alert type.
42
40
  module Type
@@ -46,11 +44,8 @@ module Orb
46
44
  CREDIT_BALANCE_DROPPED = :credit_balance_dropped
47
45
  CREDIT_BALANCE_RECOVERED = :credit_balance_recovered
48
46
 
49
- finalize!
50
-
51
- # @!parse
52
- # # @return [Array<Symbol>]
53
- # def self.values; end
47
+ # @!method self.values
48
+ # @return [Array<Symbol>]
54
49
  end
55
50
 
56
51
  class Threshold < Orb::Internal::Type::BaseModel
@@ -62,15 +57,15 @@ module Orb
62
57
  # @return [Float]
63
58
  required :value, Float
64
59
 
65
- # @!parse
66
- # # Thresholds are used to define the conditions under which an alert will be
67
- # # triggered.
68
- # #
69
- # # @param value [Float]
70
- # #
71
- # def initialize(value:, **) = super
72
-
73
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
60
+ # @!method initialize(value:)
61
+ # Some parameter documentations has been truncated, see
62
+ # {Orb::Models::AlertCreateForExternalCustomerParams::Threshold} for more details.
63
+ #
64
+ # Thresholds are used to define the conditions under which an alert will be
65
+ # triggered.
66
+ #
67
+ # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
68
+ # ...
74
69
  end
75
70
  end
76
71
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Alerts#create_for_subscription
6
6
  class AlertCreateForSubscriptionParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute thresholds
@@ -27,15 +26,14 @@ module Orb
27
26
  # @return [String, nil]
28
27
  optional :metric_id, String, nil?: true
29
28
 
30
- # @!parse
31
- # # @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>]
32
- # # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type]
33
- # # @param metric_id [String, nil]
34
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
35
- # #
36
- # def initialize(thresholds:, type:, metric_id: nil, request_options: {}, **) = super
37
-
38
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
29
+ # @!method initialize(thresholds:, type:, metric_id: nil, request_options: {})
30
+ # @param thresholds [Array<Orb::Models::AlertCreateForSubscriptionParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
31
+ #
32
+ # @param type [Symbol, Orb::Models::AlertCreateForSubscriptionParams::Type] The type of alert to create. This must be a valid alert type.
33
+ #
34
+ # @param metric_id [String, nil] The metric to track usage for.
35
+ #
36
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
39
37
 
40
38
  class Threshold < Orb::Internal::Type::BaseModel
41
39
  # @!attribute value
@@ -46,15 +44,15 @@ module Orb
46
44
  # @return [Float]
47
45
  required :value, Float
48
46
 
49
- # @!parse
50
- # # Thresholds are used to define the conditions under which an alert will be
51
- # # triggered.
52
- # #
53
- # # @param value [Float]
54
- # #
55
- # def initialize(value:, **) = super
56
-
57
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
47
+ # @!method initialize(value:)
48
+ # Some parameter documentations has been truncated, see
49
+ # {Orb::Models::AlertCreateForSubscriptionParams::Threshold} for more details.
50
+ #
51
+ # Thresholds are used to define the conditions under which an alert will be
52
+ # triggered.
53
+ #
54
+ # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
55
+ # ...
58
56
  end
59
57
 
60
58
  # The type of alert to create. This must be a valid alert type.
@@ -64,11 +62,8 @@ module Orb
64
62
  USAGE_EXCEEDED = :usage_exceeded
65
63
  COST_EXCEEDED = :cost_exceeded
66
64
 
67
- finalize!
68
-
69
- # @!parse
70
- # # @return [Array<Symbol>]
71
- # def self.values; end
65
+ # @!method self.values
66
+ # @return [Array<Symbol>]
72
67
  end
73
68
  end
74
69
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Alerts#disable
6
6
  class AlertDisableParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute subscription_id
@@ -14,13 +13,10 @@ module Orb
14
13
  # @return [String, nil]
15
14
  optional :subscription_id, String, nil?: true
16
15
 
17
- # @!parse
18
- # # @param subscription_id [String, nil]
19
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
20
- # #
21
- # def initialize(subscription_id: nil, request_options: {}, **) = super
22
-
23
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
16
+ # @!method initialize(subscription_id: nil, request_options: {})
17
+ # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
18
+ #
19
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
24
20
  end
25
21
  end
26
22
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Alerts#enable
6
6
  class AlertEnableParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute subscription_id
@@ -14,13 +13,10 @@ module Orb
14
13
  # @return [String, nil]
15
14
  optional :subscription_id, String, nil?: true
16
15
 
17
- # @!parse
18
- # # @param subscription_id [String, nil]
19
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
20
- # #
21
- # def initialize(subscription_id: nil, request_options: {}, **) = super
22
-
23
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
16
+ # @!method initialize(subscription_id: nil, request_options: {})
17
+ # @param subscription_id [String, nil] Used to update the status of a plan alert scoped to this subscription_id
18
+ #
19
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
24
20
  end
25
21
  end
26
22
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Alerts#list
6
6
  class AlertListParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute created_at_gt
@@ -47,51 +46,42 @@ module Orb
47
46
  # @return [String, nil]
48
47
  optional :external_customer_id, String, nil?: true
49
48
 
50
- # @!attribute [r] limit
49
+ # @!attribute limit
51
50
  # The number of items to fetch. Defaults to 20.
52
51
  #
53
52
  # @return [Integer, nil]
54
53
  optional :limit, Integer
55
54
 
56
- # @!parse
57
- # # @return [Integer]
58
- # attr_writer :limit
59
-
60
55
  # @!attribute subscription_id
61
56
  # Fetch alerts scoped to this subscription_id
62
57
  #
63
58
  # @return [String, nil]
64
59
  optional :subscription_id, String, nil?: true
65
60
 
66
- # @!parse
67
- # # @param created_at_gt [Time, nil]
68
- # # @param created_at_gte [Time, nil]
69
- # # @param created_at_lt [Time, nil]
70
- # # @param created_at_lte [Time, nil]
71
- # # @param cursor [String, nil]
72
- # # @param customer_id [String, nil]
73
- # # @param external_customer_id [String, nil]
74
- # # @param limit [Integer]
75
- # # @param subscription_id [String, nil]
76
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
77
- # #
78
- # def initialize(
79
- # created_at_gt: nil,
80
- # created_at_gte: nil,
81
- # created_at_lt: nil,
82
- # created_at_lte: nil,
83
- # cursor: nil,
84
- # customer_id: nil,
85
- # external_customer_id: nil,
86
- # limit: nil,
87
- # subscription_id: nil,
88
- # request_options: {},
89
- # **
90
- # )
91
- # super
92
- # end
93
-
94
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
61
+ # @!method initialize(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: {})
62
+ # Some parameter documentations has been truncated, see
63
+ # {Orb::Models::AlertListParams} for more details.
64
+ #
65
+ # @param created_at_gt [Time, nil]
66
+ #
67
+ # @param created_at_gte [Time, nil]
68
+ #
69
+ # @param created_at_lt [Time, nil]
70
+ #
71
+ # @param created_at_lte [Time, nil]
72
+ #
73
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
74
+ # ...
75
+ #
76
+ # @param customer_id [String, nil] Fetch alerts scoped to this customer_id
77
+ #
78
+ # @param external_customer_id [String, nil] Fetch alerts scoped to this external_customer_id
79
+ #
80
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
81
+ #
82
+ # @param subscription_id [String, nil] Fetch alerts scoped to this subscription_id
83
+ #
84
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
95
85
  end
96
86
  end
97
87
  end
@@ -4,16 +4,11 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Alerts#retrieve
6
6
  class AlertRetrieveParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
- # @!parse
12
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
13
- # #
14
- # def initialize(request_options: {}, **) = super
15
-
16
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
17
12
  end
18
13
  end
19
14
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Alerts#update
6
6
  class AlertUpdateParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute thresholds
@@ -14,13 +13,10 @@ module Orb
14
13
  # @return [Array<Orb::Models::AlertUpdateParams::Threshold>]
15
14
  required :thresholds, -> { Orb::Internal::Type::ArrayOf[Orb::Models::AlertUpdateParams::Threshold] }
16
15
 
17
- # @!parse
18
- # # @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>]
19
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
20
- # #
21
- # def initialize(thresholds:, request_options: {}, **) = super
22
-
23
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
16
+ # @!method initialize(thresholds:, request_options: {})
17
+ # @param thresholds [Array<Orb::Models::AlertUpdateParams::Threshold>] The thresholds that define the values at which the alert will be triggered.
18
+ #
19
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
24
20
 
25
21
  class Threshold < Orb::Internal::Type::BaseModel
26
22
  # @!attribute value
@@ -31,15 +27,15 @@ module Orb
31
27
  # @return [Float]
32
28
  required :value, Float
33
29
 
34
- # @!parse
35
- # # Thresholds are used to define the conditions under which an alert will be
36
- # # triggered.
37
- # #
38
- # # @param value [Float]
39
- # #
40
- # def initialize(value:, **) = super
41
-
42
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
30
+ # @!method initialize(value:)
31
+ # Some parameter documentations has been truncated, see
32
+ # {Orb::Models::AlertUpdateParams::Threshold} for more details.
33
+ #
34
+ # Thresholds are used to define the conditions under which an alert will be
35
+ # triggered.
36
+ #
37
+ # @param value [Float] The value at which an alert will fire. For credit balance alerts, the alert will
38
+ # ...
43
39
  end
44
40
  end
45
41
  end