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
@@ -984,6 +984,12 @@ module MetronomeSDK
984
984
  required :access_amount,
985
985
  -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::AccessAmount }
986
986
 
987
+ # @!attribute anchor_date
988
+ # The date this recurring commit's billing periods are anchored to.
989
+ #
990
+ # @return [Time]
991
+ required :anchor_date, Time
992
+
987
993
  # @!attribute commit_duration
988
994
  # The amount of time the created commits will be valid for
989
995
  #
@@ -1121,7 +1127,7 @@ module MetronomeSDK
1121
1127
  # @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
1122
1128
  optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
1123
1129
 
1124
- # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
1130
+ # @!method initialize(id:, access_amount:, anchor_date:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
1125
1131
  # Some parameter documentations has been truncated, see
1126
1132
  # {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit}
1127
1133
  # for more details.
@@ -1130,6 +1136,8 @@ module MetronomeSDK
1130
1136
  #
1131
1137
  # @param access_amount [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::AccessAmount] The amount of commit to grant.
1132
1138
  #
1139
+ # @param anchor_date [Time] The date this recurring commit's billing periods are anchored to.
1140
+ #
1133
1141
  # @param commit_duration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::CommitDuration] The amount of time the created commits will be valid for
1134
1142
  #
1135
1143
  # @param priority [Float] Will be passed down to the individual commits
@@ -1173,6 +1181,8 @@ module MetronomeSDK
1173
1181
  # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit#access_amount
1174
1182
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
1175
1183
  # @!attribute credit_type_id
1184
+ # This ID identifies the credit type for the access amount. Quantity-based
1185
+ # recurring commits and credits return the null credit type UUID.
1176
1186
  #
1177
1187
  # @return [String]
1178
1188
  required :credit_type_id, String
@@ -1182,17 +1192,47 @@ module MetronomeSDK
1182
1192
  # @return [Float]
1183
1193
  required :unit_price, Float
1184
1194
 
1195
+ # @!attribute access_type
1196
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1197
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1198
+ #
1199
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::AccessAmount::AccessType, nil]
1200
+ optional :access_type,
1201
+ enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::AccessAmount::AccessType }
1202
+
1185
1203
  # @!attribute quantity
1186
1204
  #
1187
1205
  # @return [Float, nil]
1188
1206
  optional :quantity, Float
1189
1207
 
1190
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
1208
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
1209
+ # Some parameter documentations has been truncated, see
1210
+ # {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::AccessAmount}
1211
+ # for more details.
1212
+ #
1191
1213
  # The amount of commit to grant.
1192
1214
  #
1193
- # @param credit_type_id [String]
1215
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
1216
+ #
1194
1217
  # @param unit_price [Float]
1218
+ #
1219
+ # @param access_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
1220
+ #
1195
1221
  # @param quantity [Float]
1222
+
1223
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1224
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1225
+ #
1226
+ # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit::AccessAmount#access_type
1227
+ module AccessType
1228
+ extend MetronomeSDK::Internal::Type::Enum
1229
+
1230
+ SPEND = :SPEND
1231
+ QUANTITY = :QUANTITY
1232
+
1233
+ # @!method self.values
1234
+ # @return [Array<Symbol>]
1235
+ end
1196
1236
  end
1197
1237
 
1198
1238
  # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCommit#commit_duration
@@ -1439,6 +1479,12 @@ module MetronomeSDK
1439
1479
  required :access_amount,
1440
1480
  -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::AccessAmount }
1441
1481
 
1482
+ # @!attribute anchor_date
1483
+ # The date this recurring commit's billing periods are anchored to.
1484
+ #
1485
+ # @return [Time]
1486
+ required :anchor_date, Time
1487
+
1442
1488
  # @!attribute commit_duration
1443
1489
  # The amount of time the created commits will be valid for
1444
1490
  #
@@ -1569,7 +1615,7 @@ module MetronomeSDK
1569
1615
  # @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
1570
1616
  optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
1571
1617
 
1572
- # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
1618
+ # @!method initialize(id:, access_amount:, anchor_date:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
1573
1619
  # Some parameter documentations has been truncated, see
1574
1620
  # {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit}
1575
1621
  # for more details.
@@ -1578,6 +1624,8 @@ module MetronomeSDK
1578
1624
  #
1579
1625
  # @param access_amount [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::AccessAmount] The amount of commit to grant.
1580
1626
  #
1627
+ # @param anchor_date [Time] The date this recurring commit's billing periods are anchored to.
1628
+ #
1581
1629
  # @param commit_duration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::CommitDuration] The amount of time the created commits will be valid for
1582
1630
  #
1583
1631
  # @param priority [Float] Will be passed down to the individual commits
@@ -1619,6 +1667,8 @@ module MetronomeSDK
1619
1667
  # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit#access_amount
1620
1668
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
1621
1669
  # @!attribute credit_type_id
1670
+ # This ID identifies the credit type for the access amount. Quantity-based
1671
+ # recurring commits and credits return the null credit type UUID.
1622
1672
  #
1623
1673
  # @return [String]
1624
1674
  required :credit_type_id, String
@@ -1628,17 +1678,47 @@ module MetronomeSDK
1628
1678
  # @return [Float]
1629
1679
  required :unit_price, Float
1630
1680
 
1681
+ # @!attribute access_type
1682
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1683
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1684
+ #
1685
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::AccessAmount::AccessType, nil]
1686
+ optional :access_type,
1687
+ enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::AccessAmount::AccessType }
1688
+
1631
1689
  # @!attribute quantity
1632
1690
  #
1633
1691
  # @return [Float, nil]
1634
1692
  optional :quantity, Float
1635
1693
 
1636
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
1694
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
1695
+ # Some parameter documentations has been truncated, see
1696
+ # {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::AccessAmount}
1697
+ # for more details.
1698
+ #
1637
1699
  # The amount of commit to grant.
1638
1700
  #
1639
- # @param credit_type_id [String]
1701
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
1702
+ #
1640
1703
  # @param unit_price [Float]
1704
+ #
1705
+ # @param access_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
1706
+ #
1641
1707
  # @param quantity [Float]
1708
+
1709
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1710
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1711
+ #
1712
+ # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit::AccessAmount#access_type
1713
+ module AccessType
1714
+ extend MetronomeSDK::Internal::Type::Enum
1715
+
1716
+ SPEND = :SPEND
1717
+ QUANTITY = :QUANTITY
1718
+
1719
+ # @!method self.values
1720
+ # @return [Array<Symbol>]
1721
+ end
1642
1722
  end
1643
1723
 
1644
1724
  # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddRecurringCredit#commit_duration
@@ -1970,6 +2050,11 @@ module MetronomeSDK
1970
2050
  required :collection_schedule,
1971
2051
  enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::CollectionSchedule }
1972
2052
 
2053
+ # @!attribute created_at
2054
+ #
2055
+ # @return [Time]
2056
+ required :created_at, Time
2057
+
1973
2058
  # @!attribute proration
1974
2059
  #
1975
2060
  # @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration]
@@ -2021,6 +2106,13 @@ module MetronomeSDK
2021
2106
  optional :billing_cycle_config,
2022
2107
  -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig }
2023
2108
 
2109
+ # @!attribute custom_credit_type_id
2110
+ # If provided, the subscription's price will be in terms of this custom pricing
2111
+ # unit instead of the fiat currency.
2112
+ #
2113
+ # @return [String, nil]
2114
+ optional :custom_credit_type_id, String
2115
+
2024
2116
  # @!attribute custom_fields
2025
2117
  # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
2026
2118
  #
@@ -2047,13 +2139,21 @@ module MetronomeSDK
2047
2139
  # @return [String, nil]
2048
2140
  optional :name, String
2049
2141
 
2142
+ # @!attribute product_custom_fields
2143
+ # Custom fields from the subscription product referenced by
2144
+ # `subscription_rate.product`. These are distinct from the subscription instance's
2145
+ # `custom_fields`.
2146
+ #
2147
+ # @return [Hash{Symbol=>String}, nil]
2148
+ optional :product_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
2149
+
2050
2150
  # @!attribute seat_config
2051
2151
  #
2052
2152
  # @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::SeatConfig, nil]
2053
2153
  optional :seat_config,
2054
2154
  -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::SeatConfig }
2055
2155
 
2056
- # @!method initialize(billing_periods:, collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, seat_config: nil)
2156
+ # @!method initialize(billing_periods:, collection_schedule:, created_at:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_credit_type_id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, product_custom_fields: nil, seat_config: nil)
2057
2157
  # Some parameter documentations has been truncated, see
2058
2158
  # {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription}
2059
2159
  # for more details.
@@ -2062,6 +2162,8 @@ module MetronomeSDK
2062
2162
  #
2063
2163
  # @param collection_schedule [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::CollectionSchedule]
2064
2164
  #
2165
+ # @param created_at [Time]
2166
+ #
2065
2167
  # @param proration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::Proration]
2066
2168
  #
2067
2169
  # @param quantity_management_mode [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::QuantityManagementMode] Determines how the subscription's quantity is controlled. Defaults to QUANTITY_O
@@ -2076,6 +2178,8 @@ module MetronomeSDK
2076
2178
  #
2077
2179
  # @param billing_cycle_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::BillingCycleConfig]
2078
2180
  #
2181
+ # @param custom_credit_type_id [String] If provided, the subscription's price will be in terms of this custom pricing un
2182
+ #
2079
2183
  # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
2080
2184
  #
2081
2185
  # @param description [String]
@@ -2086,6 +2190,8 @@ module MetronomeSDK
2086
2190
  #
2087
2191
  # @param name [String]
2088
2192
  #
2193
+ # @param product_custom_fields [Hash{Symbol=>String}] Custom fields from the subscription product referenced by `subscription_rate.pro
2194
+ #
2089
2195
  # @param seat_config [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription::SeatConfig]
2090
2196
 
2091
2197
  # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::AddSubscription#billing_periods
@@ -3412,6 +3518,32 @@ module MetronomeSDK
3412
3518
  # @return [Array<String>, nil]
3413
3519
  optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String], nil?: true
3414
3520
 
3521
+ # @!attribute duration
3522
+ # The length of time the created commit will be valid, starting from the end of
3523
+ # the invoice's service period. Set to null to clear a previously configured
3524
+ # duration.
3525
+ #
3526
+ # @return [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration, nil]
3527
+ optional :duration,
3528
+ -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration },
3529
+ nil?: true
3530
+
3531
+ # @!attribute rate_type
3532
+ # Whether the created commits will be charged at commit rate or list rate. Set to
3533
+ # null to clear a previously configured rate type.
3534
+ #
3535
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::RateType, nil]
3536
+ optional :rate_type,
3537
+ enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::RateType },
3538
+ nil?: true
3539
+
3540
+ # @!attribute rollover_fraction
3541
+ # Fraction of the created commit's unused balance that will roll over. Must be
3542
+ # between 0 and 1. Set to null to clear a previously configured rollover fraction.
3543
+ #
3544
+ # @return [Float, nil]
3545
+ optional :rollover_fraction, Float, nil?: true
3546
+
3415
3547
  # @!attribute specifiers
3416
3548
  # List of filters that determine what kind of customer usage draws down a commit
3417
3549
  # or credit. A customer's usage needs to meet the condition of at least one of the
@@ -3425,7 +3557,7 @@ module MetronomeSDK
3425
3557
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] },
3426
3558
  nil?: true
3427
3559
 
3428
- # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, specifiers: nil)
3560
+ # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, duration: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil)
3429
3561
  # Some parameter documentations has been truncated, see
3430
3562
  # {MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit}
3431
3563
  # for more details.
@@ -3434,7 +3566,59 @@ module MetronomeSDK
3434
3566
  #
3435
3567
  # @param applicable_product_tags [Array<String>, nil] Which tags the threshold commit applies to. If both applicable_product_ids and a
3436
3568
  #
3569
+ # @param duration [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration, nil] The length of time the created commit will be valid, starting from the end of th
3570
+ #
3571
+ # @param rate_type [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::RateType, nil] Whether the created commits will be charged at commit rate or list rate. Set to
3572
+ #
3573
+ # @param rollover_fraction [Float, nil] Fraction of the created commit's unused balance that will roll over. Must be bet
3574
+ #
3437
3575
  # @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil] List of filters that determine what kind of customer usage draws down a commit o
3576
+
3577
+ class Duration < MetronomeSDK::Internal::Type::BaseModel
3578
+ # @!attribute unit
3579
+ #
3580
+ # @return [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration::Unit]
3581
+ required :unit,
3582
+ enum: -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration::Unit }
3583
+
3584
+ # @!attribute value
3585
+ #
3586
+ # @return [Integer]
3587
+ required :value, Integer
3588
+
3589
+ # @!method initialize(unit:, value:)
3590
+ # The length of time the created commit will be valid, starting from the end of
3591
+ # the invoice's service period. Set to null to clear a previously configured
3592
+ # duration.
3593
+ #
3594
+ # @param unit [Symbol, MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration::Unit]
3595
+ # @param value [Integer]
3596
+
3597
+ # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration::Commit::Duration#unit
3598
+ module Unit
3599
+ extend MetronomeSDK::Internal::Type::Enum
3600
+
3601
+ DAYS = :DAYS
3602
+ WEEKS = :WEEKS
3603
+ MONTHS = :MONTHS
3604
+ YEARS = :YEARS
3605
+
3606
+ # @!method self.values
3607
+ # @return [Array<Symbol>]
3608
+ end
3609
+ end
3610
+
3611
+ # Whether the created commits will be charged at commit rate or list rate. Set to
3612
+ # null to clear a previously configured rate type.
3613
+ module RateType
3614
+ extend MetronomeSDK::Internal::Type::Enum
3615
+
3616
+ COMMIT_RATE = :COMMIT_RATE
3617
+ LIST_RATE = :LIST_RATE
3618
+
3619
+ # @!method self.values
3620
+ # @return [Array<Symbol>]
3621
+ end
3438
3622
  end
3439
3623
 
3440
3624
  # @see MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdatePrepaidBalanceThresholdConfiguration#discount_configuration
@@ -4135,6 +4319,11 @@ module MetronomeSDK
4135
4319
  # @return [Time, nil]
4136
4320
  optional :ending_before, Time
4137
4321
 
4322
+ # @!attribute name
4323
+ #
4324
+ # @return [String, nil]
4325
+ optional :name, String
4326
+
4138
4327
  # @!attribute quantity_updates
4139
4328
  #
4140
4329
  # @return [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::QuantityUpdate>, nil]
@@ -4148,11 +4337,13 @@ module MetronomeSDK
4148
4337
  optional :seat_updates,
4149
4338
  -> { MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates }
4150
4339
 
4151
- # @!method initialize(id:, ending_before: nil, quantity_updates: nil, seat_updates: nil)
4340
+ # @!method initialize(id:, ending_before: nil, name: nil, quantity_updates: nil, seat_updates: nil)
4152
4341
  # @param id [String]
4153
4342
  #
4154
4343
  # @param ending_before [Time]
4155
4344
  #
4345
+ # @param name [String]
4346
+ #
4156
4347
  # @param quantity_updates [Array<MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::QuantityUpdate>]
4157
4348
  #
4158
4349
  # @param seat_updates [MetronomeSDK::Models::V2::ContractGetEditHistoryResponse::Data::UpdateSubscription::SeatUpdates] Manage subscription seats for subscriptions in SEAT_BASED mode.
@@ -20,6 +20,12 @@ module MetronomeSDK
20
20
  # @return [Time, nil]
21
21
  optional :covering_date, Time
22
22
 
23
+ # @!attribute cursor
24
+ # Cursor from a previous response to fetch the next page of contracts.
25
+ #
26
+ # @return [String, nil]
27
+ optional :cursor, String
28
+
23
29
  # @!attribute include_archived
24
30
  # Include archived contracts in the response.
25
31
  #
@@ -40,6 +46,12 @@ module MetronomeSDK
40
46
  # @return [Boolean, nil]
41
47
  optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean
42
48
 
49
+ # @!attribute limit
50
+ # Max number of contracts to return per page. Range: 1-20. Default: 20.
51
+ #
52
+ # @return [Float, nil]
53
+ optional :limit, Float
54
+
43
55
  # @!attribute starting_at
44
56
  # Optional RFC 3339 timestamp. Only include contracts that started on or after
45
57
  # this date. This cannot be provided if covering_date filter is provided.
@@ -47,7 +59,7 @@ module MetronomeSDK
47
59
  # @return [Time, nil]
48
60
  optional :starting_at, Time
49
61
 
50
- # @!method initialize(customer_id:, covering_date: nil, include_archived: nil, include_balance: nil, include_ledgers: nil, starting_at: nil, request_options: {})
62
+ # @!method initialize(customer_id:, covering_date: nil, cursor: nil, include_archived: nil, include_balance: nil, include_ledgers: nil, limit: nil, starting_at: nil, request_options: {})
51
63
  # Some parameter documentations has been truncated, see
52
64
  # {MetronomeSDK::Models::V2::ContractListParams} for more details.
53
65
  #
@@ -55,12 +67,16 @@ module MetronomeSDK
55
67
  #
56
68
  # @param covering_date [Time] Optional RFC 3339 timestamp. Only include contracts active on the provided date.
57
69
  #
70
+ # @param cursor [String] Cursor from a previous response to fetch the next page of contracts.
71
+ #
58
72
  # @param include_archived [Boolean] Include archived contracts in the response.
59
73
  #
60
74
  # @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma
61
75
  #
62
76
  # @param include_ledgers [Boolean] Include commit/credit ledgers in the response. Setting this flag may cause the r
63
77
  #
78
+ # @param limit [Float] Max number of contracts to return per page. Range: 1-20. Default: 20.
79
+ #
64
80
  # @param starting_at [Time] Optional RFC 3339 timestamp. Only include contracts that started on or after thi
65
81
  #
66
82
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
@@ -0,0 +1,104 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ class LifecycleEventOffsetNotificationConfig < MetronomeSDK::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # ID for this offset notification configuration
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute archived_at
14
+ # When this notification configuration was archived
15
+ #
16
+ # @return [Time, nil]
17
+ required :archived_at, Time, nil?: true
18
+
19
+ # @!attribute created_at
20
+ # RFC 3339 timestamp when this notification configuration was created.
21
+ #
22
+ # @return [Time]
23
+ required :created_at, Time
24
+
25
+ # @!attribute created_by
26
+ # Who created this notification configuration
27
+ #
28
+ # @return [String]
29
+ required :created_by, String
30
+
31
+ # @!attribute environment_type
32
+ # The environment type where this notification configuration was created.
33
+ #
34
+ # @return [String]
35
+ required :environment_type, String
36
+
37
+ # @!attribute name
38
+ # The name for this offset notification configuration.
39
+ #
40
+ # @return [String]
41
+ required :name, String
42
+
43
+ # @!attribute policy
44
+ #
45
+ # @return [MetronomeSDK::Models::V2::LifecycleEventOffsetNotificationConfig::Policy]
46
+ required :policy, -> { MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig::Policy }
47
+
48
+ # @!attribute type
49
+ # Indicates this is an offset lifecycle event notification
50
+ #
51
+ # @return [String]
52
+ required :type, String
53
+
54
+ # @!method initialize(id:, archived_at:, created_at:, created_by:, environment_type:, name:, policy:, type:)
55
+ # Some parameter documentations has been truncated, see
56
+ # {MetronomeSDK::Models::V2::LifecycleEventOffsetNotificationConfig} for more
57
+ # details.
58
+ #
59
+ # @param id [String] ID for this offset notification configuration
60
+ #
61
+ # @param archived_at [Time, nil] When this notification configuration was archived
62
+ #
63
+ # @param created_at [Time] RFC 3339 timestamp when this notification configuration was created.
64
+ #
65
+ # @param created_by [String] Who created this notification configuration
66
+ #
67
+ # @param environment_type [String] The environment type where this notification configuration was created.
68
+ #
69
+ # @param name [String] The name for this offset notification configuration.
70
+ #
71
+ # @param policy [MetronomeSDK::Models::V2::LifecycleEventOffsetNotificationConfig::Policy]
72
+ #
73
+ # @param type [String] Indicates this is an offset lifecycle event notification
74
+
75
+ # @see MetronomeSDK::Models::V2::LifecycleEventOffsetNotificationConfig#policy
76
+ class Policy < MetronomeSDK::Internal::Type::BaseModel
77
+ # @!attribute offset
78
+ # ISO-8601 duration string indicating how much time before or after the base event
79
+ # this notification should be sent. Positive values indicate notifications after
80
+ # the event, negative values indicate notifications before the event. Examples:
81
+ # "P1D" (1 day after), "-PT2H" (2 hours before)
82
+ #
83
+ # @return [String]
84
+ required :offset, String
85
+
86
+ # @!attribute type
87
+ # The type of lifecycle event that this offset is based on.
88
+ #
89
+ # @return [String]
90
+ required :type, String
91
+
92
+ # @!method initialize(offset:, type:)
93
+ # Some parameter documentations has been truncated, see
94
+ # {MetronomeSDK::Models::V2::LifecycleEventOffsetNotificationConfig::Policy} for
95
+ # more details.
96
+ #
97
+ # @param offset [String] ISO-8601 duration string indicating how much time before or after the base event
98
+ #
99
+ # @param type [String] The type of lifecycle event that this offset is based on.
100
+ end
101
+ end
102
+ end
103
+ end
104
+ end
@@ -0,0 +1,45 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ class LifecycleEventSystemNotificationConfig < MetronomeSDK::Internal::Type::BaseModel
7
+ # @!attribute policy
8
+ #
9
+ # @return [MetronomeSDK::Models::V2::LifecycleEventSystemNotificationConfig::Policy]
10
+ required :policy, -> { MetronomeSDK::V2::LifecycleEventSystemNotificationConfig::Policy }
11
+
12
+ # @!attribute type
13
+ # Indicates this is a system lifecycle event notification
14
+ #
15
+ # @return [String]
16
+ required :type, String
17
+
18
+ # @!attribute is_enabled
19
+ # Whether or not webhook publishing for this lifecycle event is enabled
20
+ #
21
+ # @return [Boolean, nil]
22
+ optional :is_enabled, MetronomeSDK::Internal::Type::Boolean
23
+
24
+ # @!method initialize(policy:, type:, is_enabled: nil)
25
+ # @param policy [MetronomeSDK::Models::V2::LifecycleEventSystemNotificationConfig::Policy]
26
+ #
27
+ # @param type [String] Indicates this is a system lifecycle event notification
28
+ #
29
+ # @param is_enabled [Boolean] Whether or not webhook publishing for this lifecycle event is enabled
30
+
31
+ # @see MetronomeSDK::Models::V2::LifecycleEventSystemNotificationConfig#policy
32
+ class Policy < MetronomeSDK::Internal::Type::BaseModel
33
+ # @!attribute type
34
+ # The type of lifecycle event (e.g., "contract.create", "contract.start")
35
+ #
36
+ # @return [String]
37
+ required :type, String
38
+
39
+ # @!method initialize(type:)
40
+ # @param type [String] The type of lifecycle event (e.g., "contract.create", "contract.start")
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,29 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ module Notifications
7
+ # @see MetronomeSDK::Resources::V2::Notifications::Offset#archive
8
+ class OffsetArchiveParams < MetronomeSDK::Internal::Type::BaseModel
9
+ extend MetronomeSDK::Internal::Type::RequestParameters::Converter
10
+ include MetronomeSDK::Internal::Type::RequestParameters
11
+
12
+ # @!attribute id
13
+ # The ID of the offset lifecycle event notification configuration to archive.
14
+ #
15
+ # @return [String]
16
+ required :id, String
17
+
18
+ # @!method initialize(id:, request_options: {})
19
+ # Some parameter documentations has been truncated, see
20
+ # {MetronomeSDK::Models::V2::Notifications::OffsetArchiveParams} for more details.
21
+ #
22
+ # @param id [String] The ID of the offset lifecycle event notification configuration to archive.
23
+ #
24
+ # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
25
+ end
26
+ end
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V2
6
+ module Notifications
7
+ # @see MetronomeSDK::Resources::V2::Notifications::Offset#archive
8
+ class OffsetArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
9
+ # @!attribute data
10
+ #
11
+ # @return [MetronomeSDK::Models::V2::LifecycleEventOffsetNotificationConfig]
12
+ required :data, -> { MetronomeSDK::V2::LifecycleEventOffsetNotificationConfig }
13
+
14
+ # @!method initialize(data:)
15
+ # @param data [MetronomeSDK::Models::V2::LifecycleEventOffsetNotificationConfig]
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end