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::Invoices#list
6
6
  class InvoiceListParams < 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 amount
@@ -94,16 +93,12 @@ module Orb
94
93
  # @return [Boolean, nil]
95
94
  optional :is_recurring, Orb::Internal::Type::Boolean, nil?: true
96
95
 
97
- # @!attribute [r] limit
96
+ # @!attribute limit
98
97
  # The number of items to fetch. Defaults to 20.
99
98
  #
100
99
  # @return [Integer, nil]
101
100
  optional :limit, Integer
102
101
 
103
- # @!parse
104
- # # @return [Integer]
105
- # attr_writer :limit
106
-
107
102
  # @!attribute status
108
103
  #
109
104
  # @return [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
@@ -116,55 +111,51 @@ module Orb
116
111
  # @return [String, nil]
117
112
  optional :subscription_id, String, nil?: true
118
113
 
119
- # @!parse
120
- # # @param amount [String, nil]
121
- # # @param amount_gt [String, nil]
122
- # # @param amount_lt [String, nil]
123
- # # @param cursor [String, nil]
124
- # # @param customer_id [String, nil]
125
- # # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
126
- # # @param due_date [Date, nil]
127
- # # @param due_date_window [String, nil]
128
- # # @param due_date_gt [Date, nil]
129
- # # @param due_date_lt [Date, nil]
130
- # # @param external_customer_id [String, nil]
131
- # # @param invoice_date_gt [Time, nil]
132
- # # @param invoice_date_gte [Time, nil]
133
- # # @param invoice_date_lt [Time, nil]
134
- # # @param invoice_date_lte [Time, nil]
135
- # # @param is_recurring [Boolean, nil]
136
- # # @param limit [Integer]
137
- # # @param status [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
138
- # # @param subscription_id [String, nil]
139
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
140
- # #
141
- # def initialize(
142
- # amount: nil,
143
- # amount_gt: nil,
144
- # amount_lt: nil,
145
- # cursor: nil,
146
- # customer_id: nil,
147
- # date_type: nil,
148
- # due_date: nil,
149
- # due_date_window: nil,
150
- # due_date_gt: nil,
151
- # due_date_lt: nil,
152
- # external_customer_id: nil,
153
- # invoice_date_gt: nil,
154
- # invoice_date_gte: nil,
155
- # invoice_date_lt: nil,
156
- # invoice_date_lte: nil,
157
- # is_recurring: nil,
158
- # limit: nil,
159
- # status: nil,
160
- # subscription_id: nil,
161
- # request_options: {},
162
- # **
163
- # )
164
- # super
165
- # end
166
-
167
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
114
+ # @!method initialize(amount: nil, amount_gt: nil, amount_lt: nil, cursor: nil, customer_id: nil, date_type: nil, due_date: nil, due_date_window: nil, due_date_gt: nil, due_date_lt: nil, external_customer_id: nil, invoice_date_gt: nil, invoice_date_gte: nil, invoice_date_lt: nil, invoice_date_lte: nil, is_recurring: nil, limit: nil, status: nil, subscription_id: nil, request_options: {})
115
+ # Some parameter documentations has been truncated, see
116
+ # {Orb::Models::InvoiceListParams} for more details.
117
+ #
118
+ # @param amount [String, nil]
119
+ #
120
+ # @param amount_gt [String, nil]
121
+ #
122
+ # @param amount_lt [String, nil]
123
+ #
124
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
125
+ # ...
126
+ #
127
+ # @param customer_id [String, nil]
128
+ #
129
+ # @param date_type [Symbol, Orb::Models::InvoiceListParams::DateType, nil]
130
+ #
131
+ # @param due_date [Date, nil]
132
+ #
133
+ # @param due_date_window [String, nil] Filters invoices by their due dates within a specific time range in the past. Sp
134
+ # ...
135
+ #
136
+ # @param due_date_gt [Date, nil]
137
+ #
138
+ # @param due_date_lt [Date, nil]
139
+ #
140
+ # @param external_customer_id [String, nil]
141
+ #
142
+ # @param invoice_date_gt [Time, nil]
143
+ #
144
+ # @param invoice_date_gte [Time, nil]
145
+ #
146
+ # @param invoice_date_lt [Time, nil]
147
+ #
148
+ # @param invoice_date_lte [Time, nil]
149
+ #
150
+ # @param is_recurring [Boolean, nil]
151
+ #
152
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
153
+ #
154
+ # @param status [Array<Symbol, Orb::Models::InvoiceListParams::Status>, nil]
155
+ #
156
+ # @param subscription_id [String, nil]
157
+ #
158
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
168
159
 
169
160
  module DateType
170
161
  extend Orb::Internal::Type::Enum
@@ -172,11 +163,8 @@ module Orb
172
163
  DUE_DATE = :due_date
173
164
  INVOICE_DATE = :invoice_date
174
165
 
175
- finalize!
176
-
177
- # @!parse
178
- # # @return [Array<Symbol>]
179
- # def self.values; end
166
+ # @!method self.values
167
+ # @return [Array<Symbol>]
180
168
  end
181
169
 
182
170
  module Status
@@ -188,11 +176,8 @@ module Orb
188
176
  SYNCED = :synced
189
177
  VOID = :void
190
178
 
191
- finalize!
192
-
193
- # @!parse
194
- # # @return [Array<Symbol>]
195
- # def self.values; end
179
+ # @!method self.values
180
+ # @return [Array<Symbol>]
196
181
  end
197
182
  end
198
183
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Invoices#mark_paid
6
6
  class InvoiceMarkPaidParams < 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 payment_received_date
@@ -26,15 +25,14 @@ module Orb
26
25
  # @return [String, nil]
27
26
  optional :notes, String, nil?: true
28
27
 
29
- # @!parse
30
- # # @param payment_received_date [Date]
31
- # # @param external_id [String, nil]
32
- # # @param notes [String, nil]
33
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
34
- # #
35
- # def initialize(payment_received_date:, external_id: nil, notes: nil, request_options: {}, **) = super
36
-
37
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
28
+ # @!method initialize(payment_received_date:, external_id: nil, notes: nil, request_options: {})
29
+ # @param payment_received_date [Date] A date string to specify the date of the payment.
30
+ #
31
+ # @param external_id [String, nil] An optional external ID to associate with the payment.
32
+ #
33
+ # @param notes [String, nil] An optional note to associate with the payment.
34
+ #
35
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
38
36
  end
39
37
  end
40
38
  end
@@ -4,16 +4,11 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Invoices#pay
6
6
  class InvoicePayParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
- # @!parse
12
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
13
- # #
14
- # def initialize(request_options: {}, **) = super
15
-
16
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
17
12
  end
18
13
  end
19
14
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Invoices#update
6
6
  class InvoiceUpdateParams < 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 metadata
@@ -16,13 +15,14 @@ module Orb
16
15
  # @return [Hash{Symbol=>String, nil}, nil]
17
16
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
18
17
 
19
- # @!parse
20
- # # @param metadata [Hash{Symbol=>String, nil}, nil]
21
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
22
- # #
23
- # def initialize(metadata: nil, request_options: {}, **) = super
24
-
25
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
18
+ # @!method initialize(metadata: nil, request_options: {})
19
+ # Some parameter documentations has been truncated, see
20
+ # {Orb::Models::InvoiceUpdateParams} for more details.
21
+ #
22
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
23
+ # ...
24
+ #
25
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
26
26
  end
27
27
  end
28
28
  end
@@ -4,16 +4,11 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Invoices#void
6
6
  class InvoiceVoidParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
- # @!parse
12
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
13
- # #
14
- # def initialize(request_options: {}, **) = super
15
-
16
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
17
12
  end
18
13
  end
19
14
  end
@@ -24,19 +24,15 @@ module Orb
24
24
  # @return [String]
25
25
  required :name, String
26
26
 
27
- # @!parse
28
- # # The Item resource represents a sellable product or good. Items are associated
29
- # # with all line items, billable metrics, and prices and are used for defining
30
- # # external sync behavior for invoices and tax calculation purposes.
31
- # #
32
- # # @param id [String]
33
- # # @param created_at [Time]
34
- # # @param external_connections [Array<Orb::Models::Item::ExternalConnection>]
35
- # # @param name [String]
36
- # #
37
- # def initialize(id:, created_at:, external_connections:, name:, **) = super
38
-
39
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
27
+ # @!method initialize(id:, created_at:, external_connections:, name:)
28
+ # The Item resource represents a sellable product or good. Items are associated
29
+ # with all line items, billable metrics, and prices and are used for defining
30
+ # external sync behavior for invoices and tax calculation purposes.
31
+ #
32
+ # @param id [String]
33
+ # @param created_at [Time]
34
+ # @param external_connections [Array<Orb::Models::Item::ExternalConnection>]
35
+ # @param name [String]
40
36
 
41
37
  class ExternalConnection < Orb::Internal::Type::BaseModel
42
38
  # @!attribute external_connection_name
@@ -50,13 +46,9 @@ module Orb
50
46
  # @return [String]
51
47
  required :external_entity_id, String
52
48
 
53
- # @!parse
54
- # # @param external_connection_name [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName]
55
- # # @param external_entity_id [String]
56
- # #
57
- # def initialize(external_connection_name:, external_entity_id:, **) = super
58
-
59
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
49
+ # @!method initialize(external_connection_name:, external_entity_id:)
50
+ # @param external_connection_name [Symbol, Orb::Models::Item::ExternalConnection::ExternalConnectionName]
51
+ # @param external_entity_id [String]
60
52
 
61
53
  # @see Orb::Models::Item::ExternalConnection#external_connection_name
62
54
  module ExternalConnectionName
@@ -70,11 +62,8 @@ module Orb
70
62
  AVALARA = :avalara
71
63
  ANROK = :anrok
72
64
 
73
- finalize!
74
-
75
- # @!parse
76
- # # @return [Array<Symbol>]
77
- # def self.values; end
65
+ # @!method self.values
66
+ # @return [Array<Symbol>]
78
67
  end
79
68
  end
80
69
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Items#create
6
6
  class ItemCreateParams < 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 name
@@ -14,13 +13,10 @@ module Orb
14
13
  # @return [String]
15
14
  required :name, String
16
15
 
17
- # @!parse
18
- # # @param name [String]
19
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
20
- # #
21
- # def initialize(name:, request_options: {}, **) = super
22
-
23
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
16
+ # @!method initialize(name:, request_options: {})
17
+ # @param name [String] The name of the item.
18
+ #
19
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
24
20
  end
25
21
  end
26
22
  end
@@ -4,16 +4,11 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Items#fetch
6
6
  class ItemFetchParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
- # @!parse
12
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
13
- # #
14
- # def initialize(request_options: {}, **) = super
15
-
16
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
17
12
  end
18
13
  end
19
14
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Items#list
6
6
  class ItemListParams < 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 cursor
@@ -15,24 +14,22 @@ module Orb
15
14
  # @return [String, nil]
16
15
  optional :cursor, String, nil?: true
17
16
 
18
- # @!attribute [r] limit
17
+ # @!attribute limit
19
18
  # The number of items to fetch. Defaults to 20.
20
19
  #
21
20
  # @return [Integer, nil]
22
21
  optional :limit, Integer
23
22
 
24
- # @!parse
25
- # # @return [Integer]
26
- # attr_writer :limit
27
-
28
- # @!parse
29
- # # @param cursor [String, nil]
30
- # # @param limit [Integer]
31
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
32
- # #
33
- # def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
34
-
35
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
23
+ # @!method initialize(cursor: nil, limit: nil, request_options: {})
24
+ # Some parameter documentations has been truncated, see
25
+ # {Orb::Models::ItemListParams} for more details.
26
+ #
27
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
28
+ # ...
29
+ #
30
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
31
+ #
32
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
36
33
  end
37
34
  end
38
35
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Items#update
6
6
  class ItemUpdateParams < 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 external_connections
@@ -20,14 +19,10 @@ module Orb
20
19
  # @return [String, nil]
21
20
  optional :name, String, nil?: true
22
21
 
23
- # @!parse
24
- # # @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
25
- # # @param name [String, nil]
26
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
27
- # #
28
- # def initialize(external_connections: nil, name: nil, request_options: {}, **) = super
29
-
30
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
22
+ # @!method initialize(external_connections: nil, name: nil, request_options: {})
23
+ # @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
24
+ # @param name [String, nil]
25
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
31
26
 
32
27
  class ExternalConnection < Orb::Internal::Type::BaseModel
33
28
  # @!attribute external_connection_name
@@ -41,13 +36,9 @@ module Orb
41
36
  # @return [String]
42
37
  required :external_entity_id, String
43
38
 
44
- # @!parse
45
- # # @param external_connection_name [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
46
- # # @param external_entity_id [String]
47
- # #
48
- # def initialize(external_connection_name:, external_entity_id:, **) = super
49
-
50
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
39
+ # @!method initialize(external_connection_name:, external_entity_id:)
40
+ # @param external_connection_name [Symbol, Orb::Models::ItemUpdateParams::ExternalConnection::ExternalConnectionName]
41
+ # @param external_entity_id [String]
51
42
 
52
43
  # @see Orb::Models::ItemUpdateParams::ExternalConnection#external_connection_name
53
44
  module ExternalConnectionName
@@ -61,11 +52,8 @@ module Orb
61
52
  AVALARA = :avalara
62
53
  ANROK = :anrok
63
54
 
64
- finalize!
65
-
66
- # @!parse
67
- # # @return [Array<Symbol>]
68
- # def self.values; end
55
+ # @!method self.values
56
+ # @return [Array<Symbol>]
69
57
  end
70
58
  end
71
59
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Metrics#create
6
6
  class MetricCreateParams < 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 description
@@ -40,17 +39,22 @@ module Orb
40
39
  # @return [Hash{Symbol=>String, nil}, nil]
41
40
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
42
41
 
43
- # @!parse
44
- # # @param description [String, nil]
45
- # # @param item_id [String]
46
- # # @param name [String]
47
- # # @param sql [String]
48
- # # @param metadata [Hash{Symbol=>String, nil}, nil]
49
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
50
- # #
51
- # def initialize(description:, item_id:, name:, sql:, metadata: nil, request_options: {}, **) = super
52
-
53
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
42
+ # @!method initialize(description:, item_id:, name:, sql:, metadata: nil, request_options: {})
43
+ # Some parameter documentations has been truncated, see
44
+ # {Orb::Models::MetricCreateParams} for more details.
45
+ #
46
+ # @param description [String, nil] A description of the metric.
47
+ #
48
+ # @param item_id [String] The id of the item
49
+ #
50
+ # @param name [String] The name of the metric.
51
+ #
52
+ # @param sql [String] A sql string defining the metric.
53
+ #
54
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
55
+ # ...
56
+ #
57
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
54
58
  end
55
59
  end
56
60
  end
@@ -4,16 +4,11 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Metrics#fetch
6
6
  class MetricFetchParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
- # @!parse
12
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
13
- # #
14
- # def initialize(request_options: {}, **) = super
15
-
16
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
17
12
  end
18
13
  end
19
14
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Metrics#list
6
6
  class MetricListParams < Orb::Internal::Type::BaseModel
7
- # @!parse
8
- # extend Orb::Internal::Type::RequestParameters::Converter
7
+ extend Orb::Internal::Type::RequestParameters::Converter
9
8
  include Orb::Internal::Type::RequestParameters
10
9
 
11
10
  # @!attribute created_at_gt
@@ -35,39 +34,30 @@ module Orb
35
34
  # @return [String, nil]
36
35
  optional :cursor, String, nil?: true
37
36
 
38
- # @!attribute [r] limit
37
+ # @!attribute limit
39
38
  # The number of items to fetch. Defaults to 20.
40
39
  #
41
40
  # @return [Integer, nil]
42
41
  optional :limit, Integer
43
42
 
44
- # @!parse
45
- # # @return [Integer]
46
- # attr_writer :limit
47
-
48
- # @!parse
49
- # # @param created_at_gt [Time, nil]
50
- # # @param created_at_gte [Time, nil]
51
- # # @param created_at_lt [Time, nil]
52
- # # @param created_at_lte [Time, nil]
53
- # # @param cursor [String, nil]
54
- # # @param limit [Integer]
55
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
56
- # #
57
- # def initialize(
58
- # created_at_gt: nil,
59
- # created_at_gte: nil,
60
- # created_at_lt: nil,
61
- # created_at_lte: nil,
62
- # cursor: nil,
63
- # limit: nil,
64
- # request_options: {},
65
- # **
66
- # )
67
- # super
68
- # end
69
-
70
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
43
+ # @!method initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, limit: nil, request_options: {})
44
+ # Some parameter documentations has been truncated, see
45
+ # {Orb::Models::MetricListParams} for more details.
46
+ #
47
+ # @param created_at_gt [Time, nil]
48
+ #
49
+ # @param created_at_gte [Time, nil]
50
+ #
51
+ # @param created_at_lt [Time, nil]
52
+ #
53
+ # @param created_at_lte [Time, nil]
54
+ #
55
+ # @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
56
+ # ...
57
+ #
58
+ # @param limit [Integer] The number of items to fetch. Defaults to 20.
59
+ #
60
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
71
61
  end
72
62
  end
73
63
  end
@@ -4,8 +4,7 @@ module Orb
4
4
  module Models
5
5
  # @see Orb::Resources::Metrics#update
6
6
  class MetricUpdateParams < 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 metadata
@@ -16,13 +15,14 @@ module Orb
16
15
  # @return [Hash{Symbol=>String, nil}, nil]
17
16
  optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
18
17
 
19
- # @!parse
20
- # # @param metadata [Hash{Symbol=>String, nil}, nil]
21
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
22
- # #
23
- # def initialize(metadata: nil, request_options: {}, **) = super
24
-
25
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
18
+ # @!method initialize(metadata: nil, request_options: {})
19
+ # Some parameter documentations has been truncated, see
20
+ # {Orb::Models::MetricUpdateParams} for more details.
21
+ #
22
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
23
+ # ...
24
+ #
25
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
26
26
  end
27
27
  end
28
28
  end