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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b696954210f4bfed05c1d32c78ae7c38101e515f542781ff37cc49ef5b8aa64e
4
- data.tar.gz: 6645acf1a6a3b40d2515f909f591ea74837837c5fcea90af965a363eb4e67e40
3
+ metadata.gz: f0624635cfead511d42cb71f806934731be4395e4629855ec44cee8d16f5949b
4
+ data.tar.gz: '096003ff28a8d89a26cd64a696f0e7b770991d634319ef6afd85d1e8310862bd'
5
5
  SHA512:
6
- metadata.gz: aa99380e1a02c6e89b1633b002eecd1a3f20ae850141c302ed1dda4520eef09bf3de437944db64e381a0817afa963648a2b8d53d4d91e767621972015b274a94
7
- data.tar.gz: 5ead08a83536b93ce7b43d66964e8f132632c4a6846059a08be8e3d2f2b6af6389988a0a709af4b19d9094d902a20bd4cc28384a8a815f465fb33314c1834dac
6
+ metadata.gz: 030b7ac5acc02cc54be8849680482c4d2dd7296d79bf202fc3453228acdccb8890e2bc105ac7927b8283027f4f88572e2805781ec4e9eea748264fb1c40fcf7f
7
+ data.tar.gz: 9df531bfa34b01ab70b434f92e9fb464fa86398ac9894c64c0decce182c33133db094becbfc62b68633f415d7fd4477a7733f2a47a2e9a9e6e9349679d6f0f54
data/CHANGELOG.md CHANGED
@@ -1,5 +1,55 @@
1
1
  # Changelog
2
2
 
3
+ ## [3.12.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.11.0-alpha.1...v3.12.0) (2026-10-27)
4
+
5
+ Adds public API support for quantity-based balances, pricing-unit management, and subscription updates. Contract listing now supports pagination; see the migration guidance below.
6
+
7
+ ### Features
8
+
9
+ - Set `access_type` to `SPEND` or `QUANTITY` for commit and credit access schedules, and filter commits, balances, and net balances by access type. ([3f11961](https://github.com/Metronome-Industries/metronome-ruby/commit/3f119613eb1ca9bfdbe2d16ffc50d0110f159cce))
10
+ - Read the units deducted from quantity-based commits through invoice line-item `quantity_consumed`. ([62d2fac](https://github.com/Metronome-Industries/metronome-ruby/commit/62d2fac3d0d0f45b3c3de70d65e641395a8daa53))
11
+ - Update a billable metric's display name. ([bb67f19](https://github.com/Metronome-Industries/metronome-ruby/commit/bb67f193de2d7dfab3ee5162a5577c571674b37c))
12
+ - Create and archive custom pricing units. ([1da3c41](https://github.com/Metronome-Industries/metronome-ruby/commit/1da3c41b1a9efb110d27f50954b8114b634fd9d9))
13
+ - Read subscription product custom fields in contract responses, and rename subscriptions through contract edits. ([6fe8489](https://github.com/Metronome-Industries/metronome-ruby/commit/6fe84892ecc6330a41fec0329b2aa6183df8d224)) ([8441689](https://github.com/Metronome-Industries/metronome-ruby/commit/8441689bbd631599d97c0808447eebcd1d1a165b))
14
+ - Use `CUSTOM_DATE` as the billing-cycle anchor when creating a package. ([ae3f975](https://github.com/Metronome-Industries/metronome-ruby/commit/ae3f97579b8cc787427c62152344c3143b9f1a60))
15
+ - Configure the duration, rate type, and rollover fraction of commits created by prepaid-balance threshold billing. ([c0211f6](https://github.com/Metronome-Industries/metronome-ruby/commit/c0211f6daaa730d698ba053a95ec36b50c7be4e9))
16
+ - Set `include_composite_spend` to include spend from other composite products. ([8844080](https://github.com/Metronome-Industries/metronome-ruby/commit/884408098023336d329d4b644e7dc406ed25a333))
17
+ - Supply a `uniqueness_key` when adding a manual balance entry to prevent duplicate adjustments. ([95213a9](https://github.com/Metronome-Industries/metronome-ruby/commit/95213a9aa6e99539af27b48671f2f41c58726e04))
18
+ - Manage offset lifecycle notifications and list system notification types through `v2.notifications`. ([99e0bb8](https://github.com/Metronome-Industries/metronome-ruby/commit/99e0bb8631dc9aeb36e1111d064647dbf8cbe3eb))
19
+ - Include historical commit invoices when listing invoices with `include_historical_commit_invoices`. ([91338bc](https://github.com/Metronome-Industries/metronome-ruby/commit/91338bca0569f5423eba58d095f77fe94cef3887))
20
+
21
+ ### Documentation
22
+
23
+ - Clarify that archiving an already archived threshold notification succeeds, and update links to the support portal. ([3f8d931](https://github.com/Metronome-Industries/metronome-ruby/commit/3f8d93141c9489a3eb3a896846491dcf8d823c22)) ([f545900](https://github.com/Metronome-Industries/metronome-ruby/commit/f5459008f431108d9e86c2cea41b385de3d14a81))
24
+
25
+ ### Breaking changes
26
+
27
+ - V1 and V2 contract `list` methods now return a pagination object instead of `V1::ContractListResponse` or `V2::ContractListResponse`; those response classes are removed. Update explicit class references and type assertions. Use `page.data` for one page, `page.auto_paging_each` to process every contract, or `page.next_page?` / `page.next_page` for manual pagination. Requests accept `cursor` and `limit` (1–20); a single page contains at most 20 contracts. ([02a2ebe](https://github.com/Metronome-Industries/metronome-ruby/commit/02a2ebe01f4d29718377dd75c080db6f1bd71752))
28
+
29
+ ## [3.11.0-alpha.1](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.10.0...v3.11.0-alpha.1) (2026-07-29)
30
+
31
+
32
+ ### Features
33
+
34
+ * add release-please workflow ([#27](https://github.com/Metronome-Industries/metronome-ruby/issues/27)) ([03844d8](https://github.com/Metronome-Industries/metronome-ruby/commit/03844d89a8dcd94ae1af42a3adaab0e80e86c0ac))
35
+ * **release:** add App-token release workflow and in-PR overrides ([#30](https://github.com/Metronome-Industries/metronome-ruby/issues/30)) ([8e907d6](https://github.com/Metronome-Industries/metronome-ruby/commit/8e907d6a95aead3575af00f0123fa2762d7fca0c))
36
+ * **stlc:** dispatch custom-code seals to api ([3b86868](https://github.com/Metronome-Industries/metronome-ruby/commit/3b86868ff54438037af4f13ad6ae40409fa4b728))
37
+ * **stlc:** dispatch custom-code seals to api ([f3fc992](https://github.com/Metronome-Industries/metronome-ruby/commit/f3fc9929937ed044e5c3fa945ab4eb756260b1ff))
38
+
39
+
40
+ ### Bug Fixes
41
+
42
+ * **stlc:** use bot token for sync ([d80fe13](https://github.com/Metronome-Industries/metronome-ruby/commit/d80fe13b320e348522129cdb8d4dbef19b030572))
43
+ * **stlc:** use bot token for sync ([25835bf](https://github.com/Metronome-Industries/metronome-ruby/commit/25835bfd8586274cdf7399cf4ffb74bb891e47b4))
44
+
45
+
46
+ ### Chores
47
+
48
+ * initial promote from stlc staging ([a7c3956](https://github.com/Metronome-Industries/metronome-ruby/commit/a7c39562193758c563806594397f9c2b0df131dc))
49
+ * promote SDK changes from staging ([7659721](https://github.com/Metronome-Industries/metronome-ruby/commit/7659721dfa9b8482fb4c7c342e521f9d8f69c30c))
50
+ * **stlc:** reconcile production history into staging ([fbc1ce6](https://github.com/Metronome-Industries/metronome-ruby/commit/fbc1ce606c5ebe8377109b919bb9750fde62bfc2))
51
+ * **stlc:** reconcile Ruby production history into staging ([7984d3e](https://github.com/Metronome-Industries/metronome-ruby/commit/7984d3e146fffba603062f6d4e2cd54833c6ef89))
52
+
3
53
  ## 3.10.0 (2026-07-23)
4
54
 
5
55
  Full Changelog: [v3.9.0...v3.10.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v3.9.0...v3.10.0)
data/README.md CHANGED
@@ -4,15 +4,6 @@ The Metronome Ruby library provides convenient access to the Metronome REST API
4
4
 
5
5
  It is generated with [Stainless](https://www.stainless.com/).
6
6
 
7
- ## MCP Server
8
-
9
- Use the Metronome MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
10
-
11
- [![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40metronome%2Fmcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBtZXRyb25vbWUvbWNwIl0sImVudiI6eyJNRVRST05PTUVfQkVBUkVSX1RPS0VOIjoiTXkgQmVhcmVyIFRva2VuIiwiTUVUUk9OT01FX1dFQkhPT0tfU0VDUkVUIjoiTXkgV2ViaG9vayBTZWNyZXQifX0)
12
- [![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40metronome%2Fmcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40metronome%2Fmcp%22%5D%2C%22env%22%3A%7B%22METRONOME_BEARER_TOKEN%22%3A%22My%20Bearer%20Token%22%2C%22METRONOME_WEBHOOK_SECRET%22%3A%22My%20Webhook%20Secret%22%7D%7D)
13
-
14
- > Note: You may need to set environment variables in your MCP client.
15
-
16
7
  ## Documentation
17
8
 
18
9
  Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/metronome-sdk).
@@ -26,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
26
17
  <!-- x-release-please-start-version -->
27
18
 
28
19
  ```ruby
29
- gem "metronome-sdk", "~> 3.10.0"
20
+ gem "metronome-sdk", "~> 3.12.0"
30
21
  ```
31
22
 
32
23
  <!-- x-release-please-end -->
@@ -0,0 +1,86 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Internal
5
+ # @generic Elem
6
+ #
7
+ # @example
8
+ # if body_cursor_page_cursor_field.has_next?
9
+ # body_cursor_page_cursor_field = body_cursor_page_cursor_field.next_page
10
+ # end
11
+ #
12
+ # @example
13
+ # body_cursor_page_cursor_field.auto_paging_each do |contract|
14
+ # puts(contract)
15
+ # end
16
+ class BodyCursorPageCursorField
17
+ include MetronomeSDK::Internal::Type::BasePage
18
+
19
+ # @return [String]
20
+ attr_accessor :cursor
21
+
22
+ # @return [Array<generic<Elem>>, nil]
23
+ attr_accessor :data
24
+
25
+ # @return [Boolean]
26
+ def next_page?
27
+ !cursor.to_s.empty?
28
+ end
29
+
30
+ # @raise [MetronomeSDK::HTTP::Error]
31
+ # @return [self]
32
+ def next_page
33
+ unless next_page?
34
+ message = "No more pages available. Please check #next_page? before calling ##{__method__}"
35
+ raise RuntimeError.new(message)
36
+ end
37
+
38
+ req = MetronomeSDK::Internal::Util.deep_merge(@req, {body: {cursor: cursor}})
39
+ @client.request(req)
40
+ end
41
+
42
+ # @param blk [Proc]
43
+ #
44
+ # @yieldparam [generic<Elem>]
45
+ def auto_paging_each(&blk)
46
+ unless block_given?
47
+ raise ArgumentError.new("A block must be given to ##{__method__}")
48
+ end
49
+
50
+ page = self
51
+ loop do
52
+ page.data&.each(&blk)
53
+
54
+ break unless page.next_page?
55
+ page = page.next_page
56
+ end
57
+ end
58
+
59
+ # @api private
60
+ #
61
+ # @param client [MetronomeSDK::Internal::Transport::BaseClient]
62
+ # @param req [Hash{Symbol=>Object}]
63
+ # @param headers [Hash{String=>String}]
64
+ # @param page_data [Hash{Symbol=>Object}]
65
+ def initialize(client:, req:, headers:, page_data:)
66
+ super
67
+
68
+ @cursor = page_data[:cursor]
69
+ case page_data
70
+ in {data: Array => data}
71
+ @data = data.map { MetronomeSDK::Internal::Type::Converter.coerce(@model, _1) }
72
+ else
73
+ end
74
+ end
75
+
76
+ # @api private
77
+ #
78
+ # @return [String]
79
+ def inspect
80
+ model = MetronomeSDK::Internal::Type::Converter.inspect(@model, depth: 1)
81
+
82
+ "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)} cursor=#{cursor.inspect}>"
83
+ end
84
+ end
85
+ end
86
+ end
@@ -2820,6 +2820,12 @@ module MetronomeSDK
2820
2820
  # @return [MetronomeSDK::Models::ContractV2::RecurringCommit::AccessAmount]
2821
2821
  required :access_amount, -> { MetronomeSDK::ContractV2::RecurringCommit::AccessAmount }
2822
2822
 
2823
+ # @!attribute anchor_date
2824
+ # The date this recurring commit's billing periods are anchored to.
2825
+ #
2826
+ # @return [Time]
2827
+ required :anchor_date, Time
2828
+
2823
2829
  # @!attribute commit_duration
2824
2830
  # The amount of time the created commits will be valid for
2825
2831
  #
@@ -2951,7 +2957,7 @@ module MetronomeSDK
2951
2957
  # @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
2952
2958
  optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
2953
2959
 
2954
- # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
2960
+ # @!method initialize(id:, access_amount:, anchor_date:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
2955
2961
  # Some parameter documentations has been truncated, see
2956
2962
  # {MetronomeSDK::Models::ContractV2::RecurringCommit} for more details.
2957
2963
  #
@@ -2959,6 +2965,8 @@ module MetronomeSDK
2959
2965
  #
2960
2966
  # @param access_amount [MetronomeSDK::Models::ContractV2::RecurringCommit::AccessAmount] The amount of commit to grant.
2961
2967
  #
2968
+ # @param anchor_date [Time] The date this recurring commit's billing periods are anchored to.
2969
+ #
2962
2970
  # @param commit_duration [MetronomeSDK::Models::ContractV2::RecurringCommit::CommitDuration] The amount of time the created commits will be valid for
2963
2971
  #
2964
2972
  # @param priority [Float] Will be passed down to the individual commits
@@ -3002,6 +3010,8 @@ module MetronomeSDK
3002
3010
  # @see MetronomeSDK::Models::ContractV2::RecurringCommit#access_amount
3003
3011
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
3004
3012
  # @!attribute credit_type_id
3013
+ # This ID identifies the credit type for the access amount. Quantity-based
3014
+ # recurring commits and credits return the null credit type UUID.
3005
3015
  #
3006
3016
  # @return [String]
3007
3017
  required :credit_type_id, String
@@ -3011,17 +3021,46 @@ module MetronomeSDK
3011
3021
  # @return [Float]
3012
3022
  required :unit_price, Float
3013
3023
 
3024
+ # @!attribute access_type
3025
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
3026
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
3027
+ #
3028
+ # @return [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::AccessAmount::AccessType, nil]
3029
+ optional :access_type, enum: -> { MetronomeSDK::ContractV2::RecurringCommit::AccessAmount::AccessType }
3030
+
3014
3031
  # @!attribute quantity
3015
3032
  #
3016
3033
  # @return [Float, nil]
3017
3034
  optional :quantity, Float
3018
3035
 
3019
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
3036
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
3037
+ # Some parameter documentations has been truncated, see
3038
+ # {MetronomeSDK::Models::ContractV2::RecurringCommit::AccessAmount} for more
3039
+ # details.
3040
+ #
3020
3041
  # The amount of commit to grant.
3021
3042
  #
3022
- # @param credit_type_id [String]
3043
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
3044
+ #
3023
3045
  # @param unit_price [Float]
3046
+ #
3047
+ # @param access_type [Symbol, MetronomeSDK::Models::ContractV2::RecurringCommit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
3048
+ #
3024
3049
  # @param quantity [Float]
3050
+
3051
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
3052
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
3053
+ #
3054
+ # @see MetronomeSDK::Models::ContractV2::RecurringCommit::AccessAmount#access_type
3055
+ module AccessType
3056
+ extend MetronomeSDK::Internal::Type::Enum
3057
+
3058
+ SPEND = :SPEND
3059
+ QUANTITY = :QUANTITY
3060
+
3061
+ # @!method self.values
3062
+ # @return [Array<Symbol>]
3063
+ end
3025
3064
  end
3026
3065
 
3027
3066
  # @see MetronomeSDK::Models::ContractV2::RecurringCommit#commit_duration
@@ -3264,6 +3303,12 @@ module MetronomeSDK
3264
3303
  # @return [MetronomeSDK::Models::ContractV2::RecurringCredit::AccessAmount]
3265
3304
  required :access_amount, -> { MetronomeSDK::ContractV2::RecurringCredit::AccessAmount }
3266
3305
 
3306
+ # @!attribute anchor_date
3307
+ # The date this recurring commit's billing periods are anchored to.
3308
+ #
3309
+ # @return [Time]
3310
+ required :anchor_date, Time
3311
+
3267
3312
  # @!attribute commit_duration
3268
3313
  # The amount of time the created commits will be valid for
3269
3314
  #
@@ -3389,7 +3434,7 @@ module MetronomeSDK
3389
3434
  # @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
3390
3435
  optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
3391
3436
 
3392
- # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
3437
+ # @!method initialize(id:, access_amount:, anchor_date:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
3393
3438
  # Some parameter documentations has been truncated, see
3394
3439
  # {MetronomeSDK::Models::ContractV2::RecurringCredit} for more details.
3395
3440
  #
@@ -3397,6 +3442,8 @@ module MetronomeSDK
3397
3442
  #
3398
3443
  # @param access_amount [MetronomeSDK::Models::ContractV2::RecurringCredit::AccessAmount] The amount of commit to grant.
3399
3444
  #
3445
+ # @param anchor_date [Time] The date this recurring commit's billing periods are anchored to.
3446
+ #
3400
3447
  # @param commit_duration [MetronomeSDK::Models::ContractV2::RecurringCredit::CommitDuration] The amount of time the created commits will be valid for
3401
3448
  #
3402
3449
  # @param priority [Float] Will be passed down to the individual commits
@@ -3438,6 +3485,8 @@ module MetronomeSDK
3438
3485
  # @see MetronomeSDK::Models::ContractV2::RecurringCredit#access_amount
3439
3486
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
3440
3487
  # @!attribute credit_type_id
3488
+ # This ID identifies the credit type for the access amount. Quantity-based
3489
+ # recurring commits and credits return the null credit type UUID.
3441
3490
  #
3442
3491
  # @return [String]
3443
3492
  required :credit_type_id, String
@@ -3447,17 +3496,46 @@ module MetronomeSDK
3447
3496
  # @return [Float]
3448
3497
  required :unit_price, Float
3449
3498
 
3499
+ # @!attribute access_type
3500
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
3501
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
3502
+ #
3503
+ # @return [Symbol, MetronomeSDK::Models::ContractV2::RecurringCredit::AccessAmount::AccessType, nil]
3504
+ optional :access_type, enum: -> { MetronomeSDK::ContractV2::RecurringCredit::AccessAmount::AccessType }
3505
+
3450
3506
  # @!attribute quantity
3451
3507
  #
3452
3508
  # @return [Float, nil]
3453
3509
  optional :quantity, Float
3454
3510
 
3455
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
3511
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
3512
+ # Some parameter documentations has been truncated, see
3513
+ # {MetronomeSDK::Models::ContractV2::RecurringCredit::AccessAmount} for more
3514
+ # details.
3515
+ #
3456
3516
  # The amount of commit to grant.
3457
3517
  #
3458
- # @param credit_type_id [String]
3518
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
3519
+ #
3459
3520
  # @param unit_price [Float]
3521
+ #
3522
+ # @param access_type [Symbol, MetronomeSDK::Models::ContractV2::RecurringCredit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
3523
+ #
3460
3524
  # @param quantity [Float]
3525
+
3526
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
3527
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
3528
+ #
3529
+ # @see MetronomeSDK::Models::ContractV2::RecurringCredit::AccessAmount#access_type
3530
+ module AccessType
3531
+ extend MetronomeSDK::Internal::Type::Enum
3532
+
3533
+ SPEND = :SPEND
3534
+ QUANTITY = :QUANTITY
3535
+
3536
+ # @!method self.values
3537
+ # @return [Array<Symbol>]
3538
+ end
3461
3539
  end
3462
3540
 
3463
3541
  # @see MetronomeSDK::Models::ContractV2::RecurringCredit#commit_duration
@@ -4039,6 +4117,11 @@ module MetronomeSDK
4039
4117
  # @return [Symbol, MetronomeSDK::Models::ContractV2::Subscription::CollectionSchedule]
4040
4118
  required :collection_schedule, enum: -> { MetronomeSDK::ContractV2::Subscription::CollectionSchedule }
4041
4119
 
4120
+ # @!attribute created_at
4121
+ #
4122
+ # @return [Time]
4123
+ required :created_at, Time
4124
+
4042
4125
  # @!attribute proration
4043
4126
  #
4044
4127
  # @return [MetronomeSDK::Models::ContractV2::Subscription::Proration]
@@ -4087,6 +4170,13 @@ module MetronomeSDK
4087
4170
  # @return [MetronomeSDK::Models::ContractV2::Subscription::BillingCycleConfig, nil]
4088
4171
  optional :billing_cycle_config, -> { MetronomeSDK::ContractV2::Subscription::BillingCycleConfig }
4089
4172
 
4173
+ # @!attribute custom_credit_type_id
4174
+ # If provided, the subscription's price will be in terms of this custom pricing
4175
+ # unit instead of the fiat currency.
4176
+ #
4177
+ # @return [String, nil]
4178
+ optional :custom_credit_type_id, String
4179
+
4090
4180
  # @!attribute custom_fields
4091
4181
  # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
4092
4182
  #
@@ -4113,12 +4203,20 @@ module MetronomeSDK
4113
4203
  # @return [String, nil]
4114
4204
  optional :name, String
4115
4205
 
4206
+ # @!attribute product_custom_fields
4207
+ # Custom fields from the subscription product referenced by
4208
+ # `subscription_rate.product`. These are distinct from the subscription instance's
4209
+ # `custom_fields`.
4210
+ #
4211
+ # @return [Hash{Symbol=>String}, nil]
4212
+ optional :product_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
4213
+
4116
4214
  # @!attribute seat_config
4117
4215
  #
4118
4216
  # @return [MetronomeSDK::Models::ContractV2::Subscription::SeatConfig, nil]
4119
4217
  optional :seat_config, -> { MetronomeSDK::ContractV2::Subscription::SeatConfig }
4120
4218
 
4121
- # @!method initialize(billing_periods:, collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, seat_config: nil)
4219
+ # @!method initialize(billing_periods:, collection_schedule:, created_at:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_credit_type_id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, product_custom_fields: nil, seat_config: nil)
4122
4220
  # Some parameter documentations has been truncated, see
4123
4221
  # {MetronomeSDK::Models::ContractV2::Subscription} for more details.
4124
4222
  #
@@ -4126,6 +4224,8 @@ module MetronomeSDK
4126
4224
  #
4127
4225
  # @param collection_schedule [Symbol, MetronomeSDK::Models::ContractV2::Subscription::CollectionSchedule]
4128
4226
  #
4227
+ # @param created_at [Time]
4228
+ #
4129
4229
  # @param proration [MetronomeSDK::Models::ContractV2::Subscription::Proration]
4130
4230
  #
4131
4231
  # @param quantity_management_mode [Symbol, MetronomeSDK::Models::ContractV2::Subscription::QuantityManagementMode] Determines how the subscription's quantity is controlled. Defaults to QUANTITY_O
@@ -4140,6 +4240,8 @@ module MetronomeSDK
4140
4240
  #
4141
4241
  # @param billing_cycle_config [MetronomeSDK::Models::ContractV2::Subscription::BillingCycleConfig]
4142
4242
  #
4243
+ # @param custom_credit_type_id [String] If provided, the subscription's price will be in terms of this custom pricing un
4244
+ #
4143
4245
  # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
4144
4246
  #
4145
4247
  # @param description [String]
@@ -4150,6 +4252,8 @@ module MetronomeSDK
4150
4252
  #
4151
4253
  # @param name [String]
4152
4254
  #
4255
+ # @param product_custom_fields [Hash{Symbol=>String}] Custom fields from the subscription product referenced by `subscription_rate.pro
4256
+ #
4153
4257
  # @param seat_config [MetronomeSDK::Models::ContractV2::Subscription::SeatConfig]
4154
4258
 
4155
4259
  # @see MetronomeSDK::Models::ContractV2::Subscription#billing_periods
@@ -294,6 +294,12 @@ module MetronomeSDK
294
294
  # @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::AccessAmount]
295
295
  required :access_amount, -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount }
296
296
 
297
+ # @!attribute anchor_date
298
+ # The date this recurring commit's billing periods are anchored to.
299
+ #
300
+ # @return [Time]
301
+ required :anchor_date, Time
302
+
297
303
  # @!attribute commit_duration
298
304
  # The amount of time the created commits will be valid for
299
305
  #
@@ -425,7 +431,7 @@ module MetronomeSDK
425
431
  # @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
426
432
  optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
427
433
 
428
- # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
434
+ # @!method initialize(id:, access_amount:, anchor_date:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
429
435
  # Some parameter documentations has been truncated, see
430
436
  # {MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit} for more
431
437
  # details.
@@ -434,6 +440,8 @@ module MetronomeSDK
434
440
  #
435
441
  # @param access_amount [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::AccessAmount] The amount of commit to grant.
436
442
  #
443
+ # @param anchor_date [Time] The date this recurring commit's billing periods are anchored to.
444
+ #
437
445
  # @param commit_duration [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::CommitDuration] The amount of time the created commits will be valid for
438
446
  #
439
447
  # @param priority [Float] Will be passed down to the individual commits
@@ -477,6 +485,8 @@ module MetronomeSDK
477
485
  # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit#access_amount
478
486
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
479
487
  # @!attribute credit_type_id
488
+ # This ID identifies the credit type for the access amount. Quantity-based
489
+ # recurring commits and credits return the null credit type UUID.
480
490
  #
481
491
  # @return [String]
482
492
  required :credit_type_id, String
@@ -486,17 +496,47 @@ module MetronomeSDK
486
496
  # @return [Float]
487
497
  required :unit_price, Float
488
498
 
499
+ # @!attribute access_type
500
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
501
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
502
+ #
503
+ # @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType, nil]
504
+ optional :access_type,
505
+ enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType }
506
+
489
507
  # @!attribute quantity
490
508
  #
491
509
  # @return [Float, nil]
492
510
  optional :quantity, Float
493
511
 
494
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
512
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
513
+ # Some parameter documentations has been truncated, see
514
+ # {MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::AccessAmount}
515
+ # for more details.
516
+ #
495
517
  # The amount of commit to grant.
496
518
  #
497
- # @param credit_type_id [String]
519
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
520
+ #
498
521
  # @param unit_price [Float]
522
+ #
523
+ # @param access_type [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
524
+ #
499
525
  # @param quantity [Float]
526
+
527
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
528
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
529
+ #
530
+ # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit::AccessAmount#access_type
531
+ module AccessType
532
+ extend MetronomeSDK::Internal::Type::Enum
533
+
534
+ SPEND = :SPEND
535
+ QUANTITY = :QUANTITY
536
+
537
+ # @!method self.values
538
+ # @return [Array<Symbol>]
539
+ end
500
540
  end
501
541
 
502
542
  # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCommit#commit_duration
@@ -744,6 +784,12 @@ module MetronomeSDK
744
784
  # @return [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::AccessAmount]
745
785
  required :access_amount, -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount }
746
786
 
787
+ # @!attribute anchor_date
788
+ # The date this recurring commit's billing periods are anchored to.
789
+ #
790
+ # @return [Time]
791
+ required :anchor_date, Time
792
+
747
793
  # @!attribute commit_duration
748
794
  # The amount of time the created commits will be valid for
749
795
  #
@@ -869,7 +915,7 @@ module MetronomeSDK
869
915
  # @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
870
916
  optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
871
917
 
872
- # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
918
+ # @!method initialize(id:, access_amount:, anchor_date:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
873
919
  # Some parameter documentations has been truncated, see
874
920
  # {MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit} for more
875
921
  # details.
@@ -878,6 +924,8 @@ module MetronomeSDK
878
924
  #
879
925
  # @param access_amount [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::AccessAmount] The amount of commit to grant.
880
926
  #
927
+ # @param anchor_date [Time] The date this recurring commit's billing periods are anchored to.
928
+ #
881
929
  # @param commit_duration [MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::CommitDuration] The amount of time the created commits will be valid for
882
930
  #
883
931
  # @param priority [Float] Will be passed down to the individual commits
@@ -919,6 +967,8 @@ module MetronomeSDK
919
967
  # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit#access_amount
920
968
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
921
969
  # @!attribute credit_type_id
970
+ # This ID identifies the credit type for the access amount. Quantity-based
971
+ # recurring commits and credits return the null credit type UUID.
922
972
  #
923
973
  # @return [String]
924
974
  required :credit_type_id, String
@@ -928,17 +978,47 @@ module MetronomeSDK
928
978
  # @return [Float]
929
979
  required :unit_price, Float
930
980
 
981
+ # @!attribute access_type
982
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
983
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
984
+ #
985
+ # @return [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType, nil]
986
+ optional :access_type,
987
+ enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType }
988
+
931
989
  # @!attribute quantity
932
990
  #
933
991
  # @return [Float, nil]
934
992
  optional :quantity, Float
935
993
 
936
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
994
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
995
+ # Some parameter documentations has been truncated, see
996
+ # {MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::AccessAmount}
997
+ # for more details.
998
+ #
937
999
  # The amount of commit to grant.
938
1000
  #
939
- # @param credit_type_id [String]
1001
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
1002
+ #
940
1003
  # @param unit_price [Float]
1004
+ #
1005
+ # @param access_type [Symbol, MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
1006
+ #
941
1007
  # @param quantity [Float]
1008
+
1009
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1010
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1011
+ #
1012
+ # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit::AccessAmount#access_type
1013
+ module AccessType
1014
+ extend MetronomeSDK::Internal::Type::Enum
1015
+
1016
+ SPEND = :SPEND
1017
+ QUANTITY = :QUANTITY
1018
+
1019
+ # @!method self.values
1020
+ # @return [Array<Symbol>]
1021
+ end
942
1022
  end
943
1023
 
944
1024
  # @see MetronomeSDK::Models::ContractWithoutAmendments::RecurringCredit#commit_duration
@@ -57,6 +57,16 @@ module MetronomeSDK
57
57
  # @return [MetronomeSDK::Models::Credit::Contract, nil]
58
58
  optional :contract, -> { MetronomeSDK::Credit::Contract }
59
59
 
60
+ # @!attribute created_at
61
+ # Timestamp of when the credit was created.
62
+ #
63
+ # - Recurring credit: latter of credit service period date and parent credit start
64
+ # date
65
+ # - Rollover credit: when the new contract started
66
+ #
67
+ # @return [Time, nil]
68
+ optional :created_at, Time
69
+
60
70
  # @!attribute created_by
61
71
  # The actor who created this credit. Omitted for system-generated credits such as
62
72
  # recurring credits.
@@ -153,7 +163,7 @@ module MetronomeSDK
153
163
  # @return [String, nil]
154
164
  optional :uniqueness_key, String
155
165
 
156
- # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, created_by: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_credit_id: nil, rolled_over_from: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil, uniqueness_key: nil)
166
+ # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, created_at: nil, created_by: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_credit_id: nil, rolled_over_from: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil, uniqueness_key: nil)
157
167
  # Some parameter documentations has been truncated, see
158
168
  # {MetronomeSDK::Models::Credit} for more details.
159
169
  #
@@ -175,6 +185,8 @@ module MetronomeSDK
175
185
  #
176
186
  # @param contract [MetronomeSDK::Models::Credit::Contract]
177
187
  #
188
+ # @param created_at [Time] Timestamp of when the credit was created.
189
+ #
178
190
  # @param created_by [String] The actor who created this credit. Omitted for system-generated credits such as
179
191
  #
180
192
  # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }