metronome-sdk 3.10.0 → 3.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (256) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +50 -0
  3. data/README.md +1 -10
  4. data/lib/metronome_sdk/internal/body_cursor_page_cursor_field.rb +86 -0
  5. data/lib/metronome_sdk/models/contract_v2.rb +111 -7
  6. data/lib/metronome_sdk/models/contract_without_amendments.rb +86 -6
  7. data/lib/metronome_sdk/models/credit.rb +13 -1
  8. data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb +70 -1
  9. data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb +70 -1
  10. data/lib/metronome_sdk/models/schedule_duration.rb +28 -1
  11. data/lib/metronome_sdk/models/subscription.rb +27 -1
  12. data/lib/metronome_sdk/models/v1/alert_create_params.rb +43 -5
  13. data/lib/metronome_sdk/models/v1/billable_metric_update_params.rb +31 -0
  14. data/lib/metronome_sdk/models/v1/billable_metric_update_response.rb +18 -0
  15. data/lib/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rb +11 -1
  16. data/lib/metronome_sdk/models/v1/contract_amend_params.rb +62 -2
  17. data/lib/metronome_sdk/models/v1/contract_create_params.rb +128 -18
  18. data/lib/metronome_sdk/models/v1/contract_create_response.rb +86 -6
  19. data/lib/metronome_sdk/models/v1/contract_get_net_balance_params.rb +22 -1
  20. data/lib/metronome_sdk/models/v1/contract_get_net_balance_response.rb +4 -3
  21. data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +22 -1
  22. data/lib/metronome_sdk/models/v1/contract_list_params.rb +18 -2
  23. data/lib/metronome_sdk/models/v1/contract_list_seat_balances_response.rb +96 -4
  24. data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rb +16 -1
  25. data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +10 -1
  26. data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +10 -1
  27. data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +10 -1
  28. data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +10 -1
  29. data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +10 -1
  30. data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_params.rb +82 -0
  31. data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_response.rb +69 -0
  32. data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rb +10 -1
  33. data/lib/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rb +10 -1
  34. data/lib/metronome_sdk/models/v1/customer_create_params.rb +4 -14
  35. data/lib/metronome_sdk/models/v1/customer_set_billing_configurations_params.rb +2 -4
  36. data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +4 -3
  37. data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +2 -6
  38. data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +2 -6
  39. data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +31 -1
  40. data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb +22 -1
  41. data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +31 -1
  42. data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +46 -5
  43. data/lib/metronome_sdk/models/v1/customers/invoice.rb +52 -13
  44. data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +10 -1
  45. data/lib/metronome_sdk/models/v1/package_create_params.rb +129 -18
  46. data/lib/metronome_sdk/models/v1/package_list_response.rb +139 -7
  47. data/lib/metronome_sdk/models/v1/package_retrieve_response.rb +139 -7
  48. data/lib/metronome_sdk/models/v1/pricing_unit_archive_params.rb +16 -0
  49. data/lib/metronome_sdk/models/v1/pricing_unit_archive_response.rb +18 -0
  50. data/lib/metronome_sdk/models/v1/pricing_unit_create_params.rb +24 -0
  51. data/lib/metronome_sdk/models/v1/pricing_unit_create_response.rb +18 -0
  52. data/lib/metronome_sdk/models/v1/usage_list_params.rb +4 -2
  53. data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +11 -8
  54. data/lib/metronome_sdk/models/v2/contract_edit_params.rb +221 -20
  55. data/lib/metronome_sdk/models/v2/contract_edit_response.rb +200 -9
  56. data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +200 -9
  57. data/lib/metronome_sdk/models/v2/contract_list_params.rb +17 -1
  58. data/lib/metronome_sdk/models/v2/lifecycle_event_offset_notification_config.rb +104 -0
  59. data/lib/metronome_sdk/models/v2/lifecycle_event_system_notification_config.rb +45 -0
  60. data/lib/metronome_sdk/models/v2/notifications/offset_archive_params.rb +29 -0
  61. data/lib/metronome_sdk/models/v2/notifications/offset_archive_response.rb +20 -0
  62. data/lib/metronome_sdk/models/v2/notifications/offset_create_params.rb +77 -0
  63. data/lib/metronome_sdk/models/v2/notifications/offset_create_response.rb +20 -0
  64. data/lib/metronome_sdk/models/v2/notifications/offset_edit_params.rb +98 -0
  65. data/lib/metronome_sdk/models/v2/notifications/offset_edit_response.rb +32 -0
  66. data/lib/metronome_sdk/models/v2/notifications/offset_list_params.rb +57 -0
  67. data/lib/metronome_sdk/models/v2/notifications/offset_retrieve_params.rb +26 -0
  68. data/lib/metronome_sdk/models/v2/notifications/offset_retrieve_response.rb +20 -0
  69. data/lib/metronome_sdk/models/v2/notifications/system_list_params.rb +18 -0
  70. data/lib/metronome_sdk/models/v2/notifications/system_list_response.rb +27 -0
  71. data/lib/metronome_sdk/resources/v1/alerts.rb +6 -2
  72. data/lib/metronome_sdk/resources/v1/billable_metrics.rb +45 -0
  73. data/lib/metronome_sdk/resources/v1/contracts/products.rb +6 -2
  74. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rb +46 -2
  75. data/lib/metronome_sdk/resources/v1/contracts.rb +26 -9
  76. data/lib/metronome_sdk/resources/v1/custom_fields.rb +3 -0
  77. data/lib/metronome_sdk/resources/v1/customers/alerts.rb +1 -1
  78. data/lib/metronome_sdk/resources/v1/customers/commits.rb +6 -1
  79. data/lib/metronome_sdk/resources/v1/customers/credits.rb +3 -0
  80. data/lib/metronome_sdk/resources/v1/customers/invoices.rb +3 -1
  81. data/lib/metronome_sdk/resources/v1/pricing_units.rb +45 -0
  82. data/lib/metronome_sdk/resources/v1/usage.rb +12 -10
  83. data/lib/metronome_sdk/resources/v2/contracts.rb +15 -6
  84. data/lib/metronome_sdk/resources/v2/notifications/offset.rb +157 -0
  85. data/lib/metronome_sdk/resources/v2/notifications/system.rb +37 -0
  86. data/lib/metronome_sdk/resources/v2/notifications.rb +24 -0
  87. data/lib/metronome_sdk/resources/v2.rb +4 -0
  88. data/lib/metronome_sdk/version.rb +1 -1
  89. data/lib/metronome_sdk.rb +25 -2
  90. data/rbi/metronome_sdk/internal/body_cursor_page_cursor_field.rbi +22 -0
  91. data/rbi/metronome_sdk/models/contract_v2.rbi +202 -4
  92. data/rbi/metronome_sdk/models/contract_without_amendments.rbi +168 -4
  93. data/rbi/metronome_sdk/models/credit.rbi +19 -0
  94. data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi +186 -0
  95. data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi +186 -0
  96. data/rbi/metronome_sdk/models/schedule_duration.rbi +57 -1
  97. data/rbi/metronome_sdk/models/subscription.rbi +34 -0
  98. data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +91 -6
  99. data/rbi/metronome_sdk/models/v1/billable_metric_update_params.rbi +54 -0
  100. data/rbi/metronome_sdk/models/v1/billable_metric_update_response.rbi +31 -0
  101. data/rbi/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbi +15 -0
  102. data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +130 -0
  103. data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +284 -12
  104. data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +158 -2
  105. data/rbi/metronome_sdk/models/v1/contract_get_net_balance_params.rbi +62 -0
  106. data/rbi/metronome_sdk/models/v1/contract_get_net_balance_response.rbi +6 -4
  107. data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +62 -0
  108. data/rbi/metronome_sdk/models/v1/contract_list_params.rbi +24 -2
  109. data/rbi/metronome_sdk/models/v1/contract_list_seat_balances_response.rbi +219 -3
  110. data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbi +13 -0
  111. data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +13 -0
  112. data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +13 -0
  113. data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +13 -0
  114. data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +13 -0
  115. data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +13 -0
  116. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_params.rbi +122 -0
  117. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_response.rbi +123 -0
  118. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbi +13 -0
  119. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbi +13 -0
  120. data/rbi/metronome_sdk/models/v1/customer_create_params.rbi +6 -22
  121. data/rbi/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbi +3 -6
  122. data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +6 -4
  123. data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi +3 -16
  124. data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +3 -16
  125. data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +65 -0
  126. data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi +62 -0
  127. data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +65 -0
  128. data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +96 -6
  129. data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +99 -19
  130. data/rbi/metronome_sdk/models/v1/customers/invoice_list_params.rbi +13 -0
  131. data/rbi/metronome_sdk/models/v1/package_create_params.rbi +289 -12
  132. data/rbi/metronome_sdk/models/v1/package_list_response.rbi +306 -10
  133. data/rbi/metronome_sdk/models/v1/package_retrieve_response.rbi +306 -10
  134. data/rbi/metronome_sdk/models/v1/pricing_unit_archive_params.rbi +34 -0
  135. data/rbi/metronome_sdk/models/v1/pricing_unit_archive_response.rbi +31 -0
  136. data/rbi/metronome_sdk/models/v1/pricing_unit_create_params.rbi +45 -0
  137. data/rbi/metronome_sdk/models/v1/pricing_unit_create_response.rbi +31 -0
  138. data/rbi/metronome_sdk/models/v1/usage_list_params.rbi +4 -0
  139. data/rbi/metronome_sdk/models/v1/usage_list_with_groups_params.rbi +16 -10
  140. data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +492 -14
  141. data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +394 -2
  142. data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +402 -4
  143. data/rbi/metronome_sdk/models/v2/contract_list_params.rbi +22 -0
  144. data/rbi/metronome_sdk/models/v2/lifecycle_event_offset_notification_config.rbi +147 -0
  145. data/rbi/metronome_sdk/models/v2/lifecycle_event_system_notification_config.rbi +98 -0
  146. data/rbi/metronome_sdk/models/v2/notifications/offset_archive_params.rbi +47 -0
  147. data/rbi/metronome_sdk/models/v2/notifications/offset_archive_response.rbi +49 -0
  148. data/rbi/metronome_sdk/models/v2/notifications/offset_create_params.rbi +127 -0
  149. data/rbi/metronome_sdk/models/v2/notifications/offset_create_response.rbi +49 -0
  150. data/rbi/metronome_sdk/models/v2/notifications/offset_edit_params.rbi +181 -0
  151. data/rbi/metronome_sdk/models/v2/notifications/offset_edit_response.rbi +71 -0
  152. data/rbi/metronome_sdk/models/v2/notifications/offset_list_params.rbi +127 -0
  153. data/rbi/metronome_sdk/models/v2/notifications/offset_retrieve_params.rbi +47 -0
  154. data/rbi/metronome_sdk/models/v2/notifications/offset_retrieve_response.rbi +49 -0
  155. data/rbi/metronome_sdk/models/v2/notifications/system_list_params.rbi +36 -0
  156. data/rbi/metronome_sdk/models/v2/notifications/system_list_response.rbi +55 -0
  157. data/rbi/metronome_sdk/resources/v1/alerts.rbi +18 -3
  158. data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +34 -0
  159. data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +8 -0
  160. data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbi +47 -0
  161. data/rbi/metronome_sdk/resources/v1/contracts.rbi +36 -5
  162. data/rbi/metronome_sdk/resources/v1/custom_fields.rbi +3 -0
  163. data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +3 -2
  164. data/rbi/metronome_sdk/resources/v1/customers/billing_config.rbi +1 -2
  165. data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +8 -0
  166. data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +3 -0
  167. data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +4 -0
  168. data/rbi/metronome_sdk/resources/v1/pricing_units.rbi +26 -0
  169. data/rbi/metronome_sdk/resources/v1/usage.rbi +18 -13
  170. data/rbi/metronome_sdk/resources/v2/contracts.rbi +18 -4
  171. data/rbi/metronome_sdk/resources/v2/notifications/offset.rbi +130 -0
  172. data/rbi/metronome_sdk/resources/v2/notifications/system.rbi +28 -0
  173. data/rbi/metronome_sdk/resources/v2/notifications.rbi +20 -0
  174. data/rbi/metronome_sdk/resources/v2.rbi +3 -0
  175. data/sig/metronome_sdk/internal/body_cursor_page_cursor_field.rbs +13 -0
  176. data/sig/metronome_sdk/models/contract_v2.rbs +81 -2
  177. data/sig/metronome_sdk/models/contract_without_amendments.rbs +60 -2
  178. data/sig/metronome_sdk/models/credit.rbs +7 -0
  179. data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration.rbs +71 -0
  180. data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbs +71 -0
  181. data/sig/metronome_sdk/models/schedule_duration.rbs +20 -0
  182. data/sig/metronome_sdk/models/subscription.rbs +21 -0
  183. data/sig/metronome_sdk/models/v1/alert_create_params.rbs +22 -0
  184. data/sig/metronome_sdk/models/v1/billable_metric_update_params.rbs +30 -0
  185. data/sig/metronome_sdk/models/v1/billable_metric_update_response.rbs +15 -0
  186. data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +8 -1
  187. data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +40 -0
  188. data/sig/metronome_sdk/models/v1/contract_create_params.rbs +102 -10
  189. data/sig/metronome_sdk/models/v1/contract_create_response.rbs +60 -2
  190. data/sig/metronome_sdk/models/v1/contract_get_net_balance_params.rbs +20 -0
  191. data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +20 -0
  192. data/sig/metronome_sdk/models/v1/contract_list_params.rbs +14 -0
  193. data/sig/metronome_sdk/models/v1/contract_list_seat_balances_response.rbs +81 -3
  194. data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbs +7 -0
  195. data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +7 -0
  196. data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +7 -0
  197. data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +7 -0
  198. data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +7 -0
  199. data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +7 -0
  200. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_params.rbs +74 -0
  201. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_list_response.rbs +68 -0
  202. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +8 -1
  203. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +8 -1
  204. data/sig/metronome_sdk/models/v1/customer_create_params.rbs +1 -7
  205. data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +1 -7
  206. data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +1 -6
  207. data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +20 -0
  208. data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +20 -0
  209. data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +20 -0
  210. data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +22 -0
  211. data/sig/metronome_sdk/models/v1/customers/invoice.rbs +30 -3
  212. data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +7 -0
  213. data/sig/metronome_sdk/models/v1/package_create_params.rbs +104 -11
  214. data/sig/metronome_sdk/models/v1/package_list_response.rbs +105 -9
  215. data/sig/metronome_sdk/models/v1/package_retrieve_response.rbs +105 -9
  216. data/sig/metronome_sdk/models/v1/pricing_unit_archive_params.rbs +17 -0
  217. data/sig/metronome_sdk/models/v1/pricing_unit_archive_response.rbs +15 -0
  218. data/sig/metronome_sdk/models/v1/pricing_unit_create_params.rbs +25 -0
  219. data/sig/metronome_sdk/models/v1/pricing_unit_create_response.rbs +15 -0
  220. data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +180 -10
  221. data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +159 -2
  222. data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +159 -2
  223. data/sig/metronome_sdk/models/v2/contract_list_params.rbs +14 -0
  224. data/sig/metronome_sdk/models/v2/lifecycle_event_offset_notification_config.rbs +69 -0
  225. data/sig/metronome_sdk/models/v2/lifecycle_event_system_notification_config.rbs +44 -0
  226. data/sig/metronome_sdk/models/v2/notifications/offset_archive_params.rbs +27 -0
  227. data/sig/metronome_sdk/models/v2/notifications/offset_archive_response.rbs +22 -0
  228. data/sig/metronome_sdk/models/v2/notifications/offset_create_params.rbs +54 -0
  229. data/sig/metronome_sdk/models/v2/notifications/offset_create_response.rbs +22 -0
  230. data/sig/metronome_sdk/models/v2/notifications/offset_edit_params.rbs +77 -0
  231. data/sig/metronome_sdk/models/v2/notifications/offset_edit_response.rbs +34 -0
  232. data/sig/metronome_sdk/models/v2/notifications/offset_list_params.rbs +60 -0
  233. data/sig/metronome_sdk/models/v2/notifications/offset_retrieve_params.rbs +27 -0
  234. data/sig/metronome_sdk/models/v2/notifications/offset_retrieve_response.rbs +22 -0
  235. data/sig/metronome_sdk/models/v2/notifications/system_list_params.rbs +19 -0
  236. data/sig/metronome_sdk/models/v2/notifications/system_list_response.rbs +29 -0
  237. data/sig/metronome_sdk/resources/v1/alerts.rbs +1 -0
  238. data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +6 -0
  239. data/sig/metronome_sdk/resources/v1/contracts/products.rbs +2 -0
  240. data/sig/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbs +13 -0
  241. data/sig/metronome_sdk/resources/v1/contracts.rbs +6 -1
  242. data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
  243. data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -0
  244. data/sig/metronome_sdk/resources/v1/pricing_units.rbs +10 -0
  245. data/sig/metronome_sdk/resources/v2/contracts.rbs +3 -1
  246. data/sig/metronome_sdk/resources/v2/notifications/offset.rbs +42 -0
  247. data/sig/metronome_sdk/resources/v2/notifications/system.rbs +15 -0
  248. data/sig/metronome_sdk/resources/v2/notifications.rbs +13 -0
  249. data/sig/metronome_sdk/resources/v2.rbs +2 -0
  250. metadata +77 -8
  251. data/lib/metronome_sdk/models/v1/contract_list_response.rb +0 -18
  252. data/lib/metronome_sdk/models/v2/contract_list_response.rb +0 -18
  253. data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +0 -32
  254. data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +0 -32
  255. data/sig/metronome_sdk/models/v1/contract_list_response.rbs +0 -15
  256. data/sig/metronome_sdk/models/v2/contract_list_response.rbs +0 -15
@@ -625,17 +625,33 @@ module MetronomeSDK
625
625
  required :schedule_items,
626
626
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCommit::AccessSchedule::ScheduleItem] }
627
627
 
628
+ # @!attribute access_type
629
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
630
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
631
+ # omitted.
632
+ #
633
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddCommit::AccessSchedule::AccessType, nil]
634
+ optional :access_type,
635
+ enum: -> { MetronomeSDK::V2::ContractEditParams::AddCommit::AccessSchedule::AccessType }
636
+
628
637
  # @!attribute credit_type_id
629
638
  #
630
639
  # @return [String, nil]
631
640
  optional :credit_type_id, String
632
641
 
633
- # @!method initialize(schedule_items:, credit_type_id: nil)
642
+ # @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
643
+ # Some parameter documentations has been truncated, see
644
+ # {MetronomeSDK::Models::V2::ContractEditParams::AddCommit::AccessSchedule} for
645
+ # more details.
646
+ #
634
647
  # Required: Schedule for distributing the commit to the customer. For "POSTPAID"
635
648
  # commits only one schedule item is allowed and amount must match invoice_schedule
636
649
  # total.
637
650
  #
638
651
  # @param schedule_items [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCommit::AccessSchedule::ScheduleItem>]
652
+ #
653
+ # @param access_type [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddCommit::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
654
+ #
639
655
  # @param credit_type_id [String]
640
656
 
641
657
  class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
@@ -663,6 +679,21 @@ module MetronomeSDK
663
679
  #
664
680
  # @param starting_at [Time] RFC 3339 timestamp (inclusive)
665
681
  end
682
+
683
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
684
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
685
+ # omitted.
686
+ #
687
+ # @see MetronomeSDK::Models::V2::ContractEditParams::AddCommit::AccessSchedule#access_type
688
+ module AccessType
689
+ extend MetronomeSDK::Internal::Type::Enum
690
+
691
+ SPEND = :SPEND
692
+ QUANTITY = :QUANTITY
693
+
694
+ # @!method self.values
695
+ # @return [Array<Symbol>]
696
+ end
666
697
  end
667
698
 
668
699
  # @see MetronomeSDK::Models::V2::ContractEditParams::AddCommit#invoice_schedule
@@ -1183,15 +1214,31 @@ module MetronomeSDK
1183
1214
  required :schedule_items,
1184
1215
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCredit::AccessSchedule::ScheduleItem] }
1185
1216
 
1217
+ # @!attribute access_type
1218
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
1219
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
1220
+ # omitted.
1221
+ #
1222
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddCredit::AccessSchedule::AccessType, nil]
1223
+ optional :access_type,
1224
+ enum: -> { MetronomeSDK::V2::ContractEditParams::AddCredit::AccessSchedule::AccessType }
1225
+
1186
1226
  # @!attribute credit_type_id
1187
1227
  #
1188
1228
  # @return [String, nil]
1189
1229
  optional :credit_type_id, String
1190
1230
 
1191
- # @!method initialize(schedule_items:, credit_type_id: nil)
1231
+ # @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
1232
+ # Some parameter documentations has been truncated, see
1233
+ # {MetronomeSDK::Models::V2::ContractEditParams::AddCredit::AccessSchedule} for
1234
+ # more details.
1235
+ #
1192
1236
  # Schedule for distributing the credit to the customer.
1193
1237
  #
1194
1238
  # @param schedule_items [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCredit::AccessSchedule::ScheduleItem>]
1239
+ #
1240
+ # @param access_type [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddCredit::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
1241
+ #
1195
1242
  # @param credit_type_id [String]
1196
1243
 
1197
1244
  class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
@@ -1219,6 +1266,21 @@ module MetronomeSDK
1219
1266
  #
1220
1267
  # @param starting_at [Time] RFC 3339 timestamp (inclusive)
1221
1268
  end
1269
+
1270
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
1271
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
1272
+ # omitted.
1273
+ #
1274
+ # @see MetronomeSDK::Models::V2::ContractEditParams::AddCredit::AccessSchedule#access_type
1275
+ module AccessType
1276
+ extend MetronomeSDK::Internal::Type::Enum
1277
+
1278
+ SPEND = :SPEND
1279
+ QUANTITY = :QUANTITY
1280
+
1281
+ # @!method self.values
1282
+ # @return [Array<Symbol>]
1283
+ end
1222
1284
  end
1223
1285
 
1224
1286
  # @see MetronomeSDK::Models::V2::ContractEditParams::AddCredit#rate_type
@@ -2068,16 +2130,25 @@ module MetronomeSDK
2068
2130
 
2069
2131
  # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit#access_amount
2070
2132
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
2071
- # @!attribute credit_type_id
2072
- #
2073
- # @return [String]
2074
- required :credit_type_id, String
2075
-
2076
2133
  # @!attribute unit_price
2077
2134
  #
2078
2135
  # @return [Float]
2079
2136
  required :unit_price, Float
2080
2137
 
2138
+ # @!attribute access_type
2139
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2140
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2141
+ #
2142
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::AccessAmount::AccessType, nil]
2143
+ optional :access_type,
2144
+ enum: -> { MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::AccessAmount::AccessType }
2145
+
2146
+ # @!attribute credit_type_id
2147
+ # Defaults to USD (cents) if not passed
2148
+ #
2149
+ # @return [String, nil]
2150
+ optional :credit_type_id, String
2151
+
2081
2152
  # @!attribute quantity
2082
2153
  # This field is required unless a subscription is attached via
2083
2154
  # `subscription_config`.
@@ -2085,18 +2156,34 @@ module MetronomeSDK
2085
2156
  # @return [Float, nil]
2086
2157
  optional :quantity, Float
2087
2158
 
2088
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
2159
+ # @!method initialize(unit_price:, access_type: nil, credit_type_id: nil, quantity: nil)
2089
2160
  # Some parameter documentations has been truncated, see
2090
2161
  # {MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::AccessAmount}
2091
2162
  # for more details.
2092
2163
  #
2093
2164
  # The amount of commit to grant.
2094
2165
  #
2095
- # @param credit_type_id [String]
2096
- #
2097
2166
  # @param unit_price [Float]
2098
2167
  #
2168
+ # @param access_type [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
2169
+ #
2170
+ # @param credit_type_id [String] Defaults to USD (cents) if not passed
2171
+ #
2099
2172
  # @param quantity [Float] This field is required unless a subscription is attached via `subscription_confi
2173
+
2174
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2175
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2176
+ #
2177
+ # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::AccessAmount#access_type
2178
+ module AccessType
2179
+ extend MetronomeSDK::Internal::Type::Enum
2180
+
2181
+ SPEND = :SPEND
2182
+ QUANTITY = :QUANTITY
2183
+
2184
+ # @!method self.values
2185
+ # @return [Array<Symbol>]
2186
+ end
2100
2187
  end
2101
2188
 
2102
2189
  # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit#commit_duration
@@ -2552,16 +2639,25 @@ module MetronomeSDK
2552
2639
 
2553
2640
  # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit#access_amount
2554
2641
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
2555
- # @!attribute credit_type_id
2556
- #
2557
- # @return [String]
2558
- required :credit_type_id, String
2559
-
2560
2642
  # @!attribute unit_price
2561
2643
  #
2562
2644
  # @return [Float]
2563
2645
  required :unit_price, Float
2564
2646
 
2647
+ # @!attribute access_type
2648
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2649
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2650
+ #
2651
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::AccessAmount::AccessType, nil]
2652
+ optional :access_type,
2653
+ enum: -> { MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::AccessAmount::AccessType }
2654
+
2655
+ # @!attribute credit_type_id
2656
+ # Defaults to USD (cents) if not passed
2657
+ #
2658
+ # @return [String, nil]
2659
+ optional :credit_type_id, String
2660
+
2565
2661
  # @!attribute quantity
2566
2662
  # This field is required unless a subscription is attached via
2567
2663
  # `subscription_config`.
@@ -2569,18 +2665,34 @@ module MetronomeSDK
2569
2665
  # @return [Float, nil]
2570
2666
  optional :quantity, Float
2571
2667
 
2572
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
2668
+ # @!method initialize(unit_price:, access_type: nil, credit_type_id: nil, quantity: nil)
2573
2669
  # Some parameter documentations has been truncated, see
2574
2670
  # {MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::AccessAmount}
2575
2671
  # for more details.
2576
2672
  #
2577
2673
  # The amount of commit to grant.
2578
2674
  #
2579
- # @param credit_type_id [String]
2580
- #
2581
2675
  # @param unit_price [Float]
2582
2676
  #
2677
+ # @param access_type [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
2678
+ #
2679
+ # @param credit_type_id [String] Defaults to USD (cents) if not passed
2680
+ #
2583
2681
  # @param quantity [Float] This field is required unless a subscription is attached via `subscription_confi
2682
+
2683
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2684
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2685
+ #
2686
+ # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::AccessAmount#access_type
2687
+ module AccessType
2688
+ extend MetronomeSDK::Internal::Type::Enum
2689
+
2690
+ SPEND = :SPEND
2691
+ QUANTITY = :QUANTITY
2692
+
2693
+ # @!method self.values
2694
+ # @return [Array<Symbol>]
2695
+ end
2584
2696
  end
2585
2697
 
2586
2698
  # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit#commit_duration
@@ -4361,6 +4473,36 @@ module MetronomeSDK
4361
4473
  # @return [Array<String>, nil]
4362
4474
  optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
4363
4475
 
4476
+ # @!attribute duration
4477
+ # The length of time the created commit will be valid, starting from the end of
4478
+ # the invoice's service period. Set to null to clear a previously configured
4479
+ # duration.
4480
+ #
4481
+ # @return [MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration, nil]
4482
+ optional :duration,
4483
+ -> {
4484
+ MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration
4485
+ },
4486
+ nil?: true
4487
+
4488
+ # @!attribute rate_type
4489
+ # Whether the created commits will be charged at commit rate or list rate. Set to
4490
+ # null to clear a previously configured rate type.
4491
+ #
4492
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::RateType, nil]
4493
+ optional :rate_type,
4494
+ enum: -> {
4495
+ MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::RateType
4496
+ },
4497
+ nil?: true
4498
+
4499
+ # @!attribute rollover_fraction
4500
+ # Fraction of the created commit's unused balance that will roll over. Must be
4501
+ # between 0 and 1. Set to null to clear a previously configured rollover fraction.
4502
+ #
4503
+ # @return [Float, nil]
4504
+ optional :rollover_fraction, Float, nil?: true
4505
+
4364
4506
  # @!attribute specifiers
4365
4507
  # List of filters that determine what kind of customer usage draws down a commit
4366
4508
  # or credit. A customer's usage needs to meet the condition of at least one of the
@@ -4374,7 +4516,7 @@ module MetronomeSDK
4374
4516
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
4375
4517
  nil?: true
4376
4518
 
4377
- # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, specifiers: nil)
4519
+ # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, duration: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil)
4378
4520
  # Some parameter documentations has been truncated, see
4379
4521
  # {MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit}
4380
4522
  # for more details.
@@ -4383,7 +4525,59 @@ module MetronomeSDK
4383
4525
  #
4384
4526
  # @param applicable_product_tags [Array<String>, nil] Which tags the threshold commit applies to. If both applicable_product_ids and a
4385
4527
  #
4528
+ # @param duration [MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration, nil] The length of time the created commit will be valid, starting from the end of th
4529
+ #
4530
+ # @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::RateType, nil] Whether the created commits will be charged at commit rate or list rate. Set to
4531
+ #
4532
+ # @param rollover_fraction [Float, nil] Fraction of the created commit's unused balance that will roll over. Must be bet
4533
+ #
4386
4534
  # @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil] List of filters that determine what kind of customer usage draws down a commit o
4535
+
4536
+ class Duration < MetronomeSDK::Internal::Type::BaseModel
4537
+ # @!attribute unit
4538
+ #
4539
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration::Unit]
4540
+ required :unit,
4541
+ enum: -> { MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration::Unit }
4542
+
4543
+ # @!attribute value
4544
+ #
4545
+ # @return [Integer]
4546
+ required :value, Integer
4547
+
4548
+ # @!method initialize(unit:, value:)
4549
+ # The length of time the created commit will be valid, starting from the end of
4550
+ # the invoice's service period. Set to null to clear a previously configured
4551
+ # duration.
4552
+ #
4553
+ # @param unit [Symbol, MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration::Unit]
4554
+ # @param value [Integer]
4555
+
4556
+ # @see MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration#unit
4557
+ module Unit
4558
+ extend MetronomeSDK::Internal::Type::Enum
4559
+
4560
+ DAYS = :DAYS
4561
+ WEEKS = :WEEKS
4562
+ MONTHS = :MONTHS
4563
+ YEARS = :YEARS
4564
+
4565
+ # @!method self.values
4566
+ # @return [Array<Symbol>]
4567
+ end
4568
+ end
4569
+
4570
+ # Whether the created commits will be charged at commit rate or list rate. Set to
4571
+ # null to clear a previously configured rate type.
4572
+ module RateType
4573
+ extend MetronomeSDK::Internal::Type::Enum
4574
+
4575
+ COMMIT_RATE = :COMMIT_RATE
4576
+ LIST_RATE = :LIST_RATE
4577
+
4578
+ # @!method self.values
4579
+ # @return [Array<Symbol>]
4580
+ end
4387
4581
  end
4388
4582
 
4389
4583
  # @see MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration#discount_configuration
@@ -5082,6 +5276,11 @@ module MetronomeSDK
5082
5276
  # @return [Time, nil]
5083
5277
  optional :ending_before, Time, nil?: true
5084
5278
 
5279
+ # @!attribute name
5280
+ #
5281
+ # @return [String, nil]
5282
+ optional :name, String
5283
+
5085
5284
  # @!attribute proration_rounding
5086
5285
  #
5087
5286
  # @return [MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::ProrationRounding, nil]
@@ -5111,7 +5310,7 @@ module MetronomeSDK
5111
5310
  # @return [MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::SeatUpdates, nil]
5112
5311
  optional :seat_updates, -> { MetronomeSDK::V2::ContractEditParams::UpdateSubscription::SeatUpdates }
5113
5312
 
5114
- # @!method initialize(subscription_id:, ending_before: nil, proration_rounding: nil, quantity_management_mode_update: nil, quantity_updates: nil, seat_updates: nil)
5313
+ # @!method initialize(subscription_id:, ending_before: nil, name: nil, proration_rounding: nil, quantity_management_mode_update: nil, quantity_updates: nil, seat_updates: nil)
5115
5314
  # Some parameter documentations has been truncated, see
5116
5315
  # {MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription} for more
5117
5316
  # details.
@@ -5120,6 +5319,8 @@ module MetronomeSDK
5120
5319
  #
5121
5320
  # @param ending_before [Time, nil]
5122
5321
  #
5322
+ # @param name [String]
5323
+ #
5123
5324
  # @param proration_rounding [MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::ProrationRounding, nil]
5124
5325
  #
5125
5326
  # @param quantity_management_mode_update [MetronomeSDK::Models::V2::ContractEditParams::UpdateSubscription::QuantityManagementModeUpdate] Update the subscription's quantity management mode from QUANTITY_ONLY to SEAT_BA