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
@@ -254,6 +254,26 @@ module MetronomeSDK
254
254
  end
255
255
  attr_accessor :schedule_items
256
256
 
257
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
258
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
259
+ # omitted.
260
+ sig do
261
+ returns(
262
+ T.nilable(
263
+ MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::AccessType::OrSymbol
264
+ )
265
+ )
266
+ end
267
+ attr_reader :access_type
268
+
269
+ sig do
270
+ params(
271
+ access_type:
272
+ MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::AccessType::OrSymbol
273
+ ).void
274
+ end
275
+ attr_writer :access_type
276
+
257
277
  # Defaults to USD (cents) if not passed
258
278
  sig { returns(T.nilable(String)) }
259
279
  attr_reader :credit_type_id
@@ -268,11 +288,17 @@ module MetronomeSDK
268
288
  T::Array[
269
289
  MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem::OrHash
270
290
  ],
291
+ access_type:
292
+ MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::AccessType::OrSymbol,
271
293
  credit_type_id: String
272
294
  ).returns(T.attached_class)
273
295
  end
274
296
  def self.new(
275
297
  schedule_items:,
298
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
299
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
300
+ # omitted.
301
+ access_type: nil,
276
302
  # Defaults to USD (cents) if not passed
277
303
  credit_type_id: nil
278
304
  )
@@ -285,6 +311,8 @@ module MetronomeSDK
285
311
  T::Array[
286
312
  MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem
287
313
  ],
314
+ access_type:
315
+ MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::AccessType::OrSymbol,
288
316
  credit_type_id: String
289
317
  }
290
318
  )
@@ -336,6 +364,43 @@ module MetronomeSDK
336
364
  def to_hash
337
365
  end
338
366
  end
367
+
368
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
369
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
370
+ # omitted.
371
+ module AccessType
372
+ extend MetronomeSDK::Internal::Type::Enum
373
+
374
+ TaggedSymbol =
375
+ T.type_alias do
376
+ T.all(
377
+ Symbol,
378
+ MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::AccessType
379
+ )
380
+ end
381
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
382
+
383
+ SPEND =
384
+ T.let(
385
+ :SPEND,
386
+ MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::AccessType::TaggedSymbol
387
+ )
388
+ QUANTITY =
389
+ T.let(
390
+ :QUANTITY,
391
+ MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::AccessType::TaggedSymbol
392
+ )
393
+
394
+ sig do
395
+ override.returns(
396
+ T::Array[
397
+ MetronomeSDK::V1::Customers::CreditCreateParams::AccessSchedule::AccessType::TaggedSymbol
398
+ ]
399
+ )
400
+ end
401
+ def self.values
402
+ end
403
+ end
339
404
  end
340
405
 
341
406
  module RateType
@@ -116,9 +116,36 @@ module MetronomeSDK
116
116
  sig { returns(Time) }
117
117
  attr_accessor :updated_at
118
118
 
119
- # Present for `low_remaining_contract_credit_and_commit_balance_reached`
120
- # notifications. The filters that define the balances that are considered when
121
- # evaluating the alert.
119
+ # Indicates the commit access type this notification is scoped to. Defaults to
120
+ # `SPEND` if not otherwise specified. Only present for
121
+ # `low_remaining_commit_balance_reached`,
122
+ # `low_remaining_commit_percentage_reached`,
123
+ # `low_remaining_contract_credit_and_commit_balance_reached`,
124
+ # `low_remaining_contract_credit_and_commit_percentage_reached`,
125
+ # `low_remaining_contract_credit_balance_reached`,
126
+ # `low_remaining_contract_credit_percentage_reached`, and
127
+ # `low_remaining_seat_balance_reached` notifications.
128
+ sig do
129
+ returns(
130
+ T.nilable(
131
+ MetronomeSDK::V1::Customers::CustomerAlert::Alert::AccessType::TaggedSymbol
132
+ )
133
+ )
134
+ end
135
+ attr_reader :access_type
136
+
137
+ sig do
138
+ params(
139
+ access_type:
140
+ MetronomeSDK::V1::Customers::CustomerAlert::Alert::AccessType::OrSymbol
141
+ ).void
142
+ end
143
+ attr_writer :access_type
144
+
145
+ # Present for `low_remaining_contract_credit_and_commit_balance_reached` and
146
+ # `low_remaining_contract_credit_and_commit_percentage_reached` notifications. The
147
+ # filters that define the commits and credits used to calculate the remaining
148
+ # balance or percentage.
122
149
  sig do
123
150
  returns(
124
151
  T.nilable(
@@ -271,6 +298,8 @@ module MetronomeSDK
271
298
  type:
272
299
  MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type::OrSymbol,
273
300
  updated_at: Time,
301
+ access_type:
302
+ MetronomeSDK::V1::Customers::CustomerAlert::Alert::AccessType::OrSymbol,
274
303
  alert_specifiers:
275
304
  T::Array[
276
305
  MetronomeSDK::V1::Customers::CustomerAlert::Alert::AlertSpecifier::OrHash
@@ -306,9 +335,20 @@ module MetronomeSDK
306
335
  type:,
307
336
  # Timestamp for when the threshold notification's customer status was last updated
308
337
  updated_at:,
309
- # Present for `low_remaining_contract_credit_and_commit_balance_reached`
310
- # notifications. The filters that define the balances that are considered when
311
- # evaluating the alert.
338
+ # Indicates the commit access type this notification is scoped to. Defaults to
339
+ # `SPEND` if not otherwise specified. Only present for
340
+ # `low_remaining_commit_balance_reached`,
341
+ # `low_remaining_commit_percentage_reached`,
342
+ # `low_remaining_contract_credit_and_commit_balance_reached`,
343
+ # `low_remaining_contract_credit_and_commit_percentage_reached`,
344
+ # `low_remaining_contract_credit_balance_reached`,
345
+ # `low_remaining_contract_credit_percentage_reached`, and
346
+ # `low_remaining_seat_balance_reached` notifications.
347
+ access_type: nil,
348
+ # Present for `low_remaining_contract_credit_and_commit_balance_reached` and
349
+ # `low_remaining_contract_credit_and_commit_percentage_reached` notifications. The
350
+ # filters that define the commits and credits used to calculate the remaining
351
+ # balance or percentage.
312
352
  alert_specifiers: nil,
313
353
  # An array of strings, representing a way to filter the credit grant this
314
354
  # threshold notification applies to, by looking at the credit_grant_type field on
@@ -349,6 +389,8 @@ module MetronomeSDK
349
389
  type:
350
390
  MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type::TaggedSymbol,
351
391
  updated_at: Time,
392
+ access_type:
393
+ MetronomeSDK::V1::Customers::CustomerAlert::Alert::AccessType::TaggedSymbol,
352
394
  alert_specifiers:
353
395
  T::Array[
354
396
  MetronomeSDK::V1::Customers::CustomerAlert::Alert::AlertSpecifier
@@ -493,6 +535,11 @@ module MetronomeSDK
493
535
  :low_remaining_contract_credit_and_commit_balance_reached,
494
536
  MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type::TaggedSymbol
495
537
  )
538
+ LOW_REMAINING_CONTRACT_CREDIT_AND_COMMIT_PERCENTAGE_REACHED =
539
+ T.let(
540
+ :low_remaining_contract_credit_and_commit_percentage_reached,
541
+ MetronomeSDK::V1::Customers::CustomerAlert::Alert::Type::TaggedSymbol
542
+ )
496
543
  LOW_REMAINING_SEAT_BALANCE_REACHED =
497
544
  T.let(
498
545
  :low_remaining_seat_balance_reached,
@@ -515,6 +562,49 @@ module MetronomeSDK
515
562
  end
516
563
  end
517
564
 
565
+ # Indicates the commit access type this notification is scoped to. Defaults to
566
+ # `SPEND` if not otherwise specified. Only present for
567
+ # `low_remaining_commit_balance_reached`,
568
+ # `low_remaining_commit_percentage_reached`,
569
+ # `low_remaining_contract_credit_and_commit_balance_reached`,
570
+ # `low_remaining_contract_credit_and_commit_percentage_reached`,
571
+ # `low_remaining_contract_credit_balance_reached`,
572
+ # `low_remaining_contract_credit_percentage_reached`, and
573
+ # `low_remaining_seat_balance_reached` notifications.
574
+ module AccessType
575
+ extend MetronomeSDK::Internal::Type::Enum
576
+
577
+ TaggedSymbol =
578
+ T.type_alias do
579
+ T.all(
580
+ Symbol,
581
+ MetronomeSDK::V1::Customers::CustomerAlert::Alert::AccessType
582
+ )
583
+ end
584
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
585
+
586
+ SPEND =
587
+ T.let(
588
+ :SPEND,
589
+ MetronomeSDK::V1::Customers::CustomerAlert::Alert::AccessType::TaggedSymbol
590
+ )
591
+ QUANTITY =
592
+ T.let(
593
+ :QUANTITY,
594
+ MetronomeSDK::V1::Customers::CustomerAlert::Alert::AccessType::TaggedSymbol
595
+ )
596
+
597
+ sig do
598
+ override.returns(
599
+ T::Array[
600
+ MetronomeSDK::V1::Customers::CustomerAlert::Alert::AccessType::TaggedSymbol
601
+ ]
602
+ )
603
+ end
604
+ def self.values
605
+ end
606
+ end
607
+
518
608
  class AlertSpecifier < MetronomeSDK::Internal::Type::BaseModel
519
609
  OrHash =
520
610
  T.type_alias do
@@ -45,7 +45,8 @@ module MetronomeSDK
45
45
  sig { params(amendment_id: String).void }
46
46
  attr_writer :amendment_id
47
47
 
48
- # This field's availability is dependent on your client's configuration.
48
+ # Indicates if the invoice has been or will be sent to the configured customer
49
+ # billing provider. Defaults to `billable`.
49
50
  sig { returns(T.nilable(T.anything)) }
50
51
  attr_reader :billable_status
51
52
 
@@ -339,7 +340,8 @@ module MetronomeSDK
339
340
  total:,
340
341
  type:,
341
342
  amendment_id: nil,
342
- # This field's availability is dependent on your client's configuration.
343
+ # Indicates if the invoice has been or will be sent to the configured customer
344
+ # billing provider. Defaults to `billable`.
343
345
  billable_status: nil,
344
346
  # Required on invoices with type USAGE_CONSOLIDATED. List of constituent invoices
345
347
  # that were consolidated to create this invoice.
@@ -490,8 +492,8 @@ module MetronomeSDK
490
492
  attr_accessor :type
491
493
 
492
494
  # Details about the credit or commit that was applied to this line item. Only
493
- # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
494
- # types.
495
+ # present on line items with product of `USAGE`, `SUBSCRIPTION`, `COMPOSITE`, or
496
+ # `CPU_CONVERSION` types.
495
497
  sig do
496
498
  returns(
497
499
  T.nilable(
@@ -516,10 +518,10 @@ module MetronomeSDK
516
518
  sig { params(commit_custom_fields: T::Hash[Symbol, String]).void }
517
519
  attr_writer :commit_custom_fields
518
520
 
519
- # For line items with product of `USAGE`, `SUBSCRIPTION`, or `COMPOSITE` types,
520
- # the ID of the credit or commit that was applied to this line item. For line
521
- # items with product type of `FIXED`, the ID of the prepaid or postpaid commit
522
- # that is being paid for.
521
+ # For line items with product of `USAGE`, `SUBSCRIPTION`, `COMPOSITE`, or
522
+ # `CPU_CONVERSION` types, the ID of the credit or commit that was applied to this
523
+ # line item. For line items with product type of `FIXED`, the ID of the prepaid or
524
+ # postpaid commit that is being paid for.
523
525
  sig { returns(T.nilable(String)) }
524
526
  attr_reader :commit_id
525
527
 
@@ -745,6 +747,14 @@ module MetronomeSDK
745
747
  sig { params(quantity: Float).void }
746
748
  attr_writer :quantity
747
749
 
750
+ # Present on applied commit line items for quantity-based commits. Represents the
751
+ # unit quantity deducted the commit.
752
+ sig { returns(T.nilable(Float)) }
753
+ attr_reader :quantity_consumed
754
+
755
+ sig { params(quantity_consumed: Float).void }
756
+ attr_writer :quantity_consumed
757
+
748
758
  sig do
749
759
  returns(
750
760
  T.nilable(
@@ -887,6 +897,7 @@ module MetronomeSDK
887
897
  professional_service_custom_fields: T::Hash[Symbol, String],
888
898
  professional_service_id: String,
889
899
  quantity: Float,
900
+ quantity_consumed: Float,
890
901
  reseller_type:
891
902
  MetronomeSDK::V1::Customers::Invoice::LineItem::ResellerType::OrSymbol,
892
903
  scheduled_charge_custom_fields: T::Hash[Symbol, String],
@@ -932,15 +943,15 @@ module MetronomeSDK
932
943
  # converted to fiat currency using a cpu_conversion line item.
933
944
  type:,
934
945
  # Details about the credit or commit that was applied to this line item. Only
935
- # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
936
- # types.
946
+ # present on line items with product of `USAGE`, `SUBSCRIPTION`, `COMPOSITE`, or
947
+ # `CPU_CONVERSION` types.
937
948
  applied_commit_or_credit: nil,
938
949
  # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
939
950
  commit_custom_fields: nil,
940
- # For line items with product of `USAGE`, `SUBSCRIPTION`, or `COMPOSITE` types,
941
- # the ID of the credit or commit that was applied to this line item. For line
942
- # items with product type of `FIXED`, the ID of the prepaid or postpaid commit
943
- # that is being paid for.
951
+ # For line items with product of `USAGE`, `SUBSCRIPTION`, `COMPOSITE`, or
952
+ # `CPU_CONVERSION` types, the ID of the credit or commit that was applied to this
953
+ # line item. For line items with product type of `FIXED`, the ID of the prepaid or
954
+ # postpaid commit that is being paid for.
944
955
  commit_id: nil,
945
956
  commit_netsuite_item_id: nil,
946
957
  commit_netsuite_sales_order_id: nil,
@@ -999,6 +1010,9 @@ module MetronomeSDK
999
1010
  professional_service_id: nil,
1000
1011
  # The quantity associated with the line item.
1001
1012
  quantity: nil,
1013
+ # Present on applied commit line items for quantity-based commits. Represents the
1014
+ # unit quantity deducted the commit.
1015
+ quantity_consumed: nil,
1002
1016
  reseller_type: nil,
1003
1017
  # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
1004
1018
  scheduled_charge_custom_fields: nil,
@@ -1059,6 +1073,7 @@ module MetronomeSDK
1059
1073
  professional_service_custom_fields: T::Hash[Symbol, String],
1060
1074
  professional_service_id: String,
1061
1075
  quantity: Float,
1076
+ quantity_consumed: Float,
1062
1077
  reseller_type:
1063
1078
  MetronomeSDK::V1::Customers::Invoice::LineItem::ResellerType::TaggedSymbol,
1064
1079
  scheduled_charge_custom_fields: T::Hash[Symbol, String],
@@ -1097,17 +1112,44 @@ module MetronomeSDK
1097
1112
  end
1098
1113
  attr_accessor :type
1099
1114
 
1115
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
1116
+ # usage. `QUANTITY` deducts the number of units used.
1117
+ sig do
1118
+ returns(
1119
+ T.nilable(
1120
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType::TaggedSymbol
1121
+ )
1122
+ )
1123
+ end
1124
+ attr_reader :access_type
1125
+
1126
+ sig do
1127
+ params(
1128
+ access_type:
1129
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType::OrSymbol
1130
+ ).void
1131
+ end
1132
+ attr_writer :access_type
1133
+
1100
1134
  # Details about the credit or commit that was applied to this line item. Only
1101
- # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
1102
- # types.
1135
+ # present on line items with product of `USAGE`, `SUBSCRIPTION`, `COMPOSITE`, or
1136
+ # `CPU_CONVERSION` types.
1103
1137
  sig do
1104
1138
  params(
1105
1139
  id: String,
1106
1140
  type:
1107
- MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type::OrSymbol
1141
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type::OrSymbol,
1142
+ access_type:
1143
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType::OrSymbol
1108
1144
  ).returns(T.attached_class)
1109
1145
  end
1110
- def self.new(id:, type:)
1146
+ def self.new(
1147
+ id:,
1148
+ type:,
1149
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
1150
+ # usage. `QUANTITY` deducts the number of units used.
1151
+ access_type: nil
1152
+ )
1111
1153
  end
1112
1154
 
1113
1155
  sig do
@@ -1115,7 +1157,9 @@ module MetronomeSDK
1115
1157
  {
1116
1158
  id: String,
1117
1159
  type:
1118
- MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type::TaggedSymbol
1160
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::Type::TaggedSymbol,
1161
+ access_type:
1162
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType::TaggedSymbol
1119
1163
  }
1120
1164
  )
1121
1165
  end
@@ -1160,6 +1204,42 @@ module MetronomeSDK
1160
1204
  def self.values
1161
1205
  end
1162
1206
  end
1207
+
1208
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
1209
+ # usage. `QUANTITY` deducts the number of units used.
1210
+ module AccessType
1211
+ extend MetronomeSDK::Internal::Type::Enum
1212
+
1213
+ TaggedSymbol =
1214
+ T.type_alias do
1215
+ T.all(
1216
+ Symbol,
1217
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType
1218
+ )
1219
+ end
1220
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1221
+
1222
+ SPEND =
1223
+ T.let(
1224
+ :SPEND,
1225
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType::TaggedSymbol
1226
+ )
1227
+ QUANTITY =
1228
+ T.let(
1229
+ :QUANTITY,
1230
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType::TaggedSymbol
1231
+ )
1232
+
1233
+ sig do
1234
+ override.returns(
1235
+ T::Array[
1236
+ MetronomeSDK::V1::Customers::Invoice::LineItem::AppliedCommitOrCredit::AccessType::TaggedSymbol
1237
+ ]
1238
+ )
1239
+ end
1240
+ def self.values
1241
+ end
1242
+ end
1163
1243
  end
1164
1244
 
1165
1245
  class Origin < MetronomeSDK::Internal::Type::BaseModel
@@ -41,6 +41,14 @@ module MetronomeSDK
41
41
  sig { params(ending_before: Time).void }
42
42
  attr_writer :ending_before
43
43
 
44
+ # When true, includes historical commit invoices alongside active invoices.
45
+ # Defaults to false.
46
+ sig { returns(T.nilable(T::Boolean)) }
47
+ attr_reader :include_historical_commit_invoices
48
+
49
+ sig { params(include_historical_commit_invoices: T::Boolean).void }
50
+ attr_writer :include_historical_commit_invoices
51
+
44
52
  # Max number of results that should be returned
45
53
  sig { returns(T.nilable(Integer)) }
46
54
  attr_reader :limit
@@ -128,6 +136,7 @@ module MetronomeSDK
128
136
  contract_id: String,
129
137
  credit_type_id: String,
130
138
  ending_before: Time,
139
+ include_historical_commit_invoices: T::Boolean,
131
140
  limit: Integer,
132
141
  next_page: String,
133
142
  skip_zero_qty_line_items: T::Boolean,
@@ -150,6 +159,9 @@ module MetronomeSDK
150
159
  # RFC 3339 timestamp (exclusive). Invoices will only be returned for billing
151
160
  # periods that end before this time.
152
161
  ending_before: nil,
162
+ # When true, includes historical commit invoices alongside active invoices.
163
+ # Defaults to false.
164
+ include_historical_commit_invoices: nil,
153
165
  # Max number of results that should be returned
154
166
  limit: nil,
155
167
  # Cursor that indicates where the next page of results should start.
@@ -180,6 +192,7 @@ module MetronomeSDK
180
192
  contract_id: String,
181
193
  credit_type_id: String,
182
194
  ending_before: Time,
195
+ include_historical_commit_invoices: T::Boolean,
183
196
  limit: Integer,
184
197
  next_page: String,
185
198
  skip_zero_qty_line_items: T::Boolean,