orb-billing 0.1.3 → 0.3.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 (381) hide show
  1. checksums.yaml +4 -4
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +65 -0
  4. data/README.md +61 -51
  5. data/lib/orb/client.rb +7 -6
  6. data/lib/orb/file_part.rb +55 -0
  7. data/lib/orb/internal/page.rb +37 -39
  8. data/lib/orb/internal/transport/base_client.rb +21 -11
  9. data/lib/orb/internal/transport/pooled_net_requester.rb +3 -3
  10. data/lib/orb/internal/type/array_of.rb +28 -2
  11. data/lib/orb/internal/type/base_model.rb +83 -21
  12. data/lib/orb/internal/type/base_page.rb +10 -1
  13. data/lib/orb/internal/type/boolean.rb +6 -0
  14. data/lib/orb/internal/type/converter.rb +28 -1
  15. data/lib/orb/internal/type/enum.rb +28 -8
  16. data/lib/orb/internal/type/{io_like.rb → file_input.rb} +35 -15
  17. data/lib/orb/internal/type/hash_of.rb +28 -2
  18. data/lib/orb/internal/type/request_parameters.rb +1 -2
  19. data/lib/orb/internal/type/union.rb +27 -4
  20. data/lib/orb/internal/type/unknown.rb +6 -0
  21. data/lib/orb/internal/util.rb +105 -70
  22. data/lib/orb/internal.rb +5 -2
  23. data/lib/orb/models/alert.rb +68 -71
  24. data/lib/orb/models/alert_create_for_customer_params.rb +20 -25
  25. data/lib/orb/models/alert_create_for_external_customer_params.rb +20 -25
  26. data/lib/orb/models/alert_create_for_subscription_params.rb +20 -25
  27. data/lib/orb/models/alert_disable_params.rb +5 -9
  28. data/lib/orb/models/alert_enable_params.rb +5 -9
  29. data/lib/orb/models/alert_list_params.rb +26 -36
  30. data/lib/orb/models/alert_retrieve_params.rb +3 -8
  31. data/lib/orb/models/alert_update_params.rb +14 -18
  32. data/lib/orb/models/amount_discount.rb +14 -14
  33. data/lib/orb/models/billable_metric.rb +23 -20
  34. data/lib/orb/models/billing_cycle_relative_date.rb +2 -5
  35. data/lib/orb/models/coupon.rb +28 -21
  36. data/lib/orb/models/coupon_archive_params.rb +3 -8
  37. data/lib/orb/models/coupon_create_params.rb +24 -29
  38. data/lib/orb/models/coupon_fetch_params.rb +3 -8
  39. data/lib/orb/models/coupon_list_params.rb +17 -17
  40. data/lib/orb/models/coupons/subscription_list_params.rb +12 -15
  41. data/lib/orb/models/credit_note.rb +100 -166
  42. data/lib/orb/models/credit_note_create_params.rb +15 -23
  43. data/lib/orb/models/credit_note_fetch_params.rb +3 -8
  44. data/lib/orb/models/credit_note_list_params.rb +20 -30
  45. data/lib/orb/models/customer.rb +224 -271
  46. data/lib/orb/models/customer_create_params.rb +211 -252
  47. data/lib/orb/models/customer_delete_params.rb +3 -8
  48. data/lib/orb/models/customer_fetch_by_external_id_params.rb +3 -8
  49. data/lib/orb/models/customer_fetch_params.rb +3 -8
  50. data/lib/orb/models/customer_list_params.rb +20 -30
  51. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +3 -8
  52. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +3 -8
  53. data/lib/orb/models/customer_update_by_external_id_params.rb +207 -250
  54. data/lib/orb/models/customer_update_params.rb +207 -250
  55. data/lib/orb/models/customers/balance_transaction_create_params.rb +11 -16
  56. data/lib/orb/models/customers/balance_transaction_create_response.rb +33 -51
  57. data/lib/orb/models/customers/balance_transaction_list_params.rb +20 -30
  58. data/lib/orb/models/customers/balance_transaction_list_response.rb +33 -51
  59. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +17 -17
  60. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +22 -26
  61. data/lib/orb/models/customers/cost_list_params.rb +17 -17
  62. data/lib/orb/models/customers/cost_list_response.rb +22 -26
  63. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +18 -22
  64. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +10 -17
  65. data/lib/orb/models/customers/credit_list_params.rb +18 -22
  66. data/lib/orb/models/customers/credit_list_response.rb +10 -17
  67. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +64 -66
  68. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +300 -406
  69. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +63 -66
  70. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +300 -406
  71. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +33 -48
  72. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +300 -406
  73. data/lib/orb/models/customers/credits/ledger_list_params.rb +32 -48
  74. data/lib/orb/models/customers/credits/ledger_list_response.rb +300 -406
  75. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +47 -50
  76. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +43 -46
  77. data/lib/orb/models/customers/credits/top_up_create_params.rb +46 -50
  78. data/lib/orb/models/customers/credits/top_up_create_response.rb +42 -46
  79. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +4 -9
  80. data/lib/orb/models/customers/credits/top_up_delete_params.rb +4 -9
  81. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +12 -15
  82. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +43 -46
  83. data/lib/orb/models/customers/credits/top_up_list_params.rb +12 -15
  84. data/lib/orb/models/customers/credits/top_up_list_response.rb +42 -46
  85. data/lib/orb/models/dimensional_price_group.rb +21 -15
  86. data/lib/orb/models/dimensional_price_group_create_params.rb +17 -23
  87. data/lib/orb/models/dimensional_price_group_list_params.rb +12 -15
  88. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +3 -8
  89. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +3 -8
  90. data/lib/orb/models/dimensional_price_groups.rb +3 -7
  91. data/lib/orb/models/discount.rb +2 -3
  92. data/lib/orb/models/evaluate_price_group.rb +8 -11
  93. data/lib/orb/models/event_deprecate_params.rb +3 -8
  94. data/lib/orb/models/event_deprecate_response.rb +2 -6
  95. data/lib/orb/models/event_ingest_params.rb +33 -27
  96. data/lib/orb/models/event_ingest_response.rb +23 -24
  97. data/lib/orb/models/event_search_params.rb +15 -11
  98. data/lib/orb/models/event_search_response.rb +27 -22
  99. data/lib/orb/models/event_update_params.rb +19 -13
  100. data/lib/orb/models/event_update_response.rb +2 -6
  101. data/lib/orb/models/events/backfill_close_params.rb +3 -8
  102. data/lib/orb/models/events/backfill_close_response.rb +34 -39
  103. data/lib/orb/models/events/backfill_create_params.rb +28 -32
  104. data/lib/orb/models/events/backfill_create_response.rb +34 -39
  105. data/lib/orb/models/events/backfill_fetch_params.rb +3 -8
  106. data/lib/orb/models/events/backfill_fetch_response.rb +34 -39
  107. data/lib/orb/models/events/backfill_list_params.rb +12 -15
  108. data/lib/orb/models/events/backfill_list_response.rb +34 -39
  109. data/lib/orb/models/events/backfill_revert_params.rb +3 -8
  110. data/lib/orb/models/events/backfill_revert_response.rb +34 -39
  111. data/lib/orb/models/events/event_volumes.rb +11 -17
  112. data/lib/orb/models/events/volume_list_params.rb +19 -22
  113. data/lib/orb/models/invoice.rb +589 -637
  114. data/lib/orb/models/invoice_create_params.rb +52 -61
  115. data/lib/orb/models/invoice_fetch_params.rb +3 -8
  116. data/lib/orb/models/invoice_fetch_upcoming_params.rb +4 -9
  117. data/lib/orb/models/invoice_fetch_upcoming_response.rb +584 -631
  118. data/lib/orb/models/invoice_issue_params.rb +10 -14
  119. data/lib/orb/models/invoice_level_discount.rb +2 -3
  120. data/lib/orb/models/invoice_line_item_create_params.rb +19 -14
  121. data/lib/orb/models/invoice_line_item_create_response.rb +247 -269
  122. data/lib/orb/models/invoice_list_params.rb +51 -66
  123. data/lib/orb/models/invoice_mark_paid_params.rb +9 -11
  124. data/lib/orb/models/invoice_pay_params.rb +3 -8
  125. data/lib/orb/models/invoice_update_params.rb +9 -9
  126. data/lib/orb/models/invoice_void_params.rb +3 -8
  127. data/lib/orb/models/item.rb +14 -25
  128. data/lib/orb/models/item_create_params.rb +5 -9
  129. data/lib/orb/models/item_fetch_params.rb +3 -8
  130. data/lib/orb/models/item_list_params.rb +12 -15
  131. data/lib/orb/models/item_update_params.rb +10 -22
  132. data/lib/orb/models/metric_create_params.rb +17 -13
  133. data/lib/orb/models/metric_fetch_params.rb +3 -8
  134. data/lib/orb/models/metric_list_params.rb +20 -30
  135. data/lib/orb/models/metric_update_params.rb +9 -9
  136. data/lib/orb/models/pagination_metadata.rb +3 -7
  137. data/lib/orb/models/percentage_discount.rb +15 -14
  138. data/lib/orb/models/plan.rb +250 -279
  139. data/lib/orb/models/plan_create_params.rb +1623 -1984
  140. data/lib/orb/models/plan_fetch_params.rb +3 -8
  141. data/lib/orb/models/plan_list_params.rb +25 -42
  142. data/lib/orb/models/plan_update_params.rb +12 -10
  143. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +3 -8
  144. data/lib/orb/models/plans/external_plan_id_update_params.rb +12 -10
  145. data/lib/orb/models/price.rb +2709 -3820
  146. data/lib/orb/models/price_create_params.rb +203 -244
  147. data/lib/orb/models/price_evaluate_params.rb +21 -30
  148. data/lib/orb/models/price_evaluate_response.rb +2 -6
  149. data/lib/orb/models/price_fetch_params.rb +3 -8
  150. data/lib/orb/models/price_list_params.rb +12 -15
  151. data/lib/orb/models/price_update_params.rb +9 -9
  152. data/lib/orb/models/prices/external_price_id_fetch_params.rb +3 -8
  153. data/lib/orb/models/prices/external_price_id_update_params.rb +9 -9
  154. data/lib/orb/models/subscription.rb +343 -382
  155. data/lib/orb/models/subscription_cancel_params.rb +16 -16
  156. data/lib/orb/models/subscription_cancel_response.rb +339 -377
  157. data/lib/orb/models/subscription_change_apply_params.rb +7 -10
  158. data/lib/orb/models/subscription_change_apply_response.rb +365 -398
  159. data/lib/orb/models/subscription_change_cancel_params.rb +3 -8
  160. data/lib/orb/models/subscription_change_cancel_response.rb +365 -398
  161. data/lib/orb/models/subscription_change_retrieve_params.rb +3 -8
  162. data/lib/orb/models/subscription_change_retrieve_response.rb +366 -398
  163. data/lib/orb/models/subscription_create_params.rb +3771 -4402
  164. data/lib/orb/models/subscription_create_response.rb +339 -377
  165. data/lib/orb/models/subscription_fetch_costs_params.rb +17 -17
  166. data/lib/orb/models/subscription_fetch_costs_response.rb +22 -26
  167. data/lib/orb/models/subscription_fetch_params.rb +3 -8
  168. data/lib/orb/models/subscription_fetch_schedule_params.rb +20 -30
  169. data/lib/orb/models/subscription_fetch_schedule_response.rb +15 -17
  170. data/lib/orb/models/subscription_fetch_usage_params.rb +32 -43
  171. data/lib/orb/models/subscription_list_params.rb +28 -41
  172. data/lib/orb/models/subscription_price_intervals_params.rb +2018 -2472
  173. data/lib/orb/models/subscription_price_intervals_response.rb +342 -377
  174. data/lib/orb/models/subscription_schedule_plan_change_params.rb +3764 -4392
  175. data/lib/orb/models/subscription_schedule_plan_change_response.rb +342 -377
  176. data/lib/orb/models/subscription_trigger_phase_params.rb +12 -10
  177. data/lib/orb/models/subscription_trigger_phase_response.rb +341 -377
  178. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +3 -8
  179. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +342 -377
  180. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +5 -9
  181. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +343 -377
  182. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +3 -8
  183. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +343 -377
  184. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +22 -33
  185. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +342 -377
  186. data/lib/orb/models/subscription_update_params.rb +21 -23
  187. data/lib/orb/models/subscription_update_trial_params.rb +15 -18
  188. data/lib/orb/models/subscription_update_trial_response.rb +341 -377
  189. data/lib/orb/models/subscription_usage.rb +37 -80
  190. data/lib/orb/models/subscriptions.rb +3 -7
  191. data/lib/orb/models/top_level_ping_params.rb +3 -8
  192. data/lib/orb/models/top_level_ping_response.rb +2 -6
  193. data/lib/orb/models/trial_discount.rb +16 -24
  194. data/lib/orb/models/usage_discount.rb +15 -14
  195. data/lib/orb/request_options.rb +3 -4
  196. data/lib/orb/resources/alerts.rb +48 -17
  197. data/lib/orb/resources/coupons/subscriptions.rb +9 -2
  198. data/lib/orb/resources/coupons.rb +25 -7
  199. data/lib/orb/resources/credit_notes.rb +17 -4
  200. data/lib/orb/resources/customers/balance_transactions.rb +18 -3
  201. data/lib/orb/resources/customers/costs.rb +26 -8
  202. data/lib/orb/resources/customers/credits/ledger.rb +108 -28
  203. data/lib/orb/resources/customers/credits/top_ups.rb +67 -20
  204. data/lib/orb/resources/customers/credits.rb +28 -8
  205. data/lib/orb/resources/customers.rb +135 -36
  206. data/lib/orb/resources/dimensional_price_groups.rb +19 -4
  207. data/lib/orb/resources/events/backfills.rb +32 -9
  208. data/lib/orb/resources/events/volume.rb +14 -4
  209. data/lib/orb/resources/events.rb +40 -11
  210. data/lib/orb/resources/invoice_line_items.rb +16 -6
  211. data/lib/orb/resources/invoices.rb +77 -17
  212. data/lib/orb/resources/items.rb +10 -3
  213. data/lib/orb/resources/metrics.rb +33 -8
  214. data/lib/orb/resources/plans/external_plan_id.rb +10 -2
  215. data/lib/orb/resources/plans.rb +47 -11
  216. data/lib/orb/resources/prices/external_price_id.rb +7 -1
  217. data/lib/orb/resources/prices.rb +97 -22
  218. data/lib/orb/resources/subscription_changes.rb +5 -2
  219. data/lib/orb/resources/subscriptions.rb +292 -78
  220. data/lib/orb/version.rb +1 -1
  221. data/lib/orb.rb +2 -10
  222. data/rbi/lib/orb/client.rbi +7 -6
  223. data/rbi/lib/orb/file_part.rbi +34 -0
  224. data/rbi/lib/orb/internal/page.rbi +1 -0
  225. data/rbi/lib/orb/internal/transport/base_client.rbi +18 -3
  226. data/rbi/lib/orb/internal/type/array_of.rbi +15 -9
  227. data/rbi/lib/orb/internal/type/base_model.rbi +22 -0
  228. data/rbi/lib/orb/internal/type/base_page.rbi +2 -0
  229. data/rbi/lib/orb/internal/type/boolean.rbi +4 -5
  230. data/rbi/lib/orb/internal/type/converter.rbi +8 -0
  231. data/rbi/lib/orb/internal/type/enum.rbi +7 -6
  232. data/rbi/lib/orb/internal/type/{io_like.rbi → file_input.rbi} +9 -7
  233. data/rbi/lib/orb/internal/type/hash_of.rbi +15 -9
  234. data/rbi/lib/orb/internal/type/union.rbi +7 -0
  235. data/rbi/lib/orb/internal/type/unknown.rbi +4 -5
  236. data/rbi/lib/orb/internal/util.rbi +39 -19
  237. data/rbi/lib/orb/internal.rbi +1 -2
  238. data/rbi/lib/orb/models/alert.rbi +28 -8
  239. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +16 -6
  240. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +16 -6
  241. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +16 -6
  242. data/rbi/lib/orb/models/alert_disable_params.rbi +5 -2
  243. data/rbi/lib/orb/models/alert_enable_params.rbi +5 -2
  244. data/rbi/lib/orb/models/alert_list_params.rbi +6 -0
  245. data/rbi/lib/orb/models/alert_update_params.rbi +11 -4
  246. data/rbi/lib/orb/models/amount_discount.rbi +10 -4
  247. data/rbi/lib/orb/models/billable_metric.rbi +16 -3
  248. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +1 -1
  249. data/rbi/lib/orb/models/coupon.rbi +10 -3
  250. data/rbi/lib/orb/models/coupon_create_params.rbi +6 -3
  251. data/rbi/lib/orb/models/coupon_list_params.rbi +13 -3
  252. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +8 -2
  253. data/rbi/lib/orb/models/credit_note.rbi +44 -12
  254. data/rbi/lib/orb/models/credit_note_create_params.rbi +15 -6
  255. data/rbi/lib/orb/models/credit_note_list_params.rbi +3 -0
  256. data/rbi/lib/orb/models/customer.rbi +130 -11
  257. data/rbi/lib/orb/models/customer_create_params.rbi +142 -8
  258. data/rbi/lib/orb/models/customer_list_params.rbi +3 -0
  259. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +140 -8
  260. data/rbi/lib/orb/models/customer_update_params.rbi +140 -8
  261. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +8 -4
  262. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +18 -8
  263. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +3 -0
  264. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +18 -8
  265. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +9 -5
  266. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +21 -4
  267. data/rbi/lib/orb/models/customers/cost_list_params.rbi +9 -5
  268. data/rbi/lib/orb/models/customers/cost_list_response.rbi +21 -4
  269. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +13 -3
  270. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +1 -2
  271. data/rbi/lib/orb/models/customers/credit_list_params.rbi +13 -3
  272. data/rbi/lib/orb/models/customers/credit_list_response.rbi +1 -2
  273. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +40 -18
  274. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +35 -56
  275. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +40 -6
  276. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +35 -56
  277. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +6 -16
  278. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +35 -56
  279. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +6 -4
  280. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +35 -56
  281. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +27 -10
  282. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +25 -10
  283. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +27 -4
  284. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +25 -10
  285. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +8 -2
  286. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +25 -10
  287. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +8 -2
  288. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +25 -4
  289. data/rbi/lib/orb/models/dimensional_price_group.rbi +11 -3
  290. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +4 -0
  291. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +8 -2
  292. data/rbi/lib/orb/models/evaluate_price_group.rbi +8 -2
  293. data/rbi/lib/orb/models/event_deprecate_response.rbi +4 -2
  294. data/rbi/lib/orb/models/event_ingest_params.rbi +22 -5
  295. data/rbi/lib/orb/models/event_ingest_response.rbi +15 -4
  296. data/rbi/lib/orb/models/event_search_params.rbi +14 -2
  297. data/rbi/lib/orb/models/event_search_response.rbi +14 -3
  298. data/rbi/lib/orb/models/event_update_params.rbi +10 -3
  299. data/rbi/lib/orb/models/event_update_response.rbi +4 -2
  300. data/rbi/lib/orb/models/events/backfill_close_response.rbi +14 -2
  301. data/rbi/lib/orb/models/events/backfill_create_params.rbi +18 -0
  302. data/rbi/lib/orb/models/events/backfill_create_response.rbi +14 -2
  303. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +14 -2
  304. data/rbi/lib/orb/models/events/backfill_list_params.rbi +8 -2
  305. data/rbi/lib/orb/models/events/backfill_list_response.rbi +14 -2
  306. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +14 -2
  307. data/rbi/lib/orb/models/events/event_volumes.rbi +6 -2
  308. data/rbi/lib/orb/models/events/volume_list_params.rbi +18 -2
  309. data/rbi/lib/orb/models/invoice.rbi +375 -46
  310. data/rbi/lib/orb/models/invoice_create_params.rbi +38 -6
  311. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +375 -66
  312. data/rbi/lib/orb/models/invoice_issue_params.rbi +9 -2
  313. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +16 -2
  314. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +141 -20
  315. data/rbi/lib/orb/models/invoice_list_params.rbi +9 -2
  316. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +9 -2
  317. data/rbi/lib/orb/models/invoice_update_params.rbi +7 -2
  318. data/rbi/lib/orb/models/item.rbi +1 -2
  319. data/rbi/lib/orb/models/item_create_params.rbi +5 -2
  320. data/rbi/lib/orb/models/item_list_params.rbi +8 -2
  321. data/rbi/lib/orb/models/item_update_params.rbi +1 -8
  322. data/rbi/lib/orb/models/metric_create_params.rbi +15 -2
  323. data/rbi/lib/orb/models/metric_list_params.rbi +3 -0
  324. data/rbi/lib/orb/models/metric_update_params.rbi +7 -2
  325. data/rbi/lib/orb/models/percentage_discount.rbi +11 -4
  326. data/rbi/lib/orb/models/plan.rbi +102 -15
  327. data/rbi/lib/orb/models/plan_create_params.rbi +997 -679
  328. data/rbi/lib/orb/models/plan_list_params.rbi +5 -1
  329. data/rbi/lib/orb/models/plan_update_params.rbi +11 -2
  330. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +11 -2
  331. data/rbi/lib/orb/models/price.rbi +717 -688
  332. data/rbi/lib/orb/models/price_create_params.rbi +137 -53
  333. data/rbi/lib/orb/models/price_evaluate_params.rbi +10 -0
  334. data/rbi/lib/orb/models/price_list_params.rbi +8 -2
  335. data/rbi/lib/orb/models/price_update_params.rbi +7 -2
  336. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +7 -2
  337. data/rbi/lib/orb/models/subscription.rbi +174 -11
  338. data/rbi/lib/orb/models/subscription_cancel_params.rbi +8 -5
  339. data/rbi/lib/orb/models/subscription_cancel_response.rbi +187 -14
  340. data/rbi/lib/orb/models/subscription_change_apply_params.rbi +7 -2
  341. data/rbi/lib/orb/models/subscription_change_apply_response.rbi +199 -18
  342. data/rbi/lib/orb/models/subscription_change_cancel_response.rbi +199 -18
  343. data/rbi/lib/orb/models/subscription_change_retrieve_response.rbi +199 -18
  344. data/rbi/lib/orb/models/subscription_create_params.rbi +2282 -1536
  345. data/rbi/lib/orb/models/subscription_create_response.rbi +187 -14
  346. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +9 -5
  347. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +21 -4
  348. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +3 -0
  349. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +8 -2
  350. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +13 -4
  351. data/rbi/lib/orb/models/subscription_list_params.rbi +4 -2
  352. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +1228 -861
  353. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +187 -14
  354. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +2288 -1544
  355. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +187 -14
  356. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +10 -2
  357. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +187 -14
  358. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +187 -14
  359. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +5 -2
  360. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +187 -20
  361. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +187 -14
  362. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +11 -2
  363. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +187 -14
  364. data/rbi/lib/orb/models/subscription_update_params.rbi +15 -0
  365. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +11 -5
  366. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +187 -14
  367. data/rbi/lib/orb/models/subscription_usage.rbi +2 -16
  368. data/rbi/lib/orb/models/trial_discount.rbi +5 -1
  369. data/rbi/lib/orb/models/usage_discount.rbi +11 -3
  370. data/sig/orb/file_part.rbs +21 -0
  371. data/sig/orb/internal/transport/base_client.rbs +9 -3
  372. data/sig/orb/internal/type/array_of.rbs +4 -0
  373. data/sig/orb/internal/type/base_model.rbs +12 -0
  374. data/sig/orb/internal/type/converter.rbs +4 -0
  375. data/sig/orb/internal/type/enum.rbs +4 -2
  376. data/sig/orb/internal/type/{io_like.rbs → file_input.rbs} +1 -1
  377. data/sig/orb/internal/type/hash_of.rbs +4 -0
  378. data/sig/orb/internal/type/union.rbs +4 -0
  379. data/sig/orb/internal/util.rbs +16 -12
  380. data/sig/orb/internal.rbs +1 -1
  381. metadata +9 -5
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Events#ingest
6
6
  class EventIngestParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute events
@@ -20,25 +19,24 @@ module Orb
20
19
  # @return [String, nil]
21
20
  optional :backfill_id, String, nil?: true
22
21
 
23
- # @!attribute [r] debug
22
+ # @!attribute debug
24
23
  # Flag to enable additional debug information in the endpoint response
25
24
  #
26
25
  # @return [Boolean, nil]
27
26
  optional :debug, Orb::Internal::Type::Boolean
28
27
 
29
- # @!parse
30
- # # @return [Boolean]
31
- # attr_writer :debug
32
-
33
- # @!parse
34
- # # @param events [Array<Orb::Models::EventIngestParams::Event>]
35
- # # @param backfill_id [String, nil]
36
- # # @param debug [Boolean]
37
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
38
- # #
39
- # def initialize(events:, backfill_id: nil, debug: nil, request_options: {}, **) = super
40
-
41
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
28
+ # @!method initialize(events:, backfill_id: nil, debug: nil, request_options: {})
29
+ # Some parameter documentations has been truncated, see
30
+ # {Orb::Models::EventIngestParams} for more details.
31
+ #
32
+ # @param events [Array<Orb::Models::EventIngestParams::Event>]
33
+ #
34
+ # @param backfill_id [String, nil] If this ingestion request is part of a backfill, this parameter ties the ingeste
35
+ # ...
36
+ #
37
+ # @param debug [Boolean] Flag to enable additional debug information in the endpoint response
38
+ #
39
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
42
40
 
43
41
  class Event < Orb::Internal::Type::BaseModel
44
42
  # @!attribute event_name
@@ -83,17 +81,25 @@ module Orb
83
81
  # @return [String, nil]
84
82
  optional :external_customer_id, String, nil?: true
85
83
 
86
- # @!parse
87
- # # @param event_name [String]
88
- # # @param idempotency_key [String]
89
- # # @param properties [Object]
90
- # # @param timestamp [Time]
91
- # # @param customer_id [String, nil]
92
- # # @param external_customer_id [String, nil]
93
- # #
94
- # def initialize(event_name:, idempotency_key:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, **) = super
95
-
96
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
84
+ # @!method initialize(event_name:, idempotency_key:, properties:, timestamp:, customer_id: nil, external_customer_id: nil)
85
+ # Some parameter documentations has been truncated, see
86
+ # {Orb::Models::EventIngestParams::Event} for more details.
87
+ #
88
+ # @param event_name [String] A name to meaningfully identify the action or event type.
89
+ #
90
+ # @param idempotency_key [String] A unique value, generated by the client, that is used to de-duplicate events. Ex
91
+ # ...
92
+ #
93
+ # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
94
+ # ...
95
+ #
96
+ # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
97
+ # ...
98
+ #
99
+ # @param customer_id [String, nil] The Orb Customer identifier
100
+ #
101
+ # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
102
+ # ...
97
103
  end
98
104
  end
99
105
  end
@@ -19,13 +19,15 @@ module Orb
19
19
  # @return [Orb::Models::EventIngestResponse::Debug, nil]
20
20
  optional :debug, -> { Orb::Models::EventIngestResponse::Debug }, nil?: true
21
21
 
22
- # @!parse
23
- # # @param validation_failed [Array<Orb::Models::EventIngestResponse::ValidationFailed>]
24
- # # @param debug [Orb::Models::EventIngestResponse::Debug, nil]
25
- # #
26
- # def initialize(validation_failed:, debug: nil, **) = super
27
-
28
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
22
+ # @!method initialize(validation_failed:, debug: nil)
23
+ # Some parameter documentations has been truncated, see
24
+ # {Orb::Models::EventIngestResponse} for more details.
25
+ #
26
+ # @param validation_failed [Array<Orb::Models::EventIngestResponse::ValidationFailed>] Contains all failing validation events. In the case of a 200, this array will al
27
+ # ...
28
+ #
29
+ # @param debug [Orb::Models::EventIngestResponse::Debug, nil] Optional debug information (only present when debug=true is passed to the endpoi
30
+ # ...
29
31
 
30
32
  class ValidationFailed < Orb::Internal::Type::BaseModel
31
33
  # @!attribute idempotency_key
@@ -41,13 +43,14 @@ module Orb
41
43
  # @return [Array<String>]
42
44
  required :validation_errors, Orb::Internal::Type::ArrayOf[String]
43
45
 
44
- # @!parse
45
- # # @param idempotency_key [String]
46
- # # @param validation_errors [Array<String>]
47
- # #
48
- # def initialize(idempotency_key:, validation_errors:, **) = super
49
-
50
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
46
+ # @!method initialize(idempotency_key:, validation_errors:)
47
+ # Some parameter documentations has been truncated, see
48
+ # {Orb::Models::EventIngestResponse::ValidationFailed} for more details.
49
+ #
50
+ # @param idempotency_key [String] The passed idempotency_key corresponding to the validation_errors
51
+ #
52
+ # @param validation_errors [Array<String>] An array of strings corresponding to validation failures for this idempotency_ke
53
+ # ...
51
54
  end
52
55
 
53
56
  # @see Orb::Models::EventIngestResponse#debug
@@ -62,16 +65,12 @@ module Orb
62
65
  # @return [Array<String>]
63
66
  required :ingested, Orb::Internal::Type::ArrayOf[String]
64
67
 
65
- # @!parse
66
- # # Optional debug information (only present when debug=true is passed to the
67
- # # endpoint). Contains ingested and duplicate event idempotency keys.
68
- # #
69
- # # @param duplicate [Array<String>]
70
- # # @param ingested [Array<String>]
71
- # #
72
- # def initialize(duplicate:, ingested:, **) = super
73
-
74
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
68
+ # @!method initialize(duplicate:, ingested:)
69
+ # Optional debug information (only present when debug=true is passed to the
70
+ # endpoint). Contains ingested and duplicate event idempotency keys.
71
+ #
72
+ # @param duplicate [Array<String>]
73
+ # @param ingested [Array<String>]
75
74
  end
76
75
  end
77
76
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Events#search
6
6
  class EventSearchParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute event_ids
@@ -31,15 +30,20 @@ module Orb
31
30
  # @return [Time, nil]
32
31
  optional :timeframe_start, Time, nil?: true
33
32
 
34
- # @!parse
35
- # # @param event_ids [Array<String>]
36
- # # @param timeframe_end [Time, nil]
37
- # # @param timeframe_start [Time, nil]
38
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
39
- # #
40
- # def initialize(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {}, **) = super
41
-
42
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
33
+ # @!method initialize(event_ids:, timeframe_end: nil, timeframe_start: nil, request_options: {})
34
+ # Some parameter documentations has been truncated, see
35
+ # {Orb::Models::EventSearchParams} for more details.
36
+ #
37
+ # @param event_ids [Array<String>] This is an explicit array of IDs to filter by. Note that an event's ID is the id
38
+ # ...
39
+ #
40
+ # @param timeframe_end [Time, nil] The end of the timeframe, exclusive, in which to search events. If not specified
41
+ # ...
42
+ #
43
+ # @param timeframe_start [Time, nil] The start of the timeframe, inclusive, in which to search events. If not specifi
44
+ # ...
45
+ #
46
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
43
47
  end
44
48
  end
45
49
  end
@@ -9,12 +9,8 @@ module Orb
9
9
  # @return [Array<Orb::Models::EventSearchResponse::Data>]
10
10
  required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::EventSearchResponse::Data] }
11
11
 
12
- # @!parse
13
- # # @param data [Array<Orb::Models::EventSearchResponse::Data>]
14
- # #
15
- # def initialize(data:, **) = super
16
-
17
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
12
+ # @!method initialize(data:)
13
+ # @param data [Array<Orb::Models::EventSearchResponse::Data>]
18
14
 
19
15
  class Data < Orb::Internal::Type::BaseModel
20
16
  # @!attribute id
@@ -65,22 +61,31 @@ module Orb
65
61
  # @return [Time]
66
62
  required :timestamp, Time
67
63
 
68
- # @!parse
69
- # # The [Event](/core-concepts#event) resource represents a usage event that has
70
- # # been created for a customer. Events are the core of Orb's usage-based billing
71
- # # model, and are used to calculate the usage charges for a given billing period.
72
- # #
73
- # # @param id [String]
74
- # # @param customer_id [String, nil]
75
- # # @param deprecated [Boolean]
76
- # # @param event_name [String]
77
- # # @param external_customer_id [String, nil]
78
- # # @param properties [Object]
79
- # # @param timestamp [Time]
80
- # #
81
- # def initialize(id:, customer_id:, deprecated:, event_name:, external_customer_id:, properties:, timestamp:, **) = super
82
-
83
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
64
+ # @!method initialize(id:, customer_id:, deprecated:, event_name:, external_customer_id:, properties:, timestamp:)
65
+ # Some parameter documentations has been truncated, see
66
+ # {Orb::Models::EventSearchResponse::Data} for more details.
67
+ #
68
+ # The [Event](/core-concepts#event) resource represents a usage event that has
69
+ # been created for a customer. Events are the core of Orb's usage-based billing
70
+ # model, and are used to calculate the usage charges for a given billing period.
71
+ #
72
+ # @param id [String] A unique value, generated by the client, that is used to de-duplicate events. Ex
73
+ # ...
74
+ #
75
+ # @param customer_id [String, nil] The Orb Customer identifier
76
+ #
77
+ # @param deprecated [Boolean] A boolean indicating whether the event is currently deprecated.
78
+ #
79
+ # @param event_name [String] A name to meaningfully identify the action or event type.
80
+ #
81
+ # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
82
+ # ...
83
+ #
84
+ # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
85
+ # ...
86
+ #
87
+ # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
88
+ # ...
84
89
  end
85
90
  end
86
91
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Events#update
6
6
  class EventUpdateParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute event_name
@@ -42,17 +41,24 @@ module Orb
42
41
  # @return [String, nil]
43
42
  optional :external_customer_id, String, nil?: true
44
43
 
45
- # @!parse
46
- # # @param event_name [String]
47
- # # @param properties [Object]
48
- # # @param timestamp [Time]
49
- # # @param customer_id [String, nil]
50
- # # @param external_customer_id [String, nil]
51
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
52
- # #
53
- # def initialize(event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {}, **) = super
54
-
55
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
44
+ # @!method initialize(event_name:, properties:, timestamp:, customer_id: nil, external_customer_id: nil, request_options: {})
45
+ # Some parameter documentations has been truncated, see
46
+ # {Orb::Models::EventUpdateParams} for more details.
47
+ #
48
+ # @param event_name [String] A name to meaningfully identify the action or event type.
49
+ #
50
+ # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
51
+ # ...
52
+ #
53
+ # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
54
+ # ...
55
+ #
56
+ # @param customer_id [String, nil] The Orb Customer identifier
57
+ #
58
+ # @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
59
+ # ...
60
+ #
61
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
56
62
  end
57
63
  end
58
64
  end
@@ -10,12 +10,8 @@ module Orb
10
10
  # @return [String]
11
11
  required :amended, String
12
12
 
13
- # @!parse
14
- # # @param amended [String]
15
- # #
16
- # def initialize(amended:, **) = super
17
-
18
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
13
+ # @!method initialize(amended:)
14
+ # @param amended [String] event_id of the amended event, if successfully ingested
19
15
  end
20
16
  end
21
17
  end
@@ -5,16 +5,11 @@ module Orb
5
5
  module Events
6
6
  # @see Orb::Resources::Events::Backfills#close
7
7
  class BackfillCloseParams < Orb::Internal::Type::BaseModel
8
- # @!parse
9
- # extend Orb::Internal::Type::RequestParameters::Converter
8
+ extend Orb::Internal::Type::RequestParameters::Converter
10
9
  include Orb::Internal::Type::RequestParameters
11
10
 
12
- # @!parse
13
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
14
- # #
15
- # def initialize(request_options: {}, **) = super
16
-
17
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
11
+ # @!method initialize(request_options: {})
12
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
18
13
  end
19
14
  end
20
15
  end
@@ -73,40 +73,38 @@ module Orb
73
73
  # @return [String, nil]
74
74
  optional :deprecation_filter, String, nil?: true
75
75
 
76
- # @!parse
77
- # # A backfill represents an update to historical usage data, adding or replacing
78
- # # events in a timeframe.
79
- # #
80
- # # @param id [String]
81
- # # @param close_time [Time, nil]
82
- # # @param created_at [Time]
83
- # # @param customer_id [String, nil]
84
- # # @param events_ingested [Integer]
85
- # # @param replace_existing_events [Boolean]
86
- # # @param reverted_at [Time, nil]
87
- # # @param status [Symbol, Orb::Models::Events::BackfillCloseResponse::Status]
88
- # # @param timeframe_end [Time]
89
- # # @param timeframe_start [Time]
90
- # # @param deprecation_filter [String, nil]
91
- # #
92
- # def initialize(
93
- # id:,
94
- # close_time:,
95
- # created_at:,
96
- # customer_id:,
97
- # events_ingested:,
98
- # replace_existing_events:,
99
- # reverted_at:,
100
- # status:,
101
- # timeframe_end:,
102
- # timeframe_start:,
103
- # deprecation_filter: nil,
104
- # **
105
- # )
106
- # super
107
- # end
108
-
109
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
76
+ # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
77
+ # Some parameter documentations has been truncated, see
78
+ # {Orb::Models::Events::BackfillCloseResponse} for more details.
79
+ #
80
+ # A backfill represents an update to historical usage data, adding or replacing
81
+ # events in a timeframe.
82
+ #
83
+ # @param id [String]
84
+ #
85
+ # @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
86
+ # ...
87
+ #
88
+ # @param created_at [Time]
89
+ #
90
+ # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
91
+ # ...
92
+ #
93
+ # @param events_ingested [Integer] The number of events ingested in this backfill.
94
+ #
95
+ # @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
96
+ # ...
97
+ #
98
+ # @param reverted_at [Time, nil] The time at which this backfill was reverted.
99
+ #
100
+ # @param status [Symbol, Orb::Models::Events::BackfillCloseResponse::Status] The status of the backfill.
101
+ #
102
+ # @param timeframe_end [Time]
103
+ #
104
+ # @param timeframe_start [Time]
105
+ #
106
+ # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
107
+ # ...
110
108
 
111
109
  # The status of the backfill.
112
110
  #
@@ -119,11 +117,8 @@ module Orb
119
117
  PENDING_REVERT = :pending_revert
120
118
  REVERTED = :reverted
121
119
 
122
- finalize!
123
-
124
- # @!parse
125
- # # @return [Array<Symbol>]
126
- # def self.values; end
120
+ # @!method self.values
121
+ # @return [Array<Symbol>]
127
122
  end
128
123
  end
129
124
  end
@@ -5,8 +5,7 @@ module Orb
5
5
  module Events
6
6
  # @see Orb::Resources::Events::Backfills#create
7
7
  class BackfillCreateParams < Orb::Internal::Type::BaseModel
8
- # @!parse
9
- # extend Orb::Internal::Type::RequestParameters::Converter
8
+ extend Orb::Internal::Type::RequestParameters::Converter
10
9
  include Orb::Internal::Type::RequestParameters
11
10
 
12
11
  # @!attribute timeframe_end
@@ -55,42 +54,39 @@ module Orb
55
54
  # @return [String, nil]
56
55
  optional :external_customer_id, String, nil?: true
57
56
 
58
- # @!attribute [r] replace_existing_events
57
+ # @!attribute replace_existing_events
59
58
  # If true, replaces all existing events in the timeframe with the newly ingested
60
59
  # events. If false, adds the newly ingested events to the existing events.
61
60
  #
62
61
  # @return [Boolean, nil]
63
62
  optional :replace_existing_events, Orb::Internal::Type::Boolean
64
63
 
65
- # @!parse
66
- # # @return [Boolean]
67
- # attr_writer :replace_existing_events
68
-
69
- # @!parse
70
- # # @param timeframe_end [Time]
71
- # # @param timeframe_start [Time]
72
- # # @param close_time [Time, nil]
73
- # # @param customer_id [String, nil]
74
- # # @param deprecation_filter [String, nil]
75
- # # @param external_customer_id [String, nil]
76
- # # @param replace_existing_events [Boolean]
77
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
78
- # #
79
- # def initialize(
80
- # timeframe_end:,
81
- # timeframe_start:,
82
- # close_time: nil,
83
- # customer_id: nil,
84
- # deprecation_filter: nil,
85
- # external_customer_id: nil,
86
- # replace_existing_events: nil,
87
- # request_options: {},
88
- # **
89
- # )
90
- # super
91
- # end
92
-
93
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
64
+ # @!method initialize(timeframe_end:, timeframe_start:, close_time: nil, customer_id: nil, deprecation_filter: nil, external_customer_id: nil, replace_existing_events: nil, request_options: {})
65
+ # Some parameter documentations has been truncated, see
66
+ # {Orb::Models::Events::BackfillCreateParams} for more details.
67
+ #
68
+ # @param timeframe_end [Time] The (exclusive) end of the usage timeframe affected by this backfill. By default
69
+ # ...
70
+ #
71
+ # @param timeframe_start [Time] The (inclusive) start of the usage timeframe affected by this backfill. By defau
72
+ # ...
73
+ #
74
+ # @param close_time [Time, nil] The time at which no more events will be accepted for this backfill. The backfil
75
+ # ...
76
+ #
77
+ # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. Omitting
78
+ # ...
79
+ #
80
+ # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
81
+ # ...
82
+ #
83
+ # @param external_customer_id [String, nil] The external customer ID of the customer to which this backfill is scoped. Omitt
84
+ # ...
85
+ #
86
+ # @param replace_existing_events [Boolean] If true, replaces all existing events in the timeframe with the newly ingested e
87
+ # ...
88
+ #
89
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
94
90
  end
95
91
  end
96
92
  end
@@ -73,40 +73,38 @@ module Orb
73
73
  # @return [String, nil]
74
74
  optional :deprecation_filter, String, nil?: true
75
75
 
76
- # @!parse
77
- # # A backfill represents an update to historical usage data, adding or replacing
78
- # # events in a timeframe.
79
- # #
80
- # # @param id [String]
81
- # # @param close_time [Time, nil]
82
- # # @param created_at [Time]
83
- # # @param customer_id [String, nil]
84
- # # @param events_ingested [Integer]
85
- # # @param replace_existing_events [Boolean]
86
- # # @param reverted_at [Time, nil]
87
- # # @param status [Symbol, Orb::Models::Events::BackfillCreateResponse::Status]
88
- # # @param timeframe_end [Time]
89
- # # @param timeframe_start [Time]
90
- # # @param deprecation_filter [String, nil]
91
- # #
92
- # def initialize(
93
- # id:,
94
- # close_time:,
95
- # created_at:,
96
- # customer_id:,
97
- # events_ingested:,
98
- # replace_existing_events:,
99
- # reverted_at:,
100
- # status:,
101
- # timeframe_end:,
102
- # timeframe_start:,
103
- # deprecation_filter: nil,
104
- # **
105
- # )
106
- # super
107
- # end
108
-
109
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
76
+ # @!method initialize(id:, close_time:, created_at:, customer_id:, events_ingested:, replace_existing_events:, reverted_at:, status:, timeframe_end:, timeframe_start:, deprecation_filter: nil)
77
+ # Some parameter documentations has been truncated, see
78
+ # {Orb::Models::Events::BackfillCreateResponse} for more details.
79
+ #
80
+ # A backfill represents an update to historical usage data, adding or replacing
81
+ # events in a timeframe.
82
+ #
83
+ # @param id [String]
84
+ #
85
+ # @param close_time [Time, nil] If in the future, the time at which the backfill will automatically close. If in
86
+ # ...
87
+ #
88
+ # @param created_at [Time]
89
+ #
90
+ # @param customer_id [String, nil] The Orb-generated ID of the customer to which this backfill is scoped. If `null`
91
+ # ...
92
+ #
93
+ # @param events_ingested [Integer] The number of events ingested in this backfill.
94
+ #
95
+ # @param replace_existing_events [Boolean] If `true`, existing events in the backfill's timeframe will be replaced with the
96
+ # ...
97
+ #
98
+ # @param reverted_at [Time, nil] The time at which this backfill was reverted.
99
+ #
100
+ # @param status [Symbol, Orb::Models::Events::BackfillCreateResponse::Status] The status of the backfill.
101
+ #
102
+ # @param timeframe_end [Time]
103
+ #
104
+ # @param timeframe_start [Time]
105
+ #
106
+ # @param deprecation_filter [String, nil] A boolean [computed property](/extensibility/advanced-metrics#computed-propertie
107
+ # ...
110
108
 
111
109
  # The status of the backfill.
112
110
  #
@@ -119,11 +117,8 @@ module Orb
119
117
  PENDING_REVERT = :pending_revert
120
118
  REVERTED = :reverted
121
119
 
122
- finalize!
123
-
124
- # @!parse
125
- # # @return [Array<Symbol>]
126
- # def self.values; end
120
+ # @!method self.values
121
+ # @return [Array<Symbol>]
127
122
  end
128
123
  end
129
124
  end
@@ -5,16 +5,11 @@ module Orb
5
5
  module Events
6
6
  # @see Orb::Resources::Events::Backfills#fetch
7
7
  class BackfillFetchParams < Orb::Internal::Type::BaseModel
8
- # @!parse
9
- # extend Orb::Internal::Type::RequestParameters::Converter
8
+ extend Orb::Internal::Type::RequestParameters::Converter
10
9
  include Orb::Internal::Type::RequestParameters
11
10
 
12
- # @!parse
13
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
14
- # #
15
- # def initialize(request_options: {}, **) = super
16
-
17
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
11
+ # @!method initialize(request_options: {})
12
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
18
13
  end
19
14
  end
20
15
  end