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
@@ -6,7 +6,10 @@ module Orb
6
6
  extend Orb::Internal::Type::RequestParameters::Converter
7
7
  include Orb::Internal::Type::RequestParameters
8
8
 
9
- sig { returns(T::Array[Orb::Models::EventIngestParams::Event]) }
9
+ OrHash =
10
+ T.type_alias { T.any(Orb::EventIngestParams, Orb::Internal::AnyHash) }
11
+
12
+ sig { returns(T::Array[Orb::EventIngestParams::Event]) }
10
13
  attr_accessor :events
11
14
 
12
15
  # If this ingestion request is part of a backfill, this parameter ties the
@@ -23,12 +26,11 @@ module Orb
23
26
 
24
27
  sig do
25
28
  params(
26
- events: T::Array[T.any(Orb::Models::EventIngestParams::Event, Orb::Internal::AnyHash)],
29
+ events: T::Array[Orb::EventIngestParams::Event::OrHash],
27
30
  backfill_id: T.nilable(String),
28
31
  debug: T::Boolean,
29
- request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)
30
- )
31
- .returns(T.attached_class)
32
+ request_options: Orb::RequestOptions::OrHash
33
+ ).returns(T.attached_class)
32
34
  end
33
35
  def self.new(
34
36
  events:,
@@ -38,21 +40,28 @@ module Orb
38
40
  # Flag to enable additional debug information in the endpoint response
39
41
  debug: nil,
40
42
  request_options: {}
41
- ); end
43
+ )
44
+ end
45
+
42
46
  sig do
43
- override
44
- .returns(
45
- {
46
- events: T::Array[Orb::Models::EventIngestParams::Event],
47
- backfill_id: T.nilable(String),
48
- debug: T::Boolean,
49
- request_options: Orb::RequestOptions
50
- }
51
- )
47
+ override.returns(
48
+ {
49
+ events: T::Array[Orb::EventIngestParams::Event],
50
+ backfill_id: T.nilable(String),
51
+ debug: T::Boolean,
52
+ request_options: Orb::RequestOptions
53
+ }
54
+ )
55
+ end
56
+ def to_hash
52
57
  end
53
- def to_hash; end
54
58
 
55
59
  class Event < Orb::Internal::Type::BaseModel
60
+ OrHash =
61
+ T.type_alias do
62
+ T.any(Orb::EventIngestParams::Event, Orb::Internal::AnyHash)
63
+ end
64
+
56
65
  # A name to meaningfully identify the action or event type.
57
66
  sig { returns(String) }
58
67
  attr_accessor :event_name
@@ -91,8 +100,7 @@ module Orb
91
100
  timestamp: Time,
92
101
  customer_id: T.nilable(String),
93
102
  external_customer_id: T.nilable(String)
94
- )
95
- .returns(T.attached_class)
103
+ ).returns(T.attached_class)
96
104
  end
97
105
  def self.new(
98
106
  # A name to meaningfully identify the action or event type.
@@ -113,21 +121,23 @@ module Orb
113
121
  # An alias for the Orb customer, whose mapping is specified when creating the
114
122
  # customer
115
123
  external_customer_id: nil
116
- ); end
124
+ )
125
+ end
126
+
117
127
  sig do
118
- override
119
- .returns(
120
- {
121
- event_name: String,
122
- idempotency_key: String,
123
- properties: T.anything,
124
- timestamp: Time,
125
- customer_id: T.nilable(String),
126
- external_customer_id: T.nilable(String)
127
- }
128
- )
128
+ override.returns(
129
+ {
130
+ event_name: String,
131
+ idempotency_key: String,
132
+ properties: T.anything,
133
+ timestamp: Time,
134
+ customer_id: T.nilable(String),
135
+ external_customer_id: T.nilable(String)
136
+ }
137
+ )
138
+ end
139
+ def to_hash
129
140
  end
130
- def to_hash; end
131
141
  end
132
142
  end
133
143
  end
@@ -3,9 +3,16 @@
3
3
  module Orb
4
4
  module Models
5
5
  class EventIngestResponse < Orb::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(Orb::Models::EventIngestResponse, Orb::Internal::AnyHash)
9
+ end
10
+
6
11
  # Contains all failing validation events. In the case of a 200, this array will
7
12
  # always be empty. This field will always be present.
8
- sig { returns(T::Array[Orb::Models::EventIngestResponse::ValidationFailed]) }
13
+ sig do
14
+ returns(T::Array[Orb::Models::EventIngestResponse::ValidationFailed])
15
+ end
9
16
  attr_accessor :validation_failed
10
17
 
11
18
  # Optional debug information (only present when debug=true is passed to the
@@ -13,15 +20,21 @@ module Orb
13
20
  sig { returns(T.nilable(Orb::Models::EventIngestResponse::Debug)) }
14
21
  attr_reader :debug
15
22
 
16
- sig { params(debug: T.nilable(T.any(Orb::Models::EventIngestResponse::Debug, Orb::Internal::AnyHash))).void }
23
+ sig do
24
+ params(
25
+ debug: T.nilable(Orb::Models::EventIngestResponse::Debug::OrHash)
26
+ ).void
27
+ end
17
28
  attr_writer :debug
18
29
 
19
30
  sig do
20
31
  params(
21
- validation_failed: T::Array[T.any(Orb::Models::EventIngestResponse::ValidationFailed, Orb::Internal::AnyHash)],
22
- debug: T.nilable(T.any(Orb::Models::EventIngestResponse::Debug, Orb::Internal::AnyHash))
23
- )
24
- .returns(T.attached_class)
32
+ validation_failed:
33
+ T::Array[
34
+ Orb::Models::EventIngestResponse::ValidationFailed::OrHash
35
+ ],
36
+ debug: T.nilable(Orb::Models::EventIngestResponse::Debug::OrHash)
37
+ ).returns(T.attached_class)
25
38
  end
26
39
  def self.new(
27
40
  # Contains all failing validation events. In the case of a 200, this array will
@@ -30,19 +43,30 @@ module Orb
30
43
  # Optional debug information (only present when debug=true is passed to the
31
44
  # endpoint). Contains ingested and duplicate event idempotency keys.
32
45
  debug: nil
33
- ); end
46
+ )
47
+ end
48
+
34
49
  sig do
35
- override
36
- .returns(
37
- {
38
- validation_failed: T::Array[Orb::Models::EventIngestResponse::ValidationFailed],
39
- debug: T.nilable(Orb::Models::EventIngestResponse::Debug)
40
- }
41
- )
50
+ override.returns(
51
+ {
52
+ validation_failed:
53
+ T::Array[Orb::Models::EventIngestResponse::ValidationFailed],
54
+ debug: T.nilable(Orb::Models::EventIngestResponse::Debug)
55
+ }
56
+ )
57
+ end
58
+ def to_hash
42
59
  end
43
- def to_hash; end
44
60
 
45
61
  class ValidationFailed < Orb::Internal::Type::BaseModel
62
+ OrHash =
63
+ T.type_alias do
64
+ T.any(
65
+ Orb::Models::EventIngestResponse::ValidationFailed,
66
+ Orb::Internal::AnyHash
67
+ )
68
+ end
69
+
46
70
  # The passed idempotency_key corresponding to the validation_errors
47
71
  sig { returns(String) }
48
72
  attr_accessor :idempotency_key
@@ -52,19 +76,39 @@ module Orb
52
76
  sig { returns(T::Array[String]) }
53
77
  attr_accessor :validation_errors
54
78
 
55
- sig { params(idempotency_key: String, validation_errors: T::Array[String]).returns(T.attached_class) }
79
+ sig do
80
+ params(
81
+ idempotency_key: String,
82
+ validation_errors: T::Array[String]
83
+ ).returns(T.attached_class)
84
+ end
56
85
  def self.new(
57
86
  # The passed idempotency_key corresponding to the validation_errors
58
87
  idempotency_key:,
59
88
  # An array of strings corresponding to validation failures for this
60
89
  # idempotency_key.
61
90
  validation_errors:
62
- ); end
63
- sig { override.returns({idempotency_key: String, validation_errors: T::Array[String]}) }
64
- def to_hash; end
91
+ )
92
+ end
93
+
94
+ sig do
95
+ override.returns(
96
+ { idempotency_key: String, validation_errors: T::Array[String] }
97
+ )
98
+ end
99
+ def to_hash
100
+ end
65
101
  end
66
102
 
67
103
  class Debug < Orb::Internal::Type::BaseModel
104
+ OrHash =
105
+ T.type_alias do
106
+ T.any(
107
+ Orb::Models::EventIngestResponse::Debug,
108
+ Orb::Internal::AnyHash
109
+ )
110
+ end
111
+
68
112
  sig { returns(T::Array[String]) }
69
113
  attr_accessor :duplicate
70
114
 
@@ -73,11 +117,22 @@ module Orb
73
117
 
74
118
  # Optional debug information (only present when debug=true is passed to the
75
119
  # endpoint). Contains ingested and duplicate event idempotency keys.
76
- sig { params(duplicate: T::Array[String], ingested: T::Array[String]).returns(T.attached_class) }
77
- def self.new(duplicate:, ingested:); end
120
+ sig do
121
+ params(
122
+ duplicate: T::Array[String],
123
+ ingested: T::Array[String]
124
+ ).returns(T.attached_class)
125
+ end
126
+ def self.new(duplicate:, ingested:)
127
+ end
78
128
 
79
- sig { override.returns({duplicate: T::Array[String], ingested: T::Array[String]}) }
80
- def to_hash; end
129
+ sig do
130
+ override.returns(
131
+ { duplicate: T::Array[String], ingested: T::Array[String] }
132
+ )
133
+ end
134
+ def to_hash
135
+ end
81
136
  end
82
137
  end
83
138
  end
@@ -6,6 +6,9 @@ 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 { T.any(Orb::EventSearchParams, Orb::Internal::AnyHash) }
11
+
9
12
  # This is an explicit array of IDs to filter by. Note that an event's ID is the
10
13
  # idempotency_key that was originally used for ingestion, and this only supports
11
14
  # events that have not been amended. Values in this array will be treated case
@@ -28,9 +31,8 @@ module Orb
28
31
  event_ids: T::Array[String],
29
32
  timeframe_end: T.nilable(Time),
30
33
  timeframe_start: T.nilable(Time),
31
- request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)
32
- )
33
- .returns(T.attached_class)
34
+ request_options: Orb::RequestOptions::OrHash
35
+ ).returns(T.attached_class)
34
36
  end
35
37
  def self.new(
36
38
  # This is an explicit array of IDs to filter by. Note that an event's ID is the
@@ -45,19 +47,21 @@ module Orb
45
47
  # specified, the one week ago is used.
46
48
  timeframe_start: nil,
47
49
  request_options: {}
48
- ); end
50
+ )
51
+ end
52
+
49
53
  sig do
50
- override
51
- .returns(
52
- {
53
- event_ids: T::Array[String],
54
- timeframe_end: T.nilable(Time),
55
- timeframe_start: T.nilable(Time),
56
- request_options: Orb::RequestOptions
57
- }
58
- )
54
+ override.returns(
55
+ {
56
+ event_ids: T::Array[String],
57
+ timeframe_end: T.nilable(Time),
58
+ timeframe_start: T.nilable(Time),
59
+ request_options: Orb::RequestOptions
60
+ }
61
+ )
62
+ end
63
+ def to_hash
59
64
  end
60
- def to_hash; end
61
65
  end
62
66
  end
63
67
  end
@@ -3,19 +3,39 @@
3
3
  module Orb
4
4
  module Models
5
5
  class EventSearchResponse < Orb::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(Orb::Models::EventSearchResponse, Orb::Internal::AnyHash)
9
+ end
10
+
6
11
  sig { returns(T::Array[Orb::Models::EventSearchResponse::Data]) }
7
12
  attr_accessor :data
8
13
 
9
14
  sig do
10
- params(data: T::Array[T.any(Orb::Models::EventSearchResponse::Data, Orb::Internal::AnyHash)])
11
- .returns(T.attached_class)
15
+ params(
16
+ data: T::Array[Orb::Models::EventSearchResponse::Data::OrHash]
17
+ ).returns(T.attached_class)
18
+ end
19
+ def self.new(data:)
12
20
  end
13
- def self.new(data:); end
14
21
 
15
- sig { override.returns({data: T::Array[Orb::Models::EventSearchResponse::Data]}) }
16
- def to_hash; end
22
+ sig do
23
+ override.returns(
24
+ { data: T::Array[Orb::Models::EventSearchResponse::Data] }
25
+ )
26
+ end
27
+ def to_hash
28
+ end
17
29
 
18
30
  class Data < Orb::Internal::Type::BaseModel
31
+ OrHash =
32
+ T.type_alias do
33
+ T.any(
34
+ Orb::Models::EventSearchResponse::Data,
35
+ Orb::Internal::AnyHash
36
+ )
37
+ end
38
+
19
39
  # A unique value, generated by the client, that is used to de-duplicate events.
20
40
  # Exactly one event with a given idempotency key will be ingested, which allows
21
41
  # for safe request retries.
@@ -62,8 +82,7 @@ module Orb
62
82
  external_customer_id: T.nilable(String),
63
83
  properties: T.anything,
64
84
  timestamp: Time
65
- )
66
- .returns(T.attached_class)
85
+ ).returns(T.attached_class)
67
86
  end
68
87
  def self.new(
69
88
  # A unique value, generated by the client, that is used to de-duplicate events.
@@ -86,22 +105,24 @@ module Orb
86
105
  # represent the time that usage was recorded, and is particularly important to
87
106
  # attribute usage to a given billing period.
88
107
  timestamp:
89
- ); end
108
+ )
109
+ end
110
+
90
111
  sig do
91
- override
92
- .returns(
93
- {
94
- id: String,
95
- customer_id: T.nilable(String),
96
- deprecated: T::Boolean,
97
- event_name: String,
98
- external_customer_id: T.nilable(String),
99
- properties: T.anything,
100
- timestamp: Time
101
- }
102
- )
112
+ override.returns(
113
+ {
114
+ id: String,
115
+ customer_id: T.nilable(String),
116
+ deprecated: T::Boolean,
117
+ event_name: String,
118
+ external_customer_id: T.nilable(String),
119
+ properties: T.anything,
120
+ timestamp: Time
121
+ }
122
+ )
123
+ end
124
+ def to_hash
103
125
  end
104
- def to_hash; end
105
126
  end
106
127
  end
107
128
  end
@@ -6,6 +6,9 @@ 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 { T.any(Orb::EventUpdateParams, Orb::Internal::AnyHash) }
11
+
9
12
  # A name to meaningfully identify the action or event type.
10
13
  sig { returns(String) }
11
14
  attr_accessor :event_name
@@ -37,9 +40,8 @@ module Orb
37
40
  timestamp: Time,
38
41
  customer_id: T.nilable(String),
39
42
  external_customer_id: T.nilable(String),
40
- request_options: T.any(Orb::RequestOptions, Orb::Internal::AnyHash)
41
- )
42
- .returns(T.attached_class)
43
+ request_options: Orb::RequestOptions::OrHash
44
+ ).returns(T.attached_class)
43
45
  end
44
46
  def self.new(
45
47
  # A name to meaningfully identify the action or event type.
@@ -57,21 +59,23 @@ module Orb
57
59
  # customer
58
60
  external_customer_id: nil,
59
61
  request_options: {}
60
- ); end
62
+ )
63
+ end
64
+
61
65
  sig do
62
- override
63
- .returns(
64
- {
65
- event_name: String,
66
- properties: T.anything,
67
- timestamp: Time,
68
- customer_id: T.nilable(String),
69
- external_customer_id: T.nilable(String),
70
- request_options: Orb::RequestOptions
71
- }
72
- )
66
+ override.returns(
67
+ {
68
+ event_name: String,
69
+ properties: T.anything,
70
+ timestamp: Time,
71
+ customer_id: T.nilable(String),
72
+ external_customer_id: T.nilable(String),
73
+ request_options: Orb::RequestOptions
74
+ }
75
+ )
76
+ end
77
+ def to_hash
73
78
  end
74
- def to_hash; end
75
79
  end
76
80
  end
77
81
  end
@@ -3,6 +3,11 @@
3
3
  module Orb
4
4
  module Models
5
5
  class EventUpdateResponse < Orb::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(Orb::Models::EventUpdateResponse, Orb::Internal::AnyHash)
9
+ end
10
+
6
11
  # event_id of the amended event, if successfully ingested
7
12
  sig { returns(String) }
8
13
  attr_accessor :amended
@@ -11,9 +16,12 @@ module Orb
11
16
  def self.new(
12
17
  # event_id of the amended event, if successfully ingested
13
18
  amended:
14
- ); end
15
- sig { override.returns({amended: String}) }
16
- def to_hash; end
19
+ )
20
+ end
21
+
22
+ sig { override.returns({ amended: String }) }
23
+ def to_hash
24
+ end
17
25
  end
18
26
  end
19
27
  end
@@ -7,18 +7,22 @@ module Orb
7
7
  extend Orb::Internal::Type::RequestParameters::Converter
8
8
  include Orb::Internal::Type::RequestParameters
9
9
 
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(Orb::Events::BackfillCloseParams, Orb::Internal::AnyHash)
13
+ end
14
+
10
15
  sig do
11
- params(
12
- request_options: T.any(
13
- Orb::RequestOptions,
14
- Orb::Internal::AnyHash
15
- )
16
- ).returns(T.attached_class)
16
+ params(request_options: Orb::RequestOptions::OrHash).returns(
17
+ T.attached_class
18
+ )
19
+ end
20
+ def self.new(request_options: {})
17
21
  end
18
- def self.new(request_options: {}); end
19
22
 
20
- sig { override.returns({request_options: Orb::RequestOptions}) }
21
- def to_hash; end
23
+ sig { override.returns({ request_options: Orb::RequestOptions }) }
24
+ def to_hash
25
+ end
22
26
  end
23
27
  end
24
28
  end
@@ -4,6 +4,14 @@ module Orb
4
4
  module Models
5
5
  module Events
6
6
  class BackfillCloseResponse < Orb::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ Orb::Models::Events::BackfillCloseResponse,
11
+ Orb::Internal::AnyHash
12
+ )
13
+ end
14
+
7
15
  sig { returns(String) }
8
16
  attr_accessor :id
9
17
 
@@ -35,7 +43,11 @@ module Orb
35
43
  attr_accessor :reverted_at
36
44
 
37
45
  # The status of the backfill.
38
- sig { returns(Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol) }
46
+ sig do
47
+ returns(
48
+ Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
49
+ )
50
+ end
39
51
  attr_accessor :status
40
52
 
41
53
  sig { returns(Time) }
@@ -61,12 +73,12 @@ module Orb
61
73
  events_ingested: Integer,
62
74
  replace_existing_events: T::Boolean,
63
75
  reverted_at: T.nilable(Time),
64
- status: Orb::Models::Events::BackfillCloseResponse::Status::OrSymbol,
76
+ status:
77
+ Orb::Models::Events::BackfillCloseResponse::Status::OrSymbol,
65
78
  timeframe_end: Time,
66
79
  timeframe_start: Time,
67
80
  deprecation_filter: T.nilable(String)
68
- )
69
- .returns(T.attached_class)
81
+ ).returns(T.attached_class)
70
82
  end
71
83
  def self.new(
72
84
  id:,
@@ -93,41 +105,70 @@ module Orb
93
105
  # [computed property](/extensibility/advanced-metrics#computed-properties) used to
94
106
  # filter the set of events to deprecate
95
107
  deprecation_filter: nil
96
- ); end
108
+ )
109
+ end
110
+
97
111
  sig do
98
- override
99
- .returns(
100
- {
101
- id: String,
102
- close_time: T.nilable(Time),
103
- created_at: Time,
104
- customer_id: T.nilable(String),
105
- events_ingested: Integer,
106
- replace_existing_events: T::Boolean,
107
- reverted_at: T.nilable(Time),
108
- status: Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol,
109
- timeframe_end: Time,
110
- timeframe_start: Time,
111
- deprecation_filter: T.nilable(String)
112
- }
113
- )
112
+ override.returns(
113
+ {
114
+ id: String,
115
+ close_time: T.nilable(Time),
116
+ created_at: Time,
117
+ customer_id: T.nilable(String),
118
+ events_ingested: Integer,
119
+ replace_existing_events: T::Boolean,
120
+ reverted_at: T.nilable(Time),
121
+ status:
122
+ Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol,
123
+ timeframe_end: Time,
124
+ timeframe_start: Time,
125
+ deprecation_filter: T.nilable(String)
126
+ }
127
+ )
128
+ end
129
+ def to_hash
114
130
  end
115
- def to_hash; end
116
131
 
117
132
  # The status of the backfill.
118
133
  module Status
119
134
  extend Orb::Internal::Type::Enum
120
135
 
121
- TaggedSymbol = T.type_alias { T.all(Symbol, Orb::Models::Events::BackfillCloseResponse::Status) }
136
+ TaggedSymbol =
137
+ T.type_alias do
138
+ T.all(Symbol, Orb::Models::Events::BackfillCloseResponse::Status)
139
+ end
122
140
  OrSymbol = T.type_alias { T.any(Symbol, String) }
123
141
 
124
- PENDING = T.let(:pending, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
125
- REFLECTED = T.let(:reflected, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
126
- PENDING_REVERT = T.let(:pending_revert, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
127
- REVERTED = T.let(:reverted, Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol)
142
+ PENDING =
143
+ T.let(
144
+ :pending,
145
+ Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
146
+ )
147
+ REFLECTED =
148
+ T.let(
149
+ :reflected,
150
+ Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
151
+ )
152
+ PENDING_REVERT =
153
+ T.let(
154
+ :pending_revert,
155
+ Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
156
+ )
157
+ REVERTED =
158
+ T.let(
159
+ :reverted,
160
+ Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
161
+ )
128
162
 
129
- sig { override.returns(T::Array[Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol]) }
130
- def self.values; end
163
+ sig do
164
+ override.returns(
165
+ T::Array[
166
+ Orb::Models::Events::BackfillCloseResponse::Status::TaggedSymbol
167
+ ]
168
+ )
169
+ end
170
+ def self.values
171
+ end
131
172
  end
132
173
  end
133
174
  end