orb-billing 0.1.0.pre.alpha.33

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 (635) hide show
  1. checksums.yaml +7 -0
  2. data/README.md +169 -0
  3. data/lib/orb/client.rb +129 -0
  4. data/lib/orb/errors.rb +317 -0
  5. data/lib/orb/models/alert.rb +225 -0
  6. data/lib/orb/models/alert_create_for_customer_params.rb +77 -0
  7. data/lib/orb/models/alert_create_for_external_customer_params.rb +77 -0
  8. data/lib/orb/models/alert_create_for_subscription_params.rb +74 -0
  9. data/lib/orb/models/alert_disable_params.rb +26 -0
  10. data/lib/orb/models/alert_enable_params.rb +26 -0
  11. data/lib/orb/models/alert_list_params.rb +97 -0
  12. data/lib/orb/models/alert_retrieve_params.rb +19 -0
  13. data/lib/orb/models/alert_update_params.rb +46 -0
  14. data/lib/orb/models/amount_discount.rb +53 -0
  15. data/lib/orb/models/billable_metric.rb +76 -0
  16. data/lib/orb/models/billing_cycle_relative_date.rb +18 -0
  17. data/lib/orb/models/coupon.rb +86 -0
  18. data/lib/orb/models/coupon_archive_params.rb +19 -0
  19. data/lib/orb/models/coupon_create_params.rb +102 -0
  20. data/lib/orb/models/coupon_fetch_params.rb +19 -0
  21. data/lib/orb/models/coupon_list_params.rb +53 -0
  22. data/lib/orb/models/coupons/subscription_list_params.rb +40 -0
  23. data/lib/orb/models/credit_note.rb +522 -0
  24. data/lib/orb/models/credit_note_create_params.rb +77 -0
  25. data/lib/orb/models/credit_note_fetch_params.rb +19 -0
  26. data/lib/orb/models/credit_note_list_params.rb +73 -0
  27. data/lib/orb/models/customer.rb +872 -0
  28. data/lib/orb/models/customer_create_params.rb +843 -0
  29. data/lib/orb/models/customer_delete_params.rb +19 -0
  30. data/lib/orb/models/customer_fetch_by_external_id_params.rb +19 -0
  31. data/lib/orb/models/customer_fetch_params.rb +19 -0
  32. data/lib/orb/models/customer_list_params.rb +73 -0
  33. data/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rb +19 -0
  34. data/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rb +19 -0
  35. data/lib/orb/models/customer_update_by_external_id_params.rb +848 -0
  36. data/lib/orb/models/customer_update_params.rb +838 -0
  37. data/lib/orb/models/customers/balance_transaction_create_params.rb +53 -0
  38. data/lib/orb/models/customers/balance_transaction_create_response.rb +167 -0
  39. data/lib/orb/models/customers/balance_transaction_list_params.rb +75 -0
  40. data/lib/orb/models/customers/balance_transaction_list_response.rb +167 -0
  41. data/lib/orb/models/customers/cost_list_by_external_id_params.rb +69 -0
  42. data/lib/orb/models/customers/cost_list_by_external_id_response.rb +106 -0
  43. data/lib/orb/models/customers/cost_list_params.rb +69 -0
  44. data/lib/orb/models/customers/cost_list_response.rb +106 -0
  45. data/lib/orb/models/customers/credit_list_by_external_id_params.rb +59 -0
  46. data/lib/orb/models/customers/credit_list_by_external_id_response.rb +72 -0
  47. data/lib/orb/models/customers/credit_list_params.rb +59 -0
  48. data/lib/orb/models/customers/credit_list_response.rb +72 -0
  49. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb +215 -0
  50. data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb +1311 -0
  51. data/lib/orb/models/customers/credits/ledger_create_entry_params.rb +214 -0
  52. data/lib/orb/models/customers/credits/ledger_create_entry_response.rb +1310 -0
  53. data/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rb +141 -0
  54. data/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb +1310 -0
  55. data/lib/orb/models/customers/credits/ledger_list_params.rb +141 -0
  56. data/lib/orb/models/customers/credits/ledger_list_response.rb +1306 -0
  57. data/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb +159 -0
  58. data/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb +154 -0
  59. data/lib/orb/models/customers/credits/top_up_create_params.rb +158 -0
  60. data/lib/orb/models/customers/credits/top_up_create_response.rb +153 -0
  61. data/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rb +29 -0
  62. data/lib/orb/models/customers/credits/top_up_delete_params.rb +29 -0
  63. data/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rb +42 -0
  64. data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb +154 -0
  65. data/lib/orb/models/customers/credits/top_up_list_params.rb +42 -0
  66. data/lib/orb/models/customers/credits/top_up_list_response.rb +153 -0
  67. data/lib/orb/models/dimensional_price_group.rb +64 -0
  68. data/lib/orb/models/dimensional_price_group_create_params.rb +63 -0
  69. data/lib/orb/models/dimensional_price_group_list_params.rb +38 -0
  70. data/lib/orb/models/dimensional_price_group_retrieve_params.rb +19 -0
  71. data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb +21 -0
  72. data/lib/orb/models/dimensional_price_groups.rb +25 -0
  73. data/lib/orb/models/discount.rb +23 -0
  74. data/lib/orb/models/evaluate_price_group.rb +48 -0
  75. data/lib/orb/models/event_deprecate_params.rb +19 -0
  76. data/lib/orb/models/event_deprecate_response.rb +21 -0
  77. data/lib/orb/models/event_ingest_params.rb +100 -0
  78. data/lib/orb/models/event_ingest_response.rb +77 -0
  79. data/lib/orb/models/event_search_params.rb +45 -0
  80. data/lib/orb/models/event_search_response.rb +87 -0
  81. data/lib/orb/models/event_update_params.rb +58 -0
  82. data/lib/orb/models/event_update_response.rb +21 -0
  83. data/lib/orb/models/events/backfill_close_params.rb +21 -0
  84. data/lib/orb/models/events/backfill_close_response.rb +131 -0
  85. data/lib/orb/models/events/backfill_create_params.rb +97 -0
  86. data/lib/orb/models/events/backfill_create_response.rb +131 -0
  87. data/lib/orb/models/events/backfill_fetch_params.rb +21 -0
  88. data/lib/orb/models/events/backfill_fetch_response.rb +131 -0
  89. data/lib/orb/models/events/backfill_list_params.rb +40 -0
  90. data/lib/orb/models/events/backfill_list_response.rb +131 -0
  91. data/lib/orb/models/events/backfill_revert_params.rb +21 -0
  92. data/lib/orb/models/events/backfill_revert_response.rb +131 -0
  93. data/lib/orb/models/events/event_volumes.rb +54 -0
  94. data/lib/orb/models/events/volume_list_params.rb +64 -0
  95. data/lib/orb/models/invoice.rb +2218 -0
  96. data/lib/orb/models/invoice_create_params.rb +200 -0
  97. data/lib/orb/models/invoice_fetch_params.rb +19 -0
  98. data/lib/orb/models/invoice_fetch_upcoming_params.rb +25 -0
  99. data/lib/orb/models/invoice_fetch_upcoming_response.rb +2226 -0
  100. data/lib/orb/models/invoice_issue_params.rb +34 -0
  101. data/lib/orb/models/invoice_level_discount.rb +21 -0
  102. data/lib/orb/models/invoice_line_item_create_params.rb +62 -0
  103. data/lib/orb/models/invoice_line_item_create_response.rb +929 -0
  104. data/lib/orb/models/invoice_list_params.rb +197 -0
  105. data/lib/orb/models/invoice_mark_paid_params.rb +40 -0
  106. data/lib/orb/models/invoice_pay_params.rb +19 -0
  107. data/lib/orb/models/invoice_update_params.rb +28 -0
  108. data/lib/orb/models/invoice_void_params.rb +19 -0
  109. data/lib/orb/models/item.rb +82 -0
  110. data/lib/orb/models/item_create_params.rb +26 -0
  111. data/lib/orb/models/item_fetch_params.rb +19 -0
  112. data/lib/orb/models/item_list_params.rb +38 -0
  113. data/lib/orb/models/item_update_params.rb +73 -0
  114. data/lib/orb/models/metric_create_params.rb +56 -0
  115. data/lib/orb/models/metric_fetch_params.rb +19 -0
  116. data/lib/orb/models/metric_list_params.rb +73 -0
  117. data/lib/orb/models/metric_update_params.rb +28 -0
  118. data/lib/orb/models/pagination_metadata.rb +25 -0
  119. data/lib/orb/models/percentage_discount.rb +54 -0
  120. data/lib/orb/models/plan.rb +894 -0
  121. data/lib/orb/models/plan_create_params.rb +6702 -0
  122. data/lib/orb/models/plan_fetch_params.rb +19 -0
  123. data/lib/orb/models/plan_list_params.rb +100 -0
  124. data/lib/orb/models/plan_update_params.rb +37 -0
  125. data/lib/orb/models/plans/external_plan_id_fetch_params.rb +21 -0
  126. data/lib/orb/models/plans/external_plan_id_update_params.rb +39 -0
  127. data/lib/orb/models/price.rb +12229 -0
  128. data/lib/orb/models/price_create_params.rb +808 -0
  129. data/lib/orb/models/price_evaluate_params.rb +80 -0
  130. data/lib/orb/models/price_evaluate_response.rb +20 -0
  131. data/lib/orb/models/price_fetch_params.rb +19 -0
  132. data/lib/orb/models/price_list_params.rb +38 -0
  133. data/lib/orb/models/price_update_params.rb +28 -0
  134. data/lib/orb/models/prices/external_price_id_fetch_params.rb +21 -0
  135. data/lib/orb/models/prices/external_price_id_update_params.rb +30 -0
  136. data/lib/orb/models/subscription.rb +1233 -0
  137. data/lib/orb/models/subscription_cancel_params.rb +58 -0
  138. data/lib/orb/models/subscription_cancel_response.rb +1217 -0
  139. data/lib/orb/models/subscription_create_params.rb +15065 -0
  140. data/lib/orb/models/subscription_create_response.rb +1217 -0
  141. data/lib/orb/models/subscription_fetch_costs_params.rb +67 -0
  142. data/lib/orb/models/subscription_fetch_costs_response.rb +104 -0
  143. data/lib/orb/models/subscription_fetch_params.rb +19 -0
  144. data/lib/orb/models/subscription_fetch_schedule_params.rb +73 -0
  145. data/lib/orb/models/subscription_fetch_schedule_response.rb +68 -0
  146. data/lib/orb/models/subscription_fetch_usage_params.rb +135 -0
  147. data/lib/orb/models/subscription_list_params.rb +108 -0
  148. data/lib/orb/models/subscription_price_intervals_params.rb +8358 -0
  149. data/lib/orb/models/subscription_price_intervals_response.rb +1224 -0
  150. data/lib/orb/models/subscription_schedule_plan_change_params.rb +15088 -0
  151. data/lib/orb/models/subscription_schedule_plan_change_response.rb +1224 -0
  152. data/lib/orb/models/subscription_trigger_phase_params.rb +36 -0
  153. data/lib/orb/models/subscription_trigger_phase_response.rb +1224 -0
  154. data/lib/orb/models/subscription_unschedule_cancellation_params.rb +19 -0
  155. data/lib/orb/models/subscription_unschedule_cancellation_response.rb +1224 -0
  156. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rb +26 -0
  157. data/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb +1228 -0
  158. data/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rb +19 -0
  159. data/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb +1224 -0
  160. data/lib/orb/models/subscription_update_fixed_fee_quantity_params.rb +90 -0
  161. data/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb +1224 -0
  162. data/lib/orb/models/subscription_update_params.rb +74 -0
  163. data/lib/orb/models/subscription_update_trial_params.rb +59 -0
  164. data/lib/orb/models/subscription_update_trial_response.rb +1222 -0
  165. data/lib/orb/models/subscription_usage.rb +258 -0
  166. data/lib/orb/models/subscriptions.rb +25 -0
  167. data/lib/orb/models/top_level_ping_params.rb +19 -0
  168. data/lib/orb/models/top_level_ping_response.rb +20 -0
  169. data/lib/orb/models/trial_discount.rb +69 -0
  170. data/lib/orb/models/usage_discount.rb +54 -0
  171. data/lib/orb/page.rb +114 -0
  172. data/lib/orb/request_options.rb +75 -0
  173. data/lib/orb/resources/alerts.rb +239 -0
  174. data/lib/orb/resources/coupons/subscriptions.rb +43 -0
  175. data/lib/orb/resources/coupons.rb +115 -0
  176. data/lib/orb/resources/credit_notes.rb +87 -0
  177. data/lib/orb/resources/customers/balance_transactions.rb +96 -0
  178. data/lib/orb/resources/customers/costs.rb +298 -0
  179. data/lib/orb/resources/customers/credits/ledger.rb +527 -0
  180. data/lib/orb/resources/customers/credits/top_ups.rb +192 -0
  181. data/lib/orb/resources/customers/credits.rb +88 -0
  182. data/lib/orb/resources/customers.rb +321 -0
  183. data/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rb +38 -0
  184. data/lib/orb/resources/dimensional_price_groups.rb +93 -0
  185. data/lib/orb/resources/events/backfills.rb +174 -0
  186. data/lib/orb/resources/events/volume.rb +52 -0
  187. data/lib/orb/resources/events.rb +415 -0
  188. data/lib/orb/resources/invoice_line_items.rb +41 -0
  189. data/lib/orb/resources/invoices.rb +266 -0
  190. data/lib/orb/resources/items.rb +95 -0
  191. data/lib/orb/resources/metrics.rb +114 -0
  192. data/lib/orb/resources/plans/external_plan_id.rb +76 -0
  193. data/lib/orb/resources/plans.rb +133 -0
  194. data/lib/orb/resources/prices/external_price_id.rb +61 -0
  195. data/lib/orb/resources/prices.rb +197 -0
  196. data/lib/orb/resources/subscriptions.rb +1278 -0
  197. data/lib/orb/resources/top_level.rb +37 -0
  198. data/lib/orb/transport/base_client.rb +459 -0
  199. data/lib/orb/transport/pooled_net_requester.rb +182 -0
  200. data/lib/orb/type/array_of.rb +112 -0
  201. data/lib/orb/type/base_model.rb +367 -0
  202. data/lib/orb/type/base_page.rb +61 -0
  203. data/lib/orb/type/boolean_model.rb +52 -0
  204. data/lib/orb/type/converter.rb +217 -0
  205. data/lib/orb/type/enum.rb +101 -0
  206. data/lib/orb/type/hash_of.rb +132 -0
  207. data/lib/orb/type/request_parameters.rb +38 -0
  208. data/lib/orb/type/union.rb +225 -0
  209. data/lib/orb/type/unknown.rb +56 -0
  210. data/lib/orb/type.rb +23 -0
  211. data/lib/orb/util.rb +722 -0
  212. data/lib/orb/version.rb +5 -0
  213. data/lib/orb.rb +247 -0
  214. data/manifest.yaml +15 -0
  215. data/rbi/lib/orb/client.rbi +90 -0
  216. data/rbi/lib/orb/errors.rbi +246 -0
  217. data/rbi/lib/orb/models/alert.rbi +239 -0
  218. data/rbi/lib/orb/models/alert_create_for_customer_params.rbi +86 -0
  219. data/rbi/lib/orb/models/alert_create_for_external_customer_params.rbi +88 -0
  220. data/rbi/lib/orb/models/alert_create_for_subscription_params.rbi +83 -0
  221. data/rbi/lib/orb/models/alert_disable_params.rbi +28 -0
  222. data/rbi/lib/orb/models/alert_enable_params.rbi +28 -0
  223. data/rbi/lib/orb/models/alert_list_params.rbi +95 -0
  224. data/rbi/lib/orb/models/alert_retrieve_params.rbi +20 -0
  225. data/rbi/lib/orb/models/alert_update_params.rbi +51 -0
  226. data/rbi/lib/orb/models/amount_discount.rbi +62 -0
  227. data/rbi/lib/orb/models/billable_metric.rbi +83 -0
  228. data/rbi/lib/orb/models/billing_cycle_relative_date.rbi +19 -0
  229. data/rbi/lib/orb/models/coupon.rbi +90 -0
  230. data/rbi/lib/orb/models/coupon_archive_params.rbi +20 -0
  231. data/rbi/lib/orb/models/coupon_create_params.rbi +120 -0
  232. data/rbi/lib/orb/models/coupon_fetch_params.rbi +20 -0
  233. data/rbi/lib/orb/models/coupon_list_params.rbi +59 -0
  234. data/rbi/lib/orb/models/coupons/subscription_list_params.rbi +41 -0
  235. data/rbi/lib/orb/models/credit_note.rbi +546 -0
  236. data/rbi/lib/orb/models/credit_note_create_params.rbi +84 -0
  237. data/rbi/lib/orb/models/credit_note_fetch_params.rbi +20 -0
  238. data/rbi/lib/orb/models/credit_note_list_params.rbi +74 -0
  239. data/rbi/lib/orb/models/customer.rbi +941 -0
  240. data/rbi/lib/orb/models/customer_create_params.rbi +923 -0
  241. data/rbi/lib/orb/models/customer_delete_params.rbi +20 -0
  242. data/rbi/lib/orb/models/customer_fetch_by_external_id_params.rbi +20 -0
  243. data/rbi/lib/orb/models/customer_fetch_params.rbi +20 -0
  244. data/rbi/lib/orb/models/customer_list_params.rbi +74 -0
  245. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbi +20 -0
  246. data/rbi/lib/orb/models/customer_sync_payment_methods_from_gateway_params.rbi +20 -0
  247. data/rbi/lib/orb/models/customer_update_by_external_id_params.rbi +945 -0
  248. data/rbi/lib/orb/models/customer_update_params.rbi +919 -0
  249. data/rbi/lib/orb/models/customers/balance_transaction_create_params.rbi +64 -0
  250. data/rbi/lib/orb/models/customers/balance_transaction_create_response.rbi +199 -0
  251. data/rbi/lib/orb/models/customers/balance_transaction_list_params.rbi +76 -0
  252. data/rbi/lib/orb/models/customers/balance_transaction_list_response.rbi +191 -0
  253. data/rbi/lib/orb/models/customers/cost_list_by_external_id_params.rbi +86 -0
  254. data/rbi/lib/orb/models/customers/cost_list_by_external_id_response.rbi +214 -0
  255. data/rbi/lib/orb/models/customers/cost_list_params.rbi +84 -0
  256. data/rbi/lib/orb/models/customers/cost_list_response.rbi +212 -0
  257. data/rbi/lib/orb/models/customers/credit_list_by_external_id_params.rbi +64 -0
  258. data/rbi/lib/orb/models/customers/credit_list_by_external_id_response.rbi +87 -0
  259. data/rbi/lib/orb/models/customers/credit_list_params.rbi +64 -0
  260. data/rbi/lib/orb/models/customers/credit_list_response.rbi +86 -0
  261. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi +270 -0
  262. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbi +1670 -0
  263. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_params.rbi +238 -0
  264. data/rbi/lib/orb/models/customers/credits/ledger_create_entry_response.rbi +1626 -0
  265. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_params.rbi +181 -0
  266. data/rbi/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rbi +1654 -0
  267. data/rbi/lib/orb/models/customers/credits/ledger_list_params.rbi +144 -0
  268. data/rbi/lib/orb/models/customers/credits/ledger_list_response.rbi +1588 -0
  269. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_params.rbi +196 -0
  270. data/rbi/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rbi +198 -0
  271. data/rbi/lib/orb/models/customers/credits/top_up_create_params.rbi +176 -0
  272. data/rbi/lib/orb/models/customers/credits/top_up_create_response.rbi +175 -0
  273. data/rbi/lib/orb/models/customers/credits/top_up_delete_by_external_id_params.rbi +31 -0
  274. data/rbi/lib/orb/models/customers/credits/top_up_delete_params.rbi +28 -0
  275. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_params.rbi +49 -0
  276. data/rbi/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rbi +188 -0
  277. data/rbi/lib/orb/models/customers/credits/top_up_list_params.rbi +49 -0
  278. data/rbi/lib/orb/models/customers/credits/top_up_list_response.rbi +168 -0
  279. data/rbi/lib/orb/models/dimensional_price_group.rbi +75 -0
  280. data/rbi/lib/orb/models/dimensional_price_group_create_params.rbi +66 -0
  281. data/rbi/lib/orb/models/dimensional_price_group_list_params.rbi +39 -0
  282. data/rbi/lib/orb/models/dimensional_price_group_retrieve_params.rbi +20 -0
  283. data/rbi/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbi +22 -0
  284. data/rbi/lib/orb/models/dimensional_price_groups.rbi +35 -0
  285. data/rbi/lib/orb/models/discount.rbi +18 -0
  286. data/rbi/lib/orb/models/evaluate_price_group.rbi +45 -0
  287. data/rbi/lib/orb/models/event_deprecate_params.rbi +20 -0
  288. data/rbi/lib/orb/models/event_deprecate_response.rbi +19 -0
  289. data/rbi/lib/orb/models/event_ingest_params.rbi +120 -0
  290. data/rbi/lib/orb/models/event_ingest_response.rbi +79 -0
  291. data/rbi/lib/orb/models/event_search_params.rbi +53 -0
  292. data/rbi/lib/orb/models/event_search_response.rbi +100 -0
  293. data/rbi/lib/orb/models/event_update_params.rbi +71 -0
  294. data/rbi/lib/orb/models/event_update_response.rbi +19 -0
  295. data/rbi/lib/orb/models/events/backfill_close_params.rbi +22 -0
  296. data/rbi/lib/orb/models/events/backfill_close_response.rbi +127 -0
  297. data/rbi/lib/orb/models/events/backfill_create_params.rbi +97 -0
  298. data/rbi/lib/orb/models/events/backfill_create_response.rbi +128 -0
  299. data/rbi/lib/orb/models/events/backfill_fetch_params.rbi +22 -0
  300. data/rbi/lib/orb/models/events/backfill_fetch_response.rbi +127 -0
  301. data/rbi/lib/orb/models/events/backfill_list_params.rbi +41 -0
  302. data/rbi/lib/orb/models/events/backfill_list_response.rbi +127 -0
  303. data/rbi/lib/orb/models/events/backfill_revert_params.rbi +22 -0
  304. data/rbi/lib/orb/models/events/backfill_revert_response.rbi +128 -0
  305. data/rbi/lib/orb/models/events/event_volumes.rbi +47 -0
  306. data/rbi/lib/orb/models/events/volume_list_params.rbi +69 -0
  307. data/rbi/lib/orb/models/invoice.rbi +2466 -0
  308. data/rbi/lib/orb/models/invoice_create_params.rbi +230 -0
  309. data/rbi/lib/orb/models/invoice_fetch_params.rbi +20 -0
  310. data/rbi/lib/orb/models/invoice_fetch_upcoming_params.rbi +24 -0
  311. data/rbi/lib/orb/models/invoice_fetch_upcoming_response.rbi +2646 -0
  312. data/rbi/lib/orb/models/invoice_issue_params.rbi +32 -0
  313. data/rbi/lib/orb/models/invoice_level_discount.rbi +16 -0
  314. data/rbi/lib/orb/models/invoice_line_item_create_params.rbi +67 -0
  315. data/rbi/lib/orb/models/invoice_line_item_create_response.rbi +1164 -0
  316. data/rbi/lib/orb/models/invoice_list_params.rbi +187 -0
  317. data/rbi/lib/orb/models/invoice_mark_paid_params.rbi +48 -0
  318. data/rbi/lib/orb/models/invoice_pay_params.rbi +20 -0
  319. data/rbi/lib/orb/models/invoice_update_params.rbi +36 -0
  320. data/rbi/lib/orb/models/invoice_void_params.rbi +20 -0
  321. data/rbi/lib/orb/models/item.rbi +101 -0
  322. data/rbi/lib/orb/models/item_create_params.rbi +25 -0
  323. data/rbi/lib/orb/models/item_fetch_params.rbi +20 -0
  324. data/rbi/lib/orb/models/item_list_params.rbi +39 -0
  325. data/rbi/lib/orb/models/item_update_params.rbi +113 -0
  326. data/rbi/lib/orb/models/metric_create_params.rbi +62 -0
  327. data/rbi/lib/orb/models/metric_fetch_params.rbi +20 -0
  328. data/rbi/lib/orb/models/metric_list_params.rbi +74 -0
  329. data/rbi/lib/orb/models/metric_update_params.rbi +36 -0
  330. data/rbi/lib/orb/models/pagination_metadata.rbi +21 -0
  331. data/rbi/lib/orb/models/percentage_discount.rbi +63 -0
  332. data/rbi/lib/orb/models/plan.rbi +1071 -0
  333. data/rbi/lib/orb/models/plan_create_params.rbi +10069 -0
  334. data/rbi/lib/orb/models/plan_fetch_params.rbi +20 -0
  335. data/rbi/lib/orb/models/plan_list_params.rbi +100 -0
  336. data/rbi/lib/orb/models/plan_update_params.rbi +46 -0
  337. data/rbi/lib/orb/models/plans/external_plan_id_fetch_params.rbi +22 -0
  338. data/rbi/lib/orb/models/plans/external_plan_id_update_params.rbi +48 -0
  339. data/rbi/lib/orb/models/price.rbi +15341 -0
  340. data/rbi/lib/orb/models/price_create_params.rbi +885 -0
  341. data/rbi/lib/orb/models/price_evaluate_params.rbi +81 -0
  342. data/rbi/lib/orb/models/price_evaluate_response.rbi +21 -0
  343. data/rbi/lib/orb/models/price_fetch_params.rbi +20 -0
  344. data/rbi/lib/orb/models/price_list_params.rbi +39 -0
  345. data/rbi/lib/orb/models/price_update_params.rbi +36 -0
  346. data/rbi/lib/orb/models/prices/external_price_id_fetch_params.rbi +22 -0
  347. data/rbi/lib/orb/models/prices/external_price_id_update_params.rbi +38 -0
  348. data/rbi/lib/orb/models/subscription.rbi +1381 -0
  349. data/rbi/lib/orb/models/subscription_cancel_params.rbi +75 -0
  350. data/rbi/lib/orb/models/subscription_cancel_response.rbi +1374 -0
  351. data/rbi/lib/orb/models/subscription_create_params.rbi +23422 -0
  352. data/rbi/lib/orb/models/subscription_create_response.rbi +1374 -0
  353. data/rbi/lib/orb/models/subscription_fetch_costs_params.rbi +82 -0
  354. data/rbi/lib/orb/models/subscription_fetch_costs_response.rbi +210 -0
  355. data/rbi/lib/orb/models/subscription_fetch_params.rbi +20 -0
  356. data/rbi/lib/orb/models/subscription_fetch_schedule_params.rbi +74 -0
  357. data/rbi/lib/orb/models/subscription_fetch_schedule_response.rbi +81 -0
  358. data/rbi/lib/orb/models/subscription_fetch_usage_params.rbi +137 -0
  359. data/rbi/lib/orb/models/subscription_list_params.rbi +108 -0
  360. data/rbi/lib/orb/models/subscription_price_intervals_params.rbi +12991 -0
  361. data/rbi/lib/orb/models/subscription_price_intervals_response.rbi +1387 -0
  362. data/rbi/lib/orb/models/subscription_schedule_plan_change_params.rbi +23589 -0
  363. data/rbi/lib/orb/models/subscription_schedule_plan_change_response.rbi +1390 -0
  364. data/rbi/lib/orb/models/subscription_trigger_phase_params.rbi +45 -0
  365. data/rbi/lib/orb/models/subscription_trigger_phase_response.rbi +1381 -0
  366. data/rbi/lib/orb/models/subscription_unschedule_cancellation_params.rbi +20 -0
  367. data/rbi/lib/orb/models/subscription_unschedule_cancellation_response.rbi +1400 -0
  368. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbi +25 -0
  369. data/rbi/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbi +1451 -0
  370. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_params.rbi +20 -0
  371. data/rbi/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rbi +1410 -0
  372. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_params.rbi +104 -0
  373. data/rbi/lib/orb/models/subscription_update_fixed_fee_quantity_response.rbi +1400 -0
  374. data/rbi/lib/orb/models/subscription_update_params.rbi +77 -0
  375. data/rbi/lib/orb/models/subscription_update_trial_params.rbi +63 -0
  376. data/rbi/lib/orb/models/subscription_update_trial_response.rbi +1378 -0
  377. data/rbi/lib/orb/models/subscription_usage.rbi +323 -0
  378. data/rbi/lib/orb/models/subscriptions.rbi +33 -0
  379. data/rbi/lib/orb/models/top_level_ping_params.rbi +20 -0
  380. data/rbi/lib/orb/models/top_level_ping_response.rbi +18 -0
  381. data/rbi/lib/orb/models/trial_discount.rbi +73 -0
  382. data/rbi/lib/orb/models/usage_discount.rbi +62 -0
  383. data/rbi/lib/orb/page.rbi +35 -0
  384. data/rbi/lib/orb/request_options.rbi +48 -0
  385. data/rbi/lib/orb/resources/alerts.rbi +216 -0
  386. data/rbi/lib/orb/resources/coupons/subscriptions.rbi +38 -0
  387. data/rbi/lib/orb/resources/coupons.rbi +96 -0
  388. data/rbi/lib/orb/resources/credit_notes.rbi +74 -0
  389. data/rbi/lib/orb/resources/customers/balance_transactions.rbi +92 -0
  390. data/rbi/lib/orb/resources/customers/costs.rbi +304 -0
  391. data/rbi/lib/orb/resources/customers/credits/ledger.rbi +645 -0
  392. data/rbi/lib/orb/resources/customers/credits/top_ups.rbi +180 -0
  393. data/rbi/lib/orb/resources/customers/credits.rbi +88 -0
  394. data/rbi/lib/orb/resources/customers.rbi +714 -0
  395. data/rbi/lib/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbi +25 -0
  396. data/rbi/lib/orb/resources/dimensional_price_groups.rbi +78 -0
  397. data/rbi/lib/orb/resources/events/backfills.rbi +161 -0
  398. data/rbi/lib/orb/resources/events/volume.rbi +57 -0
  399. data/rbi/lib/orb/resources/events.rbi +408 -0
  400. data/rbi/lib/orb/resources/invoice_line_items.rbi +44 -0
  401. data/rbi/lib/orb/resources/invoices.rbi +262 -0
  402. data/rbi/lib/orb/resources/items.rbi +65 -0
  403. data/rbi/lib/orb/resources/metrics.rbi +102 -0
  404. data/rbi/lib/orb/resources/plans/external_plan_id.rbi +67 -0
  405. data/rbi/lib/orb/resources/plans.rbi +170 -0
  406. data/rbi/lib/orb/resources/prices/external_price_id.rbi +110 -0
  407. data/rbi/lib/orb/resources/prices.rbi +371 -0
  408. data/rbi/lib/orb/resources/subscriptions.rbi +1469 -0
  409. data/rbi/lib/orb/resources/top_level.rbi +25 -0
  410. data/rbi/lib/orb/transport/base_client.rbi +205 -0
  411. data/rbi/lib/orb/transport/pooled_net_requester.rbi +64 -0
  412. data/rbi/lib/orb/type/array_of.rbi +82 -0
  413. data/rbi/lib/orb/type/base_model.rbi +197 -0
  414. data/rbi/lib/orb/type/base_page.rbi +38 -0
  415. data/rbi/lib/orb/type/boolean_model.rbi +41 -0
  416. data/rbi/lib/orb/type/converter.rbi +95 -0
  417. data/rbi/lib/orb/type/enum.rbi +58 -0
  418. data/rbi/lib/orb/type/hash_of.rbi +86 -0
  419. data/rbi/lib/orb/type/request_parameters.rbi +20 -0
  420. data/rbi/lib/orb/type/union.rbi +66 -0
  421. data/rbi/lib/orb/type/unknown.rbi +37 -0
  422. data/rbi/lib/orb/type.rbi +23 -0
  423. data/rbi/lib/orb/util.rbi +278 -0
  424. data/rbi/lib/orb/version.rbi +5 -0
  425. data/sig/orb/client.rbs +53 -0
  426. data/sig/orb/errors.rbs +201 -0
  427. data/sig/orb/models/alert.rbs +142 -0
  428. data/sig/orb/models/alert_create_for_customer_params.rbs +56 -0
  429. data/sig/orb/models/alert_create_for_external_customer_params.rbs +56 -0
  430. data/sig/orb/models/alert_create_for_subscription_params.rbs +52 -0
  431. data/sig/orb/models/alert_disable_params.rbs +20 -0
  432. data/sig/orb/models/alert_enable_params.rbs +20 -0
  433. data/sig/orb/models/alert_list_params.rbs +57 -0
  434. data/sig/orb/models/alert_retrieve_params.rbs +14 -0
  435. data/sig/orb/models/alert_update_params.rbs +31 -0
  436. data/sig/orb/models/amount_discount.rbs +40 -0
  437. data/sig/orb/models/billable_metric.rbs +50 -0
  438. data/sig/orb/models/billing_cycle_relative_date.rbs +14 -0
  439. data/sig/orb/models/coupon.rbs +51 -0
  440. data/sig/orb/models/coupon_archive_params.rbs +14 -0
  441. data/sig/orb/models/coupon_create_params.rbs +77 -0
  442. data/sig/orb/models/coupon_fetch_params.rbs +14 -0
  443. data/sig/orb/models/coupon_list_params.rbs +37 -0
  444. data/sig/orb/models/coupons/subscription_list_params.rbs +27 -0
  445. data/sig/orb/models/credit_note.rbs +345 -0
  446. data/sig/orb/models/credit_note_create_params.rbs +57 -0
  447. data/sig/orb/models/credit_note_fetch_params.rbs +14 -0
  448. data/sig/orb/models/credit_note_list_params.rbs +45 -0
  449. data/sig/orb/models/customer.rbs +628 -0
  450. data/sig/orb/models/customer_create_params.rbs +624 -0
  451. data/sig/orb/models/customer_delete_params.rbs +14 -0
  452. data/sig/orb/models/customer_fetch_by_external_id_params.rbs +14 -0
  453. data/sig/orb/models/customer_fetch_params.rbs +14 -0
  454. data/sig/orb/models/customer_list_params.rbs +45 -0
  455. data/sig/orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params.rbs +15 -0
  456. data/sig/orb/models/customer_sync_payment_methods_from_gateway_params.rbs +15 -0
  457. data/sig/orb/models/customer_update_by_external_id_params.rbs +620 -0
  458. data/sig/orb/models/customer_update_params.rbs +620 -0
  459. data/sig/orb/models/customers/balance_transaction_create_params.rbs +44 -0
  460. data/sig/orb/models/customers/balance_transaction_create_response.rbs +114 -0
  461. data/sig/orb/models/customers/balance_transaction_list_params.rbs +47 -0
  462. data/sig/orb/models/customers/balance_transaction_list_response.rbs +114 -0
  463. data/sig/orb/models/customers/cost_list_by_external_id_params.rbs +48 -0
  464. data/sig/orb/models/customers/cost_list_by_external_id_response.rbs +82 -0
  465. data/sig/orb/models/customers/cost_list_params.rbs +48 -0
  466. data/sig/orb/models/customers/cost_list_response.rbs +80 -0
  467. data/sig/orb/models/customers/credit_list_by_external_id_params.rbs +41 -0
  468. data/sig/orb/models/customers/credit_list_by_external_id_response.rbs +55 -0
  469. data/sig/orb/models/customers/credit_list_params.rbs +41 -0
  470. data/sig/orb/models/customers/credit_list_response.rbs +55 -0
  471. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbs +120 -0
  472. data/sig/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rbs +814 -0
  473. data/sig/orb/models/customers/credits/ledger_create_entry_params.rbs +120 -0
  474. data/sig/orb/models/customers/credits/ledger_create_entry_response.rbs +814 -0
  475. data/sig/orb/models/customers/credits/ledger_list_by_external_id_params.rbs +99 -0
  476. data/sig/orb/models/customers/credits/ledger_list_by_external_id_response.rbs +814 -0
  477. data/sig/orb/models/customers/credits/ledger_list_params.rbs +99 -0
  478. data/sig/orb/models/customers/credits/ledger_list_response.rbs +814 -0
  479. data/sig/orb/models/customers/credits/top_up_create_by_external_id_params.rbs +95 -0
  480. data/sig/orb/models/customers/credits/top_up_create_by_external_id_response.rbs +90 -0
  481. data/sig/orb/models/customers/credits/top_up_create_params.rbs +95 -0
  482. data/sig/orb/models/customers/credits/top_up_create_response.rbs +90 -0
  483. data/sig/orb/models/customers/credits/top_up_delete_by_external_id_params.rbs +24 -0
  484. data/sig/orb/models/customers/credits/top_up_delete_params.rbs +24 -0
  485. data/sig/orb/models/customers/credits/top_up_list_by_external_id_params.rbs +29 -0
  486. data/sig/orb/models/customers/credits/top_up_list_by_external_id_response.rbs +90 -0
  487. data/sig/orb/models/customers/credits/top_up_list_params.rbs +29 -0
  488. data/sig/orb/models/customers/credits/top_up_list_response.rbs +90 -0
  489. data/sig/orb/models/dimensional_price_group.rbs +38 -0
  490. data/sig/orb/models/dimensional_price_group_create_params.rbs +39 -0
  491. data/sig/orb/models/dimensional_price_group_list_params.rbs +25 -0
  492. data/sig/orb/models/dimensional_price_group_retrieve_params.rbs +15 -0
  493. data/sig/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rbs +17 -0
  494. data/sig/orb/models/dimensional_price_groups.rbs +22 -0
  495. data/sig/orb/models/discount.rbs +15 -0
  496. data/sig/orb/models/evaluate_price_group.rbs +34 -0
  497. data/sig/orb/models/event_deprecate_params.rbs +14 -0
  498. data/sig/orb/models/event_deprecate_response.rbs +13 -0
  499. data/sig/orb/models/event_ingest_params.rbs +68 -0
  500. data/sig/orb/models/event_ingest_response.rbs +53 -0
  501. data/sig/orb/models/event_search_params.rbs +31 -0
  502. data/sig/orb/models/event_search_response.rbs +55 -0
  503. data/sig/orb/models/event_update_params.rbs +39 -0
  504. data/sig/orb/models/event_update_response.rbs +13 -0
  505. data/sig/orb/models/events/backfill_close_params.rbs +16 -0
  506. data/sig/orb/models/events/backfill_close_response.rbs +73 -0
  507. data/sig/orb/models/events/backfill_create_params.rbs +51 -0
  508. data/sig/orb/models/events/backfill_create_response.rbs +73 -0
  509. data/sig/orb/models/events/backfill_fetch_params.rbs +16 -0
  510. data/sig/orb/models/events/backfill_fetch_response.rbs +73 -0
  511. data/sig/orb/models/events/backfill_list_params.rbs +27 -0
  512. data/sig/orb/models/events/backfill_list_response.rbs +73 -0
  513. data/sig/orb/models/events/backfill_revert_params.rbs +16 -0
  514. data/sig/orb/models/events/backfill_revert_response.rbs +73 -0
  515. data/sig/orb/models/events/event_volumes.rbs +39 -0
  516. data/sig/orb/models/events/volume_list_params.rbs +41 -0
  517. data/sig/orb/models/invoice.rbs +1430 -0
  518. data/sig/orb/models/invoice_create_params.rbs +120 -0
  519. data/sig/orb/models/invoice_fetch_params.rbs +14 -0
  520. data/sig/orb/models/invoice_fetch_upcoming_params.rbs +20 -0
  521. data/sig/orb/models/invoice_fetch_upcoming_response.rbs +1430 -0
  522. data/sig/orb/models/invoice_issue_params.rbs +21 -0
  523. data/sig/orb/models/invoice_level_discount.rbs +14 -0
  524. data/sig/orb/models/invoice_line_item_create_params.rbs +43 -0
  525. data/sig/orb/models/invoice_line_item_create_response.rbs +546 -0
  526. data/sig/orb/models/invoice_list_params.rbs +122 -0
  527. data/sig/orb/models/invoice_mark_paid_params.rbs +27 -0
  528. data/sig/orb/models/invoice_pay_params.rbs +14 -0
  529. data/sig/orb/models/invoice_update_params.rbs +20 -0
  530. data/sig/orb/models/invoice_void_params.rbs +14 -0
  531. data/sig/orb/models/item.rbs +72 -0
  532. data/sig/orb/models/item_create_params.rbs +19 -0
  533. data/sig/orb/models/item_fetch_params.rbs +14 -0
  534. data/sig/orb/models/item_list_params.rbs +25 -0
  535. data/sig/orb/models/item_update_params.rbs +69 -0
  536. data/sig/orb/models/metric_create_params.rbs +39 -0
  537. data/sig/orb/models/metric_fetch_params.rbs +14 -0
  538. data/sig/orb/models/metric_list_params.rbs +45 -0
  539. data/sig/orb/models/metric_update_params.rbs +20 -0
  540. data/sig/orb/models/pagination_metadata.rbs +15 -0
  541. data/sig/orb/models/percentage_discount.rbs +40 -0
  542. data/sig/orb/models/plan.rbs +529 -0
  543. data/sig/orb/models/plan_create_params.rbs +3991 -0
  544. data/sig/orb/models/plan_fetch_params.rbs +14 -0
  545. data/sig/orb/models/plan_list_params.rbs +65 -0
  546. data/sig/orb/models/plan_update_params.rbs +24 -0
  547. data/sig/orb/models/plans/external_plan_id_fetch_params.rbs +16 -0
  548. data/sig/orb/models/plans/external_plan_id_update_params.rbs +26 -0
  549. data/sig/orb/models/price.rbs +8108 -0
  550. data/sig/orb/models/price_create_params.rbs +520 -0
  551. data/sig/orb/models/price_evaluate_params.rbs +45 -0
  552. data/sig/orb/models/price_evaluate_response.rbs +14 -0
  553. data/sig/orb/models/price_fetch_params.rbs +14 -0
  554. data/sig/orb/models/price_list_params.rbs +25 -0
  555. data/sig/orb/models/price_update_params.rbs +20 -0
  556. data/sig/orb/models/prices/external_price_id_fetch_params.rbs +16 -0
  557. data/sig/orb/models/prices/external_price_id_update_params.rbs +22 -0
  558. data/sig/orb/models/subscription.rbs +687 -0
  559. data/sig/orb/models/subscription_cancel_params.rbs +44 -0
  560. data/sig/orb/models/subscription_cancel_response.rbs +687 -0
  561. data/sig/orb/models/subscription_create_params.rbs +9141 -0
  562. data/sig/orb/models/subscription_create_response.rbs +687 -0
  563. data/sig/orb/models/subscription_fetch_costs_params.rbs +46 -0
  564. data/sig/orb/models/subscription_fetch_costs_response.rbs +78 -0
  565. data/sig/orb/models/subscription_fetch_params.rbs +14 -0
  566. data/sig/orb/models/subscription_fetch_schedule_params.rbs +45 -0
  567. data/sig/orb/models/subscription_fetch_schedule_response.rbs +48 -0
  568. data/sig/orb/models/subscription_fetch_usage_params.rbs +80 -0
  569. data/sig/orb/models/subscription_list_params.rbs +69 -0
  570. data/sig/orb/models/subscription_price_intervals_params.rbs +5117 -0
  571. data/sig/orb/models/subscription_price_intervals_response.rbs +687 -0
  572. data/sig/orb/models/subscription_schedule_plan_change_params.rbs +9133 -0
  573. data/sig/orb/models/subscription_schedule_plan_change_response.rbs +687 -0
  574. data/sig/orb/models/subscription_trigger_phase_params.rbs +24 -0
  575. data/sig/orb/models/subscription_trigger_phase_response.rbs +687 -0
  576. data/sig/orb/models/subscription_unschedule_cancellation_params.rbs +15 -0
  577. data/sig/orb/models/subscription_unschedule_cancellation_response.rbs +687 -0
  578. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_params.rbs +20 -0
  579. data/sig/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rbs +687 -0
  580. data/sig/orb/models/subscription_unschedule_pending_plan_changes_params.rbs +15 -0
  581. data/sig/orb/models/subscription_unschedule_pending_plan_changes_response.rbs +687 -0
  582. data/sig/orb/models/subscription_update_fixed_fee_quantity_params.rbs +55 -0
  583. data/sig/orb/models/subscription_update_fixed_fee_quantity_response.rbs +687 -0
  584. data/sig/orb/models/subscription_update_params.rbs +39 -0
  585. data/sig/orb/models/subscription_update_trial_params.rbs +39 -0
  586. data/sig/orb/models/subscription_update_trial_response.rbs +687 -0
  587. data/sig/orb/models/subscription_usage.rbs +196 -0
  588. data/sig/orb/models/subscriptions.rbs +22 -0
  589. data/sig/orb/models/top_level_ping_params.rbs +14 -0
  590. data/sig/orb/models/top_level_ping_response.rbs +13 -0
  591. data/sig/orb/models/trial_discount.rbs +44 -0
  592. data/sig/orb/models/usage_discount.rbs +40 -0
  593. data/sig/orb/page.rbs +22 -0
  594. data/sig/orb/request_options.rbs +32 -0
  595. data/sig/orb/resources/alerts.rbs +67 -0
  596. data/sig/orb/resources/coupons/subscriptions.rbs +16 -0
  597. data/sig/orb/resources/coupons.rbs +35 -0
  598. data/sig/orb/resources/credit_notes.rbs +29 -0
  599. data/sig/orb/resources/customers/balance_transactions.rbs +28 -0
  600. data/sig/orb/resources/customers/costs.rbs +27 -0
  601. data/sig/orb/resources/customers/credits/ledger.rbs +75 -0
  602. data/sig/orb/resources/customers/credits/top_ups.rbs +63 -0
  603. data/sig/orb/resources/customers/credits.rbs +31 -0
  604. data/sig/orb/resources/customers.rbs +114 -0
  605. data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs +14 -0
  606. data/sig/orb/resources/dimensional_price_groups.rbs +29 -0
  607. data/sig/orb/resources/events/backfills.rbs +41 -0
  608. data/sig/orb/resources/events/volume.rbs +17 -0
  609. data/sig/orb/resources/events.rbs +40 -0
  610. data/sig/orb/resources/invoice_line_items.rbs +17 -0
  611. data/sig/orb/resources/invoices.rbs +84 -0
  612. data/sig/orb/resources/items.rbs +30 -0
  613. data/sig/orb/resources/metrics.rbs +37 -0
  614. data/sig/orb/resources/plans/external_plan_id.rbs +21 -0
  615. data/sig/orb/resources/plans.rbs +44 -0
  616. data/sig/orb/resources/prices/external_price_id.rbs +20 -0
  617. data/sig/orb/resources/prices.rbs +83 -0
  618. data/sig/orb/resources/subscriptions.rbs +194 -0
  619. data/sig/orb/resources/top_level.rbs +11 -0
  620. data/sig/orb/transport/base_client.rbs +110 -0
  621. data/sig/orb/transport/pooled_net_requester.rbs +39 -0
  622. data/sig/orb/type/array_of.rbs +36 -0
  623. data/sig/orb/type/base_model.rbs +77 -0
  624. data/sig/orb/type/base_page.rbs +22 -0
  625. data/sig/orb/type/boolean_model.rbs +18 -0
  626. data/sig/orb/type/converter.rbs +36 -0
  627. data/sig/orb/type/enum.rbs +22 -0
  628. data/sig/orb/type/hash_of.rbs +36 -0
  629. data/sig/orb/type/request_parameters.rbs +13 -0
  630. data/sig/orb/type/union.rbs +37 -0
  631. data/sig/orb/type/unknown.rbs +15 -0
  632. data/sig/orb/type.rbs +22 -0
  633. data/sig/orb/util.rbs +132 -0
  634. data/sig/orb/version.rbs +3 -0
  635. metadata +692 -0
@@ -0,0 +1,808 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Orb
4
+ module Models
5
+ # @see Orb::Resources::Prices#create
6
+ class PriceCreateParams < Orb::BaseModel
7
+ # @!parse
8
+ # extend Orb::Type::RequestParameters::Converter
9
+ include Orb::RequestParameters
10
+
11
+ # @!attribute cadence
12
+ # The cadence to bill for this price on.
13
+ #
14
+ # @return [Symbol, Orb::Models::PriceCreateParams::Cadence]
15
+ required :cadence, enum: -> { Orb::Models::PriceCreateParams::Cadence }
16
+
17
+ # @!attribute currency
18
+ # An ISO 4217 currency string for which this price is billed in.
19
+ #
20
+ # @return [String]
21
+ required :currency, String
22
+
23
+ # @!attribute item_id
24
+ # The id of the item the price will be associated with.
25
+ #
26
+ # @return [String]
27
+ required :item_id, String
28
+
29
+ # @!attribute model_type
30
+ #
31
+ # @return [Symbol, Orb::Models::PriceCreateParams::ModelType]
32
+ required :model_type, enum: -> { Orb::Models::PriceCreateParams::ModelType }
33
+
34
+ # @!attribute name
35
+ # The name of the price.
36
+ #
37
+ # @return [String]
38
+ required :name, String
39
+
40
+ # @!attribute unit_config
41
+ #
42
+ # @return [Orb::Models::PriceCreateParams::UnitConfig]
43
+ required :unit_config, -> { Orb::Models::PriceCreateParams::UnitConfig }
44
+
45
+ # @!attribute billable_metric_id
46
+ # The id of the billable metric for the price. Only needed if the price is
47
+ # usage-based.
48
+ #
49
+ # @return [String, nil]
50
+ optional :billable_metric_id, String, nil?: true
51
+
52
+ # @!attribute billed_in_advance
53
+ # If the Price represents a fixed cost, the price will be billed in-advance if
54
+ # this is true, and in-arrears if this is false.
55
+ #
56
+ # @return [Boolean, nil]
57
+ optional :billed_in_advance, Orb::BooleanModel, nil?: true
58
+
59
+ # @!attribute billing_cycle_configuration
60
+ # For custom cadence: specifies the duration of the billing period in days or
61
+ # months.
62
+ #
63
+ # @return [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil]
64
+ optional :billing_cycle_configuration,
65
+ -> { Orb::Models::PriceCreateParams::BillingCycleConfiguration },
66
+ nil?: true
67
+
68
+ # @!attribute conversion_rate
69
+ # The per unit conversion rate of the price currency to the invoicing currency.
70
+ #
71
+ # @return [Float, nil]
72
+ optional :conversion_rate, Float, nil?: true
73
+
74
+ # @!attribute external_price_id
75
+ # An alias for the price.
76
+ #
77
+ # @return [String, nil]
78
+ optional :external_price_id, String, nil?: true
79
+
80
+ # @!attribute fixed_price_quantity
81
+ # If the Price represents a fixed cost, this represents the quantity of units
82
+ # applied.
83
+ #
84
+ # @return [Float, nil]
85
+ optional :fixed_price_quantity, Float, nil?: true
86
+
87
+ # @!attribute invoice_grouping_key
88
+ # The property used to group this price on an invoice
89
+ #
90
+ # @return [String, nil]
91
+ optional :invoice_grouping_key, String, nil?: true
92
+
93
+ # @!attribute invoicing_cycle_configuration
94
+ # Within each billing cycle, specifies the cadence at which invoices are produced.
95
+ # If unspecified, a single invoice is produced per billing cycle.
96
+ #
97
+ # @return [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil]
98
+ optional :invoicing_cycle_configuration,
99
+ -> { Orb::Models::PriceCreateParams::InvoicingCycleConfiguration },
100
+ nil?: true
101
+
102
+ # @!attribute metadata
103
+ # User-specified key/value pairs for the resource. Individual keys can be removed
104
+ # by setting the value to `null`, and the entire metadata mapping can be cleared
105
+ # by setting `metadata` to `null`.
106
+ #
107
+ # @return [Hash{Symbol=>String, nil}, nil]
108
+ optional :metadata, Orb::HashOf[String, nil?: true], nil?: true
109
+
110
+ # @!attribute package_config
111
+ #
112
+ # @return [Orb::Models::PriceCreateParams::PackageConfig]
113
+ required :package_config, -> { Orb::Models::PriceCreateParams::PackageConfig }
114
+
115
+ # @!attribute matrix_config
116
+ #
117
+ # @return [Orb::Models::PriceCreateParams::MatrixConfig]
118
+ required :matrix_config, -> { Orb::Models::PriceCreateParams::MatrixConfig }
119
+
120
+ # @!attribute matrix_with_allocation_config
121
+ #
122
+ # @return [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig]
123
+ required :matrix_with_allocation_config, -> { Orb::Models::PriceCreateParams::MatrixWithAllocationConfig }
124
+
125
+ # @!attribute tiered_config
126
+ #
127
+ # @return [Orb::Models::PriceCreateParams::TieredConfig]
128
+ required :tiered_config, -> { Orb::Models::PriceCreateParams::TieredConfig }
129
+
130
+ # @!attribute tiered_bps_config
131
+ #
132
+ # @return [Orb::Models::PriceCreateParams::TieredBpsConfig]
133
+ required :tiered_bps_config, -> { Orb::Models::PriceCreateParams::TieredBpsConfig }
134
+
135
+ # @!attribute bps_config
136
+ #
137
+ # @return [Orb::Models::PriceCreateParams::BpsConfig]
138
+ required :bps_config, -> { Orb::Models::PriceCreateParams::BpsConfig }
139
+
140
+ # @!attribute bulk_bps_config
141
+ #
142
+ # @return [Orb::Models::PriceCreateParams::BulkBpsConfig]
143
+ required :bulk_bps_config, -> { Orb::Models::PriceCreateParams::BulkBpsConfig }
144
+
145
+ # @!attribute bulk_config
146
+ #
147
+ # @return [Orb::Models::PriceCreateParams::BulkConfig]
148
+ required :bulk_config, -> { Orb::Models::PriceCreateParams::BulkConfig }
149
+
150
+ # @!attribute threshold_total_amount_config
151
+ #
152
+ # @return [Hash{Symbol=>Object}]
153
+ required :threshold_total_amount_config, Orb::HashOf[Orb::Unknown]
154
+
155
+ # @!attribute tiered_package_config
156
+ #
157
+ # @return [Hash{Symbol=>Object}]
158
+ required :tiered_package_config, Orb::HashOf[Orb::Unknown]
159
+
160
+ # @!attribute grouped_tiered_config
161
+ #
162
+ # @return [Hash{Symbol=>Object}]
163
+ required :grouped_tiered_config, Orb::HashOf[Orb::Unknown]
164
+
165
+ # @!attribute max_group_tiered_package_config
166
+ #
167
+ # @return [Hash{Symbol=>Object}]
168
+ required :max_group_tiered_package_config, Orb::HashOf[Orb::Unknown]
169
+
170
+ # @!attribute tiered_with_minimum_config
171
+ #
172
+ # @return [Hash{Symbol=>Object}]
173
+ required :tiered_with_minimum_config, Orb::HashOf[Orb::Unknown]
174
+
175
+ # @!attribute package_with_allocation_config
176
+ #
177
+ # @return [Hash{Symbol=>Object}]
178
+ required :package_with_allocation_config, Orb::HashOf[Orb::Unknown]
179
+
180
+ # @!attribute tiered_package_with_minimum_config
181
+ #
182
+ # @return [Hash{Symbol=>Object}]
183
+ required :tiered_package_with_minimum_config, Orb::HashOf[Orb::Unknown]
184
+
185
+ # @!attribute unit_with_percent_config
186
+ #
187
+ # @return [Hash{Symbol=>Object}]
188
+ required :unit_with_percent_config, Orb::HashOf[Orb::Unknown]
189
+
190
+ # @!attribute tiered_with_proration_config
191
+ #
192
+ # @return [Hash{Symbol=>Object}]
193
+ required :tiered_with_proration_config, Orb::HashOf[Orb::Unknown]
194
+
195
+ # @!attribute unit_with_proration_config
196
+ #
197
+ # @return [Hash{Symbol=>Object}]
198
+ required :unit_with_proration_config, Orb::HashOf[Orb::Unknown]
199
+
200
+ # @!attribute grouped_allocation_config
201
+ #
202
+ # @return [Hash{Symbol=>Object}]
203
+ required :grouped_allocation_config, Orb::HashOf[Orb::Unknown]
204
+
205
+ # @!attribute grouped_with_prorated_minimum_config
206
+ #
207
+ # @return [Hash{Symbol=>Object}]
208
+ required :grouped_with_prorated_minimum_config, Orb::HashOf[Orb::Unknown]
209
+
210
+ # @!attribute grouped_with_metered_minimum_config
211
+ #
212
+ # @return [Hash{Symbol=>Object}]
213
+ required :grouped_with_metered_minimum_config, Orb::HashOf[Orb::Unknown]
214
+
215
+ # @!attribute matrix_with_display_name_config
216
+ #
217
+ # @return [Hash{Symbol=>Object}]
218
+ required :matrix_with_display_name_config, Orb::HashOf[Orb::Unknown]
219
+
220
+ # @!attribute bulk_with_proration_config
221
+ #
222
+ # @return [Hash{Symbol=>Object}]
223
+ required :bulk_with_proration_config, Orb::HashOf[Orb::Unknown]
224
+
225
+ # @!attribute grouped_tiered_package_config
226
+ #
227
+ # @return [Hash{Symbol=>Object}]
228
+ required :grouped_tiered_package_config, Orb::HashOf[Orb::Unknown]
229
+
230
+ # @!attribute scalable_matrix_with_unit_pricing_config
231
+ #
232
+ # @return [Hash{Symbol=>Object}]
233
+ required :scalable_matrix_with_unit_pricing_config, Orb::HashOf[Orb::Unknown]
234
+
235
+ # @!attribute scalable_matrix_with_tiered_pricing_config
236
+ #
237
+ # @return [Hash{Symbol=>Object}]
238
+ required :scalable_matrix_with_tiered_pricing_config, Orb::HashOf[Orb::Unknown]
239
+
240
+ # @!attribute cumulative_grouped_bulk_config
241
+ #
242
+ # @return [Hash{Symbol=>Object}]
243
+ required :cumulative_grouped_bulk_config, Orb::HashOf[Orb::Unknown]
244
+
245
+ # @!parse
246
+ # # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence]
247
+ # # @param currency [String]
248
+ # # @param item_id [String]
249
+ # # @param model_type [Symbol, Orb::Models::PriceCreateParams::ModelType]
250
+ # # @param name [String]
251
+ # # @param unit_config [Orb::Models::PriceCreateParams::UnitConfig]
252
+ # # @param package_config [Orb::Models::PriceCreateParams::PackageConfig]
253
+ # # @param matrix_config [Orb::Models::PriceCreateParams::MatrixConfig]
254
+ # # @param matrix_with_allocation_config [Orb::Models::PriceCreateParams::MatrixWithAllocationConfig]
255
+ # # @param tiered_config [Orb::Models::PriceCreateParams::TieredConfig]
256
+ # # @param tiered_bps_config [Orb::Models::PriceCreateParams::TieredBpsConfig]
257
+ # # @param bps_config [Orb::Models::PriceCreateParams::BpsConfig]
258
+ # # @param bulk_bps_config [Orb::Models::PriceCreateParams::BulkBpsConfig]
259
+ # # @param bulk_config [Orb::Models::PriceCreateParams::BulkConfig]
260
+ # # @param threshold_total_amount_config [Hash{Symbol=>Object}]
261
+ # # @param tiered_package_config [Hash{Symbol=>Object}]
262
+ # # @param grouped_tiered_config [Hash{Symbol=>Object}]
263
+ # # @param max_group_tiered_package_config [Hash{Symbol=>Object}]
264
+ # # @param tiered_with_minimum_config [Hash{Symbol=>Object}]
265
+ # # @param package_with_allocation_config [Hash{Symbol=>Object}]
266
+ # # @param tiered_package_with_minimum_config [Hash{Symbol=>Object}]
267
+ # # @param unit_with_percent_config [Hash{Symbol=>Object}]
268
+ # # @param tiered_with_proration_config [Hash{Symbol=>Object}]
269
+ # # @param unit_with_proration_config [Hash{Symbol=>Object}]
270
+ # # @param grouped_allocation_config [Hash{Symbol=>Object}]
271
+ # # @param grouped_with_prorated_minimum_config [Hash{Symbol=>Object}]
272
+ # # @param grouped_with_metered_minimum_config [Hash{Symbol=>Object}]
273
+ # # @param matrix_with_display_name_config [Hash{Symbol=>Object}]
274
+ # # @param bulk_with_proration_config [Hash{Symbol=>Object}]
275
+ # # @param grouped_tiered_package_config [Hash{Symbol=>Object}]
276
+ # # @param scalable_matrix_with_unit_pricing_config [Hash{Symbol=>Object}]
277
+ # # @param scalable_matrix_with_tiered_pricing_config [Hash{Symbol=>Object}]
278
+ # # @param cumulative_grouped_bulk_config [Hash{Symbol=>Object}]
279
+ # # @param billable_metric_id [String, nil]
280
+ # # @param billed_in_advance [Boolean, nil]
281
+ # # @param billing_cycle_configuration [Orb::Models::PriceCreateParams::BillingCycleConfiguration, nil]
282
+ # # @param conversion_rate [Float, nil]
283
+ # # @param external_price_id [String, nil]
284
+ # # @param fixed_price_quantity [Float, nil]
285
+ # # @param invoice_grouping_key [String, nil]
286
+ # # @param invoicing_cycle_configuration [Orb::Models::PriceCreateParams::InvoicingCycleConfiguration, nil]
287
+ # # @param metadata [Hash{Symbol=>String, nil}, nil]
288
+ # # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
289
+ # #
290
+ # def initialize(
291
+ # cadence:,
292
+ # currency:,
293
+ # item_id:,
294
+ # model_type:,
295
+ # name:,
296
+ # unit_config:,
297
+ # package_config:,
298
+ # matrix_config:,
299
+ # matrix_with_allocation_config:,
300
+ # tiered_config:,
301
+ # tiered_bps_config:,
302
+ # bps_config:,
303
+ # bulk_bps_config:,
304
+ # bulk_config:,
305
+ # threshold_total_amount_config:,
306
+ # tiered_package_config:,
307
+ # grouped_tiered_config:,
308
+ # max_group_tiered_package_config:,
309
+ # tiered_with_minimum_config:,
310
+ # package_with_allocation_config:,
311
+ # tiered_package_with_minimum_config:,
312
+ # unit_with_percent_config:,
313
+ # tiered_with_proration_config:,
314
+ # unit_with_proration_config:,
315
+ # grouped_allocation_config:,
316
+ # grouped_with_prorated_minimum_config:,
317
+ # grouped_with_metered_minimum_config:,
318
+ # matrix_with_display_name_config:,
319
+ # bulk_with_proration_config:,
320
+ # grouped_tiered_package_config:,
321
+ # scalable_matrix_with_unit_pricing_config:,
322
+ # scalable_matrix_with_tiered_pricing_config:,
323
+ # cumulative_grouped_bulk_config:,
324
+ # billable_metric_id: nil,
325
+ # billed_in_advance: nil,
326
+ # billing_cycle_configuration: nil,
327
+ # conversion_rate: nil,
328
+ # external_price_id: nil,
329
+ # fixed_price_quantity: nil,
330
+ # invoice_grouping_key: nil,
331
+ # invoicing_cycle_configuration: nil,
332
+ # metadata: nil,
333
+ # request_options: {},
334
+ # **
335
+ # )
336
+ # super
337
+ # end
338
+
339
+ # def initialize: (Hash | Orb::BaseModel) -> void
340
+
341
+ # The cadence to bill for this price on.
342
+ module Cadence
343
+ extend Orb::Enum
344
+
345
+ ANNUAL = :annual
346
+ SEMI_ANNUAL = :semi_annual
347
+ MONTHLY = :monthly
348
+ QUARTERLY = :quarterly
349
+ ONE_TIME = :one_time
350
+ CUSTOM = :custom
351
+
352
+ finalize!
353
+
354
+ # @!parse
355
+ # # @return [Array<Symbol>]
356
+ # def self.values; end
357
+ end
358
+
359
+ module ModelType
360
+ extend Orb::Enum
361
+
362
+ CUMULATIVE_GROUPED_BULK = :cumulative_grouped_bulk
363
+
364
+ finalize!
365
+
366
+ # @!parse
367
+ # # @return [Array<Symbol>]
368
+ # def self.values; end
369
+ end
370
+
371
+ class UnitConfig < Orb::BaseModel
372
+ # @!attribute unit_amount
373
+ # Rate per unit of usage
374
+ #
375
+ # @return [String]
376
+ required :unit_amount, String
377
+
378
+ # @!parse
379
+ # # @param unit_amount [String]
380
+ # #
381
+ # def initialize(unit_amount:, **) = super
382
+
383
+ # def initialize: (Hash | Orb::BaseModel) -> void
384
+ end
385
+
386
+ class BillingCycleConfiguration < Orb::BaseModel
387
+ # @!attribute duration
388
+ # The duration of the billing period.
389
+ #
390
+ # @return [Integer]
391
+ required :duration, Integer
392
+
393
+ # @!attribute duration_unit
394
+ # The unit of billing period duration.
395
+ #
396
+ # @return [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit]
397
+ required :duration_unit,
398
+ enum: -> { Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit }
399
+
400
+ # @!parse
401
+ # # For custom cadence: specifies the duration of the billing period in days or
402
+ # # months.
403
+ # #
404
+ # # @param duration [Integer]
405
+ # # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::BillingCycleConfiguration::DurationUnit]
406
+ # #
407
+ # def initialize(duration:, duration_unit:, **) = super
408
+
409
+ # def initialize: (Hash | Orb::BaseModel) -> void
410
+
411
+ # The unit of billing period duration.
412
+ #
413
+ # @see Orb::Models::PriceCreateParams::BillingCycleConfiguration#duration_unit
414
+ module DurationUnit
415
+ extend Orb::Enum
416
+
417
+ DAY = :day
418
+ MONTH = :month
419
+
420
+ finalize!
421
+
422
+ # @!parse
423
+ # # @return [Array<Symbol>]
424
+ # def self.values; end
425
+ end
426
+ end
427
+
428
+ class InvoicingCycleConfiguration < Orb::BaseModel
429
+ # @!attribute duration
430
+ # The duration of the billing period.
431
+ #
432
+ # @return [Integer]
433
+ required :duration, Integer
434
+
435
+ # @!attribute duration_unit
436
+ # The unit of billing period duration.
437
+ #
438
+ # @return [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit]
439
+ required :duration_unit,
440
+ enum: -> { Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit }
441
+
442
+ # @!parse
443
+ # # Within each billing cycle, specifies the cadence at which invoices are produced.
444
+ # # If unspecified, a single invoice is produced per billing cycle.
445
+ # #
446
+ # # @param duration [Integer]
447
+ # # @param duration_unit [Symbol, Orb::Models::PriceCreateParams::InvoicingCycleConfiguration::DurationUnit]
448
+ # #
449
+ # def initialize(duration:, duration_unit:, **) = super
450
+
451
+ # def initialize: (Hash | Orb::BaseModel) -> void
452
+
453
+ # The unit of billing period duration.
454
+ #
455
+ # @see Orb::Models::PriceCreateParams::InvoicingCycleConfiguration#duration_unit
456
+ module DurationUnit
457
+ extend Orb::Enum
458
+
459
+ DAY = :day
460
+ MONTH = :month
461
+
462
+ finalize!
463
+
464
+ # @!parse
465
+ # # @return [Array<Symbol>]
466
+ # def self.values; end
467
+ end
468
+ end
469
+
470
+ class PackageConfig < Orb::BaseModel
471
+ # @!attribute package_amount
472
+ # A currency amount to rate usage by
473
+ #
474
+ # @return [String]
475
+ required :package_amount, String
476
+
477
+ # @!attribute package_size
478
+ # An integer amount to represent package size. For example, 1000 here would divide
479
+ # usage by 1000 before multiplying by package_amount in rating
480
+ #
481
+ # @return [Integer]
482
+ required :package_size, Integer
483
+
484
+ # @!parse
485
+ # # @param package_amount [String]
486
+ # # @param package_size [Integer]
487
+ # #
488
+ # def initialize(package_amount:, package_size:, **) = super
489
+
490
+ # def initialize: (Hash | Orb::BaseModel) -> void
491
+ end
492
+
493
+ class MatrixConfig < Orb::BaseModel
494
+ # @!attribute default_unit_amount
495
+ # Default per unit rate for any usage not bucketed into a specified matrix_value
496
+ #
497
+ # @return [String]
498
+ required :default_unit_amount, String
499
+
500
+ # @!attribute dimensions
501
+ # One or two event property values to evaluate matrix groups by
502
+ #
503
+ # @return [Array<String, nil>]
504
+ required :dimensions, Orb::ArrayOf[String, nil?: true]
505
+
506
+ # @!attribute matrix_values
507
+ # Matrix values for specified matrix grouping keys
508
+ #
509
+ # @return [Array<Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue>]
510
+ required :matrix_values, -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue] }
511
+
512
+ # @!parse
513
+ # # @param default_unit_amount [String]
514
+ # # @param dimensions [Array<String, nil>]
515
+ # # @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixConfig::MatrixValue>]
516
+ # #
517
+ # def initialize(default_unit_amount:, dimensions:, matrix_values:, **) = super
518
+
519
+ # def initialize: (Hash | Orb::BaseModel) -> void
520
+
521
+ class MatrixValue < Orb::BaseModel
522
+ # @!attribute dimension_values
523
+ # One or two matrix keys to filter usage to this Matrix value by. For example,
524
+ # ["region", "tier"] could be used to filter cloud usage by a cloud region and an
525
+ # instance tier.
526
+ #
527
+ # @return [Array<String, nil>]
528
+ required :dimension_values, Orb::ArrayOf[String, nil?: true]
529
+
530
+ # @!attribute unit_amount
531
+ # Unit price for the specified dimension_values
532
+ #
533
+ # @return [String]
534
+ required :unit_amount, String
535
+
536
+ # @!parse
537
+ # # @param dimension_values [Array<String, nil>]
538
+ # # @param unit_amount [String]
539
+ # #
540
+ # def initialize(dimension_values:, unit_amount:, **) = super
541
+
542
+ # def initialize: (Hash | Orb::BaseModel) -> void
543
+ end
544
+ end
545
+
546
+ class MatrixWithAllocationConfig < Orb::BaseModel
547
+ # @!attribute allocation
548
+ # Allocation to be used to calculate the price
549
+ #
550
+ # @return [Float]
551
+ required :allocation, Float
552
+
553
+ # @!attribute default_unit_amount
554
+ # Default per unit rate for any usage not bucketed into a specified matrix_value
555
+ #
556
+ # @return [String]
557
+ required :default_unit_amount, String
558
+
559
+ # @!attribute dimensions
560
+ # One or two event property values to evaluate matrix groups by
561
+ #
562
+ # @return [Array<String, nil>]
563
+ required :dimensions, Orb::ArrayOf[String, nil?: true]
564
+
565
+ # @!attribute matrix_values
566
+ # Matrix values for specified matrix grouping keys
567
+ #
568
+ # @return [Array<Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue>]
569
+ required :matrix_values,
570
+ -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue] }
571
+
572
+ # @!parse
573
+ # # @param allocation [Float]
574
+ # # @param default_unit_amount [String]
575
+ # # @param dimensions [Array<String, nil>]
576
+ # # @param matrix_values [Array<Orb::Models::PriceCreateParams::MatrixWithAllocationConfig::MatrixValue>]
577
+ # #
578
+ # def initialize(allocation:, default_unit_amount:, dimensions:, matrix_values:, **) = super
579
+
580
+ # def initialize: (Hash | Orb::BaseModel) -> void
581
+
582
+ class MatrixValue < Orb::BaseModel
583
+ # @!attribute dimension_values
584
+ # One or two matrix keys to filter usage to this Matrix value by. For example,
585
+ # ["region", "tier"] could be used to filter cloud usage by a cloud region and an
586
+ # instance tier.
587
+ #
588
+ # @return [Array<String, nil>]
589
+ required :dimension_values, Orb::ArrayOf[String, nil?: true]
590
+
591
+ # @!attribute unit_amount
592
+ # Unit price for the specified dimension_values
593
+ #
594
+ # @return [String]
595
+ required :unit_amount, String
596
+
597
+ # @!parse
598
+ # # @param dimension_values [Array<String, nil>]
599
+ # # @param unit_amount [String]
600
+ # #
601
+ # def initialize(dimension_values:, unit_amount:, **) = super
602
+
603
+ # def initialize: (Hash | Orb::BaseModel) -> void
604
+ end
605
+ end
606
+
607
+ class TieredConfig < Orb::BaseModel
608
+ # @!attribute tiers
609
+ # Tiers for rating based on total usage quantities into the specified tier
610
+ #
611
+ # @return [Array<Orb::Models::PriceCreateParams::TieredConfig::Tier>]
612
+ required :tiers, -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::TieredConfig::Tier] }
613
+
614
+ # @!parse
615
+ # # @param tiers [Array<Orb::Models::PriceCreateParams::TieredConfig::Tier>]
616
+ # #
617
+ # def initialize(tiers:, **) = super
618
+
619
+ # def initialize: (Hash | Orb::BaseModel) -> void
620
+
621
+ class Tier < Orb::BaseModel
622
+ # @!attribute first_unit
623
+ # Inclusive tier starting value
624
+ #
625
+ # @return [Float]
626
+ required :first_unit, Float
627
+
628
+ # @!attribute unit_amount
629
+ # Amount per unit
630
+ #
631
+ # @return [String]
632
+ required :unit_amount, String
633
+
634
+ # @!attribute last_unit
635
+ # Exclusive tier ending value. If null, this is treated as the last tier
636
+ #
637
+ # @return [Float, nil]
638
+ optional :last_unit, Float, nil?: true
639
+
640
+ # @!parse
641
+ # # @param first_unit [Float]
642
+ # # @param unit_amount [String]
643
+ # # @param last_unit [Float, nil]
644
+ # #
645
+ # def initialize(first_unit:, unit_amount:, last_unit: nil, **) = super
646
+
647
+ # def initialize: (Hash | Orb::BaseModel) -> void
648
+ end
649
+ end
650
+
651
+ class TieredBpsConfig < Orb::BaseModel
652
+ # @!attribute tiers
653
+ # Tiers for a Graduated BPS pricing model, where usage is bucketed into specified
654
+ # tiers
655
+ #
656
+ # @return [Array<Orb::Models::PriceCreateParams::TieredBpsConfig::Tier>]
657
+ required :tiers, -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::TieredBpsConfig::Tier] }
658
+
659
+ # @!parse
660
+ # # @param tiers [Array<Orb::Models::PriceCreateParams::TieredBpsConfig::Tier>]
661
+ # #
662
+ # def initialize(tiers:, **) = super
663
+
664
+ # def initialize: (Hash | Orb::BaseModel) -> void
665
+
666
+ class Tier < Orb::BaseModel
667
+ # @!attribute bps
668
+ # Per-event basis point rate
669
+ #
670
+ # @return [Float]
671
+ required :bps, Float
672
+
673
+ # @!attribute minimum_amount
674
+ # Inclusive tier starting value
675
+ #
676
+ # @return [String]
677
+ required :minimum_amount, String
678
+
679
+ # @!attribute maximum_amount
680
+ # Exclusive tier ending value
681
+ #
682
+ # @return [String, nil]
683
+ optional :maximum_amount, String, nil?: true
684
+
685
+ # @!attribute per_unit_maximum
686
+ # Per unit maximum to charge
687
+ #
688
+ # @return [String, nil]
689
+ optional :per_unit_maximum, String, nil?: true
690
+
691
+ # @!parse
692
+ # # @param bps [Float]
693
+ # # @param minimum_amount [String]
694
+ # # @param maximum_amount [String, nil]
695
+ # # @param per_unit_maximum [String, nil]
696
+ # #
697
+ # def initialize(bps:, minimum_amount:, maximum_amount: nil, per_unit_maximum: nil, **) = super
698
+
699
+ # def initialize: (Hash | Orb::BaseModel) -> void
700
+ end
701
+ end
702
+
703
+ class BpsConfig < Orb::BaseModel
704
+ # @!attribute bps
705
+ # Basis point take rate per event
706
+ #
707
+ # @return [Float]
708
+ required :bps, Float
709
+
710
+ # @!attribute per_unit_maximum
711
+ # Optional currency amount maximum to cap spend per event
712
+ #
713
+ # @return [String, nil]
714
+ optional :per_unit_maximum, String, nil?: true
715
+
716
+ # @!parse
717
+ # # @param bps [Float]
718
+ # # @param per_unit_maximum [String, nil]
719
+ # #
720
+ # def initialize(bps:, per_unit_maximum: nil, **) = super
721
+
722
+ # def initialize: (Hash | Orb::BaseModel) -> void
723
+ end
724
+
725
+ class BulkBpsConfig < Orb::BaseModel
726
+ # @!attribute tiers
727
+ # Tiers for a bulk BPS pricing model where all usage is aggregated to a single
728
+ # tier based on total volume
729
+ #
730
+ # @return [Array<Orb::Models::PriceCreateParams::BulkBpsConfig::Tier>]
731
+ required :tiers, -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::BulkBpsConfig::Tier] }
732
+
733
+ # @!parse
734
+ # # @param tiers [Array<Orb::Models::PriceCreateParams::BulkBpsConfig::Tier>]
735
+ # #
736
+ # def initialize(tiers:, **) = super
737
+
738
+ # def initialize: (Hash | Orb::BaseModel) -> void
739
+
740
+ class Tier < Orb::BaseModel
741
+ # @!attribute bps
742
+ # Basis points to rate on
743
+ #
744
+ # @return [Float]
745
+ required :bps, Float
746
+
747
+ # @!attribute maximum_amount
748
+ # Upper bound for tier
749
+ #
750
+ # @return [String, nil]
751
+ optional :maximum_amount, String, nil?: true
752
+
753
+ # @!attribute per_unit_maximum
754
+ # The maximum amount to charge for any one event
755
+ #
756
+ # @return [String, nil]
757
+ optional :per_unit_maximum, String, nil?: true
758
+
759
+ # @!parse
760
+ # # @param bps [Float]
761
+ # # @param maximum_amount [String, nil]
762
+ # # @param per_unit_maximum [String, nil]
763
+ # #
764
+ # def initialize(bps:, maximum_amount: nil, per_unit_maximum: nil, **) = super
765
+
766
+ # def initialize: (Hash | Orb::BaseModel) -> void
767
+ end
768
+ end
769
+
770
+ class BulkConfig < Orb::BaseModel
771
+ # @!attribute tiers
772
+ # Bulk tiers for rating based on total usage volume
773
+ #
774
+ # @return [Array<Orb::Models::PriceCreateParams::BulkConfig::Tier>]
775
+ required :tiers, -> { Orb::ArrayOf[Orb::Models::PriceCreateParams::BulkConfig::Tier] }
776
+
777
+ # @!parse
778
+ # # @param tiers [Array<Orb::Models::PriceCreateParams::BulkConfig::Tier>]
779
+ # #
780
+ # def initialize(tiers:, **) = super
781
+
782
+ # def initialize: (Hash | Orb::BaseModel) -> void
783
+
784
+ class Tier < Orb::BaseModel
785
+ # @!attribute unit_amount
786
+ # Amount per unit
787
+ #
788
+ # @return [String]
789
+ required :unit_amount, String
790
+
791
+ # @!attribute maximum_units
792
+ # Upper bound for this tier
793
+ #
794
+ # @return [Float, nil]
795
+ optional :maximum_units, Float, nil?: true
796
+
797
+ # @!parse
798
+ # # @param unit_amount [String]
799
+ # # @param maximum_units [Float, nil]
800
+ # #
801
+ # def initialize(unit_amount:, maximum_units: nil, **) = super
802
+
803
+ # def initialize: (Hash | Orb::BaseModel) -> void
804
+ end
805
+ end
806
+ end
807
+ end
808
+ end