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
@@ -0,0 +1,123 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ module Contracts
7
+ module RateCards
8
+ class NamedScheduleListResponse < MetronomeSDK::Internal::Type::BaseModel
9
+ OrHash =
10
+ T.type_alias do
11
+ T.any(
12
+ MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleListResponse,
13
+ MetronomeSDK::Internal::AnyHash
14
+ )
15
+ end
16
+
17
+ # ID of the contract this named schedule belongs to.
18
+ sig { returns(String) }
19
+ attr_accessor :contract_id
20
+
21
+ # Name of the schedule.
22
+ sig { returns(String) }
23
+ attr_accessor :schedule_name
24
+
25
+ sig do
26
+ returns(
27
+ T::Array[
28
+ MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleListResponse::Segment
29
+ ]
30
+ )
31
+ end
32
+ attr_accessor :segments
33
+
34
+ # Properties on this named schedule.
35
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
36
+ attr_reader :properties
37
+
38
+ sig { params(properties: T::Hash[Symbol, String]).void }
39
+ attr_writer :properties
40
+
41
+ sig do
42
+ params(
43
+ contract_id: String,
44
+ schedule_name: String,
45
+ segments:
46
+ T::Array[
47
+ MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleListResponse::Segment::OrHash
48
+ ],
49
+ properties: T::Hash[Symbol, String]
50
+ ).returns(T.attached_class)
51
+ end
52
+ def self.new(
53
+ # ID of the contract this named schedule belongs to.
54
+ contract_id:,
55
+ # Name of the schedule.
56
+ schedule_name:,
57
+ segments:,
58
+ # Properties on this named schedule.
59
+ properties: nil
60
+ )
61
+ end
62
+
63
+ sig do
64
+ override.returns(
65
+ {
66
+ contract_id: String,
67
+ schedule_name: String,
68
+ segments:
69
+ T::Array[
70
+ MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleListResponse::Segment
71
+ ],
72
+ properties: T::Hash[Symbol, String]
73
+ }
74
+ )
75
+ end
76
+ def to_hash
77
+ end
78
+
79
+ class Segment < MetronomeSDK::Internal::Type::BaseModel
80
+ OrHash =
81
+ T.type_alias do
82
+ T.any(
83
+ MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleListResponse::Segment,
84
+ MetronomeSDK::Internal::AnyHash
85
+ )
86
+ end
87
+
88
+ sig { returns(Time) }
89
+ attr_accessor :starting_at
90
+
91
+ sig { returns(T.anything) }
92
+ attr_accessor :value
93
+
94
+ sig { returns(T.nilable(Time)) }
95
+ attr_reader :ending_before
96
+
97
+ sig { params(ending_before: Time).void }
98
+ attr_writer :ending_before
99
+
100
+ sig do
101
+ params(
102
+ starting_at: Time,
103
+ value: T.anything,
104
+ ending_before: Time
105
+ ).returns(T.attached_class)
106
+ end
107
+ def self.new(starting_at:, value:, ending_before: nil)
108
+ end
109
+
110
+ sig do
111
+ override.returns(
112
+ { starting_at: Time, value: T.anything, ending_before: Time }
113
+ )
114
+ end
115
+ def to_hash
116
+ end
117
+ end
118
+ end
119
+ end
120
+ end
121
+ end
122
+ end
123
+ end
@@ -37,12 +37,21 @@ module MetronomeSDK
37
37
  sig { params(covering_date: Time).void }
38
38
  attr_writer :covering_date
39
39
 
40
+ # A set of key-value pairs that qualifies which schedule should be applied when
41
+ # looking up a schedule by name.
42
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
43
+ attr_reader :properties
44
+
45
+ sig { params(properties: T::Hash[Symbol, String]).void }
46
+ attr_writer :properties
47
+
40
48
  sig do
41
49
  params(
42
50
  contract_id: String,
43
51
  customer_id: String,
44
52
  schedule_name: String,
45
53
  covering_date: Time,
54
+ properties: T::Hash[Symbol, String],
46
55
  request_options: MetronomeSDK::RequestOptions::OrHash
47
56
  ).returns(T.attached_class)
48
57
  end
@@ -56,6 +65,9 @@ module MetronomeSDK
56
65
  # If provided, at most one schedule segment will be returned (the one that covers
57
66
  # this date). If not provided, all segments will be returned.
58
67
  covering_date: nil,
68
+ # A set of key-value pairs that qualifies which schedule should be applied when
69
+ # looking up a schedule by name.
70
+ properties: nil,
59
71
  request_options: {}
60
72
  )
61
73
  end
@@ -67,6 +79,7 @@ module MetronomeSDK
67
79
  customer_id: String,
68
80
  schedule_name: String,
69
81
  covering_date: Time,
82
+ properties: T::Hash[Symbol, String],
70
83
  request_options: MetronomeSDK::RequestOptions
71
84
  }
72
85
  )
@@ -43,6 +43,14 @@ module MetronomeSDK
43
43
  sig { params(ending_before: Time).void }
44
44
  attr_writer :ending_before
45
45
 
46
+ # A set of key-value pairs that qualifies which schedule should be applied when
47
+ # looking up a schedule by name.
48
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
49
+ attr_reader :properties
50
+
51
+ sig { params(properties: T::Hash[Symbol, String]).void }
52
+ attr_writer :properties
53
+
46
54
  sig do
47
55
  params(
48
56
  contract_id: String,
@@ -51,6 +59,7 @@ module MetronomeSDK
51
59
  starting_at: Time,
52
60
  value: T.anything,
53
61
  ending_before: Time,
62
+ properties: T::Hash[Symbol, String],
54
63
  request_options: MetronomeSDK::RequestOptions::OrHash
55
64
  ).returns(T.attached_class)
56
65
  end
@@ -66,6 +75,9 @@ module MetronomeSDK
66
75
  # specific to the named schedule.
67
76
  value:,
68
77
  ending_before: nil,
78
+ # A set of key-value pairs that qualifies which schedule should be applied when
79
+ # looking up a schedule by name.
80
+ properties: nil,
69
81
  request_options: {}
70
82
  )
71
83
  end
@@ -79,6 +91,7 @@ module MetronomeSDK
79
91
  starting_at: Time,
80
92
  value: T.anything,
81
93
  ending_before: Time,
94
+ properties: T::Hash[Symbol, String],
82
95
  request_options: MetronomeSDK::RequestOptions
83
96
  }
84
97
  )
@@ -219,8 +219,7 @@ module MetronomeSDK
219
219
  end
220
220
  attr_writer :aws_region
221
221
 
222
- # The collection method for the customer's invoices. NOTE:
223
- # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
222
+ # The collection method for the customer's invoices.
224
223
  sig do
225
224
  returns(
226
225
  T.nilable(
@@ -262,8 +261,7 @@ module MetronomeSDK
262
261
  aws_is_subscription_product: nil,
263
262
  aws_product_code: nil,
264
263
  aws_region: nil,
265
- # The collection method for the customer's invoices. NOTE:
266
- # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
264
+ # The collection method for the customer's invoices.
267
265
  stripe_collection_method: nil
268
266
  )
269
267
  end
@@ -506,8 +504,7 @@ module MetronomeSDK
506
504
  end
507
505
  end
508
506
 
509
- # The collection method for the customer's invoices. NOTE:
510
- # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
507
+ # The collection method for the customer's invoices.
511
508
  module StripeCollectionMethod
512
509
  extend MetronomeSDK::Internal::Type::Enum
513
510
 
@@ -530,16 +527,6 @@ module MetronomeSDK
530
527
  :send_invoice,
531
528
  MetronomeSDK::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod::TaggedSymbol
532
529
  )
533
- AUTO_CHARGE_PAYMENT_INTENT =
534
- T.let(
535
- :auto_charge_payment_intent,
536
- MetronomeSDK::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod::TaggedSymbol
537
- )
538
- MANUALLY_CHARGE_PAYMENT_INTENT =
539
- T.let(
540
- :manually_charge_payment_intent,
541
- MetronomeSDK::V1::CustomerCreateParams::BillingConfig::StripeCollectionMethod::TaggedSymbol
542
- )
543
530
 
544
531
  sig do
545
532
  override.returns(
@@ -609,8 +596,7 @@ module MetronomeSDK
609
596
 
610
597
  # Specifies which tax provider Metronome should use for tax calculation when
611
598
  # billing through Stripe. This is only supported for Stripe billing provider
612
- # configurations with auto_charge_payment_intent or manual_charge_payment_intent
613
- # collection methods.
599
+ # configurations.
614
600
  sig do
615
601
  returns(
616
602
  T.nilable(
@@ -656,8 +642,7 @@ module MetronomeSDK
656
642
  delivery_method_id: nil,
657
643
  # Specifies which tax provider Metronome should use for tax calculation when
658
644
  # billing through Stripe. This is only supported for Stripe billing provider
659
- # configurations with auto_charge_payment_intent or manual_charge_payment_intent
660
- # collection methods.
645
+ # configurations.
661
646
  tax_provider: nil
662
647
  )
663
648
  end
@@ -777,8 +762,7 @@ module MetronomeSDK
777
762
 
778
763
  # Specifies which tax provider Metronome should use for tax calculation when
779
764
  # billing through Stripe. This is only supported for Stripe billing provider
780
- # configurations with auto_charge_payment_intent or manual_charge_payment_intent
781
- # collection methods.
765
+ # configurations.
782
766
  module TaxProvider
783
767
  extend MetronomeSDK::Internal::Type::Enum
784
768
 
@@ -112,8 +112,7 @@ module MetronomeSDK
112
112
 
113
113
  # Specifies which tax provider Metronome should use for tax calculation when
114
114
  # billing through Stripe. This is only supported for Stripe billing provider
115
- # configurations with auto_charge_payment_intent or manual_charge_payment_intent
116
- # collection methods.
115
+ # configurations.
117
116
  sig do
118
117
  returns(
119
118
  T.nilable(
@@ -164,8 +163,7 @@ module MetronomeSDK
164
163
  delivery_method_id: nil,
165
164
  # Specifies which tax provider Metronome should use for tax calculation when
166
165
  # billing through Stripe. This is only supported for Stripe billing provider
167
- # configurations with auto_charge_payment_intent or manual_charge_payment_intent
168
- # collection methods.
166
+ # configurations.
169
167
  tax_provider: nil
170
168
  )
171
169
  end
@@ -306,8 +304,7 @@ module MetronomeSDK
306
304
 
307
305
  # Specifies which tax provider Metronome should use for tax calculation when
308
306
  # billing through Stripe. This is only supported for Stripe billing provider
309
- # configurations with auto_charge_payment_intent or manual_charge_payment_intent
310
- # collection methods.
307
+ # configurations.
311
308
  module TaxProvider
312
309
  extend MetronomeSDK::Internal::Type::Enum
313
310
 
@@ -24,8 +24,9 @@ module MetronomeSDK
24
24
  sig { returns(String) }
25
25
  attr_accessor :customer_id
26
26
 
27
- # Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
28
- # notifications. Used to filter the alert by the custom field key-value pair.
27
+ # Can be used only with `low_remaining_contract_credit_and_commit_balance_reached`
28
+ # and `low_remaining_contract_credit_and_commit_percentage_reached` notifications.
29
+ # Used to filter the alert by the custom field key-value pair.
29
30
  sig do
30
31
  returns(
31
32
  T.nilable(
@@ -132,8 +133,9 @@ module MetronomeSDK
132
133
  alert_id:,
133
134
  # The Metronome ID of the customer
134
135
  customer_id:,
135
- # Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
136
- # notifications. Used to filter the alert by the custom field key-value pair.
136
+ # Can be used only with `low_remaining_contract_credit_and_commit_balance_reached`
137
+ # and `low_remaining_contract_credit_and_commit_percentage_reached` notifications.
138
+ # Used to filter the alert by the custom field key-value pair.
137
139
  alert_specifiers: nil,
138
140
  # Only present for `spend_threshold_reached` notifications. Retrieve the
139
141
  # notification for a specific group key-value pair.
@@ -66,8 +66,7 @@ module MetronomeSDK
66
66
  end
67
67
  attr_writer :aws_region
68
68
 
69
- # The collection method for the customer's invoices. NOTE:
70
- # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
69
+ # The collection method for the customer's invoices.
71
70
  sig do
72
71
  returns(
73
72
  T.nilable(
@@ -111,8 +110,7 @@ module MetronomeSDK
111
110
  aws_customer_id: nil,
112
111
  aws_product_code: nil,
113
112
  aws_region: nil,
114
- # The collection method for the customer's invoices. NOTE:
115
- # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
113
+ # The collection method for the customer's invoices.
116
114
  stripe_collection_method: nil,
117
115
  request_options: {}
118
116
  )
@@ -357,8 +355,7 @@ module MetronomeSDK
357
355
  end
358
356
  end
359
357
 
360
- # The collection method for the customer's invoices. NOTE:
361
- # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
358
+ # The collection method for the customer's invoices.
362
359
  module StripeCollectionMethod
363
360
  extend MetronomeSDK::Internal::Type::Enum
364
361
 
@@ -381,16 +378,6 @@ module MetronomeSDK
381
378
  :send_invoice,
382
379
  MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::TaggedSymbol
383
380
  )
384
- AUTO_CHARGE_PAYMENT_INTENT =
385
- T.let(
386
- :auto_charge_payment_intent,
387
- MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::TaggedSymbol
388
- )
389
- MANUALLY_CHARGE_PAYMENT_INTENT =
390
- T.let(
391
- :manually_charge_payment_intent,
392
- MetronomeSDK::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::TaggedSymbol
393
- )
394
381
 
395
382
  sig do
396
383
  override.returns(
@@ -155,8 +155,7 @@ module MetronomeSDK
155
155
  sig { params(billing_provider_customer_id: String).void }
156
156
  attr_writer :billing_provider_customer_id
157
157
 
158
- # The collection method for the customer's invoices. NOTE:
159
- # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
158
+ # The collection method for the customer's invoices.
160
159
  sig do
161
160
  returns(
162
161
  T.nilable(
@@ -215,8 +214,7 @@ module MetronomeSDK
215
214
  azure_start_date: nil,
216
215
  azure_subscription_status: nil,
217
216
  billing_provider_customer_id: nil,
218
- # The collection method for the customer's invoices. NOTE:
219
- # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
217
+ # The collection method for the customer's invoices.
220
218
  stripe_collection_method: nil
221
219
  )
222
220
  end
@@ -438,8 +436,7 @@ module MetronomeSDK
438
436
  end
439
437
  end
440
438
 
441
- # The collection method for the customer's invoices. NOTE:
442
- # `auto_charge_payment_intent` and `manually_charge_payment_intent` are in beta.
439
+ # The collection method for the customer's invoices.
443
440
  module StripeCollectionMethod
444
441
  extend MetronomeSDK::Internal::Type::Enum
445
442
 
@@ -462,16 +459,6 @@ module MetronomeSDK
462
459
  :send_invoice,
463
460
  MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod::TaggedSymbol
464
461
  )
465
- AUTO_CHARGE_PAYMENT_INTENT =
466
- T.let(
467
- :auto_charge_payment_intent,
468
- MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod::TaggedSymbol
469
- )
470
- MANUALLY_CHARGE_PAYMENT_INTENT =
471
- T.let(
472
- :manually_charge_payment_intent,
473
- MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::StripeCollectionMethod::TaggedSymbol
474
- )
475
462
 
476
463
  sig do
477
464
  override.returns(
@@ -321,6 +321,26 @@ module MetronomeSDK
321
321
  end
322
322
  attr_accessor :schedule_items
323
323
 
324
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
325
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
326
+ # omitted.
327
+ sig do
328
+ returns(
329
+ T.nilable(
330
+ MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::AccessType::OrSymbol
331
+ )
332
+ )
333
+ end
334
+ attr_reader :access_type
335
+
336
+ sig do
337
+ params(
338
+ access_type:
339
+ MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::AccessType::OrSymbol
340
+ ).void
341
+ end
342
+ attr_writer :access_type
343
+
324
344
  # Defaults to USD (cents) if not passed
325
345
  sig { returns(T.nilable(String)) }
326
346
  attr_reader :credit_type_id
@@ -336,11 +356,17 @@ module MetronomeSDK
336
356
  T::Array[
337
357
  MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem::OrHash
338
358
  ],
359
+ access_type:
360
+ MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::AccessType::OrSymbol,
339
361
  credit_type_id: String
340
362
  ).returns(T.attached_class)
341
363
  end
342
364
  def self.new(
343
365
  schedule_items:,
366
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
367
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
368
+ # omitted.
369
+ access_type: nil,
344
370
  # Defaults to USD (cents) if not passed
345
371
  credit_type_id: nil
346
372
  )
@@ -353,6 +379,8 @@ module MetronomeSDK
353
379
  T::Array[
354
380
  MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem
355
381
  ],
382
+ access_type:
383
+ MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::AccessType::OrSymbol,
356
384
  credit_type_id: String
357
385
  }
358
386
  )
@@ -404,6 +432,43 @@ module MetronomeSDK
404
432
  def to_hash
405
433
  end
406
434
  end
435
+
436
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
437
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
438
+ # omitted.
439
+ module AccessType
440
+ extend MetronomeSDK::Internal::Type::Enum
441
+
442
+ TaggedSymbol =
443
+ T.type_alias do
444
+ T.all(
445
+ Symbol,
446
+ MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::AccessType
447
+ )
448
+ end
449
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
450
+
451
+ SPEND =
452
+ T.let(
453
+ :SPEND,
454
+ MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::AccessType::TaggedSymbol
455
+ )
456
+ QUANTITY =
457
+ T.let(
458
+ :QUANTITY,
459
+ MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::AccessType::TaggedSymbol
460
+ )
461
+
462
+ sig do
463
+ override.returns(
464
+ T::Array[
465
+ MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::AccessType::TaggedSymbol
466
+ ]
467
+ )
468
+ end
469
+ def self.values
470
+ end
471
+ end
407
472
  end
408
473
 
409
474
  module Type
@@ -19,6 +19,25 @@ module MetronomeSDK
19
19
  sig { returns(String) }
20
20
  attr_accessor :customer_id
21
21
 
22
+ # Filters commits by how their balances are drawn down. `SPEND` deducts the dollar
23
+ # cost of usage. `QUANTITY` deducts the number of units used.
24
+ sig do
25
+ returns(
26
+ T.nilable(
27
+ MetronomeSDK::V1::Customers::CommitListParams::AccessType::OrSymbol
28
+ )
29
+ )
30
+ end
31
+ attr_reader :access_type
32
+
33
+ sig do
34
+ params(
35
+ access_type:
36
+ MetronomeSDK::V1::Customers::CommitListParams::AccessType::OrSymbol
37
+ ).void
38
+ end
39
+ attr_writer :access_type
40
+
22
41
  sig { returns(T.nilable(String)) }
23
42
  attr_reader :commit_id
24
43
 
@@ -93,6 +112,8 @@ module MetronomeSDK
93
112
  sig do
94
113
  params(
95
114
  customer_id: String,
115
+ access_type:
116
+ MetronomeSDK::V1::Customers::CommitListParams::AccessType::OrSymbol,
96
117
  commit_id: String,
97
118
  covering_date: Time,
98
119
  effective_before: Time,
@@ -108,6 +129,9 @@ module MetronomeSDK
108
129
  end
109
130
  def self.new(
110
131
  customer_id:,
132
+ # Filters commits by how their balances are drawn down. `SPEND` deducts the dollar
133
+ # cost of usage. `QUANTITY` deducts the number of units used.
134
+ access_type: nil,
111
135
  commit_id: nil,
112
136
  # Include only commits that have access schedules that "cover" the provided date
113
137
  covering_date: nil,
@@ -137,6 +161,8 @@ module MetronomeSDK
137
161
  override.returns(
138
162
  {
139
163
  customer_id: String,
164
+ access_type:
165
+ MetronomeSDK::V1::Customers::CommitListParams::AccessType::OrSymbol,
140
166
  commit_id: String,
141
167
  covering_date: Time,
142
168
  effective_before: Time,
@@ -153,6 +179,42 @@ module MetronomeSDK
153
179
  end
154
180
  def to_hash
155
181
  end
182
+
183
+ # Filters commits by how their balances are drawn down. `SPEND` deducts the dollar
184
+ # cost of usage. `QUANTITY` deducts the number of units used.
185
+ module AccessType
186
+ extend MetronomeSDK::Internal::Type::Enum
187
+
188
+ TaggedSymbol =
189
+ T.type_alias do
190
+ T.all(
191
+ Symbol,
192
+ MetronomeSDK::V1::Customers::CommitListParams::AccessType
193
+ )
194
+ end
195
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
196
+
197
+ SPEND =
198
+ T.let(
199
+ :SPEND,
200
+ MetronomeSDK::V1::Customers::CommitListParams::AccessType::TaggedSymbol
201
+ )
202
+ QUANTITY =
203
+ T.let(
204
+ :QUANTITY,
205
+ MetronomeSDK::V1::Customers::CommitListParams::AccessType::TaggedSymbol
206
+ )
207
+
208
+ sig do
209
+ override.returns(
210
+ T::Array[
211
+ MetronomeSDK::V1::Customers::CommitListParams::AccessType::TaggedSymbol
212
+ ]
213
+ )
214
+ end
215
+ def self.values
216
+ end
217
+ end
156
218
  end
157
219
  end
158
220
  end