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
@@ -26,6 +26,13 @@ module MetronomeSDK
26
26
  sig { params(covering_date: Time).void }
27
27
  attr_writer :covering_date
28
28
 
29
+ # Cursor from a previous response to fetch the next page of contracts.
30
+ sig { returns(T.nilable(String)) }
31
+ attr_reader :cursor
32
+
33
+ sig { params(cursor: String).void }
34
+ attr_writer :cursor
35
+
29
36
  # Include archived contracts in the response.
30
37
  sig { returns(T.nilable(T::Boolean)) }
31
38
  attr_reader :include_archived
@@ -49,6 +56,13 @@ module MetronomeSDK
49
56
  sig { params(include_ledgers: T::Boolean).void }
50
57
  attr_writer :include_ledgers
51
58
 
59
+ # Max number of contracts to return per page. Range: 1-20. Default: 20.
60
+ sig { returns(T.nilable(Float)) }
61
+ attr_reader :limit
62
+
63
+ sig { params(limit: Float).void }
64
+ attr_writer :limit
65
+
52
66
  # Optional RFC 3339 timestamp. Only include contracts that started on or after
53
67
  # this date. This cannot be provided if covering_date filter is provided.
54
68
  sig { returns(T.nilable(Time)) }
@@ -61,9 +75,11 @@ module MetronomeSDK
61
75
  params(
62
76
  customer_id: String,
63
77
  covering_date: Time,
78
+ cursor: String,
64
79
  include_archived: T::Boolean,
65
80
  include_balance: T::Boolean,
66
81
  include_ledgers: T::Boolean,
82
+ limit: Float,
67
83
  starting_at: Time,
68
84
  request_options: MetronomeSDK::RequestOptions::OrHash
69
85
  ).returns(T.attached_class)
@@ -73,6 +89,8 @@ module MetronomeSDK
73
89
  # Optional RFC 3339 timestamp. Only include contracts active on the provided date.
74
90
  # This cannot be provided if starting_at filter is provided.
75
91
  covering_date: nil,
92
+ # Cursor from a previous response to fetch the next page of contracts.
93
+ cursor: nil,
76
94
  # Include archived contracts in the response.
77
95
  include_archived: nil,
78
96
  # Include the balance of credits and commits in the response. Setting this flag
@@ -81,6 +99,8 @@ module MetronomeSDK
81
99
  # Include commit/credit ledgers in the response. Setting this flag may cause the
82
100
  # response to be slower.
83
101
  include_ledgers: nil,
102
+ # Max number of contracts to return per page. Range: 1-20. Default: 20.
103
+ limit: nil,
84
104
  # Optional RFC 3339 timestamp. Only include contracts that started on or after
85
105
  # this date. This cannot be provided if covering_date filter is provided.
86
106
  starting_at: nil,
@@ -93,9 +113,11 @@ module MetronomeSDK
93
113
  {
94
114
  customer_id: String,
95
115
  covering_date: Time,
116
+ cursor: String,
96
117
  include_archived: T::Boolean,
97
118
  include_balance: T::Boolean,
98
119
  include_ledgers: T::Boolean,
120
+ limit: Float,
99
121
  starting_at: Time,
100
122
  request_options: MetronomeSDK::RequestOptions
101
123
  }
@@ -0,0 +1,147 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ class LifecycleEventOffsetNotificationConfig < MetronomeSDK::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig,
11
+ MetronomeSDK::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ # ID for this offset notification configuration
16
+ sig { returns(String) }
17
+ attr_accessor :id
18
+
19
+ # When this notification configuration was archived
20
+ sig { returns(T.nilable(Time)) }
21
+ attr_accessor :archived_at
22
+
23
+ # RFC 3339 timestamp when this notification configuration was created.
24
+ sig { returns(Time) }
25
+ attr_accessor :created_at
26
+
27
+ # Who created this notification configuration
28
+ sig { returns(String) }
29
+ attr_accessor :created_by
30
+
31
+ # The environment type where this notification configuration was created.
32
+ sig { returns(String) }
33
+ attr_accessor :environment_type
34
+
35
+ # The name for this offset notification configuration.
36
+ sig { returns(String) }
37
+ attr_accessor :name
38
+
39
+ sig do
40
+ returns(
41
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::Policy
42
+ )
43
+ end
44
+ attr_reader :policy
45
+
46
+ sig do
47
+ params(
48
+ policy:
49
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::Policy::OrHash
50
+ ).void
51
+ end
52
+ attr_writer :policy
53
+
54
+ # Indicates this is an offset lifecycle event notification
55
+ sig { returns(String) }
56
+ attr_accessor :type
57
+
58
+ sig do
59
+ params(
60
+ id: String,
61
+ archived_at: T.nilable(Time),
62
+ created_at: Time,
63
+ created_by: String,
64
+ environment_type: String,
65
+ name: String,
66
+ policy:
67
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::Policy::OrHash,
68
+ type: String
69
+ ).returns(T.attached_class)
70
+ end
71
+ def self.new(
72
+ # ID for this offset notification configuration
73
+ id:,
74
+ # When this notification configuration was archived
75
+ archived_at:,
76
+ # RFC 3339 timestamp when this notification configuration was created.
77
+ created_at:,
78
+ # Who created this notification configuration
79
+ created_by:,
80
+ # The environment type where this notification configuration was created.
81
+ environment_type:,
82
+ # The name for this offset notification configuration.
83
+ name:,
84
+ policy:,
85
+ # Indicates this is an offset lifecycle event notification
86
+ type:
87
+ )
88
+ end
89
+
90
+ sig do
91
+ override.returns(
92
+ {
93
+ id: String,
94
+ archived_at: T.nilable(Time),
95
+ created_at: Time,
96
+ created_by: String,
97
+ environment_type: String,
98
+ name: String,
99
+ policy:
100
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::Policy,
101
+ type: String
102
+ }
103
+ )
104
+ end
105
+ def to_hash
106
+ end
107
+
108
+ class Policy < MetronomeSDK::Internal::Type::BaseModel
109
+ OrHash =
110
+ T.type_alias do
111
+ T.any(
112
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::Policy,
113
+ MetronomeSDK::Internal::AnyHash
114
+ )
115
+ end
116
+
117
+ # ISO-8601 duration string indicating how much time before or after the base event
118
+ # this notification should be sent. Positive values indicate notifications after
119
+ # the event, negative values indicate notifications before the event. Examples:
120
+ # "P1D" (1 day after), "-PT2H" (2 hours before)
121
+ sig { returns(String) }
122
+ attr_accessor :offset
123
+
124
+ # The type of lifecycle event that this offset is based on.
125
+ sig { returns(String) }
126
+ attr_accessor :type
127
+
128
+ sig { params(offset: String, type: String).returns(T.attached_class) }
129
+ def self.new(
130
+ # ISO-8601 duration string indicating how much time before or after the base event
131
+ # this notification should be sent. Positive values indicate notifications after
132
+ # the event, negative values indicate notifications before the event. Examples:
133
+ # "P1D" (1 day after), "-PT2H" (2 hours before)
134
+ offset:,
135
+ # The type of lifecycle event that this offset is based on.
136
+ type:
137
+ )
138
+ end
139
+
140
+ sig { override.returns({ offset: String, type: String }) }
141
+ def to_hash
142
+ end
143
+ end
144
+ end
145
+ end
146
+ end
147
+ end
@@ -0,0 +1,98 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ class LifecycleEventSystemNotificationConfig < MetronomeSDK::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ MetronomeSDK::V2::LifecycleEventSystemNotificationConfig,
11
+ MetronomeSDK::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ sig do
16
+ returns(
17
+ MetronomeSDK::V2::LifecycleEventSystemNotificationConfig::Policy
18
+ )
19
+ end
20
+ attr_reader :policy
21
+
22
+ sig do
23
+ params(
24
+ policy:
25
+ MetronomeSDK::V2::LifecycleEventSystemNotificationConfig::Policy::OrHash
26
+ ).void
27
+ end
28
+ attr_writer :policy
29
+
30
+ # Indicates this is a system lifecycle event notification
31
+ sig { returns(String) }
32
+ attr_accessor :type
33
+
34
+ # Whether or not webhook publishing for this lifecycle event is enabled
35
+ sig { returns(T.nilable(T::Boolean)) }
36
+ attr_reader :is_enabled
37
+
38
+ sig { params(is_enabled: T::Boolean).void }
39
+ attr_writer :is_enabled
40
+
41
+ sig do
42
+ params(
43
+ policy:
44
+ MetronomeSDK::V2::LifecycleEventSystemNotificationConfig::Policy::OrHash,
45
+ type: String,
46
+ is_enabled: T::Boolean
47
+ ).returns(T.attached_class)
48
+ end
49
+ def self.new(
50
+ policy:,
51
+ # Indicates this is a system lifecycle event notification
52
+ type:,
53
+ # Whether or not webhook publishing for this lifecycle event is enabled
54
+ is_enabled: nil
55
+ )
56
+ end
57
+
58
+ sig do
59
+ override.returns(
60
+ {
61
+ policy:
62
+ MetronomeSDK::V2::LifecycleEventSystemNotificationConfig::Policy,
63
+ type: String,
64
+ is_enabled: T::Boolean
65
+ }
66
+ )
67
+ end
68
+ def to_hash
69
+ end
70
+
71
+ class Policy < MetronomeSDK::Internal::Type::BaseModel
72
+ OrHash =
73
+ T.type_alias do
74
+ T.any(
75
+ MetronomeSDK::V2::LifecycleEventSystemNotificationConfig::Policy,
76
+ MetronomeSDK::Internal::AnyHash
77
+ )
78
+ end
79
+
80
+ # The type of lifecycle event (e.g., "contract.create", "contract.start")
81
+ sig { returns(String) }
82
+ attr_accessor :type
83
+
84
+ sig { params(type: String).returns(T.attached_class) }
85
+ def self.new(
86
+ # The type of lifecycle event (e.g., "contract.create", "contract.start")
87
+ type:
88
+ )
89
+ end
90
+
91
+ sig { override.returns({ type: String }) }
92
+ def to_hash
93
+ end
94
+ end
95
+ end
96
+ end
97
+ end
98
+ end
@@ -0,0 +1,47 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ module Notifications
7
+ class OffsetArchiveParams < MetronomeSDK::Internal::Type::BaseModel
8
+ extend MetronomeSDK::Internal::Type::RequestParameters::Converter
9
+ include MetronomeSDK::Internal::Type::RequestParameters
10
+
11
+ OrHash =
12
+ T.type_alias do
13
+ T.any(
14
+ MetronomeSDK::V2::Notifications::OffsetArchiveParams,
15
+ MetronomeSDK::Internal::AnyHash
16
+ )
17
+ end
18
+
19
+ # The ID of the offset lifecycle event notification configuration to archive.
20
+ sig { returns(String) }
21
+ attr_accessor :id
22
+
23
+ sig do
24
+ params(
25
+ id: String,
26
+ request_options: MetronomeSDK::RequestOptions::OrHash
27
+ ).returns(T.attached_class)
28
+ end
29
+ def self.new(
30
+ # The ID of the offset lifecycle event notification configuration to archive.
31
+ id:,
32
+ request_options: {}
33
+ )
34
+ end
35
+
36
+ sig do
37
+ override.returns(
38
+ { id: String, request_options: MetronomeSDK::RequestOptions }
39
+ )
40
+ end
41
+ def to_hash
42
+ end
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,49 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ module Notifications
7
+ class OffsetArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
8
+ OrHash =
9
+ T.type_alias do
10
+ T.any(
11
+ MetronomeSDK::Models::V2::Notifications::OffsetArchiveResponse,
12
+ MetronomeSDK::Internal::AnyHash
13
+ )
14
+ end
15
+
16
+ sig do
17
+ returns(MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig)
18
+ end
19
+ attr_reader :data
20
+
21
+ sig do
22
+ params(
23
+ data:
24
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::OrHash
25
+ ).void
26
+ end
27
+ attr_writer :data
28
+
29
+ sig do
30
+ params(
31
+ data:
32
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::OrHash
33
+ ).returns(T.attached_class)
34
+ end
35
+ def self.new(data:)
36
+ end
37
+
38
+ sig do
39
+ override.returns(
40
+ { data: MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig }
41
+ )
42
+ end
43
+ def to_hash
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,127 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ module Notifications
7
+ class OffsetCreateParams < MetronomeSDK::Internal::Type::BaseModel
8
+ extend MetronomeSDK::Internal::Type::RequestParameters::Converter
9
+ include MetronomeSDK::Internal::Type::RequestParameters
10
+
11
+ OrHash =
12
+ T.type_alias do
13
+ T.any(
14
+ MetronomeSDK::V2::Notifications::OffsetCreateParams,
15
+ MetronomeSDK::Internal::AnyHash
16
+ )
17
+ end
18
+
19
+ # The name for this offset notification configuration.
20
+ sig { returns(String) }
21
+ attr_accessor :name
22
+
23
+ # The offset lifecycle event policy that defines when and how this notification
24
+ # should be triggered. The lifecycle event type is inferred from the policy.type
25
+ # field.
26
+ sig do
27
+ returns(MetronomeSDK::V2::Notifications::OffsetCreateParams::Policy)
28
+ end
29
+ attr_reader :policy
30
+
31
+ sig do
32
+ params(
33
+ policy:
34
+ MetronomeSDK::V2::Notifications::OffsetCreateParams::Policy::OrHash
35
+ ).void
36
+ end
37
+ attr_writer :policy
38
+
39
+ # Optional uniqueness key to prevent duplicate notification configurations.
40
+ sig { returns(T.nilable(String)) }
41
+ attr_reader :uniqueness_key
42
+
43
+ sig { params(uniqueness_key: String).void }
44
+ attr_writer :uniqueness_key
45
+
46
+ sig do
47
+ params(
48
+ name: String,
49
+ policy:
50
+ MetronomeSDK::V2::Notifications::OffsetCreateParams::Policy::OrHash,
51
+ uniqueness_key: String,
52
+ request_options: MetronomeSDK::RequestOptions::OrHash
53
+ ).returns(T.attached_class)
54
+ end
55
+ def self.new(
56
+ # The name for this offset notification configuration.
57
+ name:,
58
+ # The offset lifecycle event policy that defines when and how this notification
59
+ # should be triggered. The lifecycle event type is inferred from the policy.type
60
+ # field.
61
+ policy:,
62
+ # Optional uniqueness key to prevent duplicate notification configurations.
63
+ uniqueness_key: nil,
64
+ request_options: {}
65
+ )
66
+ end
67
+
68
+ sig do
69
+ override.returns(
70
+ {
71
+ name: String,
72
+ policy:
73
+ MetronomeSDK::V2::Notifications::OffsetCreateParams::Policy,
74
+ uniqueness_key: String,
75
+ request_options: MetronomeSDK::RequestOptions
76
+ }
77
+ )
78
+ end
79
+ def to_hash
80
+ end
81
+
82
+ class Policy < MetronomeSDK::Internal::Type::BaseModel
83
+ OrHash =
84
+ T.type_alias do
85
+ T.any(
86
+ MetronomeSDK::V2::Notifications::OffsetCreateParams::Policy,
87
+ MetronomeSDK::Internal::AnyHash
88
+ )
89
+ end
90
+
91
+ # ISO-8601 duration string indicating how much time before or after the base event
92
+ # this notification should be sent. Positive values indicate notifications after
93
+ # the event, negative values indicate notifications before the event. Examples:
94
+ # "P1D" (1 day after), "-PT2H" (2 hours before)
95
+ sig { returns(String) }
96
+ attr_accessor :offset
97
+
98
+ # The type of lifecycle event that this offset is based on.
99
+ sig { returns(String) }
100
+ attr_accessor :type
101
+
102
+ # The offset lifecycle event policy that defines when and how this notification
103
+ # should be triggered. The lifecycle event type is inferred from the policy.type
104
+ # field.
105
+ sig do
106
+ params(offset: String, type: String).returns(T.attached_class)
107
+ end
108
+ def self.new(
109
+ # ISO-8601 duration string indicating how much time before or after the base event
110
+ # this notification should be sent. Positive values indicate notifications after
111
+ # the event, negative values indicate notifications before the event. Examples:
112
+ # "P1D" (1 day after), "-PT2H" (2 hours before)
113
+ offset:,
114
+ # The type of lifecycle event that this offset is based on.
115
+ type:
116
+ )
117
+ end
118
+
119
+ sig { override.returns({ offset: String, type: String }) }
120
+ def to_hash
121
+ end
122
+ end
123
+ end
124
+ end
125
+ end
126
+ end
127
+ end
@@ -0,0 +1,49 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ module Notifications
7
+ class OffsetCreateResponse < MetronomeSDK::Internal::Type::BaseModel
8
+ OrHash =
9
+ T.type_alias do
10
+ T.any(
11
+ MetronomeSDK::Models::V2::Notifications::OffsetCreateResponse,
12
+ MetronomeSDK::Internal::AnyHash
13
+ )
14
+ end
15
+
16
+ sig do
17
+ returns(MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig)
18
+ end
19
+ attr_reader :data
20
+
21
+ sig do
22
+ params(
23
+ data:
24
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::OrHash
25
+ ).void
26
+ end
27
+ attr_writer :data
28
+
29
+ sig do
30
+ params(
31
+ data:
32
+ MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::OrHash
33
+ ).returns(T.attached_class)
34
+ end
35
+ def self.new(data:)
36
+ end
37
+
38
+ sig do
39
+ override.returns(
40
+ { data: MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig }
41
+ )
42
+ end
43
+ def to_hash
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end