orb-billing 0.3.1 → 0.3.2

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 (572) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +3 -3
  4. data/lib/orb/file_part.rb +2 -2
  5. data/lib/orb/internal/type/enum.rb +3 -3
  6. data/lib/orb/internal/type/request_parameters.rb +4 -4
  7. data/lib/orb/internal/type/union.rb +4 -4
  8. data/lib/orb/internal/util.rb +1 -1
  9. data/lib/orb/models/alert.rb +29 -32
  10. data/lib/orb/models/alert_create_for_customer_params.rb +7 -8
  11. data/lib/orb/models/alert_create_for_external_customer_params.rb +7 -8
  12. data/lib/orb/models/alert_create_for_subscription_params.rb +7 -8
  13. data/lib/orb/models/alert_list_params.rb +0 -1
  14. data/lib/orb/models/alert_update_params.rb +4 -5
  15. data/lib/orb/models/amount_discount.rb +6 -7
  16. data/lib/orb/models/billable_metric.rb +9 -11
  17. data/lib/orb/models/coupon.rb +9 -12
  18. data/lib/orb/models/coupon_create_params.rb +6 -8
  19. data/lib/orb/models/coupon_list_params.rb +0 -2
  20. data/lib/orb/models/coupons/subscription_list_params.rb +0 -1
  21. data/lib/orb/models/credit_note.rb +48 -46
  22. data/lib/orb/models/credit_note_create_params.rb +6 -6
  23. data/lib/orb/models/credit_note_list_params.rb +0 -1
  24. data/lib/orb/models/customer.rb +54 -61
  25. data/lib/orb/models/customer_create_params.rb +41 -53
  26. data/lib/orb/models/customer_list_params.rb +0 -1
  27. data/lib/orb/models/customer_update_by_external_id_params.rb +41 -53
  28. data/lib/orb/models/customer_update_params.rb +41 -51
  29. data/lib/orb/models/customers/balance_transaction_create_params.rb +3 -3
  30. data/lib/orb/models/customers/balance_transaction_create_response.rb +0 -2
  31. data/lib/orb/models/customers/balance_transaction_list_params.rb +0 -1
  32. data/lib/orb/models/customers/balance_transaction_list_response.rb +0 -2
  33. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +3 -4
  34. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +3 -3
  35. data/lib/orb/models/customers/cost_list_params.rb +3 -4
  36. data/lib/orb/models/customers/cost_list_response.rb +3 -3
  37. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +0 -2
  38. data/lib/orb/models/customers/credit_list_params.rb +0 -2
  39. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +12 -21
  40. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +0 -7
  41. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +11 -22
  42. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +0 -7
  43. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +6 -7
  44. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +0 -7
  45. data/lib/orb/models/customers/credits/ledger_list_params.rb +8 -9
  46. data/lib/orb/models/customers/credits/ledger_list_response.rb +0 -7
  47. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +10 -15
  48. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +0 -6
  49. data/lib/orb/models/customers/credits/top_up_create_params.rb +7 -15
  50. data/lib/orb/models/customers/credits/top_up_create_response.rb +0 -6
  51. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +0 -1
  52. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +0 -6
  53. data/lib/orb/models/customers/credits/top_up_list_params.rb +0 -1
  54. data/lib/orb/models/customers/credits/top_up_list_response.rb +0 -6
  55. data/lib/orb/models/dimensional_price_group.rb +1 -3
  56. data/lib/orb/models/dimensional_price_group_create_params.rb +0 -1
  57. data/lib/orb/models/dimensional_price_group_list_params.rb +0 -1
  58. data/lib/orb/models/dimensional_price_groups.rb +6 -6
  59. data/lib/orb/models/discount.rb +5 -5
  60. data/lib/orb/models/evaluate_price_group.rb +1 -1
  61. data/lib/orb/models/event_ingest_params.rb +4 -9
  62. data/lib/orb/models/event_ingest_response.rb +0 -3
  63. data/lib/orb/models/event_search_params.rb +0 -3
  64. data/lib/orb/models/event_search_response.rb +0 -4
  65. data/lib/orb/models/event_update_params.rb +0 -3
  66. data/lib/orb/models/events/backfill_close_response.rb +0 -4
  67. data/lib/orb/models/events/backfill_create_params.rb +0 -7
  68. data/lib/orb/models/events/backfill_create_response.rb +0 -4
  69. data/lib/orb/models/events/backfill_fetch_response.rb +0 -4
  70. data/lib/orb/models/events/backfill_list_params.rb +0 -1
  71. data/lib/orb/models/events/backfill_list_response.rb +0 -4
  72. data/lib/orb/models/events/backfill_revert_response.rb +0 -4
  73. data/lib/orb/models/events/event_volumes.rb +3 -3
  74. data/lib/orb/models/events/volume_list_params.rb +0 -3
  75. data/lib/orb/models/invoice.rb +157 -202
  76. data/lib/orb/models/invoice_create_params.rb +14 -21
  77. data/lib/orb/models/invoice_fetch_upcoming_response.rb +9 -54
  78. data/lib/orb/models/invoice_issue_params.rb +0 -1
  79. data/lib/orb/models/invoice_level_discount.rb +4 -4
  80. data/lib/orb/models/invoice_line_item_create_params.rb +0 -1
  81. data/lib/orb/models/invoice_line_item_create_response.rb +6 -26
  82. data/lib/orb/models/invoice_list_params.rb +6 -10
  83. data/lib/orb/models/invoice_update_params.rb +0 -1
  84. data/lib/orb/models/item.rb +7 -8
  85. data/lib/orb/models/item_list_params.rb +0 -1
  86. data/lib/orb/models/item_update_params.rb +7 -7
  87. data/lib/orb/models/metric_create_params.rb +0 -1
  88. data/lib/orb/models/metric_list_params.rb +0 -1
  89. data/lib/orb/models/metric_update_params.rb +0 -1
  90. data/lib/orb/models/percentage_discount.rb +6 -8
  91. data/lib/orb/models/plan.rb +78 -103
  92. data/lib/orb/models/plan_create_params.rb +727 -800
  93. data/lib/orb/models/plan_list_params.rb +3 -4
  94. data/lib/orb/models/plan_update_params.rb +0 -2
  95. data/lib/orb/models/plans/external_plan_id_update_params.rb +0 -2
  96. data/lib/orb/models/price.rb +1671 -1724
  97. data/lib/orb/models/price_create_params.rb +75 -84
  98. data/lib/orb/models/price_evaluate_params.rb +0 -2
  99. data/lib/orb/models/price_evaluate_response.rb +3 -3
  100. data/lib/orb/models/price_list_params.rb +0 -1
  101. data/lib/orb/models/price_update_params.rb +0 -1
  102. data/lib/orb/models/prices/external_price_id_update_params.rb +0 -1
  103. data/lib/orb/models/subscription.rb +86 -122
  104. data/lib/orb/models/subscription_cancel_params.rb +3 -5
  105. data/lib/orb/models/subscription_cancel_response.rb +21 -57
  106. data/lib/orb/models/subscription_change_apply_response.rb +21 -58
  107. data/lib/orb/models/subscription_change_cancel_response.rb +21 -58
  108. data/lib/orb/models/subscription_change_retrieve_response.rb +21 -58
  109. data/lib/orb/models/subscription_create_params.rb +1865 -1815
  110. data/lib/orb/models/subscription_create_response.rb +21 -57
  111. data/lib/orb/models/subscription_fetch_costs_params.rb +3 -4
  112. data/lib/orb/models/subscription_fetch_costs_response.rb +3 -3
  113. data/lib/orb/models/subscription_fetch_schedule_params.rb +0 -1
  114. data/lib/orb/models/subscription_fetch_schedule_response.rb +0 -1
  115. data/lib/orb/models/subscription_fetch_usage_params.rb +6 -8
  116. data/lib/orb/models/subscription_list_params.rb +3 -4
  117. data/lib/orb/models/subscription_price_intervals_params.rb +1105 -1017
  118. data/lib/orb/models/subscription_price_intervals_response.rb +21 -57
  119. data/lib/orb/models/subscription_schedule_plan_change_params.rb +1906 -1791
  120. data/lib/orb/models/subscription_schedule_plan_change_response.rb +21 -57
  121. data/lib/orb/models/subscription_trigger_phase_params.rb +0 -2
  122. data/lib/orb/models/subscription_trigger_phase_response.rb +21 -57
  123. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +21 -57
  124. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +21 -57
  125. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +21 -57
  126. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +3 -6
  127. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +21 -57
  128. data/lib/orb/models/subscription_update_params.rb +0 -5
  129. data/lib/orb/models/subscription_update_trial_params.rb +4 -6
  130. data/lib/orb/models/subscription_update_trial_response.rb +21 -57
  131. data/lib/orb/models/subscription_usage.rb +46 -39
  132. data/lib/orb/models/subscriptions.rb +6 -6
  133. data/lib/orb/models/trial_discount.rb +6 -7
  134. data/lib/orb/models/usage_discount.rb +6 -8
  135. data/lib/orb/resources/alerts.rb +30 -31
  136. data/lib/orb/resources/coupons/subscriptions.rb +3 -4
  137. data/lib/orb/resources/coupons.rb +11 -21
  138. data/lib/orb/resources/credit_notes.rb +10 -11
  139. data/lib/orb/resources/customers/balance_transactions.rb +3 -4
  140. data/lib/orb/resources/customers/costs.rb +4 -6
  141. data/lib/orb/resources/customers/credits/ledger.rb +14 -33
  142. data/lib/orb/resources/customers/credits/top_ups.rb +10 -20
  143. data/lib/orb/resources/customers/credits.rb +2 -6
  144. data/lib/orb/resources/customers.rb +40 -67
  145. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +2 -2
  146. data/lib/orb/resources/dimensional_price_groups.rb +8 -10
  147. data/lib/orb/resources/events/backfills.rb +2 -10
  148. data/lib/orb/resources/events/volume.rb +3 -6
  149. data/lib/orb/resources/events.rb +4 -12
  150. data/lib/orb/resources/invoice_line_items.rb +1 -2
  151. data/lib/orb/resources/invoices.rb +26 -43
  152. data/lib/orb/resources/items.rb +12 -13
  153. data/lib/orb/resources/metrics.rb +11 -14
  154. data/lib/orb/resources/plans/external_plan_id.rb +5 -7
  155. data/lib/orb/resources/plans.rb +14 -23
  156. data/lib/orb/resources/prices/external_price_id.rb +5 -6
  157. data/lib/orb/resources/prices.rb +25 -35
  158. data/lib/orb/resources/subscription_changes.rb +1 -1
  159. data/lib/orb/resources/subscriptions.rb +49 -107
  160. data/lib/orb/version.rb +1 -1
  161. data/lib/orb.rb +1 -0
  162. data/rbi/orb/client.rbi +5 -4
  163. data/rbi/orb/errors.rbi +59 -28
  164. data/rbi/orb/file_part.rbi +9 -6
  165. data/rbi/orb/internal/page.rbi +19 -6
  166. data/rbi/orb/internal/transport/base_client.rbi +131 -73
  167. data/rbi/orb/internal/transport/pooled_net_requester.rbi +25 -12
  168. data/rbi/orb/internal/type/array_of.rbi +42 -34
  169. data/rbi/orb/internal/type/base_model.rbi +124 -65
  170. data/rbi/orb/internal/type/base_page.rbi +11 -7
  171. data/rbi/orb/internal/type/boolean.rbi +16 -10
  172. data/rbi/orb/internal/type/converter.rbi +66 -31
  173. data/rbi/orb/internal/type/enum.rbi +27 -15
  174. data/rbi/orb/internal/type/file_input.rbi +12 -10
  175. data/rbi/orb/internal/type/hash_of.rbi +34 -24
  176. data/rbi/orb/internal/type/request_parameters.rbi +12 -4
  177. data/rbi/orb/internal/type/union.rbi +60 -25
  178. data/rbi/orb/internal/type/unknown.rbi +20 -12
  179. data/rbi/orb/internal/util.rbi +210 -89
  180. data/rbi/orb/models/alert.rbi +107 -70
  181. data/rbi/orb/models/alert_create_for_customer_params.rbi +60 -27
  182. data/rbi/orb/models/alert_create_for_external_customer_params.rbi +68 -29
  183. data/rbi/orb/models/alert_create_for_subscription_params.rbi +53 -26
  184. data/rbi/orb/models/alert_disable_params.rbi +17 -6
  185. data/rbi/orb/models/alert_enable_params.rbi +17 -6
  186. data/rbi/orb/models/alert_list_params.rbi +23 -20
  187. data/rbi/orb/models/alert_retrieve_params.rbi +10 -4
  188. data/rbi/orb/models/alert_update_params.rbi +25 -14
  189. data/rbi/orb/models/amount_discount.rbi +28 -19
  190. data/rbi/orb/models/billable_metric.rbi +33 -26
  191. data/rbi/orb/models/billing_cycle_relative_date.rbi +11 -5
  192. data/rbi/orb/models/coupon.rbi +28 -20
  193. data/rbi/orb/models/coupon_archive_params.rbi +10 -4
  194. data/rbi/orb/models/coupon_create_params.rbi +72 -38
  195. data/rbi/orb/models/coupon_fetch_params.rbi +10 -4
  196. data/rbi/orb/models/coupon_list_params.rbi +18 -15
  197. data/rbi/orb/models/coupons/subscription_list_params.rbi +16 -6
  198. data/rbi/orb/models/credit_note.rbi +293 -158
  199. data/rbi/orb/models/credit_note_create_params.rbi +58 -29
  200. data/rbi/orb/models/credit_note_fetch_params.rbi +10 -4
  201. data/rbi/orb/models/credit_note_list_params.rbi +20 -17
  202. data/rbi/orb/models/customer.rbi +430 -329
  203. data/rbi/orb/models/customer_create_params.rbi +662 -325
  204. data/rbi/orb/models/customer_delete_params.rbi +10 -4
  205. data/rbi/orb/models/customer_fetch_by_external_id_params.rbi +10 -4
  206. data/rbi/orb/models/customer_fetch_params.rbi +10 -4
  207. data/rbi/orb/models/customer_list_params.rbi +20 -17
  208. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +10 -4
  209. data/rbi/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +10 -4
  210. data/rbi/orb/models/customer_update_by_external_id_params.rbi +1136 -336
  211. data/rbi/orb/models/customer_update_params.rbi +661 -324
  212. data/rbi/orb/models/customers/balance_transaction_create_params.rbi +50 -21
  213. data/rbi/orb/models/customers/balance_transaction_create_response.rbi +154 -61
  214. data/rbi/orb/models/customers/balance_transaction_list_params.rbi +20 -17
  215. data/rbi/orb/models/customers/balance_transaction_list_response.rbi +164 -59
  216. data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi +56 -22
  217. data/rbi/orb/models/customers/cost_list_by_external_id_response.rbi +162 -124
  218. data/rbi/orb/models/customers/cost_list_params.rbi +45 -22
  219. data/rbi/orb/models/customers/cost_list_response.rbi +154 -123
  220. data/rbi/orb/models/customers/credit_list_by_external_id_params.rbi +18 -15
  221. data/rbi/orb/models/customers/credit_list_by_external_id_response.rbi +48 -22
  222. data/rbi/orb/models/customers/credit_list_params.rbi +18 -15
  223. data/rbi/orb/models/customers/credit_list_response.rbi +44 -21
  224. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +106 -68
  225. data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +643 -434
  226. data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi +117 -59
  227. data/rbi/orb/models/customers/credits/ledger_create_entry_response.rbi +700 -425
  228. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +102 -44
  229. data/rbi/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +681 -432
  230. data/rbi/orb/models/customers/credits/ledger_list_params.rbi +123 -40
  231. data/rbi/orb/models/customers/credits/ledger_list_response.rbi +735 -389
  232. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +74 -53
  233. data/rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +65 -48
  234. data/rbi/orb/models/customers/credits/top_up_create_params.rbi +84 -45
  235. data/rbi/orb/models/customers/credits/top_up_create_response.rbi +83 -43
  236. data/rbi/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +16 -6
  237. data/rbi/orb/models/customers/credits/top_up_delete_params.rbi +15 -5
  238. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +9 -5
  239. data/rbi/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +70 -49
  240. data/rbi/orb/models/customers/credits/top_up_list_params.rbi +9 -5
  241. data/rbi/orb/models/customers/credits/top_up_list_response.rbi +84 -43
  242. data/rbi/orb/models/dimensional_price_group.rbi +18 -15
  243. data/rbi/orb/models/dimensional_price_group_create_params.rbi +19 -16
  244. data/rbi/orb/models/dimensional_price_group_list_params.rbi +16 -6
  245. data/rbi/orb/models/dimensional_price_group_retrieve_params.rbi +10 -4
  246. data/rbi/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +10 -9
  247. data/rbi/orb/models/dimensional_price_groups.rbi +18 -13
  248. data/rbi/orb/models/discount.rbi +11 -5
  249. data/rbi/orb/models/evaluate_price_group.rbi +28 -12
  250. data/rbi/orb/models/event_deprecate_params.rbi +10 -4
  251. data/rbi/orb/models/event_deprecate_response.rbi +8 -3
  252. data/rbi/orb/models/event_ingest_params.rbi +37 -31
  253. data/rbi/orb/models/event_ingest_response.rbi +63 -23
  254. data/rbi/orb/models/event_search_params.rbi +17 -14
  255. data/rbi/orb/models/event_search_response.rbi +33 -21
  256. data/rbi/orb/models/event_update_params.rbi +19 -16
  257. data/rbi/orb/models/event_update_response.rbi +8 -3
  258. data/rbi/orb/models/events/backfill_close_params.rbi +10 -9
  259. data/rbi/orb/models/events/backfill_close_response.rbi +64 -29
  260. data/rbi/orb/models/events/backfill_create_params.rbi +21 -18
  261. data/rbi/orb/models/events/backfill_create_response.rbi +63 -29
  262. data/rbi/orb/models/events/backfill_fetch_params.rbi +10 -9
  263. data/rbi/orb/models/events/backfill_fetch_response.rbi +64 -29
  264. data/rbi/orb/models/events/backfill_list_params.rbi +16 -6
  265. data/rbi/orb/models/events/backfill_list_response.rbi +62 -28
  266. data/rbi/orb/models/events/backfill_revert_params.rbi +10 -9
  267. data/rbi/orb/models/events/backfill_revert_response.rbi +63 -29
  268. data/rbi/orb/models/events/event_volumes.rbi +32 -10
  269. data/rbi/orb/models/events/volume_list_params.rbi +18 -15
  270. data/rbi/orb/models/invoice.rbi +1286 -805
  271. data/rbi/orb/models/invoice_create_params.rbi +97 -69
  272. data/rbi/orb/models/invoice_fetch_params.rbi +10 -4
  273. data/rbi/orb/models/invoice_fetch_upcoming_params.rbi +15 -5
  274. data/rbi/orb/models/invoice_fetch_upcoming_response.rbi +1991 -861
  275. data/rbi/orb/models/invoice_issue_params.rbi +16 -5
  276. data/rbi/orb/models/invoice_level_discount.rbi +11 -4
  277. data/rbi/orb/models/invoice_line_item_create_params.rbi +20 -17
  278. data/rbi/orb/models/invoice_line_item_create_response.rbi +573 -376
  279. data/rbi/orb/models/invoice_list_params.rbi +67 -47
  280. data/rbi/orb/models/invoice_mark_paid_params.rbi +17 -14
  281. data/rbi/orb/models/invoice_pay_params.rbi +10 -4
  282. data/rbi/orb/models/invoice_update_params.rbi +15 -10
  283. data/rbi/orb/models/invoice_void_params.rbi +10 -4
  284. data/rbi/orb/models/item.rbi +87 -39
  285. data/rbi/orb/models/item_create_params.rbi +14 -5
  286. data/rbi/orb/models/item_fetch_params.rbi +10 -4
  287. data/rbi/orb/models/item_list_params.rbi +16 -6
  288. data/rbi/orb/models/item_update_params.rbi +79 -39
  289. data/rbi/orb/models/metric_create_params.rbi +19 -16
  290. data/rbi/orb/models/metric_fetch_params.rbi +10 -4
  291. data/rbi/orb/models/metric_list_params.rbi +20 -17
  292. data/rbi/orb/models/metric_update_params.rbi +15 -10
  293. data/rbi/orb/models/pagination_metadata.rbi +16 -4
  294. data/rbi/orb/models/percentage_discount.rbi +32 -19
  295. data/rbi/orb/models/plan.rbi +496 -365
  296. data/rbi/orb/models/plan_create_params.rbi +4785 -2875
  297. data/rbi/orb/models/plan_fetch_params.rbi +10 -4
  298. data/rbi/orb/models/plan_list_params.rbi +34 -27
  299. data/rbi/orb/models/plan_update_params.rbi +16 -13
  300. data/rbi/orb/models/plans/external_plan_id_fetch_params.rbi +10 -9
  301. data/rbi/orb/models/plans/external_plan_id_update_params.rbi +16 -13
  302. data/rbi/orb/models/price.rbi +9969 -5024
  303. data/rbi/orb/models/price_create_params.rbi +501 -245
  304. data/rbi/orb/models/price_evaluate_params.rbi +20 -17
  305. data/rbi/orb/models/price_evaluate_response.rbi +11 -6
  306. data/rbi/orb/models/price_fetch_params.rbi +10 -4
  307. data/rbi/orb/models/price_list_params.rbi +16 -6
  308. data/rbi/orb/models/price_update_params.rbi +15 -10
  309. data/rbi/orb/models/prices/external_price_id_fetch_params.rbi +10 -9
  310. data/rbi/orb/models/prices/external_price_id_update_params.rbi +15 -10
  311. data/rbi/orb/models/subscription.rbi +578 -420
  312. data/rbi/orb/models/subscription_cancel_params.rbi +44 -22
  313. data/rbi/orb/models/subscription_cancel_response.rbi +700 -438
  314. data/rbi/orb/models/subscription_change_apply_params.rbi +16 -13
  315. data/rbi/orb/models/subscription_change_apply_response.rbi +784 -504
  316. data/rbi/orb/models/subscription_change_cancel_params.rbi +10 -4
  317. data/rbi/orb/models/subscription_change_cancel_response.rbi +783 -514
  318. data/rbi/orb/models/subscription_change_retrieve_params.rbi +10 -4
  319. data/rbi/orb/models/subscription_change_retrieve_response.rbi +782 -524
  320. data/rbi/orb/models/subscription_create_params.rbi +9021 -6730
  321. data/rbi/orb/models/subscription_create_response.rbi +700 -438
  322. data/rbi/orb/models/subscription_fetch_costs_params.rbi +47 -22
  323. data/rbi/orb/models/subscription_fetch_costs_response.rbi +154 -123
  324. data/rbi/orb/models/subscription_fetch_params.rbi +10 -4
  325. data/rbi/orb/models/subscription_fetch_schedule_params.rbi +20 -17
  326. data/rbi/orb/models/subscription_fetch_schedule_response.rbi +33 -19
  327. data/rbi/orb/models/subscription_fetch_usage_params.rbi +81 -34
  328. data/rbi/orb/models/subscription_list_params.rbi +39 -28
  329. data/rbi/orb/models/subscription_price_intervals_params.rbi +5181 -3822
  330. data/rbi/orb/models/subscription_price_intervals_response.rbi +720 -453
  331. data/rbi/orb/models/subscription_schedule_plan_change_params.rbi +8602 -6910
  332. data/rbi/orb/models/subscription_schedule_plan_change_response.rbi +718 -467
  333. data/rbi/orb/models/subscription_trigger_phase_params.rbi +16 -13
  334. data/rbi/orb/models/subscription_trigger_phase_response.rbi +712 -448
  335. data/rbi/orb/models/subscription_unschedule_cancellation_params.rbi +10 -4
  336. data/rbi/orb/models/subscription_unschedule_cancellation_response.rbi +719 -467
  337. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +16 -5
  338. data/rbi/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +693 -502
  339. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +10 -4
  340. data/rbi/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +708 -497
  341. data/rbi/orb/models/subscription_update_fixed_fee_quantity_params.rbi +57 -26
  342. data/rbi/orb/models/subscription_update_fixed_fee_quantity_response.rbi +719 -467
  343. data/rbi/orb/models/subscription_update_params.rbi +19 -16
  344. data/rbi/orb/models/subscription_update_trial_params.rbi +57 -19
  345. data/rbi/orb/models/subscription_update_trial_response.rbi +712 -447
  346. data/rbi/orb/models/subscription_usage.rbi +271 -121
  347. data/rbi/orb/models/subscriptions.rbi +18 -11
  348. data/rbi/orb/models/top_level_ping_params.rbi +10 -4
  349. data/rbi/orb/models/top_level_ping_response.rbi +7 -3
  350. data/rbi/orb/models/trial_discount.rbi +29 -20
  351. data/rbi/orb/models/usage_discount.rbi +28 -19
  352. data/rbi/orb/models.rbi +22 -11
  353. data/rbi/orb/request_options.rbi +12 -6
  354. data/rbi/orb/resources/alerts.rbi +61 -40
  355. data/rbi/orb/resources/coupons/subscriptions.rbi +7 -5
  356. data/rbi/orb/resources/coupons.rbi +33 -18
  357. data/rbi/orb/resources/credit_notes.rbi +22 -13
  358. data/rbi/orb/resources/customers/balance_transactions.rbi +17 -9
  359. data/rbi/orb/resources/customers/costs.rbi +18 -11
  360. data/rbi/orb/resources/customers/credits/ledger.rbi +98 -74
  361. data/rbi/orb/resources/customers/credits/top_ups.rbi +61 -25
  362. data/rbi/orb/resources/customers/credits.rbi +16 -7
  363. data/rbi/orb/resources/customers.rbi +137 -72
  364. data/rbi/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +8 -4
  365. data/rbi/orb/resources/dimensional_price_groups.rbi +26 -12
  366. data/rbi/orb/resources/events/backfills.rbi +35 -17
  367. data/rbi/orb/resources/events/volume.rbi +7 -5
  368. data/rbi/orb/resources/events.rbi +26 -16
  369. data/rbi/orb/resources/invoice_line_items.rbi +7 -5
  370. data/rbi/orb/resources/invoices.rbi +72 -41
  371. data/rbi/orb/resources/items.rbi +40 -13
  372. data/rbi/orb/resources/metrics.rbi +25 -15
  373. data/rbi/orb/resources/plans/external_plan_id.rbi +15 -7
  374. data/rbi/orb/resources/plans.rbi +57 -47
  375. data/rbi/orb/resources/prices/external_price_id.rbi +73 -68
  376. data/rbi/orb/resources/prices.rbi +176 -156
  377. data/rbi/orb/resources/subscription_changes.rbi +19 -11
  378. data/rbi/orb/resources/subscriptions.rbi +200 -114
  379. data/rbi/orb/resources/top_level.rbi +9 -3
  380. data/sig/orb/internal/page.rbs +0 -2
  381. data/sig/orb/internal/type/request_parameters.rbs +3 -1
  382. data/sig/orb/models/alert.rbs +19 -31
  383. data/sig/orb/models/alert_create_for_customer_params.rbs +3 -7
  384. data/sig/orb/models/alert_create_for_external_customer_params.rbs +3 -7
  385. data/sig/orb/models/alert_create_for_subscription_params.rbs +3 -7
  386. data/sig/orb/models/alert_disable_params.rbs +0 -2
  387. data/sig/orb/models/alert_enable_params.rbs +0 -2
  388. data/sig/orb/models/alert_list_params.rbs +0 -2
  389. data/sig/orb/models/alert_retrieve_params.rbs +0 -2
  390. data/sig/orb/models/alert_update_params.rbs +3 -7
  391. data/sig/orb/models/amount_discount.rbs +4 -6
  392. data/sig/orb/models/billable_metric.rbs +7 -9
  393. data/sig/orb/models/coupon.rbs +5 -8
  394. data/sig/orb/models/coupon_archive_params.rbs +0 -2
  395. data/sig/orb/models/coupon_create_params.rbs +3 -9
  396. data/sig/orb/models/coupon_fetch_params.rbs +0 -2
  397. data/sig/orb/models/coupon_list_params.rbs +0 -2
  398. data/sig/orb/models/coupons/subscription_list_params.rbs +0 -2
  399. data/sig/orb/models/credit_note.rbs +48 -66
  400. data/sig/orb/models/credit_note_create_params.rbs +3 -7
  401. data/sig/orb/models/credit_note_fetch_params.rbs +0 -2
  402. data/sig/orb/models/credit_note_list_params.rbs +0 -2
  403. data/sig/orb/models/customer.rbs +43 -63
  404. data/sig/orb/models/customer_create_params.rbs +32 -52
  405. data/sig/orb/models/customer_delete_params.rbs +0 -2
  406. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +0 -2
  407. data/sig/orb/models/customer_fetch_params.rbs +0 -2
  408. data/sig/orb/models/customer_list_params.rbs +0 -2
  409. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +0 -2
  410. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +0 -2
  411. data/sig/orb/models/customer_update_by_external_id_params.rbs +32 -52
  412. data/sig/orb/models/customer_update_params.rbs +32 -52
  413. data/sig/orb/models/customers/balance_transaction_create_params.rbs +0 -2
  414. data/sig/orb/models/customers/balance_transaction_create_response.rbs +0 -6
  415. data/sig/orb/models/customers/balance_transaction_list_params.rbs +0 -2
  416. data/sig/orb/models/customers/balance_transaction_list_response.rbs +0 -6
  417. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +0 -2
  418. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +0 -6
  419. data/sig/orb/models/customers/cost_list_params.rbs +0 -2
  420. data/sig/orb/models/customers/cost_list_response.rbs +0 -6
  421. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +0 -2
  422. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +0 -2
  423. data/sig/orb/models/customers/credit_list_params.rbs +0 -2
  424. data/sig/orb/models/customers/credit_list_response.rbs +0 -2
  425. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +3 -7
  426. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +1 -43
  427. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +3 -7
  428. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +1 -43
  429. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +0 -2
  430. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +1 -43
  431. data/sig/orb/models/customers/credits/ledger_list_params.rbs +0 -2
  432. data/sig/orb/models/customers/credits/ledger_list_response.rbs +1 -43
  433. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +3 -7
  434. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +0 -4
  435. data/sig/orb/models/customers/credits/top_up_create_params.rbs +3 -7
  436. data/sig/orb/models/customers/credits/top_up_create_response.rbs +0 -4
  437. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +0 -2
  438. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +0 -2
  439. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +0 -2
  440. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +0 -4
  441. data/sig/orb/models/customers/credits/top_up_list_params.rbs +0 -2
  442. data/sig/orb/models/customers/credits/top_up_list_response.rbs +0 -4
  443. data/sig/orb/models/dimensional_price_group.rbs +0 -2
  444. data/sig/orb/models/dimensional_price_group_create_params.rbs +0 -2
  445. data/sig/orb/models/dimensional_price_group_list_params.rbs +0 -2
  446. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +0 -2
  447. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +0 -2
  448. data/sig/orb/models/dimensional_price_groups.rbs +6 -8
  449. data/sig/orb/models/discount.rbs +5 -5
  450. data/sig/orb/models/evaluate_price_group.rbs +4 -6
  451. data/sig/orb/models/event_deprecate_params.rbs +0 -2
  452. data/sig/orb/models/event_deprecate_response.rbs +0 -2
  453. data/sig/orb/models/event_ingest_params.rbs +3 -7
  454. data/sig/orb/models/event_ingest_response.rbs +0 -6
  455. data/sig/orb/models/event_search_params.rbs +0 -2
  456. data/sig/orb/models/event_search_response.rbs +0 -4
  457. data/sig/orb/models/event_update_params.rbs +0 -2
  458. data/sig/orb/models/event_update_response.rbs +0 -2
  459. data/sig/orb/models/events/backfill_close_params.rbs +0 -2
  460. data/sig/orb/models/events/backfill_close_response.rbs +0 -2
  461. data/sig/orb/models/events/backfill_create_params.rbs +0 -2
  462. data/sig/orb/models/events/backfill_create_response.rbs +0 -2
  463. data/sig/orb/models/events/backfill_fetch_params.rbs +0 -2
  464. data/sig/orb/models/events/backfill_fetch_response.rbs +0 -2
  465. data/sig/orb/models/events/backfill_list_params.rbs +0 -2
  466. data/sig/orb/models/events/backfill_list_response.rbs +0 -2
  467. data/sig/orb/models/events/backfill_revert_params.rbs +0 -2
  468. data/sig/orb/models/events/backfill_revert_response.rbs +0 -2
  469. data/sig/orb/models/events/event_volumes.rbs +3 -10
  470. data/sig/orb/models/events/volume_list_params.rbs +0 -2
  471. data/sig/orb/models/invoice.rbs +110 -172
  472. data/sig/orb/models/invoice_create_params.rbs +10 -16
  473. data/sig/orb/models/invoice_fetch_params.rbs +0 -2
  474. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +0 -2
  475. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +2 -64
  476. data/sig/orb/models/invoice_issue_params.rbs +0 -2
  477. data/sig/orb/models/invoice_level_discount.rbs +2 -4
  478. data/sig/orb/models/invoice_line_item_create_params.rbs +0 -2
  479. data/sig/orb/models/invoice_line_item_create_response.rbs +2 -36
  480. data/sig/orb/models/invoice_list_params.rbs +4 -6
  481. data/sig/orb/models/invoice_mark_paid_params.rbs +0 -2
  482. data/sig/orb/models/invoice_pay_params.rbs +0 -2
  483. data/sig/orb/models/invoice_update_params.rbs +0 -2
  484. data/sig/orb/models/invoice_void_params.rbs +0 -2
  485. data/sig/orb/models/item.rbs +7 -11
  486. data/sig/orb/models/item_create_params.rbs +0 -2
  487. data/sig/orb/models/item_fetch_params.rbs +0 -2
  488. data/sig/orb/models/item_list_params.rbs +0 -2
  489. data/sig/orb/models/item_update_params.rbs +7 -11
  490. data/sig/orb/models/metric_create_params.rbs +0 -2
  491. data/sig/orb/models/metric_fetch_params.rbs +0 -2
  492. data/sig/orb/models/metric_list_params.rbs +0 -2
  493. data/sig/orb/models/metric_update_params.rbs +0 -2
  494. data/sig/orb/models/pagination_metadata.rbs +0 -2
  495. data/sig/orb/models/percentage_discount.rbs +4 -6
  496. data/sig/orb/models/plan.rbs +45 -73
  497. data/sig/orb/models/plan_create_params.rbs +518 -696
  498. data/sig/orb/models/plan_fetch_params.rbs +0 -2
  499. data/sig/orb/models/plan_list_params.rbs +0 -2
  500. data/sig/orb/models/plan_update_params.rbs +0 -2
  501. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +0 -2
  502. data/sig/orb/models/plans/external_plan_id_update_params.rbs +0 -2
  503. data/sig/orb/models/price.rbs +1194 -1730
  504. data/sig/orb/models/price_create_params.rbs +59 -97
  505. data/sig/orb/models/price_evaluate_params.rbs +0 -2
  506. data/sig/orb/models/price_evaluate_response.rbs +3 -6
  507. data/sig/orb/models/price_fetch_params.rbs +0 -2
  508. data/sig/orb/models/price_list_params.rbs +0 -2
  509. data/sig/orb/models/price_update_params.rbs +0 -2
  510. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +0 -2
  511. data/sig/orb/models/prices/external_price_id_update_params.rbs +0 -2
  512. data/sig/orb/models/subscription.rbs +56 -94
  513. data/sig/orb/models/subscription_cancel_params.rbs +0 -2
  514. data/sig/orb/models/subscription_cancel_response.rbs +20 -60
  515. data/sig/orb/models/subscription_change_apply_params.rbs +0 -2
  516. data/sig/orb/models/subscription_change_apply_response.rbs +20 -62
  517. data/sig/orb/models/subscription_change_cancel_params.rbs +0 -2
  518. data/sig/orb/models/subscription_change_cancel_response.rbs +20 -62
  519. data/sig/orb/models/subscription_change_retrieve_params.rbs +0 -2
  520. data/sig/orb/models/subscription_change_retrieve_response.rbs +20 -62
  521. data/sig/orb/models/subscription_create_params.rbs +1103 -1499
  522. data/sig/orb/models/subscription_create_response.rbs +20 -60
  523. data/sig/orb/models/subscription_fetch_costs_params.rbs +0 -2
  524. data/sig/orb/models/subscription_fetch_costs_response.rbs +0 -6
  525. data/sig/orb/models/subscription_fetch_params.rbs +0 -2
  526. data/sig/orb/models/subscription_fetch_schedule_params.rbs +0 -2
  527. data/sig/orb/models/subscription_fetch_schedule_response.rbs +0 -4
  528. data/sig/orb/models/subscription_fetch_usage_params.rbs +0 -2
  529. data/sig/orb/models/subscription_list_params.rbs +0 -2
  530. data/sig/orb/models/subscription_price_intervals_params.rbs +666 -896
  531. data/sig/orb/models/subscription_price_intervals_response.rbs +20 -60
  532. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +1103 -1499
  533. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +20 -60
  534. data/sig/orb/models/subscription_trigger_phase_params.rbs +0 -2
  535. data/sig/orb/models/subscription_trigger_phase_response.rbs +20 -60
  536. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +0 -2
  537. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +20 -60
  538. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +0 -2
  539. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +20 -60
  540. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +0 -2
  541. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +20 -60
  542. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +0 -2
  543. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +20 -60
  544. data/sig/orb/models/subscription_update_params.rbs +0 -2
  545. data/sig/orb/models/subscription_update_trial_params.rbs +1 -3
  546. data/sig/orb/models/subscription_update_trial_response.rbs +20 -60
  547. data/sig/orb/models/subscription_usage.rbs +35 -53
  548. data/sig/orb/models/subscriptions.rbs +6 -8
  549. data/sig/orb/models/top_level_ping_params.rbs +0 -2
  550. data/sig/orb/models/top_level_ping_response.rbs +0 -2
  551. data/sig/orb/models/trial_discount.rbs +4 -6
  552. data/sig/orb/models/usage_discount.rbs +4 -6
  553. data/sig/orb/request_options.rbs +1 -1
  554. data/sig/orb/resources/alerts.rbs +12 -12
  555. data/sig/orb/resources/coupons/subscriptions.rbs +1 -1
  556. data/sig/orb/resources/coupons.rbs +4 -4
  557. data/sig/orb/resources/credit_notes.rbs +4 -4
  558. data/sig/orb/resources/customers/credits/ledger.rbs +2 -2
  559. data/sig/orb/resources/customers/credits/top_ups.rbs +2 -2
  560. data/sig/orb/resources/customers.rbs +24 -24
  561. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +1 -1
  562. data/sig/orb/resources/dimensional_price_groups.rbs +3 -3
  563. data/sig/orb/resources/events/volume.rbs +1 -1
  564. data/sig/orb/resources/events.rbs +1 -1
  565. data/sig/orb/resources/invoices.rbs +10 -10
  566. data/sig/orb/resources/items.rbs +5 -5
  567. data/sig/orb/resources/metrics.rbs +4 -4
  568. data/sig/orb/resources/plans/external_plan_id.rbs +2 -2
  569. data/sig/orb/resources/plans.rbs +5 -5
  570. data/sig/orb/resources/prices.rbs +11 -11
  571. data/sig/orb/resources/subscriptions.rbs +21 -21
  572. metadata +2 -2
data/rbi/orb/errors.rbi CHANGED
@@ -29,10 +29,17 @@ module Orb
29
29
  request: NilClass,
30
30
  response: NilClass,
31
31
  message: T.nilable(String)
32
- )
33
- .returns(T.attached_class)
32
+ ).returns(T.attached_class)
33
+ end
34
+ def self.new(
35
+ url:,
36
+ status: nil,
37
+ body: nil,
38
+ request: nil,
39
+ response: nil,
40
+ message: nil
41
+ )
34
42
  end
35
- def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end
36
43
  end
37
44
 
38
45
  class APIConnectionError < Orb::Errors::APIError
@@ -51,10 +58,16 @@ module Orb
51
58
  request: NilClass,
52
59
  response: NilClass,
53
60
  message: T.nilable(String)
54
- )
55
- .returns(T.attached_class)
61
+ ).returns(T.attached_class)
56
62
  end
57
- def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
63
+ def self.new(
64
+ url:,
65
+ status: nil,
66
+ body: nil,
67
+ request: nil,
68
+ response: nil,
69
+ message: "Connection error."
70
+ )
58
71
  end
59
72
  end
60
73
 
@@ -68,10 +81,16 @@ module Orb
68
81
  request: NilClass,
69
82
  response: NilClass,
70
83
  message: T.nilable(String)
71
- )
72
- .returns(T.attached_class)
84
+ ).returns(T.attached_class)
73
85
  end
74
- def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
86
+ def self.new(
87
+ url:,
88
+ status: nil,
89
+ body: nil,
90
+ request: nil,
91
+ response: nil,
92
+ message: "Request timed out."
93
+ )
75
94
  end
76
95
  end
77
96
 
@@ -85,10 +104,10 @@ module Orb
85
104
  request: NilClass,
86
105
  response: NilClass,
87
106
  message: T.nilable(String)
88
- )
89
- .returns(T.attached_class)
107
+ ).returns(T.attached_class)
108
+ end
109
+ def self.for(url:, status:, body:, request:, response:, message: nil)
90
110
  end
91
- def self.for(url:, status:, body:, request:, response:, message: nil); end
92
111
 
93
112
  sig { returns(Integer) }
94
113
  attr_accessor :status
@@ -102,10 +121,10 @@ module Orb
102
121
  request: NilClass,
103
122
  response: NilClass,
104
123
  message: T.nilable(String)
105
- )
106
- .returns(T.attached_class)
124
+ ).returns(T.attached_class)
125
+ end
126
+ def self.new(url:, status:, body:, request:, response:, message: nil)
107
127
  end
108
- def self.new(url:, status:, body:, request:, response:, message: nil); end
109
128
  end
110
129
 
111
130
  class BadRequestError < Orb::Errors::APIStatusError
@@ -137,55 +156,67 @@ module Orb
137
156
  end
138
157
 
139
158
  class InternalServerError < Orb::Errors::APIStatusError
140
- HTTP_STATUS = T.let(500.., T::Range[Integer])
159
+ HTTP_STATUS = T.let((500..), T::Range[Integer])
141
160
  end
142
161
 
143
162
  class ConstraintViolation < Orb::Errors::BadRequestError
144
- TYPE = "https://docs.withorb.com/reference/error-responses#400-constraint-violation"
163
+ TYPE =
164
+ "https://docs.withorb.com/reference/error-responses#400-constraint-violation"
145
165
  end
146
166
 
147
167
  class DuplicateResourceCreation < Orb::Errors::BadRequestError
148
- TYPE = "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation"
168
+ TYPE =
169
+ "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation"
149
170
  end
150
171
 
151
172
  class FeatureNotAvailable < Orb::Errors::BadRequestError
152
- TYPE = "https://docs.withorb.com/reference/error-responses#404-feature-not-available"
173
+ TYPE =
174
+ "https://docs.withorb.com/reference/error-responses#404-feature-not-available"
153
175
  end
154
176
 
155
177
  class RequestValidationError < Orb::Errors::BadRequestError
156
- TYPE = "https://docs.withorb.com/reference/error-responses#400-request-validation-errors"
178
+ TYPE =
179
+ "https://docs.withorb.com/reference/error-responses#400-request-validation-errors"
157
180
  end
158
181
 
159
182
  class OrbAuthenticationError < Orb::Errors::AuthenticationError
160
- TYPE = "https://docs.withorb.com/reference/error-responses#401-authentication-error"
183
+ TYPE =
184
+ "https://docs.withorb.com/reference/error-responses#401-authentication-error"
161
185
  end
162
186
 
163
187
  class ResourceNotFound < Orb::Errors::NotFoundError
164
- TYPE = "https://docs.withorb.com/reference/error-responses#404-resource-not-found"
188
+ TYPE =
189
+ "https://docs.withorb.com/reference/error-responses#404-resource-not-found"
165
190
  end
166
191
 
167
192
  class URLNotFound < Orb::Errors::NotFoundError
168
- TYPE = "https://docs.withorb.com/reference/error-responses#404-url-not-found"
193
+ TYPE =
194
+ "https://docs.withorb.com/reference/error-responses#404-url-not-found"
169
195
  end
170
196
 
171
197
  class ResourceConflict < Orb::Errors::ConflictError
172
- TYPE = "https://docs.withorb.com/reference/error-responses#409-resource-conflict"
198
+ TYPE =
199
+ "https://docs.withorb.com/reference/error-responses#409-resource-conflict"
173
200
  end
174
201
 
175
202
  class RequestTooLarge < Orb::Errors::APIStatusError
176
- TYPE = "https://docs.withorb.com/reference/error-responses#413-request-too-large"
203
+ TYPE =
204
+ "https://docs.withorb.com/reference/error-responses#413-request-too-large"
177
205
  end
178
206
 
179
207
  class ResourceTooLarge < Orb::Errors::APIStatusError
180
- TYPE = "https://docs.withorb.com/reference/error-responses#413-resource-too-large"
208
+ TYPE =
209
+ "https://docs.withorb.com/reference/error-responses#413-resource-too-large"
181
210
  end
182
211
 
183
212
  class TooManyRequests < Orb::Errors::RateLimitError
184
- TYPE = "https://docs.withorb.com/reference/error-responses#429-too-many-requests"
213
+ TYPE =
214
+ "https://docs.withorb.com/reference/error-responses#429-too-many-requests"
185
215
  end
186
216
 
187
217
  class OrbInternalServerError < Orb::Errors::InternalServerError
188
- TYPE = "https://docs.withorb.com/reference/error-responses#500-internal-server-error"
218
+ TYPE =
219
+ "https://docs.withorb.com/reference/error-responses#500-internal-server-error"
189
220
  end
190
221
  end
191
222
  end
@@ -13,22 +13,25 @@ module Orb
13
13
 
14
14
  # @api private
15
15
  sig { returns(String) }
16
- private def read; end
16
+ private def read
17
+ end
17
18
 
18
19
  sig { params(a: T.anything).returns(String) }
19
- def to_json(*a); end
20
+ def to_json(*a)
21
+ end
20
22
 
21
23
  sig { params(a: T.anything).returns(String) }
22
- def to_yaml(*a); end
24
+ def to_yaml(*a)
25
+ end
23
26
 
24
27
  sig do
25
28
  params(
26
29
  content: T.any(Pathname, StringIO, IO, String),
27
30
  filename: T.nilable(String),
28
31
  content_type: T.nilable(String)
29
- )
30
- .returns(T.attached_class)
32
+ ).returns(T.attached_class)
33
+ end
34
+ def self.new(content, filename: nil, content_type: nil)
31
35
  end
32
- def self.new(content, filename: nil, content_type: nil); end
33
36
  end
34
37
  end
@@ -15,20 +15,33 @@ module Orb
15
15
 
16
16
  # @api private
17
17
  sig { returns(String) }
18
- def inspect; end
18
+ def inspect
19
+ end
19
20
 
20
21
  class PaginationMetadata < Orb::Internal::Type::BaseModel
22
+ OrHash = T.type_alias { T.any(T.self_type, Orb::Internal::AnyHash) }
23
+
21
24
  sig { returns(T::Boolean) }
22
25
  attr_accessor :has_more
23
26
 
24
27
  sig { returns(T.nilable(String)) }
25
28
  attr_accessor :next_cursor
26
29
 
27
- sig { params(has_more: T::Boolean, next_cursor: T.nilable(String)).returns(T.attached_class) }
28
- def self.new(has_more:, next_cursor:); end
29
-
30
- sig { override.returns({has_more: T::Boolean, next_cursor: T.nilable(String)}) }
31
- def to_hash; end
30
+ sig do
31
+ params(has_more: T::Boolean, next_cursor: T.nilable(String)).returns(
32
+ T.attached_class
33
+ )
34
+ end
35
+ def self.new(has_more:, next_cursor:)
36
+ end
37
+
38
+ sig do
39
+ override.returns(
40
+ { has_more: T::Boolean, next_cursor: T.nilable(String) }
41
+ )
42
+ end
43
+ def to_hash
44
+ end
32
45
  end
33
46
  end
34
47
  end
@@ -12,30 +12,44 @@ module Orb
12
12
  {
13
13
  method: Symbol,
14
14
  path: T.any(String, T::Array[String]),
15
- query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
16
- headers: T.nilable(
17
- T::Hash[String,
18
- T.nilable(
19
- T.any(
20
- String,
21
- Integer,
22
- T::Array[T.nilable(T.any(String, Integer))]
23
- )
24
- )]
25
- ),
15
+ query:
16
+ T.nilable(
17
+ T::Hash[String, T.nilable(T.any(T::Array[String], String))]
18
+ ),
19
+ headers:
20
+ T.nilable(
21
+ T::Hash[
22
+ String,
23
+ T.nilable(
24
+ T.any(
25
+ String,
26
+ Integer,
27
+ T::Array[T.nilable(T.any(String, Integer))]
28
+ )
29
+ )
30
+ ]
31
+ ),
26
32
  body: T.nilable(T.anything),
27
- unwrap: T.nilable(
28
- T.any(
29
- Symbol,
30
- Integer,
31
- T::Array[T.any(Symbol, Integer)],
32
- T.proc.params(arg0: T.anything).returns(T.anything)
33
- )
34
- ),
35
- page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]),
33
+ unwrap:
34
+ T.nilable(
35
+ T.any(
36
+ Symbol,
37
+ Integer,
38
+ T::Array[T.any(Symbol, Integer)],
39
+ T.proc.params(arg0: T.anything).returns(T.anything)
40
+ )
41
+ ),
42
+ page:
43
+ T.nilable(
44
+ T::Class[
45
+ Orb::Internal::Type::BasePage[
46
+ Orb::Internal::Type::BaseModel
47
+ ]
48
+ ]
49
+ ),
36
50
  stream: T.nilable(T::Class[T.anything]),
37
51
  model: T.nilable(Orb::Internal::Type::Converter::Input),
38
- options: T.nilable(Orb::RequestOpts)
52
+ options: T.nilable(Orb::RequestOptions::OrHash)
39
53
  }
40
54
  end
41
55
 
@@ -58,20 +72,23 @@ module Orb
58
72
 
59
73
  class << self
60
74
  # @api private
61
- sig { params(req: Orb::Internal::Transport::BaseClient::RequestComponentsShape).void }
62
- def validate!(req); end
75
+ sig do
76
+ params(
77
+ req: Orb::Internal::Transport::BaseClient::RequestComponentsShape
78
+ ).void
79
+ end
80
+ def validate!(req)
81
+ end
63
82
 
64
83
  # @api private
65
84
  sig do
66
85
  params(
67
86
  status: Integer,
68
- headers: T.any(
69
- T::Hash[String, String],
70
- Net::HTTPHeader
71
- )
87
+ headers: T.any(T::Hash[String, String], Net::HTTPHeader)
72
88
  ).returns(T::Boolean)
73
89
  end
74
- def should_retry?(status, headers:); end
90
+ def should_retry?(status, headers:)
91
+ end
75
92
 
76
93
  # @api private
77
94
  sig do
@@ -79,20 +96,20 @@ module Orb
79
96
  request: Orb::Internal::Transport::BaseClient::RequestInputShape,
80
97
  status: Integer,
81
98
  response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
82
- )
83
- .returns(Orb::Internal::Transport::BaseClient::RequestInputShape)
99
+ ).returns(Orb::Internal::Transport::BaseClient::RequestInputShape)
100
+ end
101
+ def follow_redirect(request, status:, response_headers:)
84
102
  end
85
- def follow_redirect(request, status:, response_headers:); end
86
103
 
87
104
  # @api private
88
105
  sig do
89
106
  params(
90
107
  status: T.any(Integer, Orb::Errors::APIConnectionError),
91
108
  stream: T.nilable(T::Enumerable[String])
92
- )
93
- .void
109
+ ).void
110
+ end
111
+ def reap_connection!(status, stream:)
94
112
  end
95
- def reap_connection!(status, stream:); end
96
113
  end
97
114
 
98
115
  # @api private
@@ -107,11 +124,19 @@ module Orb
107
124
  max_retries: Integer,
108
125
  initial_retry_delay: Float,
109
126
  max_retry_delay: Float,
110
- headers: T::Hash[String,
111
- T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))],
127
+ headers:
128
+ T::Hash[
129
+ String,
130
+ T.nilable(
131
+ T.any(
132
+ String,
133
+ Integer,
134
+ T::Array[T.nilable(T.any(String, Integer))]
135
+ )
136
+ )
137
+ ],
112
138
  idempotency_header: T.nilable(String)
113
- )
114
- .returns(T.attached_class)
139
+ ).returns(T.attached_class)
115
140
  end
116
141
  def self.new(
117
142
  base_url:,
@@ -121,26 +146,40 @@ module Orb
121
146
  max_retry_delay: 0.0,
122
147
  headers: {},
123
148
  idempotency_header: nil
124
- ); end
149
+ )
150
+ end
151
+
125
152
  # @api private
126
153
  sig { overridable.returns(T::Hash[String, String]) }
127
- private def auth_headers; end
154
+ private def auth_headers
155
+ end
128
156
 
129
157
  # @api private
130
158
  sig { returns(String) }
131
- private def generate_idempotency_key; end
159
+ private def generate_idempotency_key
160
+ end
132
161
 
133
162
  # @api private
134
163
  sig do
135
164
  overridable
136
- .params(req: Orb::Internal::Transport::BaseClient::RequestComponentsShape, opts: Orb::Internal::AnyHash)
165
+ .params(
166
+ req: Orb::Internal::Transport::BaseClient::RequestComponentsShape,
167
+ opts: Orb::Internal::AnyHash
168
+ )
137
169
  .returns(Orb::Internal::Transport::BaseClient::RequestInputShape)
138
170
  end
139
- private def build_request(req, opts); end
171
+ private def build_request(req, opts)
172
+ end
140
173
 
141
174
  # @api private
142
- sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) }
143
- private def retry_delay(headers, retry_count:); end
175
+ sig do
176
+ params(
177
+ headers: T::Hash[String, String],
178
+ retry_count: Integer
179
+ ).returns(Float)
180
+ end
181
+ private def retry_delay(headers, retry_count:)
182
+ end
144
183
 
145
184
  # @api private
146
185
  sig do
@@ -149,10 +188,15 @@ module Orb
149
188
  redirect_count: Integer,
150
189
  retry_count: Integer,
151
190
  send_retry_header: T::Boolean
152
- )
153
- .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
191
+ ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
192
+ end
193
+ private def send_request(
194
+ request,
195
+ redirect_count:,
196
+ retry_count:,
197
+ send_retry_header:
198
+ )
154
199
  end
155
- private def send_request(request, redirect_count:, retry_count:, send_retry_header:); end
156
200
 
157
201
  # Execute the request specified by `req`. This is the method that all resource
158
202
  # methods call into.
@@ -162,32 +206,43 @@ module Orb
162
206
  params(
163
207
  method: Symbol,
164
208
  path: T.any(String, T::Array[String]),
165
- query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
166
- headers: T.nilable(
167
- T::Hash[String,
168
- T.nilable(
169
- T.any(
170
- String,
171
- Integer,
172
- T::Array[T.nilable(T.any(String, Integer))]
173
- )
174
- )]
175
- ),
209
+ query:
210
+ T.nilable(
211
+ T::Hash[String, T.nilable(T.any(T::Array[String], String))]
212
+ ),
213
+ headers:
214
+ T.nilable(
215
+ T::Hash[
216
+ String,
217
+ T.nilable(
218
+ T.any(
219
+ String,
220
+ Integer,
221
+ T::Array[T.nilable(T.any(String, Integer))]
222
+ )
223
+ )
224
+ ]
225
+ ),
176
226
  body: T.nilable(T.anything),
177
- unwrap: T.nilable(
178
- T.any(
179
- Symbol,
180
- Integer,
181
- T::Array[T.any(Symbol, Integer)],
182
- T.proc.params(arg0: T.anything).returns(T.anything)
183
- )
184
- ),
185
- page: T.nilable(T::Class[Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]]),
227
+ unwrap:
228
+ T.nilable(
229
+ T.any(
230
+ Symbol,
231
+ Integer,
232
+ T::Array[T.any(Symbol, Integer)],
233
+ T.proc.params(arg0: T.anything).returns(T.anything)
234
+ )
235
+ ),
236
+ page:
237
+ T.nilable(
238
+ T::Class[
239
+ Orb::Internal::Type::BasePage[Orb::Internal::Type::BaseModel]
240
+ ]
241
+ ),
186
242
  stream: T.nilable(T::Class[T.anything]),
187
243
  model: T.nilable(Orb::Internal::Type::Converter::Input),
188
- options: T.nilable(Orb::RequestOpts)
189
- )
190
- .returns(T.anything)
244
+ options: T.nilable(Orb::RequestOptions::OrHash)
245
+ ).returns(T.anything)
191
246
  end
192
247
  def request(
193
248
  method,
@@ -200,10 +255,13 @@ module Orb
200
255
  stream: nil,
201
256
  model: Orb::Internal::Type::Unknown,
202
257
  options: {}
203
- ); end
258
+ )
259
+ end
260
+
204
261
  # @api private
205
262
  sig { returns(String) }
206
- def inspect; end
263
+ def inspect
264
+ end
207
265
  end
208
266
  end
209
267
  end
@@ -23,37 +23,50 @@ module Orb
23
23
  class << self
24
24
  # @api private
25
25
  sig { params(url: URI::Generic).returns(Net::HTTP) }
26
- def connect(url); end
26
+ def connect(url)
27
+ end
27
28
 
28
29
  # @api private
29
30
  sig { params(conn: Net::HTTP, deadline: Float).void }
30
- def calibrate_socket_timeout(conn, deadline); end
31
+ def calibrate_socket_timeout(conn, deadline)
32
+ end
31
33
 
32
34
  # @api private
33
35
  sig do
34
36
  params(
35
- request: Orb::Internal::Transport::PooledNetRequester::RequestShape,
37
+ request:
38
+ Orb::Internal::Transport::PooledNetRequester::RequestShape,
36
39
  blk: T.proc.params(arg0: String).void
37
- )
38
- .returns([Net::HTTPGenericRequest, T.proc.void])
40
+ ).returns([Net::HTTPGenericRequest, T.proc.void])
41
+ end
42
+ def build_request(request, &blk)
39
43
  end
40
- def build_request(request, &blk); end
41
44
  end
42
45
 
43
46
  # @api private
44
- sig { params(url: URI::Generic, deadline: Float, blk: T.proc.params(arg0: Net::HTTP).void).void }
45
- private def with_pool(url, deadline:, &blk); end
47
+ sig do
48
+ params(
49
+ url: URI::Generic,
50
+ deadline: Float,
51
+ blk: T.proc.params(arg0: Net::HTTP).void
52
+ ).void
53
+ end
54
+ private def with_pool(url, deadline:, &blk)
55
+ end
46
56
 
47
57
  # @api private
48
58
  sig do
49
- params(request: Orb::Internal::Transport::PooledNetRequester::RequestShape)
50
- .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
59
+ params(
60
+ request: Orb::Internal::Transport::PooledNetRequester::RequestShape
61
+ ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
62
+ end
63
+ def execute(request)
51
64
  end
52
- def execute(request); end
53
65
 
54
66
  # @api private
55
67
  sig { params(size: Integer).returns(T.attached_class) }
56
- def self.new(size: Etc.nprocessors); end
68
+ def self.new(size: Etc.nprocessors)
69
+ end
57
70
  end
58
71
  end
59
72
  end