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
@@ -386,12 +386,27 @@ module MetronomeSDK
386
386
  required :schedule_items,
387
387
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::ScheduleItem] }
388
388
 
389
- # @!method initialize(credit_type:, schedule_items:)
389
+ # @!attribute access_type
390
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
391
+ # usage. `QUANTITY` deducts the number of units used.
392
+ #
393
+ # @return [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType, nil]
394
+ optional :access_type,
395
+ enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType }
396
+
397
+ # @!method initialize(credit_type:, schedule_items:, access_type: nil)
398
+ # Some parameter documentations has been truncated, see
399
+ # {MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule}
400
+ # for more details.
401
+ #
390
402
  # The schedule that the customer will gain access to the credits purposed with
391
403
  # this commit.
392
404
  #
393
405
  # @param credit_type [MetronomeSDK::Models::CreditTypeData]
406
+ #
394
407
  # @param schedule_items [Array<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::ScheduleItem>]
408
+ #
409
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType] Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of usag
395
410
 
396
411
  class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
397
412
  # @!attribute id
@@ -484,6 +499,20 @@ module MetronomeSDK
484
499
  end
485
500
  end
486
501
  end
502
+
503
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
504
+ # usage. `QUANTITY` deducts the number of units used.
505
+ #
506
+ # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule#access_type
507
+ module AccessType
508
+ extend MetronomeSDK::Internal::Type::Enum
509
+
510
+ SPEND = :SPEND
511
+ QUANTITY = :QUANTITY
512
+
513
+ # @!method self.values
514
+ # @return [Array<Symbol>]
515
+ end
487
516
  end
488
517
 
489
518
  # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit#invoice_schedule
@@ -1025,6 +1054,7 @@ module MetronomeSDK
1025
1054
 
1026
1055
  FIRST_OF_MONTH = :FIRST_OF_MONTH
1027
1056
  CONTRACT_START = :CONTRACT_START
1057
+ CUSTOM_DATE = :CUSTOM_DATE
1028
1058
 
1029
1059
  # @!method self.values
1030
1060
  # @return [Array<Symbol>]
@@ -1190,9 +1220,24 @@ module MetronomeSDK
1190
1220
  required :schedule_items,
1191
1221
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::ScheduleItem] }
1192
1222
 
1193
- # @!method initialize(credit_type:, schedule_items:)
1223
+ # @!attribute access_type
1224
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
1225
+ # usage. `QUANTITY` deducts the number of units used.
1226
+ #
1227
+ # @return [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType, nil]
1228
+ optional :access_type,
1229
+ enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType }
1230
+
1231
+ # @!method initialize(credit_type:, schedule_items:, access_type: nil)
1232
+ # Some parameter documentations has been truncated, see
1233
+ # {MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule}
1234
+ # for more details.
1235
+ #
1194
1236
  # @param credit_type [MetronomeSDK::Models::CreditTypeData]
1237
+ #
1195
1238
  # @param schedule_items [Array<MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::ScheduleItem>]
1239
+ #
1240
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType] Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of usag
1196
1241
 
1197
1242
  class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
1198
1243
  # @!attribute id
@@ -1285,6 +1330,20 @@ module MetronomeSDK
1285
1330
  end
1286
1331
  end
1287
1332
  end
1333
+
1334
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
1335
+ # usage. `QUANTITY` deducts the number of units used.
1336
+ #
1337
+ # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule#access_type
1338
+ module AccessType
1339
+ extend MetronomeSDK::Internal::Type::Enum
1340
+
1341
+ SPEND = :SPEND
1342
+ QUANTITY = :QUANTITY
1343
+
1344
+ # @!method self.values
1345
+ # @return [Array<Symbol>]
1346
+ end
1288
1347
  end
1289
1348
 
1290
1349
  # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit#rate_type
@@ -1538,6 +1597,8 @@ module MetronomeSDK
1538
1597
  # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit#access_amount
1539
1598
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
1540
1599
  # @!attribute credit_type_id
1600
+ # This ID identifies the credit type for the access amount. Quantity-based
1601
+ # recurring commits and credits return the null credit type UUID.
1541
1602
  #
1542
1603
  # @return [String]
1543
1604
  required :credit_type_id, String
@@ -1547,17 +1608,47 @@ module MetronomeSDK
1547
1608
  # @return [Float]
1548
1609
  required :unit_price, Float
1549
1610
 
1611
+ # @!attribute access_type
1612
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1613
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1614
+ #
1615
+ # @return [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType, nil]
1616
+ optional :access_type,
1617
+ enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType }
1618
+
1550
1619
  # @!attribute quantity
1551
1620
  #
1552
1621
  # @return [Float, nil]
1553
1622
  optional :quantity, Float
1554
1623
 
1555
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
1624
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
1625
+ # Some parameter documentations has been truncated, see
1626
+ # {MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount}
1627
+ # for more details.
1628
+ #
1556
1629
  # The amount of commit to grant.
1557
1630
  #
1558
- # @param credit_type_id [String]
1631
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
1632
+ #
1559
1633
  # @param unit_price [Float]
1634
+ #
1635
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
1636
+ #
1560
1637
  # @param quantity [Float]
1638
+
1639
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1640
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1641
+ #
1642
+ # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount#access_type
1643
+ module AccessType
1644
+ extend MetronomeSDK::Internal::Type::Enum
1645
+
1646
+ SPEND = :SPEND
1647
+ QUANTITY = :QUANTITY
1648
+
1649
+ # @!method self.values
1650
+ # @return [Array<Symbol>]
1651
+ end
1561
1652
  end
1562
1653
 
1563
1654
  # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit#commit_duration
@@ -2071,6 +2162,8 @@ module MetronomeSDK
2071
2162
  # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit#access_amount
2072
2163
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
2073
2164
  # @!attribute credit_type_id
2165
+ # This ID identifies the credit type for the access amount. Quantity-based
2166
+ # recurring commits and credits return the null credit type UUID.
2074
2167
  #
2075
2168
  # @return [String]
2076
2169
  required :credit_type_id, String
@@ -2080,17 +2173,47 @@ module MetronomeSDK
2080
2173
  # @return [Float]
2081
2174
  required :unit_price, Float
2082
2175
 
2176
+ # @!attribute access_type
2177
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2178
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2179
+ #
2180
+ # @return [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType, nil]
2181
+ optional :access_type,
2182
+ enum: -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType }
2183
+
2083
2184
  # @!attribute quantity
2084
2185
  #
2085
2186
  # @return [Float, nil]
2086
2187
  optional :quantity, Float
2087
2188
 
2088
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
2189
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
2190
+ # Some parameter documentations has been truncated, see
2191
+ # {MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount}
2192
+ # for more details.
2193
+ #
2089
2194
  # The amount of commit to grant.
2090
2195
  #
2091
- # @param credit_type_id [String]
2196
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
2197
+ #
2092
2198
  # @param unit_price [Float]
2199
+ #
2200
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
2201
+ #
2093
2202
  # @param quantity [Float]
2203
+
2204
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2205
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2206
+ #
2207
+ # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount#access_type
2208
+ module AccessType
2209
+ extend MetronomeSDK::Internal::Type::Enum
2210
+
2211
+ SPEND = :SPEND
2212
+ QUANTITY = :QUANTITY
2213
+
2214
+ # @!method self.values
2215
+ # @return [Array<Symbol>]
2216
+ end
2094
2217
  end
2095
2218
 
2096
2219
  # @see MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit#commit_duration
@@ -2513,6 +2636,13 @@ module MetronomeSDK
2513
2636
  optional :billing_cycle_config,
2514
2637
  -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::BillingCycleConfig }
2515
2638
 
2639
+ # @!attribute custom_credit_type_id
2640
+ # If provided, the subscription's price will be in terms of this custom pricing
2641
+ # unit instead of the fiat currency.
2642
+ #
2643
+ # @return [String, nil]
2644
+ optional :custom_credit_type_id, String
2645
+
2516
2646
  # @!attribute custom_fields
2517
2647
  # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
2518
2648
  #
@@ -2571,7 +2701,7 @@ module MetronomeSDK
2571
2701
  optional :starting_at_offset,
2572
2702
  -> { MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::StartingAtOffset }
2573
2703
 
2574
- # @!method initialize(collection_schedule:, proration:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_fields: nil, description: nil, duration: nil, fiat_credit_type_id: nil, initial_quantity: nil, name: nil, quantity_management_mode: nil, seat_config: nil, starting_at_offset: nil)
2704
+ # @!method initialize(collection_schedule:, proration:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_credit_type_id: nil, custom_fields: nil, description: nil, duration: nil, fiat_credit_type_id: nil, initial_quantity: nil, name: nil, quantity_management_mode: nil, seat_config: nil, starting_at_offset: nil)
2575
2705
  # Some parameter documentations has been truncated, see
2576
2706
  # {MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription} for more
2577
2707
  # details.
@@ -2586,6 +2716,8 @@ module MetronomeSDK
2586
2716
  #
2587
2717
  # @param billing_cycle_config [MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::BillingCycleConfig]
2588
2718
  #
2719
+ # @param custom_credit_type_id [String] If provided, the subscription's price will be in terms of this custom pricing un
2720
+ #
2589
2721
  # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
2590
2722
  #
2591
2723
  # @param description [String]
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ # @see MetronomeSDK::Resources::V1::PricingUnits#archive
7
+ class PricingUnitArchiveParams < MetronomeSDK::Models::ID
8
+ extend MetronomeSDK::Internal::Type::RequestParameters::Converter
9
+ include MetronomeSDK::Internal::Type::RequestParameters
10
+
11
+ # @!method initialize(request_options: {})
12
+ # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
13
+ end
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ # @see MetronomeSDK::Resources::V1::PricingUnits#archive
7
+ class PricingUnitArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [MetronomeSDK::Models::ID]
11
+ required :data, -> { MetronomeSDK::ID }
12
+
13
+ # @!method initialize(data:)
14
+ # @param data [MetronomeSDK::Models::ID]
15
+ end
16
+ end
17
+ end
18
+ end
@@ -0,0 +1,24 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ # @see MetronomeSDK::Resources::V1::PricingUnits#create
7
+ class PricingUnitCreateParams < MetronomeSDK::Internal::Type::BaseModel
8
+ extend MetronomeSDK::Internal::Type::RequestParameters::Converter
9
+ include MetronomeSDK::Internal::Type::RequestParameters
10
+
11
+ # @!attribute name
12
+ # The name of the custom pricing unit. This will appear on invoices.
13
+ #
14
+ # @return [String]
15
+ required :name, String
16
+
17
+ # @!method initialize(name:, request_options: {})
18
+ # @param name [String] The name of the custom pricing unit. This will appear on invoices.
19
+ #
20
+ # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ # @see MetronomeSDK::Resources::V1::PricingUnits#create
7
+ class PricingUnitCreateResponse < MetronomeSDK::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [MetronomeSDK::Models::ID]
11
+ required :data, -> { MetronomeSDK::ID }
12
+
13
+ # @!method initialize(data:)
14
+ # @param data [MetronomeSDK::Models::ID]
15
+ end
16
+ end
17
+ end
18
+ end
@@ -9,11 +9,13 @@ module MetronomeSDK
9
9
  include MetronomeSDK::Internal::Type::RequestParameters
10
10
 
11
11
  # @!attribute ending_before
12
+ # Must be aligned to UTC midnight and at least one day after `starting_on`.
12
13
  #
13
14
  # @return [Time]
14
15
  required :ending_before, Time
15
16
 
16
17
  # @!attribute starting_on
18
+ # Must be aligned to UTC midnight, e.g. `2024-01-01T00:00:00Z`.
17
19
  #
18
20
  # @return [Time]
19
21
  required :starting_on, Time
@@ -51,9 +53,9 @@ module MetronomeSDK
51
53
  # Some parameter documentations has been truncated, see
52
54
  # {MetronomeSDK::Models::V1::UsageListParams} for more details.
53
55
  #
54
- # @param ending_before [Time]
56
+ # @param ending_before [Time] Must be aligned to UTC midnight and at least one day after `starting_on`.
55
57
  #
56
- # @param starting_on [Time]
58
+ # @param starting_on [Time] Must be aligned to UTC midnight, e.g. `2024-01-01T00:00:00Z`.
57
59
  #
58
60
  # @param window_size [Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize] A window_size of "day" or "hour" will return the usage for the specified period
59
61
  #
@@ -40,13 +40,14 @@ module MetronomeSDK
40
40
 
41
41
  # @!attribute current_period
42
42
  # If true, will return the usage for the current billing period. Will return an
43
- # error if the customer is currently uncontracted or starting_on and ending_before
44
- # are specified when this is true.
43
+ # error if the customer does not have an active plan, or if starting_on and
44
+ # ending_before are specified when this is true.
45
45
  #
46
46
  # @return [Boolean, nil]
47
47
  optional :current_period, MetronomeSDK::Internal::Type::Boolean
48
48
 
49
49
  # @!attribute ending_before
50
+ # Must be aligned to UTC midnight and at least one day after `starting_on`.
50
51
  #
51
52
  # @return [Time, nil]
52
53
  optional :ending_before, Time
@@ -63,7 +64,8 @@ module MetronomeSDK
63
64
  # @!attribute group_filters
64
65
  # Object mapping group keys to arrays of values to filter on. Only usage matching
65
66
  # these filter values will be returned. Keys must be present in group_key. Omit a
66
- # key or use an empty array to include all values for that dimension.
67
+ # key or use an empty array to include all values for that dimension. The combined
68
+ # number of entries across all value arrays may not exceed 200.
67
69
  #
68
70
  # @return [Hash{Symbol=>Array<String>}, nil]
69
71
  optional :group_filters,
@@ -86,6 +88,7 @@ module MetronomeSDK
86
88
  optional :group_key, MetronomeSDK::Internal::Type::ArrayOf[String]
87
89
 
88
90
  # @!attribute starting_on
91
+ # Must be aligned to UTC midnight, e.g. `2024-01-01T00:00:00Z`.
89
92
  #
90
93
  # @return [Time, nil]
91
94
  optional :starting_on, Time
@@ -106,7 +109,7 @@ module MetronomeSDK
106
109
  #
107
110
  # @param current_period [Boolean] If true, will return the usage for the current billing period. Will return an er
108
111
  #
109
- # @param ending_before [Time]
112
+ # @param ending_before [Time] Must be aligned to UTC midnight and at least one day after `starting_on`.
110
113
  #
111
114
  # @param group_by [MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy] Use group_key and group_filters instead. Use a single group key to group by. Com
112
115
  #
@@ -114,7 +117,7 @@ module MetronomeSDK
114
117
  #
115
118
  # @param group_key [Array<String>] Group key to group usage by. Supports both simple (single key) and compound (mul
116
119
  #
117
- # @param starting_on [Time]
120
+ # @param starting_on [Time] Must be aligned to UTC midnight, e.g. `2024-01-01T00:00:00Z`.
118
121
  #
119
122
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
120
123
 
@@ -141,8 +144,8 @@ module MetronomeSDK
141
144
  required :key, String
142
145
 
143
146
  # @!attribute values
144
- # Values of the group_by key to return in the query. Omit this if you'd like all
145
- # values for the key returned.
147
+ # Values of the group_by key to return in the query. Accepts at most 200 values.
148
+ # Omit this if you'd like all values for the key returned.
146
149
  #
147
150
  # @return [Array<String>, nil]
148
151
  optional :values, MetronomeSDK::Internal::Type::ArrayOf[String]
@@ -156,7 +159,7 @@ module MetronomeSDK
156
159
  #
157
160
  # @param key [String] The name of the group_by key to use
158
161
  #
159
- # @param values [Array<String>] Values of the group_by key to return in the query. Omit this if you'd like all v
162
+ # @param values [Array<String>] Values of the group_by key to return in the query. Accepts at most 200 values. O
160
163
  end
161
164
  end
162
165
  end