metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

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 (475) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +85 -0
  3. data/README.md +120 -74
  4. data/SECURITY.md +2 -2
  5. data/lib/metronome_sdk/client.rb +4 -4
  6. data/lib/metronome_sdk/errors.rb +22 -0
  7. data/lib/metronome_sdk/internal/transport/base_client.rb +10 -2
  8. data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +3 -1
  9. data/lib/metronome_sdk/internal/type/array_of.rb +14 -1
  10. data/lib/metronome_sdk/internal/type/base_model.rb +92 -23
  11. data/lib/metronome_sdk/internal/type/boolean.rb +15 -1
  12. data/lib/metronome_sdk/internal/type/converter.rb +42 -34
  13. data/lib/metronome_sdk/internal/type/enum.rb +25 -2
  14. data/lib/metronome_sdk/internal/type/file_input.rb +13 -1
  15. data/lib/metronome_sdk/internal/type/hash_of.rb +14 -1
  16. data/lib/metronome_sdk/internal/type/union.rb +27 -7
  17. data/lib/metronome_sdk/internal/type/unknown.rb +15 -1
  18. data/lib/metronome_sdk/internal/util.rb +62 -10
  19. data/lib/metronome_sdk/internal.rb +3 -0
  20. data/lib/metronome_sdk/models/commit.rb +230 -87
  21. data/lib/metronome_sdk/models/contract_without_amendments.rb +551 -185
  22. data/lib/metronome_sdk/models/credit.rb +201 -51
  23. data/lib/metronome_sdk/models/discount.rb +5 -5
  24. data/lib/metronome_sdk/models/event_type_filter.rb +1 -1
  25. data/lib/metronome_sdk/models/override.rb +53 -34
  26. data/lib/metronome_sdk/models/pro_service.rb +2 -2
  27. data/lib/metronome_sdk/models/property_filter.rb +1 -1
  28. data/lib/metronome_sdk/models/rate.rb +9 -9
  29. data/lib/metronome_sdk/models/schedule_duration.rb +4 -4
  30. data/lib/metronome_sdk/models/schedule_point_in_time.rb +11 -11
  31. data/lib/metronome_sdk/models/scheduled_charge.rb +5 -5
  32. data/lib/metronome_sdk/models/v1/alert_archive_response.rb +2 -2
  33. data/lib/metronome_sdk/models/v1/alert_create_params.rb +15 -12
  34. data/lib/metronome_sdk/models/v1/alert_create_response.rb +2 -2
  35. data/lib/metronome_sdk/models/v1/audit_log_list_params.rb +2 -2
  36. data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +2 -2
  37. data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +6 -6
  38. data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +2 -2
  39. data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +4 -4
  40. data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +4 -4
  41. data/lib/metronome_sdk/models/v1/contract_amend_params.rb +577 -152
  42. data/lib/metronome_sdk/models/v1/contract_amend_response.rb +2 -2
  43. data/lib/metronome_sdk/models/v1/contract_archive_response.rb +2 -2
  44. data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +12 -12
  45. data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +2 -2
  46. data/lib/metronome_sdk/models/v1/contract_create_params.rb +1317 -341
  47. data/lib/metronome_sdk/models/v1/contract_create_response.rb +2 -2
  48. data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +3 -7
  49. data/lib/metronome_sdk/models/v1/contract_list_response.rb +421 -36
  50. data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +33 -5
  51. data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +28 -7
  52. data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +422 -36
  53. data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rb +34 -0
  54. data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rb +81 -0
  55. data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +4 -4
  56. data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +2 -2
  57. data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +2 -2
  58. data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +2 -2
  59. data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +6 -6
  60. data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +2 -2
  61. data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +5 -5
  62. data/lib/metronome_sdk/models/v1/contracts/product_list_params.rb +4 -4
  63. data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +8 -8
  64. data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +8 -8
  65. data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +4 -4
  66. data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +2 -2
  67. data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +3 -3
  68. data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +3 -3
  69. data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +2 -2
  70. data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +4 -4
  71. data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +2 -2
  72. data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +4 -4
  73. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +33 -5
  74. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +26 -5
  75. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +4 -4
  76. data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +2 -2
  77. data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +2 -2
  78. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +2 -2
  79. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +2 -2
  80. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +2 -2
  81. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +46 -18
  82. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +2 -2
  83. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +36 -12
  84. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +6 -6
  85. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +33 -5
  86. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +26 -5
  87. data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +12 -20
  88. data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +2 -2
  89. data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +2 -2
  90. data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +20 -1
  91. data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +6 -6
  92. data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +8 -8
  93. data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +2 -2
  94. data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +1 -1
  95. data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb +2 -2
  96. data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb +2 -2
  97. data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +2 -2
  98. data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb +2 -2
  99. data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +2 -2
  100. data/lib/metronome_sdk/models/v1/customer.rb +1 -1
  101. data/lib/metronome_sdk/models/v1/customer_archive_response.rb +2 -2
  102. data/lib/metronome_sdk/models/v1/customer_create_params.rb +20 -20
  103. data/lib/metronome_sdk/models/v1/customer_create_response.rb +2 -2
  104. data/lib/metronome_sdk/models/v1/customer_detail.rb +10 -10
  105. data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +4 -4
  106. data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +115 -0
  107. data/lib/metronome_sdk/models/v1/customer_preview_events_response.rb +18 -0
  108. data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +2 -2
  109. data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +2 -2
  110. data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +2 -2
  111. data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +2 -2
  112. data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +2 -2
  113. data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +2 -2
  114. data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +6 -6
  115. data/lib/metronome_sdk/models/v1/customers/billing_config_delete_params.rb +2 -2
  116. data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rb +2 -2
  117. data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +9 -1
  118. data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +86 -32
  119. data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +2 -2
  120. data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +2 -2
  121. data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +2 -2
  122. data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +59 -7
  123. data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +2 -2
  124. data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +2 -2
  125. data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +2 -2
  126. data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +24 -24
  127. data/lib/metronome_sdk/models/v1/customers/invoice.rb +74 -73
  128. data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +4 -4
  129. data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +2 -2
  130. data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +2 -2
  131. data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +16 -15
  132. data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +2 -2
  133. data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +2 -2
  134. data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +14 -13
  135. data/lib/metronome_sdk/models/v1/plan_detail.rb +18 -18
  136. data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +2 -2
  137. data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +2 -2
  138. data/lib/metronome_sdk/models/v1/plan_list_customers_params.rb +2 -2
  139. data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +2 -2
  140. data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +3 -3
  141. data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +3 -3
  142. data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +2 -2
  143. data/lib/metronome_sdk/models/v1/usage_list_params.rb +9 -8
  144. data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +5 -5
  145. data/lib/metronome_sdk/models/v1/usage_search_params.rb +24 -0
  146. data/lib/metronome_sdk/models/v1/usage_search_response.rb +249 -0
  147. data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +78 -23
  148. data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +2 -2
  149. data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +62 -9
  150. data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +2 -2
  151. data/lib/metronome_sdk/models/v2/contract_edit_params.rb +1995 -443
  152. data/lib/metronome_sdk/models/v2/contract_edit_response.rb +2 -2
  153. data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +1959 -140
  154. data/lib/metronome_sdk/models/v2/contract_list_response.rb +963 -91
  155. data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +964 -91
  156. data/lib/metronome_sdk/models.rb +30 -19
  157. data/lib/metronome_sdk/resources/v1/alerts.rb +4 -4
  158. data/lib/metronome_sdk/resources/v1/audit_logs.rb +1 -1
  159. data/lib/metronome_sdk/resources/v1/billable_metrics.rb +3 -3
  160. data/lib/metronome_sdk/resources/v1/contracts/products.rb +9 -6
  161. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +1 -1
  162. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +8 -6
  163. data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +4 -4
  164. data/lib/metronome_sdk/resources/v1/contracts.rb +59 -28
  165. data/lib/metronome_sdk/resources/v1/credit_grants.rb +7 -5
  166. data/lib/metronome_sdk/resources/v1/custom_fields.rb +5 -5
  167. data/lib/metronome_sdk/resources/v1/customers/alerts.rb +2 -2
  168. data/lib/metronome_sdk/resources/v1/customers/billing_config.rb +5 -5
  169. data/lib/metronome_sdk/resources/v1/customers/commits.rb +9 -7
  170. data/lib/metronome_sdk/resources/v1/customers/credits.rb +5 -3
  171. data/lib/metronome_sdk/resources/v1/customers/invoices.rb +4 -4
  172. data/lib/metronome_sdk/resources/v1/customers/plans.rb +3 -3
  173. data/lib/metronome_sdk/resources/v1/customers.rb +43 -4
  174. data/lib/metronome_sdk/resources/v1/dashboards.rb +4 -4
  175. data/lib/metronome_sdk/resources/v1/plans.rb +1 -1
  176. data/lib/metronome_sdk/resources/v1/usage.rb +30 -5
  177. data/lib/metronome_sdk/resources/v2/contracts.rb +45 -31
  178. data/lib/metronome_sdk/version.rb +1 -1
  179. data/lib/metronome_sdk.rb +9 -1
  180. data/rbi/metronome_sdk/errors.rbi +16 -0
  181. data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi +5 -1
  182. data/rbi/metronome_sdk/internal/type/array_of.rbi +6 -0
  183. data/rbi/metronome_sdk/internal/type/base_model.rbi +5 -0
  184. data/rbi/metronome_sdk/internal/type/boolean.rbi +8 -0
  185. data/rbi/metronome_sdk/internal/type/converter.rbi +15 -15
  186. data/rbi/metronome_sdk/internal/type/enum.rbi +5 -0
  187. data/rbi/metronome_sdk/internal/type/file_input.rbi +5 -0
  188. data/rbi/metronome_sdk/internal/type/hash_of.rbi +6 -0
  189. data/rbi/metronome_sdk/internal/type/union.rbi +10 -0
  190. data/rbi/metronome_sdk/internal/type/unknown.rbi +8 -0
  191. data/rbi/metronome_sdk/internal/util.rbi +36 -0
  192. data/rbi/metronome_sdk/internal.rbi +5 -0
  193. data/rbi/metronome_sdk/models/commit.rbi +376 -39
  194. data/rbi/metronome_sdk/models/contract_without_amendments.rbi +791 -54
  195. data/rbi/metronome_sdk/models/credit.rbi +376 -25
  196. data/rbi/metronome_sdk/models/override.rbi +66 -0
  197. data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +9 -9
  198. data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +10 -4
  199. data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +995 -17
  200. data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +2220 -136
  201. data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +9 -2
  202. data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +820 -28
  203. data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi +72 -0
  204. data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +66 -0
  205. data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +820 -28
  206. data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbi +58 -0
  207. data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbi +212 -0
  208. data/rbi/metronome_sdk/models/v1/contracts/product_list_params.rbi +3 -3
  209. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbi +72 -0
  210. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +66 -0
  211. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +72 -0
  212. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +72 -0
  213. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi +72 -0
  214. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +66 -0
  215. data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +58 -0
  216. data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi +214 -0
  217. data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi +35 -0
  218. data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +11 -0
  219. data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +121 -8
  220. data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +109 -0
  221. data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +5 -0
  222. data/rbi/metronome_sdk/models/v1/usage_search_params.rbi +48 -0
  223. data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +438 -0
  224. data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +113 -8
  225. data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +101 -0
  226. data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +3667 -315
  227. data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +5965 -2014
  228. data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +2279 -226
  229. data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +2279 -226
  230. data/rbi/metronome_sdk/resources/v1/alerts.rbi +5 -2
  231. data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +2 -1
  232. data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +5 -0
  233. data/rbi/metronome_sdk/resources/v1/contracts.rbi +36 -1
  234. data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
  235. data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +15 -4
  236. data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +9 -0
  237. data/rbi/metronome_sdk/resources/v1/customers.rbi +35 -1
  238. data/rbi/metronome_sdk/resources/v1/usage.rbi +17 -0
  239. data/rbi/metronome_sdk/resources/v2/contracts.rbi +65 -7
  240. data/sig/metronome_sdk/errors.rbs +9 -0
  241. data/sig/metronome_sdk/internal/transport/pooled_net_requester.rbs +2 -0
  242. data/sig/metronome_sdk/internal/type/array_of.rbs +3 -0
  243. data/sig/metronome_sdk/internal/type/base_model.rbs +2 -0
  244. data/sig/metronome_sdk/internal/type/boolean.rbs +3 -0
  245. data/sig/metronome_sdk/internal/type/converter.rbs +7 -1
  246. data/sig/metronome_sdk/internal/type/enum.rbs +2 -0
  247. data/sig/metronome_sdk/internal/type/file_input.rbs +2 -0
  248. data/sig/metronome_sdk/internal/type/hash_of.rbs +3 -0
  249. data/sig/metronome_sdk/internal/type/union.rbs +2 -0
  250. data/sig/metronome_sdk/internal/type/unknown.rbs +3 -0
  251. data/sig/metronome_sdk/internal/util.rbs +12 -0
  252. data/sig/metronome_sdk/internal.rbs +2 -0
  253. data/sig/metronome_sdk/models/base_usage_filter.rbs +6 -0
  254. data/sig/metronome_sdk/models/commit.rbs +374 -68
  255. data/sig/metronome_sdk/models/contract_without_amendments.rbs +620 -110
  256. data/sig/metronome_sdk/models/credit.rbs +286 -40
  257. data/sig/metronome_sdk/models/credit_type_data.rbs +2 -0
  258. data/sig/metronome_sdk/models/discount.rbs +11 -0
  259. data/sig/metronome_sdk/models/event_type_filter.rbs +5 -0
  260. data/sig/metronome_sdk/models/id.rbs +2 -0
  261. data/sig/metronome_sdk/models/override.rbs +92 -22
  262. data/sig/metronome_sdk/models/pro_service.rbs +11 -0
  263. data/sig/metronome_sdk/models/property_filter.rbs +7 -0
  264. data/sig/metronome_sdk/models/rate.rbs +16 -4
  265. data/sig/metronome_sdk/models/schedule_duration.rbs +12 -0
  266. data/sig/metronome_sdk/models/schedule_point_in_time.rbs +20 -6
  267. data/sig/metronome_sdk/models/scheduled_charge.rbs +12 -0
  268. data/sig/metronome_sdk/models/tier.rbs +2 -0
  269. data/sig/metronome_sdk/models/v1/alert_archive_params.rbs +6 -0
  270. data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +2 -0
  271. data/sig/metronome_sdk/models/v1/alert_create_params.rbs +29 -4
  272. data/sig/metronome_sdk/models/v1/alert_create_response.rbs +2 -0
  273. data/sig/metronome_sdk/models/v1/audit_log_list_params.rbs +11 -0
  274. data/sig/metronome_sdk/models/v1/audit_log_list_response.rbs +16 -0
  275. data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +2 -0
  276. data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +2 -0
  277. data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +12 -0
  278. data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +2 -0
  279. data/sig/metronome_sdk/models/v1/billable_metric_list_params.rbs +7 -0
  280. data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +13 -0
  281. data/sig/metronome_sdk/models/v1/billable_metric_retrieve_params.rbs +5 -0
  282. data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +17 -0
  283. data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +11 -0
  284. data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +719 -75
  285. data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +2 -0
  286. data/sig/metronome_sdk/models/v1/contract_archive_params.rbs +7 -0
  287. data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +2 -0
  288. data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbs +47 -12
  289. data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +2 -0
  290. data/sig/metronome_sdk/models/v1/contract_create_params.rbs +1503 -250
  291. data/sig/metronome_sdk/models/v1/contract_create_response.rbs +2 -0
  292. data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +14 -0
  293. data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +5 -0
  294. data/sig/metronome_sdk/models/v1/contract_list_params.rbs +10 -0
  295. data/sig/metronome_sdk/models/v1/contract_list_response.rbs +459 -10
  296. data/sig/metronome_sdk/models/v1/contract_retrieve_params.rbs +8 -0
  297. data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbs +39 -0
  298. data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +48 -0
  299. data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +459 -10
  300. data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbs +34 -0
  301. data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbs +101 -0
  302. data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbs +21 -0
  303. data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +2 -0
  304. data/sig/metronome_sdk/models/v1/contract_set_usage_filter_params.rbs +9 -0
  305. data/sig/metronome_sdk/models/v1/contract_update_end_date_params.rbs +8 -0
  306. data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +2 -0
  307. data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbs +7 -0
  308. data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbs +10 -0
  309. data/sig/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbs +9 -0
  310. data/sig/metronome_sdk/models/v1/contracts/product_archive_params.rbs +5 -0
  311. data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +2 -0
  312. data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +18 -0
  313. data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +2 -0
  314. data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +19 -0
  315. data/sig/metronome_sdk/models/v1/contracts/product_list_params.rbs +7 -0
  316. data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +29 -0
  317. data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +2 -0
  318. data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +33 -0
  319. data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +19 -0
  320. data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +2 -0
  321. data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +10 -4
  322. data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +9 -4
  323. data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +2 -0
  324. data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +2 -0
  325. data/sig/metronome_sdk/models/v1/contracts/rate_card_create_params.rbs +21 -0
  326. data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +2 -0
  327. data/sig/metronome_sdk/models/v1/contracts/rate_card_list_params.rbs +7 -0
  328. data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +23 -0
  329. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +2 -0
  330. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs +38 -0
  331. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +46 -0
  332. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +27 -0
  333. data/sig/metronome_sdk/models/v1/contracts/rate_card_update_params.rbs +14 -0
  334. data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +2 -0
  335. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +8 -0
  336. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbs +10 -0
  337. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +10 -0
  338. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbs +6 -0
  339. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +2 -0
  340. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbs +8 -0
  341. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +2 -0
  342. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +59 -8
  343. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +2 -0
  344. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +51 -4
  345. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +23 -0
  346. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbs +38 -0
  347. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +41 -0
  348. data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +32 -4
  349. data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +2 -0
  350. data/sig/metronome_sdk/models/v1/credit_grant_edit_params.rbs +8 -0
  351. data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +2 -0
  352. data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +29 -0
  353. data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +30 -0
  354. data/sig/metronome_sdk/models/v1/credit_grant_list_params.rbs +11 -0
  355. data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +38 -0
  356. data/sig/metronome_sdk/models/v1/credit_grant_void_params.rbs +7 -0
  357. data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +2 -0
  358. data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +10 -0
  359. data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs +7 -0
  360. data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs +7 -0
  361. data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs +12 -6
  362. data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +11 -0
  363. data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs +6 -0
  364. data/sig/metronome_sdk/models/v1/custom_field_set_values_params.rbs +7 -0
  365. data/sig/metronome_sdk/models/v1/customer.rbs +8 -0
  366. data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +2 -0
  367. data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +2 -0
  368. data/sig/metronome_sdk/models/v1/customer_create_params.rbs +52 -26
  369. data/sig/metronome_sdk/models/v1/customer_create_response.rbs +2 -0
  370. data/sig/metronome_sdk/models/v1/customer_detail.rbs +23 -4
  371. data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbs +9 -0
  372. data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +17 -0
  373. data/sig/metronome_sdk/models/v1/customer_list_costs_params.rbs +9 -0
  374. data/sig/metronome_sdk/models/v1/customer_list_costs_response.rbs +19 -0
  375. data/sig/metronome_sdk/models/v1/customer_list_params.rbs +10 -0
  376. data/sig/metronome_sdk/models/v1/customer_preview_events_params.rbs +105 -0
  377. data/sig/metronome_sdk/models/v1/customer_preview_events_response.rbs +16 -0
  378. data/sig/metronome_sdk/models/v1/customer_retrieve_params.rbs +5 -0
  379. data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +2 -0
  380. data/sig/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbs +6 -0
  381. data/sig/metronome_sdk/models/v1/customer_set_name_params.rbs +6 -0
  382. data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +2 -0
  383. data/sig/metronome_sdk/models/v1/customer_update_config_params.rbs +7 -0
  384. data/sig/metronome_sdk/models/v1/customers/alert_list_params.rbs +13 -6
  385. data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +5 -0
  386. data/sig/metronome_sdk/models/v1/customers/alert_reset_params.rbs +6 -0
  387. data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +7 -0
  388. data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +2 -0
  389. data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +10 -0
  390. data/sig/metronome_sdk/models/v1/customers/billing_config_delete_params.rbs +6 -0
  391. data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbs +6 -0
  392. data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +23 -0
  393. data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +116 -8
  394. data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +2 -0
  395. data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +14 -0
  396. data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +5 -0
  397. data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbs +8 -0
  398. data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +2 -0
  399. data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +82 -0
  400. data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +2 -0
  401. data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +14 -0
  402. data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +5 -0
  403. data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbs +7 -0
  404. data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +2 -0
  405. data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +45 -16
  406. data/sig/metronome_sdk/models/v1/customers/invoice.rbs +195 -40
  407. data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbs +11 -0
  408. data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbs +2 -0
  409. data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbs +14 -0
  410. data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +5 -0
  411. data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +13 -0
  412. data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbs +7 -0
  413. data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +2 -0
  414. data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbs +7 -0
  415. data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbs +10 -0
  416. data/sig/metronome_sdk/models/v1/customers/named_schedule_update_params.rbs +9 -0
  417. data/sig/metronome_sdk/models/v1/customers/plan_add_params.rbs +38 -4
  418. data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +2 -0
  419. data/sig/metronome_sdk/models/v1/customers/plan_end_params.rbs +9 -0
  420. data/sig/metronome_sdk/models/v1/customers/plan_end_response.rbs +2 -0
  421. data/sig/metronome_sdk/models/v1/customers/plan_list_params.rbs +7 -0
  422. data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbs +8 -0
  423. data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbs +14 -0
  424. data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +23 -0
  425. data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +30 -7
  426. data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbs +6 -0
  427. data/sig/metronome_sdk/models/v1/invoice_regenerate_params.rbs +5 -0
  428. data/sig/metronome_sdk/models/v1/invoice_regenerate_response.rbs +6 -0
  429. data/sig/metronome_sdk/models/v1/invoice_void_params.rbs +5 -0
  430. data/sig/metronome_sdk/models/v1/invoice_void_response.rbs +6 -0
  431. data/sig/metronome_sdk/models/v1/plan_detail.rbs +38 -0
  432. data/sig/metronome_sdk/models/v1/plan_get_details_params.rbs +5 -0
  433. data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +2 -0
  434. data/sig/metronome_sdk/models/v1/plan_list_charges_params.rbs +7 -0
  435. data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +28 -0
  436. data/sig/metronome_sdk/models/v1/plan_list_customers_params.rbs +8 -0
  437. data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +14 -0
  438. data/sig/metronome_sdk/models/v1/plan_list_params.rbs +6 -0
  439. data/sig/metronome_sdk/models/v1/plan_list_response.rbs +7 -0
  440. data/sig/metronome_sdk/models/v1/pricing_unit_list_params.rbs +6 -0
  441. data/sig/metronome_sdk/models/v1/pricing_unit_list_response.rbs +2 -0
  442. data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +12 -4
  443. data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +9 -4
  444. data/sig/metronome_sdk/models/v1/service_list_params.rbs +2 -0
  445. data/sig/metronome_sdk/models/v1/service_list_response.rbs +10 -0
  446. data/sig/metronome_sdk/models/v1/usage_ingest_params.rbs +13 -0
  447. data/sig/metronome_sdk/models/v1/usage_list_params.rbs +17 -0
  448. data/sig/metronome_sdk/models/v1/usage_list_response.rbs +15 -0
  449. data/sig/metronome_sdk/models/v1/usage_list_with_groups_params.rbs +15 -0
  450. data/sig/metronome_sdk/models/v1/usage_list_with_groups_response.rbs +8 -0
  451. data/sig/metronome_sdk/models/v1/usage_search_params.rbs +26 -0
  452. data/sig/metronome_sdk/models/v1/usage_search_response.rbs +230 -0
  453. data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +106 -1
  454. data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +2 -0
  455. data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +81 -1
  456. data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +2 -0
  457. data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +2233 -303
  458. data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +2 -0
  459. data/sig/metronome_sdk/models/v2/contract_get_edit_history_params.rbs +6 -0
  460. data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +2475 -453
  461. data/sig/metronome_sdk/models/v2/contract_list_params.rbs +10 -0
  462. data/sig/metronome_sdk/models/v2/contract_list_response.rbs +1400 -43
  463. data/sig/metronome_sdk/models/v2/contract_retrieve_params.rbs +9 -0
  464. data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +1400 -43
  465. data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -0
  466. data/sig/metronome_sdk/resources/v1/contracts.rbs +10 -0
  467. data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
  468. data/sig/metronome_sdk/resources/v1/custom_fields.rbs +1 -1
  469. data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +1 -1
  470. data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
  471. data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -0
  472. data/sig/metronome_sdk/resources/v1/customers.rbs +8 -0
  473. data/sig/metronome_sdk/resources/v1/usage.rbs +5 -0
  474. data/sig/metronome_sdk/resources/v2/contracts.rbs +8 -1
  475. metadata +20 -2
@@ -5,29 +5,40 @@ module MetronomeSDK
5
5
  cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, MetronomeSDK::Internal::AnyHash) } }
6
6
  end
7
7
 
8
- [
9
- *MetronomeSDK::Internal::Type::Enum.included_modules,
10
- *MetronomeSDK::Internal::Type::Union.included_modules
11
- ].each do |cls|
12
- cls.constants.each do |name|
13
- case cls.const_get(name)
14
- in true | false
15
- cls.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, cls) } }
16
- cls.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
17
- in Integer
18
- cls.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, cls) } }
19
- cls.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
20
- in Float
21
- cls.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, cls) } }
22
- cls.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
23
- in Symbol
24
- cls.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, cls) } }
25
- cls.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
26
- else
8
+ MetronomeSDK::Internal::Util.walk_namespaces(MetronomeSDK::Models).each do |mod|
9
+ case mod
10
+ in MetronomeSDK::Internal::Type::Enum | MetronomeSDK::Internal::Type::Union
11
+ mod.constants.each do |name|
12
+ case mod.const_get(name)
13
+ in true | false
14
+ mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T::Boolean } }
15
+ mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
16
+ in Integer
17
+ mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { Integer } }
18
+ mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
19
+ in Float
20
+ mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { Float } }
21
+ mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
22
+ in Symbol
23
+ mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { Symbol } }
24
+ mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
25
+ else
26
+ end
27
27
  end
28
+ else
28
29
  end
29
30
  end
30
31
 
32
+ MetronomeSDK::Internal::Util.walk_namespaces(MetronomeSDK::Models)
33
+ .lazy
34
+ .grep(MetronomeSDK::Internal::Type::Union)
35
+ .each do |mod|
36
+ const = :Variants
37
+ next if mod.sorbet_constant_defined?(const)
38
+
39
+ mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
40
+ end
41
+
31
42
  BaseUsageFilter = MetronomeSDK::Models::BaseUsageFilter
32
43
 
33
44
  Commit = MetronomeSDK::Models::Commit
@@ -11,7 +11,7 @@ module MetronomeSDK
11
11
  #
12
12
  # @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_key_filter: nil, invoice_types_filter: nil, plan_id: nil, uniqueness_key: nil, request_options: {})
13
13
  #
14
- # @param alert_type [Symbol, MetronomeSDK::V1::AlertCreateParams::AlertType] Type of the alert
14
+ # @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the alert
15
15
  #
16
16
  # @param name [String] Name of the alert
17
17
  #
@@ -21,15 +21,15 @@ module MetronomeSDK
21
21
  #
22
22
  # @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
23
23
  #
24
- # @param credit_type_id [String]
24
+ # @param credit_type_id [String] ID of the credit's currency, defaults to USD. If the specific alert type require
25
25
  #
26
- # @param custom_field_filters [Array<MetronomeSDK::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering.
26
+ # @param custom_field_filters [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering.
27
27
  #
28
28
  # @param customer_id [String] If provided, will create this alert for this specific customer. To create an ale
29
29
  #
30
30
  # @param evaluate_on_create [Boolean] If true, the alert will evaluate immediately on customers that already meet the
31
31
  #
32
- # @param group_key_filter [MetronomeSDK::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
32
+ # @param group_key_filter [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
33
33
  #
34
34
  # @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
35
35
  #
@@ -24,7 +24,7 @@ module MetronomeSDK
24
24
  #
25
25
  # @param resource_type [String] Optional parameter that can be used to filter which audit logs are returned. If
26
26
  #
27
- # @param sort [Symbol, MetronomeSDK::V1::AuditLogListParams::Sort] Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
27
+ # @param sort [Symbol, MetronomeSDK::Models::V1::AuditLogListParams::Sort] Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
28
28
  #
29
29
  # @param starting_on [Time] RFC 3339 timestamp of the earliest audit log to return. Cannot be used with 'nex
30
30
  #
@@ -15,15 +15,15 @@ module MetronomeSDK
15
15
  #
16
16
  # @param aggregation_key [String] Specifies the type of aggregation performed on matching events. Required if `sql
17
17
  #
18
- # @param aggregation_type [Symbol, MetronomeSDK::V1::BillableMetricCreateParams::AggregationType] Specifies the type of aggregation performed on matching events.
18
+ # @param aggregation_type [Symbol, MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType] Specifies the type of aggregation performed on matching events.
19
19
  #
20
20
  # @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the billable metric.
21
21
  #
22
- # @param event_type_filter [MetronomeSDK::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
22
+ # @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
23
23
  #
24
24
  # @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
25
25
  #
26
- # @param property_filters [Array<MetronomeSDK::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
26
+ # @param property_filters [Array<MetronomeSDK::Models::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
27
27
  #
28
28
  # @param sql [String] The SQL query associated with the billable metric. This field is mutually exclus
29
29
  #
@@ -14,7 +14,7 @@ module MetronomeSDK
14
14
  #
15
15
  # @param name [String] displayed on invoices
16
16
  #
17
- # @param type [Symbol, MetronomeSDK::V1::Contracts::ProductCreateParams::Type]
17
+ # @param type [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::Type]
18
18
  #
19
19
  # @param billable_metric_id [String] Required for USAGE products
20
20
  #
@@ -34,9 +34,9 @@ module MetronomeSDK
34
34
  #
35
35
  # @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
36
36
  #
37
- # @param quantity_conversion [MetronomeSDK::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
37
+ # @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
38
38
  #
39
- # @param quantity_rounding [MetronomeSDK::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
39
+ # @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
40
40
  #
41
41
  # @param tags [Array<String>]
42
42
  #
@@ -108,9 +108,9 @@ module MetronomeSDK
108
108
  #
109
109
  # @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
110
110
  #
111
- # @param quantity_conversion [MetronomeSDK::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
111
+ # @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
112
112
  #
113
- # @param quantity_rounding [MetronomeSDK::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
113
+ # @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
114
114
  #
115
115
  # @param tags [Array<String>] If not provided, defaults to product's current tags
116
116
  #
@@ -130,6 +130,9 @@ module MetronomeSDK
130
130
  )
131
131
  end
132
132
 
133
+ # Some parameter documentations has been truncated, see
134
+ # {MetronomeSDK::Models::V1::Contracts::ProductListParams} for more details.
135
+ #
133
136
  # List products
134
137
  #
135
138
  # @overload list(limit: nil, next_page: nil, archive_filter: nil, request_options: {})
@@ -138,7 +141,7 @@ module MetronomeSDK
138
141
  #
139
142
  # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
140
143
  #
141
- # @param archive_filter [Symbol, MetronomeSDK::V1::Contracts::ProductListParams::ArchiveFilter] Body param: Filter options for the product list
144
+ # @param archive_filter [Symbol, MetronomeSDK::Models::V1::Contracts::ProductListParams::ArchiveFilter] Body param: Filter options for the product list. If not provided, defaults to no
142
145
  #
143
146
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
144
147
  #
@@ -10,7 +10,7 @@ module MetronomeSDK
10
10
  #
11
11
  # @overload update(product_moves:, rate_card_id:, request_options: {})
12
12
  #
13
- # @param product_moves [Array<MetronomeSDK::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove>]
13
+ # @param product_moves [Array<MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove>]
14
14
  #
15
15
  # @param rate_card_id [String] ID of the rate card to update
16
16
  #
@@ -22,7 +22,7 @@ module MetronomeSDK
22
22
  #
23
23
  # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
24
24
  #
25
- # @param selectors [Array<MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selector will be i
25
+ # @param selectors [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateListParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selector will be i
26
26
  #
27
27
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
28
28
  #
@@ -49,7 +49,7 @@ module MetronomeSDK
49
49
  #
50
50
  # Add a new rate
51
51
  #
52
- # @overload add(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil, request_options: {})
52
+ # @overload add(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil, request_options: {})
53
53
  #
54
54
  # @param entitled [Boolean]
55
55
  #
@@ -57,11 +57,13 @@ module MetronomeSDK
57
57
  #
58
58
  # @param rate_card_id [String] ID of the rate card to update
59
59
  #
60
- # @param rate_type [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType]
60
+ # @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType]
61
61
  #
62
62
  # @param starting_at [Time] inclusive effective date
63
63
  #
64
- # @param commit_rate [MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
64
+ # @param billing_frequency [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::BillingFrequency] Optional. Frequency to bill subscriptions with. Required for subscription type p
65
+ #
66
+ # @param commit_rate [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
65
67
  #
66
68
  # @param credit_type_id [String] The Metronome ID of the credit type to associate with price, defaults to USD (ce
67
69
  #
@@ -77,7 +79,7 @@ module MetronomeSDK
77
79
  #
78
80
  # @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
79
81
  #
80
- # @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
82
+ # @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
81
83
  #
82
84
  # @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
83
85
  #
@@ -102,7 +104,7 @@ module MetronomeSDK
102
104
  # @overload add_many(rate_card_id:, rates:, request_options: {})
103
105
  #
104
106
  # @param rate_card_id [String]
105
- # @param rates [Array<MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate>]
107
+ # @param rates [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate>]
106
108
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
107
109
  #
108
110
  # @return [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyResponse]
@@ -23,9 +23,9 @@ module MetronomeSDK
23
23
  #
24
24
  # @param name [String] Used only in UI/API. It is not exposed to end customers.
25
25
  #
26
- # @param aliases [Array<MetronomeSDK::V1::Contracts::RateCardCreateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
26
+ # @param aliases [Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
27
27
  #
28
- # @param credit_type_conversions [Array<MetronomeSDK::V1::Contracts::RateCardCreateParams::CreditTypeConversion>] Required when using custom pricing units in rates.
28
+ # @param credit_type_conversions [Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion>] Required when using custom pricing units in rates.
29
29
  #
30
30
  # @param custom_fields [Hash{Symbol=>String}]
31
31
  #
@@ -80,7 +80,7 @@ module MetronomeSDK
80
80
  #
81
81
  # @param rate_card_id [String] ID of the rate card to update
82
82
  #
83
- # @param aliases [Array<MetronomeSDK::V1::Contracts::RateCardUpdateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
83
+ # @param aliases [Array<MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
84
84
  #
85
85
  # @param description [String]
86
86
  #
@@ -171,7 +171,7 @@ module MetronomeSDK
171
171
  #
172
172
  # @param ending_before [Time] Body param: optional exclusive end date for the rates schedule. When not specifi
173
173
  #
174
- # @param selectors [Array<MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selector will be i
174
+ # @param selectors [Array<MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selector will be i
175
175
  #
176
176
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
177
177
  #
@@ -18,25 +18,27 @@ module MetronomeSDK
18
18
  #
19
19
  # Create a new contract
20
20
  #
21
- # @overload create(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
21
+ # @overload create(customer_id:, starting_at:, billing_provider_configuration: nil, commits: nil, credits: nil, custom_fields: nil, discounts: nil, ending_before: nil, hierarchy_configuration: nil, multiplier_override_prioritization: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, overrides: nil, prepaid_balance_threshold_configuration: nil, priority: nil, professional_services: nil, rate_card_alias: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, salesforce_opportunity_id: nil, scheduled_charges: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, total_contract_value: nil, transition: nil, uniqueness_key: nil, usage_filter: nil, usage_statement_schedule: nil, request_options: {})
22
22
  #
23
23
  # @param customer_id [String]
24
24
  #
25
25
  # @param starting_at [Time] inclusive contract start time
26
26
  #
27
- # @param billing_provider_configuration [MetronomeSDK::V1::ContractCreateParams::BillingProviderConfiguration] The billing provider configuration associated with a contract.
27
+ # @param billing_provider_configuration [MetronomeSDK::Models::V1::ContractCreateParams::BillingProviderConfiguration] The billing provider configuration associated with a contract. Provide either an
28
28
  #
29
- # @param commits [Array<MetronomeSDK::V1::ContractCreateParams::Commit>]
29
+ # @param commits [Array<MetronomeSDK::Models::V1::ContractCreateParams::Commit>]
30
30
  #
31
- # @param credits [Array<MetronomeSDK::V1::ContractCreateParams::Credit>]
31
+ # @param credits [Array<MetronomeSDK::Models::V1::ContractCreateParams::Credit>]
32
32
  #
33
33
  # @param custom_fields [Hash{Symbol=>String}]
34
34
  #
35
- # @param discounts [Array<MetronomeSDK::V1::ContractCreateParams::Discount>] This field's availability is dependent on your client's configuration.
35
+ # @param discounts [Array<MetronomeSDK::Models::V1::ContractCreateParams::Discount>] This field's availability is dependent on your client's configuration.
36
36
  #
37
37
  # @param ending_before [Time] exclusive contract end time
38
38
  #
39
- # @param multiplier_override_prioritization [Symbol, MetronomeSDK::V1::ContractCreateParams::MultiplierOverridePrioritization] Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list price
39
+ # @param hierarchy_configuration [MetronomeSDK::Models::V1::ContractCreateParams::HierarchyConfiguration]
40
+ #
41
+ # @param multiplier_override_prioritization [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::MultiplierOverridePrioritization] Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list price
40
42
  #
41
43
  # @param name [String]
42
44
  #
@@ -44,39 +46,43 @@ module MetronomeSDK
44
46
  #
45
47
  # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
46
48
  #
47
- # @param overrides [Array<MetronomeSDK::V1::ContractCreateParams::Override>]
49
+ # @param overrides [Array<MetronomeSDK::Models::V1::ContractCreateParams::Override>]
50
+ #
51
+ # @param prepaid_balance_threshold_configuration [MetronomeSDK::Models::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration]
48
52
  #
49
- # @param prepaid_balance_threshold_configuration [MetronomeSDK::V1::ContractCreateParams::PrepaidBalanceThresholdConfiguration]
53
+ # @param priority [Float] Priority of the contract.
50
54
  #
51
- # @param professional_services [Array<MetronomeSDK::V1::ContractCreateParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
55
+ # @param professional_services [Array<MetronomeSDK::Models::V1::ContractCreateParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
52
56
  #
53
57
  # @param rate_card_alias [String] Selects the rate card linked to the specified alias as of the contract's start d
54
58
  #
55
59
  # @param rate_card_id [String]
56
60
  #
57
- # @param recurring_commits [Array<MetronomeSDK::V1::ContractCreateParams::RecurringCommit>]
61
+ # @param recurring_commits [Array<MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit>]
58
62
  #
59
- # @param recurring_credits [Array<MetronomeSDK::V1::ContractCreateParams::RecurringCredit>]
63
+ # @param recurring_credits [Array<MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit>]
60
64
  #
61
- # @param reseller_royalties [Array<MetronomeSDK::V1::ContractCreateParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
65
+ # @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractCreateParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
62
66
  #
63
67
  # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
64
68
  #
65
- # @param scheduled_charges [Array<MetronomeSDK::V1::ContractCreateParams::ScheduledCharge>]
69
+ # @param scheduled_charges [Array<MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge>]
70
+ #
71
+ # @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::ScheduledChargesOnUsageInvoices] Determines which scheduled and commit charges to consolidate onto the Contract's
66
72
  #
67
- # @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::V1::ContractCreateParams::ScheduledChargesOnUsageInvoices] Determines which scheduled and commit charges to consolidate onto the Contract's
73
+ # @param spend_threshold_configuration [MetronomeSDK::Models::V1::ContractCreateParams::SpendThresholdConfiguration]
68
74
  #
69
- # @param spend_threshold_configuration [MetronomeSDK::V1::ContractCreateParams::SpendThresholdConfiguration]
75
+ # @param subscriptions [Array<MetronomeSDK::Models::V1::ContractCreateParams::Subscription>] Optional list of [subscriptions](https://docs.metronome.com/manage-product-acces
70
76
  #
71
77
  # @param total_contract_value [Float] This field's availability is dependent on your client's configuration.
72
78
  #
73
- # @param transition [MetronomeSDK::V1::ContractCreateParams::Transition]
79
+ # @param transition [MetronomeSDK::Models::V1::ContractCreateParams::Transition]
74
80
  #
75
81
  # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
76
82
  #
77
- # @param usage_filter [MetronomeSDK::BaseUsageFilter]
83
+ # @param usage_filter [MetronomeSDK::Models::BaseUsageFilter]
78
84
  #
79
- # @param usage_statement_schedule [MetronomeSDK::V1::ContractCreateParams::UsageStatementSchedule]
85
+ # @param usage_statement_schedule [MetronomeSDK::Models::V1::ContractCreateParams::UsageStatementSchedule]
80
86
  #
81
87
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
82
88
  #
@@ -214,25 +220,25 @@ module MetronomeSDK
214
220
  #
215
221
  # @param starting_at [Time] inclusive start time for the amendment
216
222
  #
217
- # @param commits [Array<MetronomeSDK::V1::ContractAmendParams::Commit>]
223
+ # @param commits [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit>]
218
224
  #
219
- # @param credits [Array<MetronomeSDK::V1::ContractAmendParams::Credit>]
225
+ # @param credits [Array<MetronomeSDK::Models::V1::ContractAmendParams::Credit>]
220
226
  #
221
227
  # @param custom_fields [Hash{Symbol=>String}]
222
228
  #
223
- # @param discounts [Array<MetronomeSDK::V1::ContractAmendParams::Discount>] This field's availability is dependent on your client's configuration.
229
+ # @param discounts [Array<MetronomeSDK::Models::V1::ContractAmendParams::Discount>] This field's availability is dependent on your client's configuration.
224
230
  #
225
231
  # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
226
232
  #
227
- # @param overrides [Array<MetronomeSDK::V1::ContractAmendParams::Override>]
233
+ # @param overrides [Array<MetronomeSDK::Models::V1::ContractAmendParams::Override>]
228
234
  #
229
- # @param professional_services [Array<MetronomeSDK::V1::ContractAmendParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
235
+ # @param professional_services [Array<MetronomeSDK::Models::V1::ContractAmendParams::ProfessionalService>] This field's availability is dependent on your client's configuration.
230
236
  #
231
- # @param reseller_royalties [Array<MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
237
+ # @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractAmendParams::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
232
238
  #
233
239
  # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
234
240
  #
235
- # @param scheduled_charges [Array<MetronomeSDK::V1::ContractAmendParams::ScheduledCharge>]
241
+ # @param scheduled_charges [Array<MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge>]
236
242
  #
237
243
  # @param total_contract_value [Float] This field's availability is dependent on your client's configuration.
238
244
  #
@@ -285,7 +291,7 @@ module MetronomeSDK
285
291
  #
286
292
  # @overload create_historical_invoices(invoices:, preview:, request_options: {})
287
293
  #
288
- # @param invoices [Array<MetronomeSDK::V1::ContractCreateHistoricalInvoicesParams::Invoice>]
294
+ # @param invoices [Array<MetronomeSDK::Models::V1::ContractCreateHistoricalInvoicesParams::Invoice>]
289
295
  # @param preview [Boolean]
290
296
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
291
297
  #
@@ -363,7 +369,7 @@ module MetronomeSDK
363
369
  #
364
370
  # @param at [Time] Body param: optional timestamp which overlaps with the returned rate schedule se
365
371
  #
366
- # @param selectors [Array<MetronomeSDK::V1::ContractRetrieveRateScheduleParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selectors will be
372
+ # @param selectors [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector>] Body param: List of rate selectors, rates matching ANY of the selectors will be
367
373
  #
368
374
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
369
375
  #
@@ -383,6 +389,31 @@ module MetronomeSDK
383
389
  )
384
390
  end
385
391
 
392
+ # Fetch the quantity and price for a subscription over time. End-point does not
393
+ # return future scheduled changes.
394
+ #
395
+ # @overload retrieve_subscription_quantity_history(contract_id:, customer_id:, subscription_id:, request_options: {})
396
+ #
397
+ # @param contract_id [String]
398
+ # @param customer_id [String]
399
+ # @param subscription_id [String]
400
+ # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
401
+ #
402
+ # @return [MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse]
403
+ #
404
+ # @see MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryParams
405
+ def retrieve_subscription_quantity_history(params)
406
+ parsed, options =
407
+ MetronomeSDK::V1::ContractRetrieveSubscriptionQuantityHistoryParams.dump_request(params)
408
+ @client.request(
409
+ method: :post,
410
+ path: "v1/contracts/getSubscriptionQuantityHistory",
411
+ body: parsed,
412
+ model: MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse,
413
+ options: options
414
+ )
415
+ end
416
+
386
417
  # Create a new scheduled invoice for Professional Services terms on a contract.
387
418
  # This endpoint's availability is dependent on your client's configuration.
388
419
  #
@@ -394,7 +425,7 @@ module MetronomeSDK
394
425
  #
395
426
  # @param issued_at [Time] The date the invoice is issued
396
427
  #
397
- # @param line_items [Array<MetronomeSDK::V1::ContractScheduleProServicesInvoiceParams::LineItem>] Each line requires an amount or both unit_price and quantity.
428
+ # @param line_items [Array<MetronomeSDK::Models::V1::ContractScheduleProServicesInvoiceParams::LineItem>] Each line requires an amount or both unit_price and quantity.
398
429
  #
399
430
  # @param netsuite_invoice_header_end [Time] The end date of the invoice header in Netsuite
400
431
  #
@@ -15,11 +15,11 @@ module MetronomeSDK
15
15
  #
16
16
  # @param expires_at [Time] The credit grant will only apply to usage or charges dated before this timestamp
17
17
  #
18
- # @param grant_amount [MetronomeSDK::V1::CreditGrantCreateParams::GrantAmount] the amount of credits granted
18
+ # @param grant_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount] the amount of credits granted
19
19
  #
20
20
  # @param name [String] the name of the credit grant as it will appear on invoices
21
21
  #
22
- # @param paid_amount [MetronomeSDK::V1::CreditGrantCreateParams::PaidAmount] the amount paid for this credit grant
22
+ # @param paid_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount] the amount paid for this credit grant
23
23
  #
24
24
  # @param priority [Float]
25
25
  #
@@ -35,7 +35,7 @@ module MetronomeSDK
35
35
  #
36
36
  # @param reason [String]
37
37
  #
38
- # @param rollover_settings [MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings] Configure a rollover for this credit grant so if it expires it rolls over a conf
38
+ # @param rollover_settings [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings] Configure a rollover for this credit grant so if it expires it rolls over a conf
39
39
  #
40
40
  # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
41
41
  #
@@ -130,10 +130,12 @@ module MetronomeSDK
130
130
  # Ledger entries are returned in chronological order. Ledger entries associated
131
131
  # with voided credit grants are not included.
132
132
  #
133
- # @overload list_entries(next_page: nil, credit_type_ids: nil, customer_ids: nil, ending_before: nil, starting_on: nil, request_options: {})
133
+ # @overload list_entries(next_page: nil, sort: nil, credit_type_ids: nil, customer_ids: nil, ending_before: nil, starting_on: nil, request_options: {})
134
134
  #
135
135
  # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
136
136
  #
137
+ # @param sort [Symbol, MetronomeSDK::Models::V1::CreditGrantListEntriesParams::Sort] Query param: Ledgers sort order by date, asc or desc. Defaults to asc.
138
+ #
137
139
  # @param credit_type_ids [Array<String>] Body param: A list of Metronome credit type IDs to fetch ledger entries for. If
138
140
  #
139
141
  # @param customer_ids [Array<String>] Body param: A list of Metronome customer IDs to fetch ledger entries for. If abs
@@ -150,7 +152,7 @@ module MetronomeSDK
150
152
  # @see MetronomeSDK::Models::V1::CreditGrantListEntriesParams
151
153
  def list_entries(params = {})
152
154
  parsed, options = MetronomeSDK::V1::CreditGrantListEntriesParams.dump_request(params)
153
- query_params = [:next_page]
155
+ query_params = [:next_page, :sort]
154
156
  @client.request(
155
157
  method: :post,
156
158
  path: "v1/credits/listEntries",
@@ -10,7 +10,7 @@ module MetronomeSDK
10
10
  # @overload add_key(enforce_uniqueness:, entity:, key:, request_options: {})
11
11
  #
12
12
  # @param enforce_uniqueness [Boolean]
13
- # @param entity [Symbol, MetronomeSDK::V1::CustomFieldAddKeyParams::Entity]
13
+ # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldAddKeyParams::Entity]
14
14
  # @param key [String]
15
15
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
16
16
  #
@@ -32,7 +32,7 @@ module MetronomeSDK
32
32
  #
33
33
  # @overload delete_values(entity:, entity_id:, keys:, request_options: {})
34
34
  #
35
- # @param entity [Symbol, MetronomeSDK::V1::CustomFieldDeleteValuesParams::Entity]
35
+ # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::Entity]
36
36
  # @param entity_id [String]
37
37
  # @param keys [Array<String>]
38
38
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -57,7 +57,7 @@ module MetronomeSDK
57
57
  #
58
58
  # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
59
59
  #
60
- # @param entities [Array<Symbol, MetronomeSDK::V1::CustomFieldListKeysParams::Entity>] Body param: Optional list of entity types to return keys for
60
+ # @param entities [Array<Symbol, MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity>] Body param: Optional list of entity types to return keys for
61
61
  #
62
62
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
63
63
  #
@@ -81,7 +81,7 @@ module MetronomeSDK
81
81
  #
82
82
  # @overload remove_key(entity:, key:, request_options: {})
83
83
  #
84
- # @param entity [Symbol, MetronomeSDK::V1::CustomFieldRemoveKeyParams::Entity]
84
+ # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity]
85
85
  # @param key [String]
86
86
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
87
87
  #
@@ -110,7 +110,7 @@ module MetronomeSDK
110
110
  # @overload set_values(custom_fields:, entity:, entity_id:, request_options: {})
111
111
  #
112
112
  # @param custom_fields [Hash{Symbol=>String}]
113
- # @param entity [Symbol, MetronomeSDK::V1::CustomFieldSetValuesParams::Entity]
113
+ # @param entity [Symbol, MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity]
114
114
  # @param entity_id [String]
115
115
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
116
116
  #
@@ -17,7 +17,7 @@ module MetronomeSDK
17
17
  #
18
18
  # @param customer_id [String] The Metronome ID of the customer
19
19
  #
20
- # @param plans_or_contracts [Symbol, MetronomeSDK::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel alerts are enabled during migration, this flag denotes whether to
20
+ # @param plans_or_contracts [Symbol, MetronomeSDK::Models::V1::Customers::AlertRetrieveParams::PlansOrContracts] When parallel alerts are enabled during migration, this flag denotes whether to
21
21
  #
22
22
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
23
23
  #
@@ -46,7 +46,7 @@ module MetronomeSDK
46
46
  #
47
47
  # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
48
48
  #
49
- # @param alert_statuses [Array<Symbol, MetronomeSDK::V1::Customers::AlertListParams::AlertStatus>] Body param: Optionally filter by alert status. If absent, only enabled alerts wi
49
+ # @param alert_statuses [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>] Body param: Optionally filter by alert status. If absent, only enabled alerts wi
50
50
  #
51
51
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
52
52
  #
@@ -15,15 +15,15 @@ module MetronomeSDK
15
15
  #
16
16
  # @param customer_id [String] Path param:
17
17
  #
18
- # @param billing_provider_type [Symbol, MetronomeSDK::V1::Customers::BillingConfigCreateParams::BillingProviderType] Path param: The billing provider (e.g. stripe)
18
+ # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::BillingProviderType] Path param: The billing provider (e.g. stripe)
19
19
  #
20
20
  # @param billing_provider_customer_id [String] Body param: The customer ID in the billing provider's system. For Azure, this is
21
21
  #
22
22
  # @param aws_product_code [String] Body param:
23
23
  #
24
- # @param aws_region [Symbol, MetronomeSDK::V1::Customers::BillingConfigCreateParams::AwsRegion] Body param:
24
+ # @param aws_region [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::AwsRegion] Body param:
25
25
  #
26
- # @param stripe_collection_method [Symbol, MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod] Body param:
26
+ # @param stripe_collection_method [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod] Body param:
27
27
  #
28
28
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
29
29
  #
@@ -55,7 +55,7 @@ module MetronomeSDK
55
55
  #
56
56
  # @param customer_id [String]
57
57
  #
58
- # @param billing_provider_type [Symbol, MetronomeSDK::V1::Customers::BillingConfigRetrieveParams::BillingProviderType] The billing provider (e.g. stripe)
58
+ # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveParams::BillingProviderType] The billing provider (e.g. stripe)
59
59
  #
60
60
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
61
61
  #
@@ -87,7 +87,7 @@ module MetronomeSDK
87
87
  #
88
88
  # @param customer_id [String]
89
89
  #
90
- # @param billing_provider_type [Symbol, MetronomeSDK::V1::Customers::BillingConfigDeleteParams::BillingProviderType] The billing provider (e.g. stripe)
90
+ # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigDeleteParams::BillingProviderType] The billing provider (e.g. stripe)
91
91
  #
92
92
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
93
93
  #