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
@@ -10,19 +10,19 @@ module MetronomeSDK
10
10
 
11
11
  # @!attribute product
12
12
  #
13
- # @return [MetronomeSDK::Commit::Product]
13
+ # @return [MetronomeSDK::Models::Commit::Product]
14
14
  required :product, -> { MetronomeSDK::Commit::Product }
15
15
 
16
16
  # @!attribute type
17
17
  #
18
- # @return [Symbol, MetronomeSDK::Commit::Type]
18
+ # @return [Symbol, MetronomeSDK::Models::Commit::Type]
19
19
  required :type, enum: -> { MetronomeSDK::Commit::Type }
20
20
 
21
21
  # @!attribute access_schedule
22
22
  # The schedule that the customer will gain access to the credits purposed with
23
23
  # this commit.
24
24
  #
25
- # @return [MetronomeSDK::ScheduleDuration, nil]
25
+ # @return [MetronomeSDK::Models::ScheduleDuration, nil]
26
26
  optional :access_schedule, -> { MetronomeSDK::ScheduleDuration }
27
27
 
28
28
  # @!attribute amount
@@ -68,7 +68,7 @@ module MetronomeSDK
68
68
 
69
69
  # @!attribute contract
70
70
  #
71
- # @return [MetronomeSDK::Commit::Contract, nil]
71
+ # @return [MetronomeSDK::Models::Commit::Contract, nil]
72
72
  optional :contract, -> { MetronomeSDK::Commit::Contract }
73
73
 
74
74
  # @!attribute custom_fields
@@ -81,23 +81,29 @@ module MetronomeSDK
81
81
  # @return [String, nil]
82
82
  optional :description, String
83
83
 
84
+ # @!attribute hierarchy_configuration
85
+ # Optional configuration for commit hierarchy access control
86
+ #
87
+ # @return [MetronomeSDK::Models::Commit::HierarchyConfiguration, nil]
88
+ optional :hierarchy_configuration, -> { MetronomeSDK::Commit::HierarchyConfiguration }
89
+
84
90
  # @!attribute invoice_contract
85
91
  # The contract that this commit will be billed on.
86
92
  #
87
- # @return [MetronomeSDK::Commit::InvoiceContract, nil]
93
+ # @return [MetronomeSDK::Models::Commit::InvoiceContract, nil]
88
94
  optional :invoice_contract, -> { MetronomeSDK::Commit::InvoiceContract }
89
95
 
90
96
  # @!attribute invoice_schedule
91
97
  # The schedule that the customer will be invoiced for this commit.
92
98
  #
93
- # @return [MetronomeSDK::SchedulePointInTime, nil]
99
+ # @return [MetronomeSDK::Models::SchedulePointInTime, nil]
94
100
  optional :invoice_schedule, -> { MetronomeSDK::SchedulePointInTime }
95
101
 
96
102
  # @!attribute ledger
97
103
  # A list of ordered events that impact the balance of a commit. For example, an
98
104
  # invoice deduction or a rollover.
99
105
  #
100
- # @return [Array<MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>, nil]
106
+ # @return [Array<MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>, nil]
101
107
  optional :ledger, -> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::Commit::Ledger] }
102
108
 
103
109
  # @!attribute name
@@ -120,12 +126,12 @@ module MetronomeSDK
120
126
 
121
127
  # @!attribute rate_type
122
128
  #
123
- # @return [Symbol, MetronomeSDK::Commit::RateType, nil]
129
+ # @return [Symbol, MetronomeSDK::Models::Commit::RateType, nil]
124
130
  optional :rate_type, enum: -> { MetronomeSDK::Commit::RateType }
125
131
 
126
132
  # @!attribute rolled_over_from
127
133
  #
128
- # @return [MetronomeSDK::Commit::RolledOverFrom, nil]
134
+ # @return [MetronomeSDK::Models::Commit::RolledOverFrom, nil]
129
135
  optional :rolled_over_from, -> { MetronomeSDK::Commit::RolledOverFrom }
130
136
 
131
137
  # @!attribute rollover_fraction
@@ -139,6 +145,14 @@ module MetronomeSDK
139
145
  # @return [String, nil]
140
146
  optional :salesforce_opportunity_id, String
141
147
 
148
+ # @!attribute specifiers
149
+ # List of filters that determine what kind of customer usage draws down a commit
150
+ # or credit. A customer's usage needs to meet the condition of at least one of the
151
+ # specifiers to contribute to a commit's or credit's drawdown.
152
+ #
153
+ # @return [Array<MetronomeSDK::Models::Commit::Specifier>, nil]
154
+ optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Commit::Specifier] }
155
+
142
156
  # @!attribute uniqueness_key
143
157
  # Prevents the creation of duplicates. If a request to create a commit or credit
144
158
  # is made with a uniqueness key that was previously used to create a commit or
@@ -148,17 +162,17 @@ module MetronomeSDK
148
162
  # @return [String, nil]
149
163
  optional :uniqueness_key, String
150
164
 
151
- # @!method initialize(id:, product:, type:, access_schedule: nil, amount: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, uniqueness_key: nil)
152
- # Some parameter documentations has been truncated, see {MetronomeSDK::Commit} for
153
- # more details.
165
+ # @!method initialize(id:, product:, type:, access_schedule: nil, amount: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, uniqueness_key: nil)
166
+ # Some parameter documentations has been truncated, see
167
+ # {MetronomeSDK::Models::Commit} for more details.
154
168
  #
155
169
  # @param id [String]
156
170
  #
157
- # @param product [MetronomeSDK::Commit::Product]
171
+ # @param product [MetronomeSDK::Models::Commit::Product]
158
172
  #
159
- # @param type [Symbol, MetronomeSDK::Commit::Type]
173
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Type]
160
174
  #
161
- # @param access_schedule [MetronomeSDK::ScheduleDuration] The schedule that the customer will gain access to the credits purposed with thi
175
+ # @param access_schedule [MetronomeSDK::Models::ScheduleDuration] The schedule that the customer will gain access to the credits purposed with thi
162
176
  #
163
177
  # @param amount [Float] (DEPRECATED) Use access_schedule + invoice_schedule instead.
164
178
  #
@@ -172,17 +186,19 @@ module MetronomeSDK
172
186
  #
173
187
  # @param balance [Float] The current balance of the credit or commit. This balance reflects the amount of
174
188
  #
175
- # @param contract [MetronomeSDK::Commit::Contract]
189
+ # @param contract [MetronomeSDK::Models::Commit::Contract]
176
190
  #
177
191
  # @param custom_fields [Hash{Symbol=>String}]
178
192
  #
179
193
  # @param description [String]
180
194
  #
181
- # @param invoice_contract [MetronomeSDK::Commit::InvoiceContract] The contract that this commit will be billed on.
195
+ # @param hierarchy_configuration [MetronomeSDK::Models::Commit::HierarchyConfiguration] Optional configuration for commit hierarchy access control
196
+ #
197
+ # @param invoice_contract [MetronomeSDK::Models::Commit::InvoiceContract] The contract that this commit will be billed on.
182
198
  #
183
- # @param invoice_schedule [MetronomeSDK::SchedulePointInTime] The schedule that the customer will be invoiced for this commit.
199
+ # @param invoice_schedule [MetronomeSDK::Models::SchedulePointInTime] The schedule that the customer will be invoiced for this commit.
184
200
  #
185
- # @param ledger [Array<MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>] A list of ordered events that impact the balance of a commit. For example, an in
201
+ # @param ledger [Array<MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry>] A list of ordered events that impact the balance of a commit. For example, an in
186
202
  #
187
203
  # @param name [String]
188
204
  #
@@ -190,17 +206,19 @@ module MetronomeSDK
190
206
  #
191
207
  # @param priority [Float] If multiple credits or commits are applicable, the one with the lower priority w
192
208
  #
193
- # @param rate_type [Symbol, MetronomeSDK::Commit::RateType]
209
+ # @param rate_type [Symbol, MetronomeSDK::Models::Commit::RateType]
194
210
  #
195
- # @param rolled_over_from [MetronomeSDK::Commit::RolledOverFrom]
211
+ # @param rolled_over_from [MetronomeSDK::Models::Commit::RolledOverFrom]
196
212
  #
197
213
  # @param rollover_fraction [Float]
198
214
  #
199
215
  # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
200
216
  #
217
+ # @param specifiers [Array<MetronomeSDK::Models::Commit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
218
+ #
201
219
  # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
202
220
 
203
- # @see MetronomeSDK::Commit#product
221
+ # @see MetronomeSDK::Models::Commit#product
204
222
  class Product < MetronomeSDK::Internal::Type::BaseModel
205
223
  # @!attribute id
206
224
  #
@@ -217,7 +235,7 @@ module MetronomeSDK
217
235
  # @param name [String]
218
236
  end
219
237
 
220
- # @see MetronomeSDK::Commit#type
238
+ # @see MetronomeSDK::Models::Commit#type
221
239
  module Type
222
240
  extend MetronomeSDK::Internal::Type::Enum
223
241
 
@@ -228,7 +246,7 @@ module MetronomeSDK
228
246
  # @return [Array<Symbol>]
229
247
  end
230
248
 
231
- # @see MetronomeSDK::Commit#contract
249
+ # @see MetronomeSDK::Models::Commit#contract
232
250
  class Contract < MetronomeSDK::Internal::Type::BaseModel
233
251
  # @!attribute id
234
252
  #
@@ -239,7 +257,115 @@ module MetronomeSDK
239
257
  # @param id [String]
240
258
  end
241
259
 
242
- # @see MetronomeSDK::Commit#invoice_contract
260
+ # @see MetronomeSDK::Models::Commit#hierarchy_configuration
261
+ class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
262
+ # @!attribute child_access
263
+ #
264
+ # @return [MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
265
+ required :child_access, union: -> { MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess }
266
+
267
+ # @!method initialize(child_access:)
268
+ # Optional configuration for commit hierarchy access control
269
+ #
270
+ # @param child_access [MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
271
+
272
+ # @see MetronomeSDK::Models::Commit::HierarchyConfiguration#child_access
273
+ module ChildAccess
274
+ extend MetronomeSDK::Internal::Type::Union
275
+
276
+ variant -> {
277
+ MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
278
+ }
279
+
280
+ variant -> {
281
+ MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
282
+ }
283
+
284
+ variant -> {
285
+ MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
286
+ }
287
+
288
+ class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
289
+ # @!attribute type
290
+ #
291
+ # @return [Symbol, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
292
+ required :type,
293
+ enum: -> {
294
+ MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
295
+ }
296
+
297
+ # @!method initialize(type:)
298
+ # @param type [Symbol, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
299
+
300
+ # @see MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
301
+ module Type
302
+ extend MetronomeSDK::Internal::Type::Enum
303
+
304
+ ALL = :ALL
305
+
306
+ # @!method self.values
307
+ # @return [Array<Symbol>]
308
+ end
309
+ end
310
+
311
+ class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
312
+ # @!attribute type
313
+ #
314
+ # @return [Symbol, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
315
+ required :type,
316
+ enum: -> {
317
+ MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
318
+ }
319
+
320
+ # @!method initialize(type:)
321
+ # @param type [Symbol, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
322
+
323
+ # @see MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
324
+ module Type
325
+ extend MetronomeSDK::Internal::Type::Enum
326
+
327
+ NONE = :NONE
328
+
329
+ # @!method self.values
330
+ # @return [Array<Symbol>]
331
+ end
332
+ end
333
+
334
+ class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
335
+ # @!attribute contract_ids
336
+ #
337
+ # @return [Array<String>]
338
+ required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
339
+
340
+ # @!attribute type
341
+ #
342
+ # @return [Symbol, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
343
+ required :type,
344
+ enum: -> {
345
+ MetronomeSDK::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
346
+ }
347
+
348
+ # @!method initialize(contract_ids:, type:)
349
+ # @param contract_ids [Array<String>]
350
+ # @param type [Symbol, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
351
+
352
+ # @see MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
353
+ module Type
354
+ extend MetronomeSDK::Internal::Type::Enum
355
+
356
+ CONTRACT_IDS = :CONTRACT_IDS
357
+
358
+ # @!method self.values
359
+ # @return [Array<Symbol>]
360
+ end
361
+ end
362
+
363
+ # @!method self.variants
364
+ # @return [Array(MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
365
+ end
366
+ end
367
+
368
+ # @see MetronomeSDK::Models::Commit#invoice_contract
243
369
  class InvoiceContract < MetronomeSDK::Internal::Type::BaseModel
244
370
  # @!attribute id
245
371
  #
@@ -299,7 +425,7 @@ module MetronomeSDK
299
425
 
300
426
  # @!attribute type
301
427
  #
302
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry::Type]
428
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry::Type]
303
429
  required :type,
304
430
  enum: -> {
305
431
  MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry::Type
@@ -309,9 +435,9 @@ module MetronomeSDK
309
435
  # @param amount [Float]
310
436
  # @param segment_id [String]
311
437
  # @param timestamp [Time]
312
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry::Type]
438
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry::Type]
313
439
 
314
- # @see MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry#type
440
+ # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry#type
315
441
  module Type
316
442
  extend MetronomeSDK::Internal::Type::Enum
317
443
 
@@ -345,7 +471,7 @@ module MetronomeSDK
345
471
 
346
472
  # @!attribute type
347
473
  #
348
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
474
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
349
475
  required :type,
350
476
  enum: -> {
351
477
  MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type
@@ -356,9 +482,9 @@ module MetronomeSDK
356
482
  # @param invoice_id [String]
357
483
  # @param segment_id [String]
358
484
  # @param timestamp [Time]
359
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
485
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
360
486
 
361
- # @see MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry#type
487
+ # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry#type
362
488
  module Type
363
489
  extend MetronomeSDK::Internal::Type::Enum
364
490
 
@@ -392,7 +518,7 @@ module MetronomeSDK
392
518
 
393
519
  # @!attribute type
394
520
  #
395
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry::Type]
521
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry::Type]
396
522
  required :type, enum: -> { MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry::Type }
397
523
 
398
524
  # @!method initialize(amount:, new_contract_id:, segment_id:, timestamp:, type:)
@@ -400,9 +526,9 @@ module MetronomeSDK
400
526
  # @param new_contract_id [String]
401
527
  # @param segment_id [String]
402
528
  # @param timestamp [Time]
403
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry::Type]
529
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry::Type]
404
530
 
405
- # @see MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry#type
531
+ # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry#type
406
532
  module Type
407
533
  extend MetronomeSDK::Internal::Type::Enum
408
534
 
@@ -431,16 +557,16 @@ module MetronomeSDK
431
557
 
432
558
  # @!attribute type
433
559
  #
434
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::Type]
560
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::Type]
435
561
  required :type, enum: -> { MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::Type }
436
562
 
437
563
  # @!method initialize(amount:, segment_id:, timestamp:, type:)
438
564
  # @param amount [Float]
439
565
  # @param segment_id [String]
440
566
  # @param timestamp [Time]
441
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::Type]
567
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry::Type]
442
568
 
443
- # @see MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry#type
569
+ # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry#type
444
570
  module Type
445
571
  extend MetronomeSDK::Internal::Type::Enum
446
572
 
@@ -474,7 +600,7 @@ module MetronomeSDK
474
600
 
475
601
  # @!attribute type
476
602
  #
477
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type]
603
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type]
478
604
  required :type, enum: -> { MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type }
479
605
 
480
606
  # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
@@ -482,9 +608,9 @@ module MetronomeSDK
482
608
  # @param invoice_id [String]
483
609
  # @param segment_id [String]
484
610
  # @param timestamp [Time]
485
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type]
611
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry::Type]
486
612
 
487
- # @see MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry#type
613
+ # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry#type
488
614
  module Type
489
615
  extend MetronomeSDK::Internal::Type::Enum
490
616
 
@@ -518,7 +644,7 @@ module MetronomeSDK
518
644
 
519
645
  # @!attribute type
520
646
  #
521
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type]
647
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type]
522
648
  required :type, enum: -> { MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type }
523
649
 
524
650
  # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
@@ -526,9 +652,9 @@ module MetronomeSDK
526
652
  # @param invoice_id [String]
527
653
  # @param segment_id [String]
528
654
  # @param timestamp [Time]
529
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type]
655
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry::Type]
530
656
 
531
- # @see MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry#type
657
+ # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry#type
532
658
  module Type
533
659
  extend MetronomeSDK::Internal::Type::Enum
534
660
 
@@ -552,7 +678,7 @@ module MetronomeSDK
552
678
 
553
679
  # @!attribute type
554
680
  #
555
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::Type]
681
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::Type]
556
682
  required :type,
557
683
  enum: -> {
558
684
  MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::Type
@@ -561,9 +687,9 @@ module MetronomeSDK
561
687
  # @!method initialize(amount:, timestamp:, type:)
562
688
  # @param amount [Float]
563
689
  # @param timestamp [Time]
564
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::Type]
690
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry::Type]
565
691
 
566
- # @see MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry#type
692
+ # @see MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry#type
567
693
  module Type
568
694
  extend MetronomeSDK::Internal::Type::Enum
569
695
 
@@ -597,7 +723,7 @@ module MetronomeSDK
597
723
 
598
724
  # @!attribute type
599
725
  #
600
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
726
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
601
727
  required :type,
602
728
  enum: -> {
603
729
  MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type
@@ -608,9 +734,9 @@ module MetronomeSDK
608
734
  # @param invoice_id [String]
609
735
  # @param segment_id [String]
610
736
  # @param timestamp [Time]
611
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
737
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry::Type]
612
738
 
613
- # @see MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry#type
739
+ # @see MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry#type
614
740
  module Type
615
741
  extend MetronomeSDK::Internal::Type::Enum
616
742
 
@@ -644,7 +770,7 @@ module MetronomeSDK
644
770
 
645
771
  # @!attribute type
646
772
  #
647
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::Type]
773
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::Type]
648
774
  required :type, enum: -> { MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::Type }
649
775
 
650
776
  # @!method initialize(amount:, new_contract_id:, segment_id:, timestamp:, type:)
@@ -652,9 +778,9 @@ module MetronomeSDK
652
778
  # @param new_contract_id [String]
653
779
  # @param segment_id [String]
654
780
  # @param timestamp [Time]
655
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::Type]
781
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry::Type]
656
782
 
657
- # @see MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry#type
783
+ # @see MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry#type
658
784
  module Type
659
785
  extend MetronomeSDK::Internal::Type::Enum
660
786
 
@@ -683,16 +809,16 @@ module MetronomeSDK
683
809
 
684
810
  # @!attribute type
685
811
  #
686
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type]
812
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type]
687
813
  required :type, enum: -> { MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type }
688
814
 
689
815
  # @!method initialize(amount:, invoice_id:, timestamp:, type:)
690
816
  # @param amount [Float]
691
817
  # @param invoice_id [String]
692
818
  # @param timestamp [Time]
693
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type]
819
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry::Type]
694
820
 
695
- # @see MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry#type
821
+ # @see MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry#type
696
822
  module Type
697
823
  extend MetronomeSDK::Internal::Type::Enum
698
824
 
@@ -721,16 +847,16 @@ module MetronomeSDK
721
847
 
722
848
  # @!attribute type
723
849
  #
724
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry::Type]
850
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry::Type]
725
851
  required :type, enum: -> { MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry::Type }
726
852
 
727
853
  # @!method initialize(amount:, reason:, timestamp:, type:)
728
854
  # @param amount [Float]
729
855
  # @param reason [String]
730
856
  # @param timestamp [Time]
731
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry::Type]
857
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry::Type]
732
858
 
733
- # @see MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry#type
859
+ # @see MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry#type
734
860
  module Type
735
861
  extend MetronomeSDK::Internal::Type::Enum
736
862
 
@@ -759,16 +885,16 @@ module MetronomeSDK
759
885
 
760
886
  # @!attribute type
761
887
  #
762
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry::Type]
888
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry::Type]
763
889
  required :type, enum: -> { MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry::Type }
764
890
 
765
891
  # @!method initialize(amount:, reason:, timestamp:, type:)
766
892
  # @param amount [Float]
767
893
  # @param reason [String]
768
894
  # @param timestamp [Time]
769
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry::Type]
895
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry::Type]
770
896
 
771
- # @see MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry#type
897
+ # @see MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry#type
772
898
  module Type
773
899
  extend MetronomeSDK::Internal::Type::Enum
774
900
 
@@ -792,15 +918,15 @@ module MetronomeSDK
792
918
 
793
919
  # @!attribute type
794
920
  #
795
- # @return [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry::Type]
921
+ # @return [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry::Type]
796
922
  required :type, enum: -> { MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry::Type }
797
923
 
798
924
  # @!method initialize(amount:, timestamp:, type:)
799
925
  # @param amount [Float]
800
926
  # @param timestamp [Time]
801
- # @param type [Symbol, MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry::Type]
927
+ # @param type [Symbol, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry::Type]
802
928
 
803
- # @see MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry#type
929
+ # @see MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry#type
804
930
  module Type
805
931
  extend MetronomeSDK::Internal::Type::Enum
806
932
 
@@ -812,30 +938,10 @@ module MetronomeSDK
812
938
  end
813
939
 
814
940
  # @!method self.variants
815
- # @return [Array(MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry)]
816
-
817
- define_sorbet_constant!(:Variants) do
818
- T.type_alias do
819
- T.any(
820
- MetronomeSDK::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry,
821
- MetronomeSDK::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry,
822
- MetronomeSDK::Commit::Ledger::PrepaidCommitRolloverLedgerEntry,
823
- MetronomeSDK::Commit::Ledger::PrepaidCommitExpirationLedgerEntry,
824
- MetronomeSDK::Commit::Ledger::PrepaidCommitCanceledLedgerEntry,
825
- MetronomeSDK::Commit::Ledger::PrepaidCommitCreditedLedgerEntry,
826
- MetronomeSDK::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry,
827
- MetronomeSDK::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry,
828
- MetronomeSDK::Commit::Ledger::PostpaidCommitRolloverLedgerEntry,
829
- MetronomeSDK::Commit::Ledger::PostpaidCommitTrueupLedgerEntry,
830
- MetronomeSDK::Commit::Ledger::PrepaidCommitManualLedgerEntry,
831
- MetronomeSDK::Commit::Ledger::PostpaidCommitManualLedgerEntry,
832
- MetronomeSDK::Commit::Ledger::PostpaidCommitExpirationLedgerEntry
833
- )
834
- end
835
- end
941
+ # @return [Array(MetronomeSDK::Models::Commit::Ledger::PrepaidCommitSegmentStartLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitExpirationLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCanceledLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitCreditedLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitInitialBalanceLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitRolloverLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitTrueupLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PrepaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitManualLedgerEntry, MetronomeSDK::Models::Commit::Ledger::PostpaidCommitExpirationLedgerEntry)]
836
942
  end
837
943
 
838
- # @see MetronomeSDK::Commit#rate_type
944
+ # @see MetronomeSDK::Models::Commit#rate_type
839
945
  module RateType
840
946
  extend MetronomeSDK::Internal::Type::Enum
841
947
 
@@ -846,7 +952,7 @@ module MetronomeSDK
846
952
  # @return [Array<Symbol>]
847
953
  end
848
954
 
849
- # @see MetronomeSDK::Commit#rolled_over_from
955
+ # @see MetronomeSDK::Models::Commit#rolled_over_from
850
956
  class RolledOverFrom < MetronomeSDK::Internal::Type::BaseModel
851
957
  # @!attribute commit_id
852
958
  #
@@ -862,6 +968,43 @@ module MetronomeSDK
862
968
  # @param commit_id [String]
863
969
  # @param contract_id [String]
864
970
  end
971
+
972
+ class Specifier < MetronomeSDK::Internal::Type::BaseModel
973
+ # @!attribute presentation_group_values
974
+ #
975
+ # @return [Hash{Symbol=>String}, nil]
976
+ optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
977
+
978
+ # @!attribute pricing_group_values
979
+ #
980
+ # @return [Hash{Symbol=>String}, nil]
981
+ optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
982
+
983
+ # @!attribute product_id
984
+ # If provided, the specifier will only apply to the product with the specified ID.
985
+ #
986
+ # @return [String, nil]
987
+ optional :product_id, String
988
+
989
+ # @!attribute product_tags
990
+ # If provided, the specifier will only apply to products with all the specified
991
+ # tags.
992
+ #
993
+ # @return [Array<String>, nil]
994
+ optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
995
+
996
+ # @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
997
+ # Some parameter documentations has been truncated, see
998
+ # {MetronomeSDK::Models::Commit::Specifier} for more details.
999
+ #
1000
+ # @param presentation_group_values [Hash{Symbol=>String}]
1001
+ #
1002
+ # @param pricing_group_values [Hash{Symbol=>String}]
1003
+ #
1004
+ # @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
1005
+ #
1006
+ # @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
1007
+ end
865
1008
  end
866
1009
  end
867
1010
  end