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
@@ -616,6 +616,10 @@ module MetronomeSDK
616
616
  end
617
617
  attr_writer :access_amount
618
618
 
619
+ # The date this recurring commit's billing periods are anchored to.
620
+ sig { returns(Time) }
621
+ attr_accessor :anchor_date
622
+
619
623
  # The amount of time the created commits will be valid for
620
624
  sig do
621
625
  returns(
@@ -855,6 +859,7 @@ module MetronomeSDK
855
859
  id: String,
856
860
  access_amount:
857
861
  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::OrHash,
862
+ anchor_date: Time,
858
863
  commit_duration:
859
864
  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::CommitDuration::OrHash,
860
865
  priority: Float,
@@ -893,6 +898,8 @@ module MetronomeSDK
893
898
  id:,
894
899
  # The amount of commit to grant.
895
900
  access_amount:,
901
+ # The date this recurring commit's billing periods are anchored to.
902
+ anchor_date:,
896
903
  # The amount of time the created commits will be valid for
897
904
  commit_duration:,
898
905
  # Will be passed down to the individual commits
@@ -950,6 +957,7 @@ module MetronomeSDK
950
957
  id: String,
951
958
  access_amount:
952
959
  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount,
960
+ anchor_date: Time,
953
961
  commit_duration:
954
962
  MetronomeSDK::ContractWithoutAmendments::RecurringCommit::CommitDuration,
955
963
  priority: Float,
@@ -997,12 +1005,33 @@ module MetronomeSDK
997
1005
  )
998
1006
  end
999
1007
 
1008
+ # This ID identifies the credit type for the access amount. Quantity-based
1009
+ # recurring commits and credits return the null credit type UUID.
1000
1010
  sig { returns(String) }
1001
1011
  attr_accessor :credit_type_id
1002
1012
 
1003
1013
  sig { returns(Float) }
1004
1014
  attr_accessor :unit_price
1005
1015
 
1016
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1017
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1018
+ sig do
1019
+ returns(
1020
+ T.nilable(
1021
+ MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType::TaggedSymbol
1022
+ )
1023
+ )
1024
+ end
1025
+ attr_reader :access_type
1026
+
1027
+ sig do
1028
+ params(
1029
+ access_type:
1030
+ MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType::OrSymbol
1031
+ ).void
1032
+ end
1033
+ attr_writer :access_type
1034
+
1006
1035
  sig { returns(T.nilable(Float)) }
1007
1036
  attr_reader :quantity
1008
1037
 
@@ -1014,19 +1043,72 @@ module MetronomeSDK
1014
1043
  params(
1015
1044
  credit_type_id: String,
1016
1045
  unit_price: Float,
1046
+ access_type:
1047
+ MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType::OrSymbol,
1017
1048
  quantity: Float
1018
1049
  ).returns(T.attached_class)
1019
1050
  end
1020
- def self.new(credit_type_id:, unit_price:, quantity: nil)
1051
+ def self.new(
1052
+ # This ID identifies the credit type for the access amount. Quantity-based
1053
+ # recurring commits and credits return the null credit type UUID.
1054
+ credit_type_id:,
1055
+ unit_price:,
1056
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1057
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1058
+ access_type: nil,
1059
+ quantity: nil
1060
+ )
1021
1061
  end
1022
1062
 
1023
1063
  sig do
1024
1064
  override.returns(
1025
- { credit_type_id: String, unit_price: Float, quantity: Float }
1065
+ {
1066
+ credit_type_id: String,
1067
+ unit_price: Float,
1068
+ access_type:
1069
+ MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType::TaggedSymbol,
1070
+ quantity: Float
1071
+ }
1026
1072
  )
1027
1073
  end
1028
1074
  def to_hash
1029
1075
  end
1076
+
1077
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1078
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1079
+ module AccessType
1080
+ extend MetronomeSDK::Internal::Type::Enum
1081
+
1082
+ TaggedSymbol =
1083
+ T.type_alias do
1084
+ T.all(
1085
+ Symbol,
1086
+ MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType
1087
+ )
1088
+ end
1089
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1090
+
1091
+ SPEND =
1092
+ T.let(
1093
+ :SPEND,
1094
+ MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType::TaggedSymbol
1095
+ )
1096
+ QUANTITY =
1097
+ T.let(
1098
+ :QUANTITY,
1099
+ MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType::TaggedSymbol
1100
+ )
1101
+
1102
+ sig do
1103
+ override.returns(
1104
+ T::Array[
1105
+ MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount::AccessType::TaggedSymbol
1106
+ ]
1107
+ )
1108
+ end
1109
+ def self.values
1110
+ end
1111
+ end
1030
1112
  end
1031
1113
 
1032
1114
  class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
@@ -1612,6 +1694,10 @@ module MetronomeSDK
1612
1694
  end
1613
1695
  attr_writer :access_amount
1614
1696
 
1697
+ # The date this recurring commit's billing periods are anchored to.
1698
+ sig { returns(Time) }
1699
+ attr_accessor :anchor_date
1700
+
1615
1701
  # The amount of time the created commits will be valid for
1616
1702
  sig do
1617
1703
  returns(
@@ -1833,6 +1919,7 @@ module MetronomeSDK
1833
1919
  id: String,
1834
1920
  access_amount:
1835
1921
  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::OrHash,
1922
+ anchor_date: Time,
1836
1923
  commit_duration:
1837
1924
  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::CommitDuration::OrHash,
1838
1925
  priority: Float,
@@ -1869,6 +1956,8 @@ module MetronomeSDK
1869
1956
  id:,
1870
1957
  # The amount of commit to grant.
1871
1958
  access_amount:,
1959
+ # The date this recurring commit's billing periods are anchored to.
1960
+ anchor_date:,
1872
1961
  # The amount of time the created commits will be valid for
1873
1962
  commit_duration:,
1874
1963
  # Will be passed down to the individual commits
@@ -1924,6 +2013,7 @@ module MetronomeSDK
1924
2013
  id: String,
1925
2014
  access_amount:
1926
2015
  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount,
2016
+ anchor_date: Time,
1927
2017
  commit_duration:
1928
2018
  MetronomeSDK::ContractWithoutAmendments::RecurringCredit::CommitDuration,
1929
2019
  priority: Float,
@@ -1969,12 +2059,33 @@ module MetronomeSDK
1969
2059
  )
1970
2060
  end
1971
2061
 
2062
+ # This ID identifies the credit type for the access amount. Quantity-based
2063
+ # recurring commits and credits return the null credit type UUID.
1972
2064
  sig { returns(String) }
1973
2065
  attr_accessor :credit_type_id
1974
2066
 
1975
2067
  sig { returns(Float) }
1976
2068
  attr_accessor :unit_price
1977
2069
 
2070
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2071
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2072
+ sig do
2073
+ returns(
2074
+ T.nilable(
2075
+ MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType::TaggedSymbol
2076
+ )
2077
+ )
2078
+ end
2079
+ attr_reader :access_type
2080
+
2081
+ sig do
2082
+ params(
2083
+ access_type:
2084
+ MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType::OrSymbol
2085
+ ).void
2086
+ end
2087
+ attr_writer :access_type
2088
+
1978
2089
  sig { returns(T.nilable(Float)) }
1979
2090
  attr_reader :quantity
1980
2091
 
@@ -1986,19 +2097,72 @@ module MetronomeSDK
1986
2097
  params(
1987
2098
  credit_type_id: String,
1988
2099
  unit_price: Float,
2100
+ access_type:
2101
+ MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType::OrSymbol,
1989
2102
  quantity: Float
1990
2103
  ).returns(T.attached_class)
1991
2104
  end
1992
- def self.new(credit_type_id:, unit_price:, quantity: nil)
2105
+ def self.new(
2106
+ # This ID identifies the credit type for the access amount. Quantity-based
2107
+ # recurring commits and credits return the null credit type UUID.
2108
+ credit_type_id:,
2109
+ unit_price:,
2110
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2111
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2112
+ access_type: nil,
2113
+ quantity: nil
2114
+ )
1993
2115
  end
1994
2116
 
1995
2117
  sig do
1996
2118
  override.returns(
1997
- { credit_type_id: String, unit_price: Float, quantity: Float }
2119
+ {
2120
+ credit_type_id: String,
2121
+ unit_price: Float,
2122
+ access_type:
2123
+ MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType::TaggedSymbol,
2124
+ quantity: Float
2125
+ }
1998
2126
  )
1999
2127
  end
2000
2128
  def to_hash
2001
2129
  end
2130
+
2131
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2132
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2133
+ module AccessType
2134
+ extend MetronomeSDK::Internal::Type::Enum
2135
+
2136
+ TaggedSymbol =
2137
+ T.type_alias do
2138
+ T.all(
2139
+ Symbol,
2140
+ MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType
2141
+ )
2142
+ end
2143
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
2144
+
2145
+ SPEND =
2146
+ T.let(
2147
+ :SPEND,
2148
+ MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType::TaggedSymbol
2149
+ )
2150
+ QUANTITY =
2151
+ T.let(
2152
+ :QUANTITY,
2153
+ MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType::TaggedSymbol
2154
+ )
2155
+
2156
+ sig do
2157
+ override.returns(
2158
+ T::Array[
2159
+ MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount::AccessType::TaggedSymbol
2160
+ ]
2161
+ )
2162
+ end
2163
+ def self.values
2164
+ end
2165
+ end
2002
2166
  end
2003
2167
 
2004
2168
  class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
@@ -67,6 +67,17 @@ module MetronomeSDK
67
67
  sig { params(contract: MetronomeSDK::Credit::Contract::OrHash).void }
68
68
  attr_writer :contract
69
69
 
70
+ # Timestamp of when the credit was created.
71
+ #
72
+ # - Recurring credit: latter of credit service period date and parent credit start
73
+ # date
74
+ # - Rollover credit: when the new contract started
75
+ sig { returns(T.nilable(Time)) }
76
+ attr_reader :created_at
77
+
78
+ sig { params(created_at: Time).void }
79
+ attr_writer :created_at
80
+
70
81
  # The actor who created this credit. Omitted for system-generated credits such as
71
82
  # recurring credits.
72
83
  sig { returns(T.nilable(String)) }
@@ -222,6 +233,7 @@ module MetronomeSDK
222
233
  applicable_product_tags: T::Array[String],
223
234
  balance: Float,
224
235
  contract: MetronomeSDK::Credit::Contract::OrHash,
236
+ created_at: Time,
225
237
  created_by: String,
226
238
  custom_fields: T::Hash[Symbol, String],
227
239
  description: String,
@@ -271,6 +283,12 @@ module MetronomeSDK
271
283
  # included in the balance, including future-dated manual ledger entries.
272
284
  balance: nil,
273
285
  contract: nil,
286
+ # Timestamp of when the credit was created.
287
+ #
288
+ # - Recurring credit: latter of credit service period date and parent credit start
289
+ # date
290
+ # - Rollover credit: when the new contract started
291
+ created_at: nil,
274
292
  # The actor who created this credit. Omitted for system-generated credits such as
275
293
  # recurring credits.
276
294
  created_by: nil,
@@ -322,6 +340,7 @@ module MetronomeSDK
322
340
  applicable_product_tags: T::Array[String],
323
341
  balance: Float,
324
342
  contract: MetronomeSDK::Credit::Contract,
343
+ created_at: Time,
325
344
  created_by: String,
326
345
  custom_fields: T::Hash[Symbol, String],
327
346
  description: String,
@@ -184,6 +184,51 @@ module MetronomeSDK
184
184
  sig { params(applicable_product_tags: T::Array[String]).void }
185
185
  attr_writer :applicable_product_tags
186
186
 
187
+ # The length of time the created commit will be valid, starting from the end of
188
+ # the invoice's service period. If not provided, defaults to one year.
189
+ sig do
190
+ returns(
191
+ T.nilable(
192
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration
193
+ )
194
+ )
195
+ end
196
+ attr_reader :duration
197
+
198
+ sig do
199
+ params(
200
+ duration:
201
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::OrHash
202
+ ).void
203
+ end
204
+ attr_writer :duration
205
+
206
+ # Whether the created commits will be charged at commit rate or list rate.
207
+ sig do
208
+ returns(
209
+ T.nilable(
210
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::RateType::OrSymbol
211
+ )
212
+ )
213
+ end
214
+ attr_reader :rate_type
215
+
216
+ sig do
217
+ params(
218
+ rate_type:
219
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::RateType::OrSymbol
220
+ ).void
221
+ end
222
+ attr_writer :rate_type
223
+
224
+ # Fraction of the created commit's unused balance that will roll over. Must be
225
+ # between 0 and 1.
226
+ sig { returns(T.nilable(Float)) }
227
+ attr_reader :rollover_fraction
228
+
229
+ sig { params(rollover_fraction: Float).void }
230
+ attr_writer :rollover_fraction
231
+
187
232
  # List of filters that determine what kind of customer usage draws down a commit
188
233
  # or credit. A customer's usage needs to meet the condition of at least one of the
189
234
  # specifiers to contribute to a commit's or credit's drawdown. This field cannot
@@ -202,6 +247,11 @@ module MetronomeSDK
202
247
  params(
203
248
  applicable_product_ids: T::Array[String],
204
249
  applicable_product_tags: T::Array[String],
250
+ duration:
251
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::OrHash,
252
+ rate_type:
253
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::RateType::OrSymbol,
254
+ rollover_fraction: Float,
205
255
  specifiers: T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]
206
256
  ).returns(T.attached_class)
207
257
  end
@@ -214,6 +264,14 @@ module MetronomeSDK
214
264
  # applicable_product_tags or specifiers are not provided, the commit applies to
215
265
  # all products.
216
266
  applicable_product_tags: nil,
267
+ # The length of time the created commit will be valid, starting from the end of
268
+ # the invoice's service period. If not provided, defaults to one year.
269
+ duration: nil,
270
+ # Whether the created commits will be charged at commit rate or list rate.
271
+ rate_type: nil,
272
+ # Fraction of the created commit's unused balance that will roll over. Must be
273
+ # between 0 and 1.
274
+ rollover_fraction: nil,
217
275
  # List of filters that determine what kind of customer usage draws down a commit
218
276
  # or credit. A customer's usage needs to meet the condition of at least one of the
219
277
  # specifiers to contribute to a commit's or credit's drawdown. This field cannot
@@ -227,12 +285,140 @@ module MetronomeSDK
227
285
  {
228
286
  applicable_product_ids: T::Array[String],
229
287
  applicable_product_tags: T::Array[String],
288
+ duration:
289
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration,
290
+ rate_type:
291
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::RateType::OrSymbol,
292
+ rollover_fraction: Float,
230
293
  specifiers: T::Array[MetronomeSDK::CommitSpecifierInput]
231
294
  }
232
295
  )
233
296
  end
234
297
  def to_hash
235
298
  end
299
+
300
+ class Duration < MetronomeSDK::Internal::Type::BaseModel
301
+ OrHash =
302
+ T.type_alias do
303
+ T.any(
304
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration,
305
+ MetronomeSDK::Internal::AnyHash
306
+ )
307
+ end
308
+
309
+ sig do
310
+ returns(
311
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit::OrSymbol
312
+ )
313
+ end
314
+ attr_accessor :unit
315
+
316
+ sig { returns(Integer) }
317
+ attr_accessor :value
318
+
319
+ # The length of time the created commit will be valid, starting from the end of
320
+ # the invoice's service period. If not provided, defaults to one year.
321
+ sig do
322
+ params(
323
+ unit:
324
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit::OrSymbol,
325
+ value: Integer
326
+ ).returns(T.attached_class)
327
+ end
328
+ def self.new(unit:, value:)
329
+ end
330
+
331
+ sig do
332
+ override.returns(
333
+ {
334
+ unit:
335
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit::OrSymbol,
336
+ value: Integer
337
+ }
338
+ )
339
+ end
340
+ def to_hash
341
+ end
342
+
343
+ module Unit
344
+ extend MetronomeSDK::Internal::Type::Enum
345
+
346
+ TaggedSymbol =
347
+ T.type_alias do
348
+ T.all(
349
+ Symbol,
350
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit
351
+ )
352
+ end
353
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
354
+
355
+ DAYS =
356
+ T.let(
357
+ :DAYS,
358
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit::TaggedSymbol
359
+ )
360
+ WEEKS =
361
+ T.let(
362
+ :WEEKS,
363
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit::TaggedSymbol
364
+ )
365
+ MONTHS =
366
+ T.let(
367
+ :MONTHS,
368
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit::TaggedSymbol
369
+ )
370
+ YEARS =
371
+ T.let(
372
+ :YEARS,
373
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit::TaggedSymbol
374
+ )
375
+
376
+ sig do
377
+ override.returns(
378
+ T::Array[
379
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit::TaggedSymbol
380
+ ]
381
+ )
382
+ end
383
+ def self.values
384
+ end
385
+ end
386
+ end
387
+
388
+ # Whether the created commits will be charged at commit rate or list rate.
389
+ module RateType
390
+ extend MetronomeSDK::Internal::Type::Enum
391
+
392
+ TaggedSymbol =
393
+ T.type_alias do
394
+ T.all(
395
+ Symbol,
396
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::RateType
397
+ )
398
+ end
399
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
400
+
401
+ COMMIT_RATE =
402
+ T.let(
403
+ :COMMIT_RATE,
404
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::RateType::TaggedSymbol
405
+ )
406
+ LIST_RATE =
407
+ T.let(
408
+ :LIST_RATE,
409
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::RateType::TaggedSymbol
410
+ )
411
+
412
+ sig do
413
+ override.returns(
414
+ T::Array[
415
+ MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::RateType::TaggedSymbol
416
+ ]
417
+ )
418
+ end
419
+ def self.values
420
+ end
421
+ end
236
422
  end
237
423
 
238
424
  class DiscountConfiguration < MetronomeSDK::Internal::Type::BaseModel