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::Prices#create
6
6
  class PriceCreateParams < 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 cadence
@@ -245,101 +244,101 @@ module Orb
245
244
  # @return [Hash{Symbol=>Object}]
246
245
  required :cumulative_grouped_bulk_config, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
247
246
 
248
- # @!parse
249
- # # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence]
250
- # # @param currency [String]
251
- # # @param item_id [String]
252
- # # @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType]
253
- # # @param name [String]
254
- # # @param unit_config [Orb::Models::PriceCreateParams::UnitConfig]
255
- # # @param package_config [Orb::Models::PriceCreateParams::PackageConfig]
256
- # # @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig]
257
- # # @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig]
258
- # # @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig]
259
- # # @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig]
260
- # # @param bps_config [Orb::Models::PriceCreateParams::BpsConfig]
261
- # # @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig]
262
- # # @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig]
263
- # # @param threshold_total_amount_config [Hash{Symbol=>Object}]
264
- # # @param tiered_package_config [Hash{Symbol=>Object}]
265
- # # @param grouped_tiered_config [Hash{Symbol=>Object}]
266
- # # @param max_group_tiered_package_config [Hash{Symbol=>Object}]
267
- # # @param tiered_with_minimum_config [Hash{Symbol=>Object}]
268
- # # @param package_with_allocation_config [Hash{Symbol=>Object}]
269
- # # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}]
270
- # # @param unit_with_percent_config [Hash{Symbol=>Object}]
271
- # # @param tiered_with_proration_config [Hash{Symbol=>Object}]
272
- # # @param unit_with_proration_config [Hash{Symbol=>Object}]
273
- # # @param grouped_allocation_config [Hash{Symbol=>Object}]
274
- # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
275
- # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
276
- # # @param matrix_with_display_name_config [Hash{Symbol=>Object}]
277
- # # @param bulk_with_proration_config [Hash{Symbol=>Object}]
278
- # # @param grouped_tiered_package_config [Hash{Symbol=>Object}]
279
- # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}]
280
- # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}]
281
- # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
282
- # # @param billable_metric_id [String, nil]
283
- # # @param billed_in_advance [Boolean, nil]
284
- # # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil]
285
- # # @param conversion_rate [Float, nil]
286
- # # @param external_price_id [String, nil]
287
- # # @param fixed_price_quantity [Float, nil]
288
- # # @param invoice_grouping_key [String, nil]
289
- # # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil]
290
- # # @param metadata [Hash{Symbol=>String, nil}, nil]
291
- # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
292
- # #
293
- # def initialize(
294
- # cadence:,
295
- # currency:,
296
- # item_id:,
297
- # model_type:,
298
- # name:,
299
- # unit_config:,
300
- # package_config:,
301
- # matrix_config:,
302
- # matrix_with_allocation_config:,
303
- # tiered_config:,
304
- # tiered_bps_config:,
305
- # bps_config:,
306
- # bulk_bps_config:,
307
- # bulk_config:,
308
- # threshold_total_amount_config:,
309
- # tiered_package_config:,
310
- # grouped_tiered_config:,
311
- # max_group_tiered_package_config:,
312
- # tiered_with_minimum_config:,
313
- # package_with_allocation_config:,
314
- # tiered_package_with_minimum_config:,
315
- # unit_with_percent_config:,
316
- # tiered_with_proration_config:,
317
- # unit_with_proration_config:,
318
- # grouped_allocation_config:,
319
- # grouped_with_prorated_minimum_config:,
320
- # grouped_with_metered_minimum_config:,
321
- # matrix_with_display_name_config:,
322
- # bulk_with_proration_config:,
323
- # grouped_tiered_package_config:,
324
- # scalable_matrix_with_unit_pricing_config:,
325
- # scalable_matrix_with_tiered_pricing_config:,
326
- # cumulative_grouped_bulk_config:,
327
- # billable_metric_id: nil,
328
- # billed_in_advance: nil,
329
- # billing_cycle_configuration: nil,
330
- # conversion_rate: nil,
331
- # external_price_id: nil,
332
- # fixed_price_quantity: nil,
333
- # invoice_grouping_key: nil,
334
- # invoicing_cycle_configuration: nil,
335
- # metadata: nil,
336
- # request_options: {},
337
- # **
338
- # )
339
- # super
340
- # end
341
-
342
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
247
+ # @!method initialize(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {})
248
+ # Some parameter documentations has been truncated, see
249
+ # {Orb::Models::PriceCreateParams} for more details.
250
+ #
251
+ # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence] The cadence to bill for this price on.
252
+ #
253
+ # @param currency [String] An ISO 4217 currency string for which this price is billed in.
254
+ #
255
+ # @param item_id [String] The id of the item the price will be associated with.
256
+ #
257
+ # @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType]
258
+ #
259
+ # @param name [String] The name of the price.
260
+ #
261
+ # @param unit_config [Orb::Models::PriceCreateParams::UnitConfig]
262
+ #
263
+ # @param package_config [Orb::Models::PriceCreateParams::PackageConfig]
264
+ #
265
+ # @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig]
266
+ #
267
+ # @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig]
268
+ #
269
+ # @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig]
270
+ #
271
+ # @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig]
272
+ #
273
+ # @param bps_config [Orb::Models::PriceCreateParams::BpsConfig]
274
+ #
275
+ # @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig]
276
+ #
277
+ # @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig]
278
+ #
279
+ # @param threshold_total_amount_config [Hash{Symbol=>Object}]
280
+ #
281
+ # @param tiered_package_config [Hash{Symbol=>Object}]
282
+ #
283
+ # @param grouped_tiered_config [Hash{Symbol=>Object}]
284
+ #
285
+ # @param max_group_tiered_package_config [Hash{Symbol=>Object}]
286
+ #
287
+ # @param tiered_with_minimum_config [Hash{Symbol=>Object}]
288
+ #
289
+ # @param package_with_allocation_config [Hash{Symbol=>Object}]
290
+ #
291
+ # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}]
292
+ #
293
+ # @param unit_with_percent_config [Hash{Symbol=>Object}]
294
+ #
295
+ # @param tiered_with_proration_config [Hash{Symbol=>Object}]
296
+ #
297
+ # @param unit_with_proration_config [Hash{Symbol=>Object}]
298
+ #
299
+ # @param grouped_allocation_config [Hash{Symbol=>Object}]
300
+ #
301
+ # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
302
+ #
303
+ # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
304
+ #
305
+ # @param matrix_with_display_name_config [Hash{Symbol=>Object}]
306
+ #
307
+ # @param bulk_with_proration_config [Hash{Symbol=>Object}]
308
+ #
309
+ # @param grouped_tiered_package_config [Hash{Symbol=>Object}]
310
+ #
311
+ # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}]
312
+ #
313
+ # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}]
314
+ #
315
+ # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
316
+ #
317
+ # @param billable_metric_id [String, nil] The id of the billable metric for the price. Only needed if the price is usage-b
318
+ # ...
319
+ #
320
+ # @param billed_in_advance [Boolean, nil] If the Price represents a fixed cost, the price will be billed in-advance if thi
321
+ # ...
322
+ #
323
+ # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil] For custom cadence: specifies the duration of the billing period in days or mont
324
+ # ...
325
+ #
326
+ # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
327
+ #
328
+ # @param external_price_id [String, nil] An alias for the price.
329
+ #
330
+ # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
331
+ # ...
332
+ #
333
+ # @param invoice_grouping_key [String, nil] The property used to group this price on an invoice
334
+ #
335
+ # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil] Within each billing cycle, specifies the cadence at which invoices are produced.
336
+ # ...
337
+ #
338
+ # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
339
+ # ...
340
+ #
341
+ # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
343
342
 
344
343
  # The cadence to bill for this price on.
345
344
  module Cadence
@@ -352,11 +351,8 @@ module Orb
352
351
  ONE_TIME = :one_time
353
352
  CUSTOM = :custom
354
353
 
355
- finalize!
356
-
357
- # @!parse
358
- # # @return [Array<Symbol>]
359
- # def self.values; end
354
+ # @!method self.values
355
+ # @return [Array<Symbol>]
360
356
  end
361
357
 
362
358
  module ModelType
@@ -364,11 +360,8 @@ module Orb
364
360
 
365
361
  CUMULATIVE_GROUPED_BULK = :cumulative_grouped_bulk
366
362
 
367
- finalize!
368
-
369
- # @!parse
370
- # # @return [Array<Symbol>]
371
- # def self.values; end
363
+ # @!method self.values
364
+ # @return [Array<Symbol>]
372
365
  end
373
366
 
374
367
  class UnitConfig < Orb::Internal::Type::BaseModel
@@ -378,12 +371,8 @@ module Orb
378
371
  # @return [String]
379
372
  required :unit_amount, String
380
373
 
381
- # @!parse
382
- # # @param unit_amount [String]
383
- # #
384
- # def initialize(unit_amount:, **) = super
385
-
386
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
374
+ # @!method initialize(unit_amount:)
375
+ # @param unit_amount [String] Rate per unit of usage
387
376
  end
388
377
 
389
378
  class BillingCycleConfiguration < Orb::Internal::Type::BaseModel
@@ -400,16 +389,13 @@ module Orb
400
389
  required :duration_unit,
401
390
  enum: -> { Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit }
402
391
 
403
- # @!parse
404
- # # For custom cadence: specifies the duration of the billing period in days or
405
- # # months.
406
- # #
407
- # # @param duration [Integer]
408
- # # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit]
409
- # #
410
- # def initialize(duration:, duration_unit:, **) = super
411
-
412
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
392
+ # @!method initialize(duration:, duration_unit:)
393
+ # For custom cadence: specifies the duration of the billing period in days or
394
+ # months.
395
+ #
396
+ # @param duration [Integer] The duration of the billing period.
397
+ #
398
+ # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit] The unit of billing period duration.
413
399
 
414
400
  # The unit of billing period duration.
415
401
  #
@@ -420,11 +406,8 @@ module Orb
420
406
  DAY = :day
421
407
  MONTH = :month
422
408
 
423
- finalize!
424
-
425
- # @!parse
426
- # # @return [Array<Symbol>]
427
- # def self.values; end
409
+ # @!method self.values
410
+ # @return [Array<Symbol>]
428
411
  end
429
412
  end
430
413
 
@@ -442,16 +425,13 @@ module Orb
442
425
  required :duration_unit,
443
426
  enum: -> { Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit }
444
427
 
445
- # @!parse
446
- # # Within each billing cycle, specifies the cadence at which invoices are produced.
447
- # # If unspecified, a single invoice is produced per billing cycle.
448
- # #
449
- # # @param duration [Integer]
450
- # # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit]
451
- # #
452
- # def initialize(duration:, duration_unit:, **) = super
453
-
454
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
428
+ # @!method initialize(duration:, duration_unit:)
429
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
430
+ # If unspecified, a single invoice is produced per billing cycle.
431
+ #
432
+ # @param duration [Integer] The duration of the billing period.
433
+ #
434
+ # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit] The unit of billing period duration.
455
435
 
456
436
  # The unit of billing period duration.
457
437
  #
@@ -462,11 +442,8 @@ module Orb
462
442
  DAY = :day
463
443
  MONTH = :month
464
444
 
465
- finalize!
466
-
467
- # @!parse
468
- # # @return [Array<Symbol>]
469
- # def self.values; end
445
+ # @!method self.values
446
+ # @return [Array<Symbol>]
470
447
  end
471
448
  end
472
449
 
@@ -484,13 +461,14 @@ module Orb
484
461
  # @return [Integer]
485
462
  required :package_size, Integer
486
463
 
487
- # @!parse
488
- # # @param package_amount [String]
489
- # # @param package_size [Integer]
490
- # #
491
- # def initialize(package_amount:, package_size:, **) = super
492
-
493
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
464
+ # @!method initialize(package_amount:, package_size:)
465
+ # Some parameter documentations has been truncated, see
466
+ # {Orb::Models::PriceCreateParams::PackageConfig} for more details.
467
+ #
468
+ # @param package_amount [String] A currency amount to rate usage by
469
+ #
470
+ # @param package_size [Integer] An integer amount to represent package size. For example, 1000 here would divide
471
+ # ...
494
472
  end
495
473
 
496
474
  class MatrixConfig < Orb::Internal::Type::BaseModel
@@ -513,14 +491,12 @@ module Orb
513
491
  required :matrix_values,
514
492
  -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue] }
515
493
 
516
- # @!parse
517
- # # @param default_unit_amount [String]
518
- # # @param dimensions [Array<String, nil>]
519
- # # @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue>]
520
- # #
521
- # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super
522
-
523
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
494
+ # @!method initialize(default_unit_amount:, dimensions:, matrix_values:)
495
+ # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
496
+ #
497
+ # @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
498
+ #
499
+ # @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue>] Matrix values for specified matrix grouping keys
524
500
 
525
501
  class MatrixValue < Orb::Internal::Type::BaseModel
526
502
  # @!attribute dimension_values
@@ -537,13 +513,14 @@ module Orb
537
513
  # @return [String]
538
514
  required :unit_amount, String
539
515
 
540
- # @!parse
541
- # # @param dimension_values [Array<String, nil>]
542
- # # @param unit_amount [String]
543
- # #
544
- # def initialize(dimension_values:, unit_amount:, **) = super
545
-
546
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
516
+ # @!method initialize(dimension_values:, unit_amount:)
517
+ # Some parameter documentations has been truncated, see
518
+ # {Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue} for more details.
519
+ #
520
+ # @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
521
+ # ...
522
+ #
523
+ # @param unit_amount [String] Unit price for the specified dimension_values
547
524
  end
548
525
  end
549
526
 
@@ -573,15 +550,14 @@ module Orb
573
550
  required :matrix_values,
574
551
  -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue] }
575
552
 
576
- # @!parse
577
- # # @param allocation [Float]
578
- # # @param default_unit_amount [String]
579
- # # @param dimensions [Array<String, nil>]
580
- # # @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue>]
581
- # #
582
- # def initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:, **) = super
583
-
584
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
553
+ # @!method initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:)
554
+ # @param allocation [Float] Allocation to be used to calculate the price
555
+ #
556
+ # @param default_unit_amount [String] Default per unit rate for any usage not bucketed into a specified matrix_value
557
+ #
558
+ # @param dimensions [Array<String, nil>] One or two event property values to evaluate matrix groups by
559
+ #
560
+ # @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue>] Matrix values for specified matrix grouping keys
585
561
 
586
562
  class MatrixValue < Orb::Internal::Type::BaseModel
587
563
  # @!attribute dimension_values
@@ -598,13 +574,15 @@ module Orb
598
574
  # @return [String]
599
575
  required :unit_amount, String
600
576
 
601
- # @!parse
602
- # # @param dimension_values [Array<String, nil>]
603
- # # @param unit_amount [String]
604
- # #
605
- # def initialize(dimension_values:, unit_amount:, **) = super
606
-
607
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
577
+ # @!method initialize(dimension_values:, unit_amount:)
578
+ # Some parameter documentations has been truncated, see
579
+ # {Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue} for
580
+ # more details.
581
+ #
582
+ # @param dimension_values [Array<String, nil>] One or two matrix keys to filter usage to this Matrix value by. For example, ["r
583
+ # ...
584
+ #
585
+ # @param unit_amount [String] Unit price for the specified dimension_values
608
586
  end
609
587
  end
610
588
 
@@ -615,12 +593,8 @@ module Orb
615
593
  # @return [Array<Orb::Models::PriceCreateParams::TieredConfig::Tier>]
616
594
  required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::TieredConfig::Tier] }
617
595
 
618
- # @!parse
619
- # # @param tiers [Array<Orb::Models::PriceCreateParams::TieredConfig::Tier>]
620
- # #
621
- # def initialize(tiers:, **) = super
622
-
623
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
596
+ # @!method initialize(tiers:)
597
+ # @param tiers [Array<Orb::Models::PriceCreateParams::TieredConfig::Tier>] Tiers for rating based on total usage quantities into the specified tier
624
598
 
625
599
  class Tier < Orb::Internal::Type::BaseModel
626
600
  # @!attribute first_unit
@@ -641,14 +615,12 @@ module Orb
641
615
  # @return [Float, nil]
642
616
  optional :last_unit, Float, nil?: true
643
617
 
644
- # @!parse
645
- # # @param first_unit [Float]
646
- # # @param unit_amount [String]
647
- # # @param last_unit [Float, nil]
648
- # #
649
- # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super
650
-
651
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
618
+ # @!method initialize(first_unit:, unit_amount:, last_unit: nil)
619
+ # @param first_unit [Float] Exclusive tier starting value
620
+ #
621
+ # @param unit_amount [String] Amount per unit
622
+ #
623
+ # @param last_unit [Float, nil] Inclusive tier ending value. If null, this is treated as the last tier
652
624
  end
653
625
  end
654
626
 
@@ -661,12 +633,12 @@ module Orb
661
633
  required :tiers,
662
634
  -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier] }
663
635
 
664
- # @!parse
665
- # # @param tiers [Array<Orb::Models::PriceCreateParams::TieredBpsConfig::Tier>]
666
- # #
667
- # def initialize(tiers:, **) = super
668
-
669
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
636
+ # @!method initialize(tiers:)
637
+ # Some parameter documentations has been truncated, see
638
+ # {Orb::Models::PriceCreateParams::TieredBpsConfig} for more details.
639
+ #
640
+ # @param tiers [Array<Orb::Models::PriceCreateParams::TieredBpsConfig::Tier>] Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
641
+ # ...
670
642
 
671
643
  class Tier < Orb::Internal::Type::BaseModel
672
644
  # @!attribute bps
@@ -693,15 +665,14 @@ module Orb
693
665
  # @return [String, nil]
694
666
  optional :per_unit_maximum, String, nil?: true
695
667
 
696
- # @!parse
697
- # # @param bps [Float]
698
- # # @param minimum_amount [String]
699
- # # @param maximum_amount [String, nil]
700
- # # @param per_unit_maximum [String, nil]
701
- # #
702
- # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super
703
-
704
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
668
+ # @!method initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil)
669
+ # @param bps [Float] Per-event basis point rate
670
+ #
671
+ # @param minimum_amount [String] Exclusive tier starting value
672
+ #
673
+ # @param maximum_amount [String, nil] Inclusive tier ending value
674
+ #
675
+ # @param per_unit_maximum [String, nil] Per unit maximum to charge
705
676
  end
706
677
  end
707
678
 
@@ -718,13 +689,10 @@ module Orb
718
689
  # @return [String, nil]
719
690
  optional :per_unit_maximum, String, nil?: true
720
691
 
721
- # @!parse
722
- # # @param bps [Float]
723
- # # @param per_unit_maximum [String, nil]
724
- # #
725
- # def initialize(bps:, per_unit_maximum: nil, **) = super
726
-
727
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
692
+ # @!method initialize(bps:, per_unit_maximum: nil)
693
+ # @param bps [Float] Basis point take rate per event
694
+ #
695
+ # @param per_unit_maximum [String, nil] Optional currency amount maximum to cap spend per event
728
696
  end
729
697
 
730
698
  class BulkBpsConfig < Orb::Internal::Type::BaseModel
@@ -735,12 +703,12 @@ module Orb
735
703
  # @return [Array<Orb::Models::PriceCreateParams::BulkBpsConfig::Tier>]
736
704
  required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier] }
737
705
 
738
- # @!parse
739
- # # @param tiers [Array<Orb::Models::PriceCreateParams::BulkBpsConfig::Tier>]
740
- # #
741
- # def initialize(tiers:, **) = super
742
-
743
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
706
+ # @!method initialize(tiers:)
707
+ # Some parameter documentations has been truncated, see
708
+ # {Orb::Models::PriceCreateParams::BulkBpsConfig} for more details.
709
+ #
710
+ # @param tiers [Array<Orb::Models::PriceCreateParams::BulkBpsConfig::Tier>] Tiers for a bulk BPS pricing model where all usage is aggregated to a single tie
711
+ # ...
744
712
 
745
713
  class Tier < Orb::Internal::Type::BaseModel
746
714
  # @!attribute bps
@@ -761,14 +729,12 @@ module Orb
761
729
  # @return [String, nil]
762
730
  optional :per_unit_maximum, String, nil?: true
763
731
 
764
- # @!parse
765
- # # @param bps [Float]
766
- # # @param maximum_amount [String, nil]
767
- # # @param per_unit_maximum [String, nil]
768
- # #
769
- # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super
770
-
771
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
732
+ # @!method initialize(bps:, maximum_amount: nil, per_unit_maximum: nil)
733
+ # @param bps [Float] Basis points to rate on
734
+ #
735
+ # @param maximum_amount [String, nil] Upper bound for tier
736
+ #
737
+ # @param per_unit_maximum [String, nil] The maximum amount to charge for any one event
772
738
  end
773
739
  end
774
740
 
@@ -779,12 +745,8 @@ module Orb
779
745
  # @return [Array<Orb::Models::PriceCreateParams::BulkConfig::Tier>]
780
746
  required :tiers, -> { Orb::Internal::Type::ArrayOf[Orb::Models::PriceCreateParams::BulkConfig::Tier] }
781
747
 
782
- # @!parse
783
- # # @param tiers [Array<Orb::Models::PriceCreateParams::BulkConfig::Tier>]
784
- # #
785
- # def initialize(tiers:, **) = super
786
-
787
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
748
+ # @!method initialize(tiers:)
749
+ # @param tiers [Array<Orb::Models::PriceCreateParams::BulkConfig::Tier>] Bulk tiers for rating based on total usage volume
788
750
 
789
751
  class Tier < Orb::Internal::Type::BaseModel
790
752
  # @!attribute unit_amount
@@ -799,13 +761,10 @@ module Orb
799
761
  # @return [Float, nil]
800
762
  optional :maximum_units, Float, nil?: true
801
763
 
802
- # @!parse
803
- # # @param unit_amount [String]
804
- # # @param maximum_units [Float, nil]
805
- # #
806
- # def initialize(unit_amount:, maximum_units: nil, **) = super
807
-
808
- # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
764
+ # @!method initialize(unit_amount:, maximum_units: nil)
765
+ # @param unit_amount [String] Amount per unit
766
+ #
767
+ # @param maximum_units [Float, nil] Upper bound for this tier
809
768
  end
810
769
  end
811
770
  end