orb-billing 0.3.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (592) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +35 -0
  3. data/README.md +3 -3
  4. data/lib/orb/errors.rb +1 -1
  5. data/lib/orb/file_part.rb +2 -2
  6. data/lib/orb/internal/transport/base_client.rb +74 -5
  7. data/lib/orb/internal/transport/pooled_net_requester.rb +14 -0
  8. data/lib/orb/internal/type/array_of.rb +1 -1
  9. data/lib/orb/internal/type/base_model.rb +62 -30
  10. data/lib/orb/internal/type/converter.rb +18 -0
  11. data/lib/orb/internal/type/enum.rb +4 -3
  12. data/lib/orb/internal/type/hash_of.rb +1 -1
  13. data/lib/orb/internal/type/request_parameters.rb +4 -4
  14. data/lib/orb/internal/type/union.rb +5 -4
  15. data/lib/orb/internal/util.rb +57 -1
  16. data/lib/orb/internal.rb +6 -0
  17. data/lib/orb/models/alert.rb +29 -32
  18. data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
  19. data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
  20. data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
  21. data/lib/orb/models/alert_list_params.rb +0 -1
  22. data/lib/orb/models/alert_update_params.rb +4 -5
  23. data/lib/orb/models/amount_discount.rb +6 -7
  24. data/lib/orb/models/billable_metric.rb +9 -11
  25. data/lib/orb/models/coupon.rb +13 -12
  26. data/lib/orb/models/coupon_create_params.rb +12 -8
  27. data/lib/orb/models/coupon_list_params.rb +0 -2
  28. data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
  29. data/lib/orb/models/credit_note.rb +48 -46
  30. data/lib/orb/models/credit_note_create_params.rb +6 -6
  31. data/lib/orb/models/credit_note_list_params.rb +0 -1
  32. data/lib/orb/models/customer.rb +54 -61
  33. data/lib/orb/models/customer_create_params.rb +50 -53
  34. data/lib/orb/models/customer_list_params.rb +0 -1
  35. data/lib/orb/models/customer_update_by_external_id_params.rb +50 -53
  36. data/lib/orb/models/customer_update_params.rb +50 -51
  37. data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
  38. data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
  39. data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
  40. data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
  41. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
  42. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
  43. data/lib/orb/models/customers/cost_list_params.rb +3 -4
  44. data/lib/orb/models/customers/cost_list_response.rb +3 -3
  45. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
  46. data/lib/orb/models/customers/credit_list_params.rb +0 -2
  47. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
  48. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +14 -7
  49. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
  50. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +14 -7
  51. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
  52. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +14 -7
  53. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
  54. data/lib/orb/models/customers/credits/ledger_list_response.rb +14 -7
  55. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
  56. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
  57. data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
  58. data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
  59. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
  60. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
  61. data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
  62. data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
  63. data/lib/orb/models/dimensional_price_group.rb +1 -3
  64. data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
  65. data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
  66. data/lib/orb/models/dimensional_price_groups.rb +6 -6
  67. data/lib/orb/models/discount.rb +11 -5
  68. data/lib/orb/models/evaluate_price_group.rb +5 -1
  69. data/lib/orb/models/event_ingest_params.rb +4 -9
  70. data/lib/orb/models/event_ingest_response.rb +0 -3
  71. data/lib/orb/models/event_search_params.rb +0 -3
  72. data/lib/orb/models/event_search_response.rb +0 -4
  73. data/lib/orb/models/event_update_params.rb +0 -3
  74. data/lib/orb/models/events/backfill_close_response.rb +0 -4
  75. data/lib/orb/models/events/backfill_create_params.rb +0 -7
  76. data/lib/orb/models/events/backfill_create_response.rb +0 -4
  77. data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
  78. data/lib/orb/models/events/backfill_list_params.rb +0 -1
  79. data/lib/orb/models/events/backfill_list_response.rb +0 -4
  80. data/lib/orb/models/events/backfill_revert_response.rb +0 -4
  81. data/lib/orb/models/events/event_volumes.rb +3 -3
  82. data/lib/orb/models/events/volume_list_params.rb +0 -3
  83. data/lib/orb/models/invoice.rb +179 -202
  84. data/lib/orb/models/invoice_create_params.rb +14 -21
  85. data/lib/orb/models/invoice_fetch_upcoming_response.rb +31 -54
  86. data/lib/orb/models/invoice_issue_params.rb +0 -1
  87. data/lib/orb/models/invoice_level_discount.rb +8 -4
  88. data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
  89. data/lib/orb/models/invoice_line_item_create_response.rb +28 -26
  90. data/lib/orb/models/invoice_list_params.rb +6 -10
  91. data/lib/orb/models/invoice_update_params.rb +0 -1
  92. data/lib/orb/models/item.rb +7 -8
  93. data/lib/orb/models/item_list_params.rb +0 -1
  94. data/lib/orb/models/item_update_params.rb +7 -7
  95. data/lib/orb/models/metric_create_params.rb +0 -1
  96. data/lib/orb/models/metric_list_params.rb +0 -1
  97. data/lib/orb/models/metric_update_params.rb +0 -1
  98. data/lib/orb/models/percentage_discount.rb +6 -8
  99. data/lib/orb/models/plan.rb +90 -103
  100. data/lib/orb/models/plan_create_params.rb +759 -800
  101. data/lib/orb/models/plan_list_params.rb +3 -4
  102. data/lib/orb/models/plan_update_params.rb +0 -2
  103. data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
  104. data/lib/orb/models/price.rb +1706 -1724
  105. data/lib/orb/models/price_create_params.rb +75 -84
  106. data/lib/orb/models/price_evaluate_params.rb +0 -2
  107. data/lib/orb/models/price_evaluate_response.rb +3 -3
  108. data/lib/orb/models/price_list_params.rb +0 -1
  109. data/lib/orb/models/price_update_params.rb +0 -1
  110. data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
  111. data/lib/orb/models/subscription.rb +108 -122
  112. data/lib/orb/models/subscription_cancel_params.rb +3 -5
  113. data/lib/orb/models/subscription_cancel_response.rb +43 -57
  114. data/lib/orb/models/subscription_change_apply_response.rb +43 -58
  115. data/lib/orb/models/subscription_change_cancel_response.rb +43 -58
  116. data/lib/orb/models/subscription_change_retrieve_response.rb +43 -58
  117. data/lib/orb/models/subscription_create_params.rb +1953 -1815
  118. data/lib/orb/models/subscription_create_response.rb +43 -57
  119. data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
  120. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
  121. data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
  122. data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
  123. data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
  124. data/lib/orb/models/subscription_list_params.rb +3 -4
  125. data/lib/orb/models/subscription_price_intervals_params.rb +1194 -1017
  126. data/lib/orb/models/subscription_price_intervals_response.rb +43 -57
  127. data/lib/orb/models/subscription_schedule_plan_change_params.rb +1994 -1791
  128. data/lib/orb/models/subscription_schedule_plan_change_response.rb +43 -57
  129. data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
  130. data/lib/orb/models/subscription_trigger_phase_response.rb +43 -57
  131. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +43 -57
  132. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +43 -57
  133. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +43 -57
  134. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
  135. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +43 -57
  136. data/lib/orb/models/subscription_update_params.rb +0 -5
  137. data/lib/orb/models/subscription_update_trial_params.rb +8 -6
  138. data/lib/orb/models/subscription_update_trial_response.rb +43 -57
  139. data/lib/orb/models/subscription_usage.rb +55 -39
  140. data/lib/orb/models/subscriptions.rb +6 -6
  141. data/lib/orb/models/trial_discount.rb +6 -7
  142. data/lib/orb/models/usage_discount.rb +6 -8
  143. data/lib/orb/models.rb +24 -0
  144. data/lib/orb/request_options.rb +4 -0
  145. data/lib/orb/resources/alerts.rb +30 -31
  146. data/lib/orb/resources/coupons/subscriptions.rb +3 -4
  147. data/lib/orb/resources/coupons.rb +11 -21
  148. data/lib/orb/resources/credit_notes.rb +10 -11
  149. data/lib/orb/resources/customers/balance_transactions.rb +3 -4
  150. data/lib/orb/resources/customers/costs.rb +4 -6
  151. data/lib/orb/resources/customers/credits/ledger.rb +14 -33
  152. data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
  153. data/lib/orb/resources/customers/credits.rb +2 -6
  154. data/lib/orb/resources/customers.rb +40 -67
  155. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
  156. data/lib/orb/resources/dimensional_price_groups.rb +8 -10
  157. data/lib/orb/resources/events/backfills.rb +2 -10
  158. data/lib/orb/resources/events/volume.rb +3 -6
  159. data/lib/orb/resources/events.rb +4 -12
  160. data/lib/orb/resources/invoice_line_items.rb +1 -2
  161. data/lib/orb/resources/invoices.rb +26 -43
  162. data/lib/orb/resources/items.rb +12 -13
  163. data/lib/orb/resources/metrics.rb +11 -14
  164. data/lib/orb/resources/plans/external_plan_id.rb +5 -7
  165. data/lib/orb/resources/plans.rb +14 -23
  166. data/lib/orb/resources/prices/external_price_id.rb +5 -6
  167. data/lib/orb/resources/prices.rb +25 -35
  168. data/lib/orb/resources/subscription_changes.rb +1 -1
  169. data/lib/orb/resources/subscriptions.rb +49 -107
  170. data/lib/orb/version.rb +1 -1
  171. data/lib/orb.rb +3 -0
  172. data/rbi/orb/client.rbi +5 -4
  173. data/rbi/orb/errors.rbi +59 -28
  174. data/rbi/orb/file_part.rbi +9 -6
  175. data/rbi/orb/internal/page.rbi +20 -6
  176. data/rbi/orb/internal/transport/base_client.rbi +159 -78
  177. data/rbi/orb/internal/transport/pooled_net_requester.rbi +27 -13
  178. data/rbi/orb/internal/type/array_of.rbi +42 -34
  179. data/rbi/orb/internal/type/base_model.rbi +144 -69
  180. data/rbi/orb/internal/type/base_page.rbi +12 -8
  181. data/rbi/orb/internal/type/boolean.rbi +16 -10
  182. data/rbi/orb/internal/type/converter.rbi +68 -31
  183. data/rbi/orb/internal/type/enum.rbi +28 -15
  184. data/rbi/orb/internal/type/file_input.rbi +12 -10
  185. data/rbi/orb/internal/type/hash_of.rbi +34 -24
  186. data/rbi/orb/internal/type/request_parameters.rbi +12 -4
  187. data/rbi/orb/internal/type/union.rbi +61 -25
  188. data/rbi/orb/internal/type/unknown.rbi +20 -12
  189. data/rbi/orb/internal/util.rbi +232 -90
  190. data/rbi/orb/internal.rbi +2 -0
  191. data/rbi/orb/models/alert.rbi +114 -70
  192. data/rbi/orb/models/alert_create_for_customer_params.rbi +69 -27
  193. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +80 -29
  194. data/rbi/orb/models/alert_create_for_subscription_params.rbi +62 -26
  195. data/rbi/orb/models/alert_disable_params.rbi +18 -6
  196. data/rbi/orb/models/alert_enable_params.rbi +18 -6
  197. data/rbi/orb/models/alert_list_params.rbi +24 -20
  198. data/rbi/orb/models/alert_retrieve_params.rbi +11 -4
  199. data/rbi/orb/models/alert_update_params.rbi +29 -14
  200. data/rbi/orb/models/amount_discount.rbi +29 -19
  201. data/rbi/orb/models/billable_metric.rbi +34 -26
  202. data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
  203. data/rbi/orb/models/coupon.rbi +28 -20
  204. data/rbi/orb/models/coupon_archive_params.rbi +11 -4
  205. data/rbi/orb/models/coupon_create_params.rbi +85 -38
  206. data/rbi/orb/models/coupon_fetch_params.rbi +11 -4
  207. data/rbi/orb/models/coupon_list_params.rbi +19 -15
  208. data/rbi/orb/models/coupons/subscription_list_params.rbi +19 -6
  209. data/rbi/orb/models/credit_note.rbi +329 -158
  210. data/rbi/orb/models/credit_note_create_params.rbi +64 -29
  211. data/rbi/orb/models/credit_note_fetch_params.rbi +13 -4
  212. data/rbi/orb/models/credit_note_list_params.rbi +23 -17
  213. data/rbi/orb/models/customer.rbi +461 -329
  214. data/rbi/orb/models/customer_create_params.rbi +713 -325
  215. data/rbi/orb/models/customer_delete_params.rbi +13 -4
  216. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +13 -4
  217. data/rbi/orb/models/customer_fetch_params.rbi +11 -4
  218. data/rbi/orb/models/customer_list_params.rbi +21 -17
  219. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +16 -4
  220. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +16 -4
  221. data/rbi/orb/models/customer_update_by_external_id_params.rbi +1193 -336
  222. data/rbi/orb/models/customer_update_params.rbi +712 -324
  223. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +56 -21
  224. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +172 -61
  225. data/rbi/orb/models/customers/balance_transaction_list_params.rbi +26 -17
  226. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +182 -59
  227. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +62 -22
  228. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +180 -124
  229. data/rbi/orb/models/customers/cost_list_params.rbi +48 -22
  230. data/rbi/orb/models/customers/cost_list_response.rbi +172 -123
  231. data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +24 -15
  232. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +54 -22
  233. data/rbi/orb/models/customers/credit_list_params.rbi +21 -15
  234. data/rbi/orb/models/customers/credit_list_response.rbi +50 -21
  235. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +118 -68
  236. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +755 -434
  237. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +129 -59
  238. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +812 -425
  239. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +108 -44
  240. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +793 -432
  241. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +129 -40
  242. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +847 -389
  243. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +86 -53
  244. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +77 -48
  245. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +96 -45
  246. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +95 -43
  247. data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +22 -6
  248. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +21 -5
  249. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +15 -5
  250. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +82 -49
  251. data/rbi/orb/models/customers/credits/top_up_list_params.rbi +15 -5
  252. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +96 -43
  253. data/rbi/orb/models/dimensional_price_group.rbi +21 -15
  254. data/rbi/orb/models/dimensional_price_group_create_params.rbi +22 -16
  255. data/rbi/orb/models/dimensional_price_group_list_params.rbi +19 -6
  256. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +16 -4
  257. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +15 -8
  258. data/rbi/orb/models/dimensional_price_groups.rbi +21 -13
  259. data/rbi/orb/models/discount.rbi +11 -5
  260. data/rbi/orb/models/evaluate_price_group.rbi +29 -12
  261. data/rbi/orb/models/event_deprecate_params.rbi +13 -4
  262. data/rbi/orb/models/event_deprecate_response.rbi +11 -3
  263. data/rbi/orb/models/event_ingest_params.rbi +41 -31
  264. data/rbi/orb/models/event_ingest_response.rbi +78 -23
  265. data/rbi/orb/models/event_search_params.rbi +18 -14
  266. data/rbi/orb/models/event_search_response.rbi +42 -21
  267. data/rbi/orb/models/event_update_params.rbi +20 -16
  268. data/rbi/orb/models/event_update_response.rbi +11 -3
  269. data/rbi/orb/models/events/backfill_close_params.rbi +13 -9
  270. data/rbi/orb/models/events/backfill_close_response.rbi +70 -29
  271. data/rbi/orb/models/events/backfill_create_params.rbi +24 -18
  272. data/rbi/orb/models/events/backfill_create_response.rbi +69 -29
  273. data/rbi/orb/models/events/backfill_fetch_params.rbi +13 -9
  274. data/rbi/orb/models/events/backfill_fetch_response.rbi +70 -29
  275. data/rbi/orb/models/events/backfill_list_params.rbi +19 -6
  276. data/rbi/orb/models/events/backfill_list_response.rbi +68 -28
  277. data/rbi/orb/models/events/backfill_revert_params.rbi +13 -9
  278. data/rbi/orb/models/events/backfill_revert_response.rbi +69 -29
  279. data/rbi/orb/models/events/event_volumes.rbi +38 -10
  280. data/rbi/orb/models/events/volume_list_params.rbi +21 -15
  281. data/rbi/orb/models/invoice.rbi +1411 -805
  282. data/rbi/orb/models/invoice_create_params.rbi +107 -69
  283. data/rbi/orb/models/invoice_fetch_params.rbi +11 -4
  284. data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +18 -5
  285. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +2187 -876
  286. data/rbi/orb/models/invoice_issue_params.rbi +17 -5
  287. data/rbi/orb/models/invoice_level_discount.rbi +11 -4
  288. data/rbi/orb/models/invoice_line_item_create_params.rbi +23 -17
  289. data/rbi/orb/models/invoice_line_item_create_response.rbi +675 -376
  290. data/rbi/orb/models/invoice_list_params.rbi +68 -47
  291. data/rbi/orb/models/invoice_mark_paid_params.rbi +20 -14
  292. data/rbi/orb/models/invoice_pay_params.rbi +11 -4
  293. data/rbi/orb/models/invoice_update_params.rbi +16 -10
  294. data/rbi/orb/models/invoice_void_params.rbi +11 -4
  295. data/rbi/orb/models/item.rbi +90 -39
  296. data/rbi/orb/models/item_create_params.rbi +15 -5
  297. data/rbi/orb/models/item_fetch_params.rbi +11 -4
  298. data/rbi/orb/models/item_list_params.rbi +17 -6
  299. data/rbi/orb/models/item_update_params.rbi +86 -39
  300. data/rbi/orb/models/metric_create_params.rbi +20 -16
  301. data/rbi/orb/models/metric_fetch_params.rbi +11 -4
  302. data/rbi/orb/models/metric_list_params.rbi +21 -17
  303. data/rbi/orb/models/metric_update_params.rbi +16 -10
  304. data/rbi/orb/models/pagination_metadata.rbi +17 -4
  305. data/rbi/orb/models/percentage_discount.rbi +33 -19
  306. data/rbi/orb/models/plan.rbi +532 -365
  307. data/rbi/orb/models/plan_create_params.rbi +5295 -2870
  308. data/rbi/orb/models/plan_fetch_params.rbi +11 -4
  309. data/rbi/orb/models/plan_list_params.rbi +35 -27
  310. data/rbi/orb/models/plan_update_params.rbi +17 -13
  311. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +13 -9
  312. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +22 -13
  313. data/rbi/orb/models/price.rbi +11332 -5033
  314. data/rbi/orb/models/price_create_params.rbi +583 -245
  315. data/rbi/orb/models/price_evaluate_params.rbi +21 -17
  316. data/rbi/orb/models/price_evaluate_response.rbi +14 -6
  317. data/rbi/orb/models/price_fetch_params.rbi +11 -4
  318. data/rbi/orb/models/price_list_params.rbi +17 -6
  319. data/rbi/orb/models/price_update_params.rbi +16 -10
  320. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +15 -8
  321. data/rbi/orb/models/prices/external_price_id_update_params.rbi +21 -10
  322. data/rbi/orb/models/subscription.rbi +668 -420
  323. data/rbi/orb/models/subscription_cancel_params.rbi +47 -22
  324. data/rbi/orb/models/subscription_cancel_response.rbi +817 -438
  325. data/rbi/orb/models/subscription_change_apply_params.rbi +19 -13
  326. data/rbi/orb/models/subscription_change_apply_response.rbi +906 -505
  327. data/rbi/orb/models/subscription_change_cancel_params.rbi +13 -4
  328. data/rbi/orb/models/subscription_change_cancel_response.rbi +906 -516
  329. data/rbi/orb/models/subscription_change_retrieve_params.rbi +13 -4
  330. data/rbi/orb/models/subscription_change_retrieve_response.rbi +903 -524
  331. data/rbi/orb/models/subscription_create_params.rbi +10096 -6746
  332. data/rbi/orb/models/subscription_create_response.rbi +817 -438
  333. data/rbi/orb/models/subscription_fetch_costs_params.rbi +50 -22
  334. data/rbi/orb/models/subscription_fetch_costs_response.rbi +172 -123
  335. data/rbi/orb/models/subscription_fetch_params.rbi +13 -4
  336. data/rbi/orb/models/subscription_fetch_schedule_params.rbi +23 -17
  337. data/rbi/orb/models/subscription_fetch_schedule_response.rbi +45 -19
  338. data/rbi/orb/models/subscription_fetch_usage_params.rbi +84 -34
  339. data/rbi/orb/models/subscription_list_params.rbi +42 -28
  340. data/rbi/orb/models/subscription_price_intervals_params.rbi +5798 -3823
  341. data/rbi/orb/models/subscription_price_intervals_response.rbi +840 -453
  342. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +9676 -6922
  343. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +838 -467
  344. data/rbi/orb/models/subscription_trigger_phase_params.rbi +19 -13
  345. data/rbi/orb/models/subscription_trigger_phase_response.rbi +832 -448
  346. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +16 -4
  347. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +839 -467
  348. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +22 -5
  349. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +815 -504
  350. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +16 -4
  351. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +828 -497
  352. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +63 -26
  353. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +839 -467
  354. data/rbi/orb/models/subscription_update_params.rbi +22 -16
  355. data/rbi/orb/models/subscription_update_trial_params.rbi +60 -19
  356. data/rbi/orb/models/subscription_update_trial_response.rbi +832 -447
  357. data/rbi/orb/models/subscription_usage.rbi +325 -121
  358. data/rbi/orb/models/subscriptions.rbi +19 -11
  359. data/rbi/orb/models/top_level_ping_params.rbi +11 -4
  360. data/rbi/orb/models/top_level_ping_response.rbi +10 -3
  361. data/rbi/orb/models/trial_discount.rbi +30 -20
  362. data/rbi/orb/models/usage_discount.rbi +29 -19
  363. data/rbi/orb/models.rbi +22 -11
  364. data/rbi/orb/request_options.rbi +12 -6
  365. data/rbi/orb/resources/alerts.rbi +61 -40
  366. data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
  367. data/rbi/orb/resources/coupons.rbi +33 -18
  368. data/rbi/orb/resources/credit_notes.rbi +22 -13
  369. data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
  370. data/rbi/orb/resources/customers/costs.rbi +18 -11
  371. data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
  372. data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
  373. data/rbi/orb/resources/customers/credits.rbi +16 -7
  374. data/rbi/orb/resources/customers.rbi +137 -72
  375. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
  376. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
  377. data/rbi/orb/resources/events/backfills.rbi +35 -17
  378. data/rbi/orb/resources/events/volume.rbi +7 -5
  379. data/rbi/orb/resources/events.rbi +26 -16
  380. data/rbi/orb/resources/invoice_line_items.rbi +7 -5
  381. data/rbi/orb/resources/invoices.rbi +72 -41
  382. data/rbi/orb/resources/items.rbi +40 -13
  383. data/rbi/orb/resources/metrics.rbi +25 -15
  384. data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
  385. data/rbi/orb/resources/plans.rbi +57 -47
  386. data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
  387. data/rbi/orb/resources/prices.rbi +176 -156
  388. data/rbi/orb/resources/subscription_changes.rbi +19 -11
  389. data/rbi/orb/resources/subscriptions.rbi +200 -114
  390. data/rbi/orb/resources/top_level.rbi +9 -3
  391. data/sig/orb/internal/page.rbs +0 -2
  392. data/sig/orb/internal/transport/base_client.rbs +16 -1
  393. data/sig/orb/internal/transport/pooled_net_requester.rbs +2 -0
  394. data/sig/orb/internal/type/base_model.rbs +11 -5
  395. data/sig/orb/internal/type/base_page.rbs +1 -1
  396. data/sig/orb/internal/type/converter.rbs +2 -0
  397. data/sig/orb/internal/type/enum.rbs +1 -0
  398. data/sig/orb/internal/type/request_parameters.rbs +3 -1
  399. data/sig/orb/internal/type/union.rbs +1 -0
  400. data/sig/orb/internal/util.rbs +13 -0
  401. data/sig/orb/internal.rbs +2 -0
  402. data/sig/orb/models/alert.rbs +19 -31
  403. data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
  404. data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
  405. data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
  406. data/sig/orb/models/alert_disable_params.rbs +0 -2
  407. data/sig/orb/models/alert_enable_params.rbs +0 -2
  408. data/sig/orb/models/alert_list_params.rbs +0 -2
  409. data/sig/orb/models/alert_retrieve_params.rbs +0 -2
  410. data/sig/orb/models/alert_update_params.rbs +3 -7
  411. data/sig/orb/models/amount_discount.rbs +4 -6
  412. data/sig/orb/models/billable_metric.rbs +7 -9
  413. data/sig/orb/models/coupon.rbs +5 -8
  414. data/sig/orb/models/coupon_archive_params.rbs +0 -2
  415. data/sig/orb/models/coupon_create_params.rbs +3 -9
  416. data/sig/orb/models/coupon_fetch_params.rbs +0 -2
  417. data/sig/orb/models/coupon_list_params.rbs +0 -2
  418. data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
  419. data/sig/orb/models/credit_note.rbs +48 -66
  420. data/sig/orb/models/credit_note_create_params.rbs +3 -7
  421. data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
  422. data/sig/orb/models/credit_note_list_params.rbs +0 -2
  423. data/sig/orb/models/customer.rbs +43 -63
  424. data/sig/orb/models/customer_create_params.rbs +32 -52
  425. data/sig/orb/models/customer_delete_params.rbs +0 -2
  426. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
  427. data/sig/orb/models/customer_fetch_params.rbs +0 -2
  428. data/sig/orb/models/customer_list_params.rbs +0 -2
  429. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
  430. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
  431. data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
  432. data/sig/orb/models/customer_update_params.rbs +32 -52
  433. data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
  434. data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
  435. data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
  436. data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
  437. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
  438. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
  439. data/sig/orb/models/customers/cost_list_params.rbs +0 -2
  440. data/sig/orb/models/customers/cost_list_response.rbs +0 -6
  441. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
  442. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
  443. data/sig/orb/models/customers/credit_list_params.rbs +0 -2
  444. data/sig/orb/models/customers/credit_list_response.rbs +0 -2
  445. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
  446. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
  447. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
  448. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
  449. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
  450. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
  451. data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
  452. data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
  453. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
  454. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
  455. data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
  456. data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
  457. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
  458. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
  459. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
  460. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
  461. data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
  462. data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
  463. data/sig/orb/models/dimensional_price_group.rbs +0 -2
  464. data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
  465. data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
  466. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
  467. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
  468. data/sig/orb/models/dimensional_price_groups.rbs +6 -8
  469. data/sig/orb/models/discount.rbs +5 -5
  470. data/sig/orb/models/evaluate_price_group.rbs +4 -6
  471. data/sig/orb/models/event_deprecate_params.rbs +0 -2
  472. data/sig/orb/models/event_deprecate_response.rbs +0 -2
  473. data/sig/orb/models/event_ingest_params.rbs +3 -7
  474. data/sig/orb/models/event_ingest_response.rbs +0 -6
  475. data/sig/orb/models/event_search_params.rbs +0 -2
  476. data/sig/orb/models/event_search_response.rbs +0 -4
  477. data/sig/orb/models/event_update_params.rbs +0 -2
  478. data/sig/orb/models/event_update_response.rbs +0 -2
  479. data/sig/orb/models/events/backfill_close_params.rbs +0 -2
  480. data/sig/orb/models/events/backfill_close_response.rbs +0 -2
  481. data/sig/orb/models/events/backfill_create_params.rbs +0 -2
  482. data/sig/orb/models/events/backfill_create_response.rbs +0 -2
  483. data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
  484. data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
  485. data/sig/orb/models/events/backfill_list_params.rbs +0 -2
  486. data/sig/orb/models/events/backfill_list_response.rbs +0 -2
  487. data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
  488. data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
  489. data/sig/orb/models/events/event_volumes.rbs +3 -10
  490. data/sig/orb/models/events/volume_list_params.rbs +0 -2
  491. data/sig/orb/models/invoice.rbs +110 -172
  492. data/sig/orb/models/invoice_create_params.rbs +10 -16
  493. data/sig/orb/models/invoice_fetch_params.rbs +0 -2
  494. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
  495. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
  496. data/sig/orb/models/invoice_issue_params.rbs +0 -2
  497. data/sig/orb/models/invoice_level_discount.rbs +2 -4
  498. data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
  499. data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
  500. data/sig/orb/models/invoice_list_params.rbs +4 -6
  501. data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
  502. data/sig/orb/models/invoice_pay_params.rbs +0 -2
  503. data/sig/orb/models/invoice_update_params.rbs +0 -2
  504. data/sig/orb/models/invoice_void_params.rbs +0 -2
  505. data/sig/orb/models/item.rbs +7 -11
  506. data/sig/orb/models/item_create_params.rbs +0 -2
  507. data/sig/orb/models/item_fetch_params.rbs +0 -2
  508. data/sig/orb/models/item_list_params.rbs +0 -2
  509. data/sig/orb/models/item_update_params.rbs +7 -11
  510. data/sig/orb/models/metric_create_params.rbs +0 -2
  511. data/sig/orb/models/metric_fetch_params.rbs +0 -2
  512. data/sig/orb/models/metric_list_params.rbs +0 -2
  513. data/sig/orb/models/metric_update_params.rbs +0 -2
  514. data/sig/orb/models/pagination_metadata.rbs +0 -2
  515. data/sig/orb/models/percentage_discount.rbs +4 -6
  516. data/sig/orb/models/plan.rbs +45 -73
  517. data/sig/orb/models/plan_create_params.rbs +518 -696
  518. data/sig/orb/models/plan_fetch_params.rbs +0 -2
  519. data/sig/orb/models/plan_list_params.rbs +0 -2
  520. data/sig/orb/models/plan_update_params.rbs +0 -2
  521. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
  522. data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
  523. data/sig/orb/models/price.rbs +1194 -1730
  524. data/sig/orb/models/price_create_params.rbs +59 -97
  525. data/sig/orb/models/price_evaluate_params.rbs +0 -2
  526. data/sig/orb/models/price_evaluate_response.rbs +3 -6
  527. data/sig/orb/models/price_fetch_params.rbs +0 -2
  528. data/sig/orb/models/price_list_params.rbs +0 -2
  529. data/sig/orb/models/price_update_params.rbs +0 -2
  530. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
  531. data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
  532. data/sig/orb/models/subscription.rbs +56 -94
  533. data/sig/orb/models/subscription_cancel_params.rbs +0 -2
  534. data/sig/orb/models/subscription_cancel_response.rbs +20 -60
  535. data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
  536. data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
  537. data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
  538. data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
  539. data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
  540. data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
  541. data/sig/orb/models/subscription_create_params.rbs +1103 -1499
  542. data/sig/orb/models/subscription_create_response.rbs +20 -60
  543. data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
  544. data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
  545. data/sig/orb/models/subscription_fetch_params.rbs +0 -2
  546. data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
  547. data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
  548. data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
  549. data/sig/orb/models/subscription_list_params.rbs +0 -2
  550. data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
  551. data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
  552. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
  553. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
  554. data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
  555. data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
  556. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
  557. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
  558. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
  559. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
  560. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
  561. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
  562. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
  563. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
  564. data/sig/orb/models/subscription_update_params.rbs +0 -2
  565. data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
  566. data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
  567. data/sig/orb/models/subscription_usage.rbs +35 -53
  568. data/sig/orb/models/subscriptions.rbs +6 -8
  569. data/sig/orb/models/top_level_ping_params.rbs +0 -2
  570. data/sig/orb/models/top_level_ping_response.rbs +0 -2
  571. data/sig/orb/models/trial_discount.rbs +4 -6
  572. data/sig/orb/models/usage_discount.rbs +4 -6
  573. data/sig/orb/request_options.rbs +1 -1
  574. data/sig/orb/resources/alerts.rbs +12 -12
  575. data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
  576. data/sig/orb/resources/coupons.rbs +4 -4
  577. data/sig/orb/resources/credit_notes.rbs +4 -4
  578. data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
  579. data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
  580. data/sig/orb/resources/customers.rbs +24 -24
  581. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
  582. data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
  583. data/sig/orb/resources/events/volume.rbs +1 -1
  584. data/sig/orb/resources/events.rbs +1 -1
  585. data/sig/orb/resources/invoices.rbs +10 -10
  586. data/sig/orb/resources/items.rbs +5 -5
  587. data/sig/orb/resources/metrics.rbs +4 -4
  588. data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
  589. data/sig/orb/resources/plans.rbs +5 -5
  590. data/sig/orb/resources/prices.rbs +11 -11
  591. data/sig/orb/resources/subscriptions.rbs +21 -21
  592. metadata +2 -2
@@ -3,6 +3,8 @@
3
3
  module Orb
4
4
  module Models
5
5
  class Alert < Orb::Internal::Type::BaseModel
6
+ OrHash = T.type_alias { T.any(Orb::Alert, Orb::Internal::AnyHash) }
7
+
6
8
  # Also referred to as alert_id in this documentation.
7
9
  sig { returns(String) }
8
10
  attr_accessor :id
@@ -16,10 +18,10 @@ module Orb
16
18
  attr_accessor :currency
17
19
 
18
20
  # The customer the alert applies to.
19
- sig { returns(T.nilable(Orb::Models::Alert::Customer)) }
21
+ sig { returns(T.nilable(Orb::Alert::Customer)) }
20
22
  attr_reader :customer
21
23
 
22
- sig { params(customer: T.nilable(T.any(Orb::Models::Alert::Customer, Orb::Internal::AnyHash))).void }
24
+ sig { params(customer: T.nilable(Orb::Alert::Customer::OrHash)).void }
23
25
  attr_writer :customer
24
26
 
25
27
  # Whether the alert is enabled or disabled.
@@ -27,33 +29,35 @@ module Orb
27
29
  attr_accessor :enabled
28
30
 
29
31
  # The metric the alert applies to.
30
- sig { returns(T.nilable(Orb::Models::Alert::Metric)) }
32
+ sig { returns(T.nilable(Orb::Alert::Metric)) }
31
33
  attr_reader :metric
32
34
 
33
- sig { params(metric: T.nilable(T.any(Orb::Models::Alert::Metric, Orb::Internal::AnyHash))).void }
35
+ sig { params(metric: T.nilable(Orb::Alert::Metric::OrHash)).void }
34
36
  attr_writer :metric
35
37
 
36
38
  # The plan the alert applies to.
37
- sig { returns(T.nilable(Orb::Models::Alert::Plan)) }
39
+ sig { returns(T.nilable(Orb::Alert::Plan)) }
38
40
  attr_reader :plan
39
41
 
40
- sig { params(plan: T.nilable(T.any(Orb::Models::Alert::Plan, Orb::Internal::AnyHash))).void }
42
+ sig { params(plan: T.nilable(Orb::Alert::Plan::OrHash)).void }
41
43
  attr_writer :plan
42
44
 
43
45
  # The subscription the alert applies to.
44
- sig { returns(T.nilable(Orb::Models::Alert::Subscription)) }
46
+ sig { returns(T.nilable(Orb::Alert::Subscription)) }
45
47
  attr_reader :subscription
46
48
 
47
- sig { params(subscription: T.nilable(T.any(Orb::Models::Alert::Subscription, Orb::Internal::AnyHash))).void }
49
+ sig do
50
+ params(subscription: T.nilable(Orb::Alert::Subscription::OrHash)).void
51
+ end
48
52
  attr_writer :subscription
49
53
 
50
54
  # The thresholds that define the conditions under which the alert will be
51
55
  # triggered.
52
- sig { returns(T.nilable(T::Array[Orb::Models::Alert::Threshold])) }
56
+ sig { returns(T.nilable(T::Array[Orb::Alert::Threshold])) }
53
57
  attr_accessor :thresholds
54
58
 
55
59
  # The type of alert. This must be a valid alert type.
56
- sig { returns(Orb::Models::Alert::Type::TaggedSymbol) }
60
+ sig { returns(Orb::Alert::Type::TaggedSymbol) }
57
61
  attr_accessor :type
58
62
 
59
63
  # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
@@ -66,15 +70,14 @@ module Orb
66
70
  id: String,
67
71
  created_at: Time,
68
72
  currency: T.nilable(String),
69
- customer: T.nilable(T.any(Orb::Models::Alert::Customer, Orb::Internal::AnyHash)),
73
+ customer: T.nilable(Orb::Alert::Customer::OrHash),
70
74
  enabled: T::Boolean,
71
- metric: T.nilable(T.any(Orb::Models::Alert::Metric, Orb::Internal::AnyHash)),
72
- plan: T.nilable(T.any(Orb::Models::Alert::Plan, Orb::Internal::AnyHash)),
73
- subscription: T.nilable(T.any(Orb::Models::Alert::Subscription, Orb::Internal::AnyHash)),
74
- thresholds: T.nilable(T::Array[T.any(Orb::Models::Alert::Threshold, Orb::Internal::AnyHash)]),
75
- type: Orb::Models::Alert::Type::OrSymbol
76
- )
77
- .returns(T.attached_class)
75
+ metric: T.nilable(Orb::Alert::Metric::OrHash),
76
+ plan: T.nilable(Orb::Alert::Plan::OrHash),
77
+ subscription: T.nilable(Orb::Alert::Subscription::OrHash),
78
+ thresholds: T.nilable(T::Array[Orb::Alert::Threshold::OrHash]),
79
+ type: Orb::Alert::Type::OrSymbol
80
+ ).returns(T.attached_class)
78
81
  end
79
82
  def self.new(
80
83
  # Also referred to as alert_id in this documentation.
@@ -98,27 +101,32 @@ module Orb
98
101
  thresholds:,
99
102
  # The type of alert. This must be a valid alert type.
100
103
  type:
101
- ); end
104
+ )
105
+ end
106
+
102
107
  sig do
103
- override
104
- .returns(
105
- {
106
- id: String,
107
- created_at: Time,
108
- currency: T.nilable(String),
109
- customer: T.nilable(Orb::Models::Alert::Customer),
110
- enabled: T::Boolean,
111
- metric: T.nilable(Orb::Models::Alert::Metric),
112
- plan: T.nilable(Orb::Models::Alert::Plan),
113
- subscription: T.nilable(Orb::Models::Alert::Subscription),
114
- thresholds: T.nilable(T::Array[Orb::Models::Alert::Threshold]),
115
- type: Orb::Models::Alert::Type::TaggedSymbol
116
- }
117
- )
108
+ override.returns(
109
+ {
110
+ id: String,
111
+ created_at: Time,
112
+ currency: T.nilable(String),
113
+ customer: T.nilable(Orb::Alert::Customer),
114
+ enabled: T::Boolean,
115
+ metric: T.nilable(Orb::Alert::Metric),
116
+ plan: T.nilable(Orb::Alert::Plan),
117
+ subscription: T.nilable(Orb::Alert::Subscription),
118
+ thresholds: T.nilable(T::Array[Orb::Alert::Threshold]),
119
+ type: Orb::Alert::Type::TaggedSymbol
120
+ }
121
+ )
122
+ end
123
+ def to_hash
118
124
  end
119
- def to_hash; end
120
125
 
121
126
  class Customer < Orb::Internal::Type::BaseModel
127
+ OrHash =
128
+ T.type_alias { T.any(Orb::Alert::Customer, Orb::Internal::AnyHash) }
129
+
122
130
  sig { returns(String) }
123
131
  attr_accessor :id
124
132
 
@@ -126,26 +134,44 @@ module Orb
126
134
  attr_accessor :external_customer_id
127
135
 
128
136
  # The customer the alert applies to.
129
- sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
130
- def self.new(id:, external_customer_id:); end
137
+ sig do
138
+ params(id: String, external_customer_id: T.nilable(String)).returns(
139
+ T.attached_class
140
+ )
141
+ end
142
+ def self.new(id:, external_customer_id:)
143
+ end
131
144
 
132
- sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
133
- def to_hash; end
145
+ sig do
146
+ override.returns(
147
+ { id: String, external_customer_id: T.nilable(String) }
148
+ )
149
+ end
150
+ def to_hash
151
+ end
134
152
  end
135
153
 
136
154
  class Metric < Orb::Internal::Type::BaseModel
155
+ OrHash =
156
+ T.type_alias { T.any(Orb::Alert::Metric, Orb::Internal::AnyHash) }
157
+
137
158
  sig { returns(String) }
138
159
  attr_accessor :id
139
160
 
140
161
  # The metric the alert applies to.
141
162
  sig { params(id: String).returns(T.attached_class) }
142
- def self.new(id:); end
163
+ def self.new(id:)
164
+ end
143
165
 
144
- sig { override.returns({id: String}) }
145
- def to_hash; end
166
+ sig { override.returns({ id: String }) }
167
+ def to_hash
168
+ end
146
169
  end
147
170
 
148
171
  class Plan < Orb::Internal::Type::BaseModel
172
+ OrHash =
173
+ T.type_alias { T.any(Orb::Alert::Plan, Orb::Internal::AnyHash) }
174
+
149
175
  sig { returns(T.nilable(String)) }
150
176
  attr_accessor :id
151
177
 
@@ -168,8 +194,7 @@ module Orb
168
194
  external_plan_id: T.nilable(String),
169
195
  name: T.nilable(String),
170
196
  plan_version: String
171
- )
172
- .returns(T.attached_class)
197
+ ).returns(T.attached_class)
173
198
  end
174
199
  def self.new(
175
200
  id:,
@@ -179,34 +204,46 @@ module Orb
179
204
  external_plan_id:,
180
205
  name:,
181
206
  plan_version:
182
- ); end
207
+ )
208
+ end
209
+
183
210
  sig do
184
- override
185
- .returns(
186
- {
187
- id: T.nilable(String),
188
- external_plan_id: T.nilable(String),
189
- name: T.nilable(String),
190
- plan_version: String
191
- }
192
- )
211
+ override.returns(
212
+ {
213
+ id: T.nilable(String),
214
+ external_plan_id: T.nilable(String),
215
+ name: T.nilable(String),
216
+ plan_version: String
217
+ }
218
+ )
219
+ end
220
+ def to_hash
193
221
  end
194
- def to_hash; end
195
222
  end
196
223
 
197
224
  class Subscription < Orb::Internal::Type::BaseModel
225
+ OrHash =
226
+ T.type_alias do
227
+ T.any(Orb::Alert::Subscription, Orb::Internal::AnyHash)
228
+ end
229
+
198
230
  sig { returns(String) }
199
231
  attr_accessor :id
200
232
 
201
233
  # The subscription the alert applies to.
202
234
  sig { params(id: String).returns(T.attached_class) }
203
- def self.new(id:); end
235
+ def self.new(id:)
236
+ end
204
237
 
205
- sig { override.returns({id: String}) }
206
- def to_hash; end
238
+ sig { override.returns({ id: String }) }
239
+ def to_hash
240
+ end
207
241
  end
208
242
 
209
243
  class Threshold < Orb::Internal::Type::BaseModel
244
+ OrHash =
245
+ T.type_alias { T.any(Orb::Alert::Threshold, Orb::Internal::AnyHash) }
246
+
210
247
  # The value at which an alert will fire. For credit balance alerts, the alert will
211
248
  # fire at or below this value. For usage and cost alerts, the alert will fire at
212
249
  # or above this value.
@@ -221,26 +258,33 @@ module Orb
221
258
  # fire at or below this value. For usage and cost alerts, the alert will fire at
222
259
  # or above this value.
223
260
  value:
224
- ); end
225
- sig { override.returns({value: Float}) }
226
- def to_hash; end
261
+ )
262
+ end
263
+
264
+ sig { override.returns({ value: Float }) }
265
+ def to_hash
266
+ end
227
267
  end
228
268
 
229
269
  # The type of alert. This must be a valid alert type.
230
270
  module Type
231
271
  extend Orb::Internal::Type::Enum
232
272
 
233
- TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Alert::Type) }
273
+ TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Alert::Type) }
234
274
  OrSymbol = T.type_alias { T.any(Symbol, String) }
235
275
 
236
- CREDIT_BALANCE_DEPLETED = T.let(:credit_balance_depleted, Orb::Models::Alert::Type::TaggedSymbol)
237
- CREDIT_BALANCE_DROPPED = T.let(:credit_balance_dropped, Orb::Models::Alert::Type::TaggedSymbol)
238
- CREDIT_BALANCE_RECOVERED = T.let(:credit_balance_recovered, Orb::Models::Alert::Type::TaggedSymbol)
239
- USAGE_EXCEEDED = T.let(:usage_exceeded, Orb::Models::Alert::Type::TaggedSymbol)
240
- COST_EXCEEDED = T.let(:cost_exceeded, Orb::Models::Alert::Type::TaggedSymbol)
241
-
242
- sig { override.returns(T::Array[Orb::Models::Alert::Type::TaggedSymbol]) }
243
- def self.values; end
276
+ CREDIT_BALANCE_DEPLETED =
277
+ T.let(:credit_balance_depleted, Orb::Alert::Type::TaggedSymbol)
278
+ CREDIT_BALANCE_DROPPED =
279
+ T.let(:credit_balance_dropped, Orb::Alert::Type::TaggedSymbol)
280
+ CREDIT_BALANCE_RECOVERED =
281
+ T.let(:credit_balance_recovered, Orb::Alert::Type::TaggedSymbol)
282
+ USAGE_EXCEEDED = T.let(:usage_exceeded, Orb::Alert::Type::TaggedSymbol)
283
+ COST_EXCEEDED = T.let(:cost_exceeded, Orb::Alert::Type::TaggedSymbol)
284
+
285
+ sig { override.returns(T::Array[Orb::Alert::Type::TaggedSymbol]) }
286
+ def self.values
287
+ end
244
288
  end
245
289
  end
246
290
  end
@@ -6,26 +6,37 @@ module Orb
6
6
  extend Orb::Internal::Type::RequestParameters::Converter
7
7
  include Orb::Internal::Type::RequestParameters
8
8
 
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(Orb::AlertCreateForCustomerParams, Orb::Internal::AnyHash)
12
+ end
13
+
9
14
  # The case sensitive currency or custom pricing unit to use for this alert.
10
15
  sig { returns(String) }
11
16
  attr_accessor :currency
12
17
 
13
18
  # The type of alert to create. This must be a valid alert type.
14
- sig { returns(Orb::Models::AlertCreateForCustomerParams::Type::OrSymbol) }
19
+ sig { returns(Orb::AlertCreateForCustomerParams::Type::OrSymbol) }
15
20
  attr_accessor :type
16
21
 
17
22
  # The thresholds that define the values at which the alert will be triggered.
18
- sig { returns(T.nilable(T::Array[Orb::Models::AlertCreateForCustomerParams::Threshold])) }
23
+ sig do
24
+ returns(
25
+ T.nilable(T::Array[Orb::AlertCreateForCustomerParams::Threshold])
26
+ )
27
+ end
19
28
  attr_accessor :thresholds
20
29
 
21
30
  sig do
22
31
  params(
23
32
  currency: String,
24
- type: Orb::Models::AlertCreateForCustomerParams::Type::OrSymbol,
25
- thresholds: T.nilable(T::Array[T.any(Orb::Models::AlertCreateForCustomerParams::Threshold, Orb::Internal::AnyHash)]),
26
- request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)
27
- )
28
- .returns(T.attached_class)
33
+ type: Orb::AlertCreateForCustomerParams::Type::OrSymbol,
34
+ thresholds:
35
+ T.nilable(
36
+ T::Array[Orb::AlertCreateForCustomerParams::Threshold::OrHash]
37
+ ),
38
+ request_options: Orb::RequestOptions::OrHash
39
+ ).returns(T.attached_class)
29
40
  end
30
41
  def self.new(
31
42
  # The case sensitive currency or custom pricing unit to use for this alert.
@@ -35,39 +46,67 @@ module Orb
35
46
  # The thresholds that define the values at which the alert will be triggered.
36
47
  thresholds: nil,
37
48
  request_options: {}
38
- ); end
49
+ )
50
+ end
51
+
39
52
  sig do
40
- override
41
- .returns(
42
- {
43
- currency: String,
44
- type: Orb::Models::AlertCreateForCustomerParams::Type::OrSymbol,
45
- thresholds: T.nilable(T::Array[Orb::Models::AlertCreateForCustomerParams::Threshold]),
46
- request_options: Orb::RequestOptions
47
- }
48
- )
53
+ override.returns(
54
+ {
55
+ currency: String,
56
+ type: Orb::AlertCreateForCustomerParams::Type::OrSymbol,
57
+ thresholds:
58
+ T.nilable(T::Array[Orb::AlertCreateForCustomerParams::Threshold]),
59
+ request_options: Orb::RequestOptions
60
+ }
61
+ )
62
+ end
63
+ def to_hash
49
64
  end
50
- def to_hash; end
51
65
 
52
66
  # The type of alert to create. This must be a valid alert type.
53
67
  module Type
54
68
  extend Orb::Internal::Type::Enum
55
69
 
56
- TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForCustomerParams::Type) }
70
+ TaggedSymbol =
71
+ T.type_alias do
72
+ T.all(Symbol, Orb::AlertCreateForCustomerParams::Type)
73
+ end
57
74
  OrSymbol = T.type_alias { T.any(Symbol, String) }
58
75
 
59
76
  CREDIT_BALANCE_DEPLETED =
60
- T.let(:credit_balance_depleted, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol)
77
+ T.let(
78
+ :credit_balance_depleted,
79
+ Orb::AlertCreateForCustomerParams::Type::TaggedSymbol
80
+ )
61
81
  CREDIT_BALANCE_DROPPED =
62
- T.let(:credit_balance_dropped, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol)
82
+ T.let(
83
+ :credit_balance_dropped,
84
+ Orb::AlertCreateForCustomerParams::Type::TaggedSymbol
85
+ )
63
86
  CREDIT_BALANCE_RECOVERED =
64
- T.let(:credit_balance_recovered, Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol)
87
+ T.let(
88
+ :credit_balance_recovered,
89
+ Orb::AlertCreateForCustomerParams::Type::TaggedSymbol
90
+ )
65
91
 
66
- sig { override.returns(T::Array[Orb::Models::AlertCreateForCustomerParams::Type::TaggedSymbol]) }
67
- def self.values; end
92
+ sig do
93
+ override.returns(
94
+ T::Array[Orb::AlertCreateForCustomerParams::Type::TaggedSymbol]
95
+ )
96
+ end
97
+ def self.values
98
+ end
68
99
  end
69
100
 
70
101
  class Threshold < Orb::Internal::Type::BaseModel
102
+ OrHash =
103
+ T.type_alias do
104
+ T.any(
105
+ Orb::AlertCreateForCustomerParams::Threshold,
106
+ Orb::Internal::AnyHash
107
+ )
108
+ end
109
+
71
110
  # The value at which an alert will fire. For credit balance alerts, the alert will
72
111
  # fire at or below this value. For usage and cost alerts, the alert will fire at
73
112
  # or above this value.
@@ -82,9 +121,12 @@ module Orb
82
121
  # fire at or below this value. For usage and cost alerts, the alert will fire at
83
122
  # or above this value.
84
123
  value:
85
- ); end
86
- sig { override.returns({value: Float}) }
87
- def to_hash; end
124
+ )
125
+ end
126
+
127
+ sig { override.returns({ value: Float }) }
128
+ def to_hash
129
+ end
88
130
  end
89
131
  end
90
132
  end
@@ -6,28 +6,44 @@ module Orb
6
6
  extend Orb::Internal::Type::RequestParameters::Converter
7
7
  include Orb::Internal::Type::RequestParameters
8
8
 
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ Orb::AlertCreateForExternalCustomerParams,
13
+ Orb::Internal::AnyHash
14
+ )
15
+ end
16
+
9
17
  # The case sensitive currency or custom pricing unit to use for this alert.
10
18
  sig { returns(String) }
11
19
  attr_accessor :currency
12
20
 
13
21
  # The type of alert to create. This must be a valid alert type.
14
- sig { returns(Orb::Models::AlertCreateForExternalCustomerParams::Type::OrSymbol) }
22
+ sig { returns(Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol) }
15
23
  attr_accessor :type
16
24
 
17
25
  # The thresholds that define the values at which the alert will be triggered.
18
- sig { returns(T.nilable(T::Array[Orb::Models::AlertCreateForExternalCustomerParams::Threshold])) }
26
+ sig do
27
+ returns(
28
+ T.nilable(
29
+ T::Array[Orb::AlertCreateForExternalCustomerParams::Threshold]
30
+ )
31
+ )
32
+ end
19
33
  attr_accessor :thresholds
20
34
 
21
35
  sig do
22
36
  params(
23
37
  currency: String,
24
- type: Orb::Models::AlertCreateForExternalCustomerParams::Type::OrSymbol,
25
- thresholds: T.nilable(
26
- T::Array[T.any(Orb::Models::AlertCreateForExternalCustomerParams::Threshold, Orb::Internal::AnyHash)]
27
- ),
28
- request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)
29
- )
30
- .returns(T.attached_class)
38
+ type: Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol,
39
+ thresholds:
40
+ T.nilable(
41
+ T::Array[
42
+ Orb::AlertCreateForExternalCustomerParams::Threshold::OrHash
43
+ ]
44
+ ),
45
+ request_options: Orb::RequestOptions::OrHash
46
+ ).returns(T.attached_class)
31
47
  end
32
48
  def self.new(
33
49
  # The case sensitive currency or custom pricing unit to use for this alert.
@@ -37,39 +53,71 @@ module Orb
37
53
  # The thresholds that define the values at which the alert will be triggered.
38
54
  thresholds: nil,
39
55
  request_options: {}
40
- ); end
56
+ )
57
+ end
58
+
41
59
  sig do
42
- override
43
- .returns(
44
- {
45
- currency: String,
46
- type: Orb::Models::AlertCreateForExternalCustomerParams::Type::OrSymbol,
47
- thresholds: T.nilable(T::Array[Orb::Models::AlertCreateForExternalCustomerParams::Threshold]),
48
- request_options: Orb::RequestOptions
49
- }
50
- )
60
+ override.returns(
61
+ {
62
+ currency: String,
63
+ type: Orb::AlertCreateForExternalCustomerParams::Type::OrSymbol,
64
+ thresholds:
65
+ T.nilable(
66
+ T::Array[Orb::AlertCreateForExternalCustomerParams::Threshold]
67
+ ),
68
+ request_options: Orb::RequestOptions
69
+ }
70
+ )
71
+ end
72
+ def to_hash
51
73
  end
52
- def to_hash; end
53
74
 
54
75
  # The type of alert to create. This must be a valid alert type.
55
76
  module Type
56
77
  extend Orb::Internal::Type::Enum
57
78
 
58
- TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::AlertCreateForExternalCustomerParams::Type) }
79
+ TaggedSymbol =
80
+ T.type_alias do
81
+ T.all(Symbol, Orb::AlertCreateForExternalCustomerParams::Type)
82
+ end
59
83
  OrSymbol = T.type_alias { T.any(Symbol, String) }
60
84
 
61
85
  CREDIT_BALANCE_DEPLETED =
62
- T.let(:credit_balance_depleted, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol)
86
+ T.let(
87
+ :credit_balance_depleted,
88
+ Orb::AlertCreateForExternalCustomerParams::Type::TaggedSymbol
89
+ )
63
90
  CREDIT_BALANCE_DROPPED =
64
- T.let(:credit_balance_dropped, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol)
91
+ T.let(
92
+ :credit_balance_dropped,
93
+ Orb::AlertCreateForExternalCustomerParams::Type::TaggedSymbol
94
+ )
65
95
  CREDIT_BALANCE_RECOVERED =
66
- T.let(:credit_balance_recovered, Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol)
96
+ T.let(
97
+ :credit_balance_recovered,
98
+ Orb::AlertCreateForExternalCustomerParams::Type::TaggedSymbol
99
+ )
67
100
 
68
- sig { override.returns(T::Array[Orb::Models::AlertCreateForExternalCustomerParams::Type::TaggedSymbol]) }
69
- def self.values; end
101
+ sig do
102
+ override.returns(
103
+ T::Array[
104
+ Orb::AlertCreateForExternalCustomerParams::Type::TaggedSymbol
105
+ ]
106
+ )
107
+ end
108
+ def self.values
109
+ end
70
110
  end
71
111
 
72
112
  class Threshold < Orb::Internal::Type::BaseModel
113
+ OrHash =
114
+ T.type_alias do
115
+ T.any(
116
+ Orb::AlertCreateForExternalCustomerParams::Threshold,
117
+ Orb::Internal::AnyHash
118
+ )
119
+ end
120
+
73
121
  # The value at which an alert will fire. For credit balance alerts, the alert will
74
122
  # fire at or below this value. For usage and cost alerts, the alert will fire at
75
123
  # or above this value.
@@ -84,9 +132,12 @@ module Orb
84
132
  # fire at or below this value. For usage and cost alerts, the alert will fire at
85
133
  # or above this value.
86
134
  value:
87
- ); end
88
- sig { override.returns({value: Float}) }
89
- def to_hash; end
135
+ )
136
+ end
137
+
138
+ sig { override.returns({ value: Float }) }
139
+ def to_hash
140
+ end
90
141
  end
91
142
  end
92
143
  end