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
@@ -872,6 +872,25 @@ module MetronomeSDK
872
872
  end
873
873
  attr_accessor :schedule_items
874
874
 
875
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
876
+ # usage. `QUANTITY` deducts the number of units used.
877
+ sig do
878
+ returns(
879
+ T.nilable(
880
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType::TaggedSymbol
881
+ )
882
+ )
883
+ end
884
+ attr_reader :access_type
885
+
886
+ sig do
887
+ params(
888
+ access_type:
889
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType::OrSymbol
890
+ ).void
891
+ end
892
+ attr_writer :access_type
893
+
875
894
  # The schedule that the customer will gain access to the credits purposed with
876
895
  # this commit.
877
896
  sig do
@@ -880,10 +899,18 @@ module MetronomeSDK
880
899
  schedule_items:
881
900
  T::Array[
882
901
  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::ScheduleItem::OrHash
883
- ]
902
+ ],
903
+ access_type:
904
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType::OrSymbol
884
905
  ).returns(T.attached_class)
885
906
  end
886
- def self.new(credit_type:, schedule_items:)
907
+ def self.new(
908
+ credit_type:,
909
+ schedule_items:,
910
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
911
+ # usage. `QUANTITY` deducts the number of units used.
912
+ access_type: nil
913
+ )
887
914
  end
888
915
 
889
916
  sig do
@@ -893,7 +920,9 @@ module MetronomeSDK
893
920
  schedule_items:
894
921
  T::Array[
895
922
  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::ScheduleItem
896
- ]
923
+ ],
924
+ access_type:
925
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType::TaggedSymbol
897
926
  }
898
927
  )
899
928
  end
@@ -1145,6 +1174,42 @@ module MetronomeSDK
1145
1174
  end
1146
1175
  end
1147
1176
  end
1177
+
1178
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
1179
+ # usage. `QUANTITY` deducts the number of units used.
1180
+ module AccessType
1181
+ extend MetronomeSDK::Internal::Type::Enum
1182
+
1183
+ TaggedSymbol =
1184
+ T.type_alias do
1185
+ T.all(
1186
+ Symbol,
1187
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType
1188
+ )
1189
+ end
1190
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
1191
+
1192
+ SPEND =
1193
+ T.let(
1194
+ :SPEND,
1195
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType::TaggedSymbol
1196
+ )
1197
+ QUANTITY =
1198
+ T.let(
1199
+ :QUANTITY,
1200
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType::TaggedSymbol
1201
+ )
1202
+
1203
+ sig do
1204
+ override.returns(
1205
+ T::Array[
1206
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Commit::AccessSchedule::AccessType::TaggedSymbol
1207
+ ]
1208
+ )
1209
+ end
1210
+ def self.values
1211
+ end
1212
+ end
1148
1213
  end
1149
1214
 
1150
1215
  class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
@@ -2503,6 +2568,11 @@ module MetronomeSDK
2503
2568
  :CONTRACT_START,
2504
2569
  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day::TaggedSymbol
2505
2570
  )
2571
+ CUSTOM_DATE =
2572
+ T.let(
2573
+ :CUSTOM_DATE,
2574
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::UsageStatementSchedule::Day::TaggedSymbol
2575
+ )
2506
2576
 
2507
2577
  sig do
2508
2578
  override.returns(
@@ -2849,16 +2919,43 @@ module MetronomeSDK
2849
2919
  end
2850
2920
  attr_accessor :schedule_items
2851
2921
 
2922
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
2923
+ # usage. `QUANTITY` deducts the number of units used.
2924
+ sig do
2925
+ returns(
2926
+ T.nilable(
2927
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType::TaggedSymbol
2928
+ )
2929
+ )
2930
+ end
2931
+ attr_reader :access_type
2932
+
2933
+ sig do
2934
+ params(
2935
+ access_type:
2936
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType::OrSymbol
2937
+ ).void
2938
+ end
2939
+ attr_writer :access_type
2940
+
2852
2941
  sig do
2853
2942
  params(
2854
2943
  credit_type: MetronomeSDK::CreditTypeData::OrHash,
2855
2944
  schedule_items:
2856
2945
  T::Array[
2857
2946
  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::ScheduleItem::OrHash
2858
- ]
2947
+ ],
2948
+ access_type:
2949
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType::OrSymbol
2859
2950
  ).returns(T.attached_class)
2860
2951
  end
2861
- def self.new(credit_type:, schedule_items:)
2952
+ def self.new(
2953
+ credit_type:,
2954
+ schedule_items:,
2955
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
2956
+ # usage. `QUANTITY` deducts the number of units used.
2957
+ access_type: nil
2958
+ )
2862
2959
  end
2863
2960
 
2864
2961
  sig do
@@ -2868,7 +2965,9 @@ module MetronomeSDK
2868
2965
  schedule_items:
2869
2966
  T::Array[
2870
2967
  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::ScheduleItem
2871
- ]
2968
+ ],
2969
+ access_type:
2970
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType::TaggedSymbol
2872
2971
  }
2873
2972
  )
2874
2973
  end
@@ -3120,6 +3219,42 @@ module MetronomeSDK
3120
3219
  end
3121
3220
  end
3122
3221
  end
3222
+
3223
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
3224
+ # usage. `QUANTITY` deducts the number of units used.
3225
+ module AccessType
3226
+ extend MetronomeSDK::Internal::Type::Enum
3227
+
3228
+ TaggedSymbol =
3229
+ T.type_alias do
3230
+ T.all(
3231
+ Symbol,
3232
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType
3233
+ )
3234
+ end
3235
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3236
+
3237
+ SPEND =
3238
+ T.let(
3239
+ :SPEND,
3240
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType::TaggedSymbol
3241
+ )
3242
+ QUANTITY =
3243
+ T.let(
3244
+ :QUANTITY,
3245
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType::TaggedSymbol
3246
+ )
3247
+
3248
+ sig do
3249
+ override.returns(
3250
+ T::Array[
3251
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Credit::AccessSchedule::AccessType::TaggedSymbol
3252
+ ]
3253
+ )
3254
+ end
3255
+ def self.values
3256
+ end
3257
+ end
3123
3258
  end
3124
3259
 
3125
3260
  module RateType
@@ -3712,12 +3847,33 @@ module MetronomeSDK
3712
3847
  )
3713
3848
  end
3714
3849
 
3850
+ # This ID identifies the credit type for the access amount. Quantity-based
3851
+ # recurring commits and credits return the null credit type UUID.
3715
3852
  sig { returns(String) }
3716
3853
  attr_accessor :credit_type_id
3717
3854
 
3718
3855
  sig { returns(Float) }
3719
3856
  attr_accessor :unit_price
3720
3857
 
3858
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
3859
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
3860
+ sig do
3861
+ returns(
3862
+ T.nilable(
3863
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType::TaggedSymbol
3864
+ )
3865
+ )
3866
+ end
3867
+ attr_reader :access_type
3868
+
3869
+ sig do
3870
+ params(
3871
+ access_type:
3872
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType::OrSymbol
3873
+ ).void
3874
+ end
3875
+ attr_writer :access_type
3876
+
3721
3877
  sig { returns(T.nilable(Float)) }
3722
3878
  attr_reader :quantity
3723
3879
 
@@ -3729,19 +3885,72 @@ module MetronomeSDK
3729
3885
  params(
3730
3886
  credit_type_id: String,
3731
3887
  unit_price: Float,
3888
+ access_type:
3889
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType::OrSymbol,
3732
3890
  quantity: Float
3733
3891
  ).returns(T.attached_class)
3734
3892
  end
3735
- def self.new(credit_type_id:, unit_price:, quantity: nil)
3893
+ def self.new(
3894
+ # This ID identifies the credit type for the access amount. Quantity-based
3895
+ # recurring commits and credits return the null credit type UUID.
3896
+ credit_type_id:,
3897
+ unit_price:,
3898
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
3899
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
3900
+ access_type: nil,
3901
+ quantity: nil
3902
+ )
3736
3903
  end
3737
3904
 
3738
3905
  sig do
3739
3906
  override.returns(
3740
- { credit_type_id: String, unit_price: Float, quantity: Float }
3907
+ {
3908
+ credit_type_id: String,
3909
+ unit_price: Float,
3910
+ access_type:
3911
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType::TaggedSymbol,
3912
+ quantity: Float
3913
+ }
3741
3914
  )
3742
3915
  end
3743
3916
  def to_hash
3744
3917
  end
3918
+
3919
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
3920
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
3921
+ module AccessType
3922
+ extend MetronomeSDK::Internal::Type::Enum
3923
+
3924
+ TaggedSymbol =
3925
+ T.type_alias do
3926
+ T.all(
3927
+ Symbol,
3928
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType
3929
+ )
3930
+ end
3931
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
3932
+
3933
+ SPEND =
3934
+ T.let(
3935
+ :SPEND,
3936
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType::TaggedSymbol
3937
+ )
3938
+ QUANTITY =
3939
+ T.let(
3940
+ :QUANTITY,
3941
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType::TaggedSymbol
3942
+ )
3943
+
3944
+ sig do
3945
+ override.returns(
3946
+ T::Array[
3947
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCommit::AccessAmount::AccessType::TaggedSymbol
3948
+ ]
3949
+ )
3950
+ end
3951
+ def self.values
3952
+ end
3953
+ end
3745
3954
  end
3746
3955
 
3747
3956
  class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
@@ -4944,12 +5153,33 @@ module MetronomeSDK
4944
5153
  )
4945
5154
  end
4946
5155
 
5156
+ # This ID identifies the credit type for the access amount. Quantity-based
5157
+ # recurring commits and credits return the null credit type UUID.
4947
5158
  sig { returns(String) }
4948
5159
  attr_accessor :credit_type_id
4949
5160
 
4950
5161
  sig { returns(Float) }
4951
5162
  attr_accessor :unit_price
4952
5163
 
5164
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
5165
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
5166
+ sig do
5167
+ returns(
5168
+ T.nilable(
5169
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType::TaggedSymbol
5170
+ )
5171
+ )
5172
+ end
5173
+ attr_reader :access_type
5174
+
5175
+ sig do
5176
+ params(
5177
+ access_type:
5178
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType::OrSymbol
5179
+ ).void
5180
+ end
5181
+ attr_writer :access_type
5182
+
4953
5183
  sig { returns(T.nilable(Float)) }
4954
5184
  attr_reader :quantity
4955
5185
 
@@ -4961,19 +5191,72 @@ module MetronomeSDK
4961
5191
  params(
4962
5192
  credit_type_id: String,
4963
5193
  unit_price: Float,
5194
+ access_type:
5195
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType::OrSymbol,
4964
5196
  quantity: Float
4965
5197
  ).returns(T.attached_class)
4966
5198
  end
4967
- def self.new(credit_type_id:, unit_price:, quantity: nil)
5199
+ def self.new(
5200
+ # This ID identifies the credit type for the access amount. Quantity-based
5201
+ # recurring commits and credits return the null credit type UUID.
5202
+ credit_type_id:,
5203
+ unit_price:,
5204
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
5205
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
5206
+ access_type: nil,
5207
+ quantity: nil
5208
+ )
4968
5209
  end
4969
5210
 
4970
5211
  sig do
4971
5212
  override.returns(
4972
- { credit_type_id: String, unit_price: Float, quantity: Float }
5213
+ {
5214
+ credit_type_id: String,
5215
+ unit_price: Float,
5216
+ access_type:
5217
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType::TaggedSymbol,
5218
+ quantity: Float
5219
+ }
4973
5220
  )
4974
5221
  end
4975
5222
  def to_hash
4976
5223
  end
5224
+
5225
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
5226
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
5227
+ module AccessType
5228
+ extend MetronomeSDK::Internal::Type::Enum
5229
+
5230
+ TaggedSymbol =
5231
+ T.type_alias do
5232
+ T.all(
5233
+ Symbol,
5234
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType
5235
+ )
5236
+ end
5237
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
5238
+
5239
+ SPEND =
5240
+ T.let(
5241
+ :SPEND,
5242
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType::TaggedSymbol
5243
+ )
5244
+ QUANTITY =
5245
+ T.let(
5246
+ :QUANTITY,
5247
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType::TaggedSymbol
5248
+ )
5249
+
5250
+ sig do
5251
+ override.returns(
5252
+ T::Array[
5253
+ MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::RecurringCredit::AccessAmount::AccessType::TaggedSymbol
5254
+ ]
5255
+ )
5256
+ end
5257
+ def self.values
5258
+ end
5259
+ end
4977
5260
  end
4978
5261
 
4979
5262
  class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
@@ -6042,6 +6325,14 @@ module MetronomeSDK
6042
6325
  end
6043
6326
  attr_writer :billing_cycle_config
6044
6327
 
6328
+ # If provided, the subscription's price will be in terms of this custom pricing
6329
+ # unit instead of the fiat currency.
6330
+ sig { returns(T.nilable(String)) }
6331
+ attr_reader :custom_credit_type_id
6332
+
6333
+ sig { params(custom_credit_type_id: String).void }
6334
+ attr_writer :custom_credit_type_id
6335
+
6045
6336
  # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
6046
6337
  sig { returns(T.nilable(T::Hash[Symbol, String])) }
6047
6338
  attr_reader :custom_fields
@@ -6161,6 +6452,7 @@ module MetronomeSDK
6161
6452
  id: String,
6162
6453
  billing_cycle_config:
6163
6454
  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::BillingCycleConfig::OrHash,
6455
+ custom_credit_type_id: String,
6164
6456
  custom_fields: T::Hash[Symbol, String],
6165
6457
  description: String,
6166
6458
  duration:
@@ -6182,6 +6474,9 @@ module MetronomeSDK
6182
6474
  subscription_rate:,
6183
6475
  id: nil,
6184
6476
  billing_cycle_config: nil,
6477
+ # If provided, the subscription's price will be in terms of this custom pricing
6478
+ # unit instead of the fiat currency.
6479
+ custom_credit_type_id: nil,
6185
6480
  # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
6186
6481
  custom_fields: nil,
6187
6482
  description: nil,
@@ -6216,6 +6511,7 @@ module MetronomeSDK
6216
6511
  id: String,
6217
6512
  billing_cycle_config:
6218
6513
  MetronomeSDK::Models::V1::PackageRetrieveResponse::Data::Subscription::BillingCycleConfig,
6514
+ custom_credit_type_id: String,
6219
6515
  custom_fields: T::Hash[Symbol, String],
6220
6516
  description: String,
6221
6517
  duration:
@@ -0,0 +1,34 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ class PricingUnitArchiveParams < MetronomeSDK::Models::ID
7
+ extend MetronomeSDK::Internal::Type::RequestParameters::Converter
8
+ include MetronomeSDK::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(
13
+ MetronomeSDK::V1::PricingUnitArchiveParams,
14
+ MetronomeSDK::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ sig do
19
+ params(request_options: MetronomeSDK::RequestOptions::OrHash).returns(
20
+ T.attached_class
21
+ )
22
+ end
23
+ def self.new(request_options: {})
24
+ end
25
+
26
+ sig do
27
+ override.returns({ request_options: MetronomeSDK::RequestOptions })
28
+ end
29
+ def to_hash
30
+ end
31
+ end
32
+ end
33
+ end
34
+ end
@@ -0,0 +1,31 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ class PricingUnitArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ MetronomeSDK::Models::V1::PricingUnitArchiveResponse,
11
+ MetronomeSDK::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ sig { returns(MetronomeSDK::ID) }
16
+ attr_reader :data
17
+
18
+ sig { params(data: MetronomeSDK::ID::OrHash).void }
19
+ attr_writer :data
20
+
21
+ sig { params(data: MetronomeSDK::ID::OrHash).returns(T.attached_class) }
22
+ def self.new(data:)
23
+ end
24
+
25
+ sig { override.returns({ data: MetronomeSDK::ID }) }
26
+ def to_hash
27
+ end
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,45 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ class PricingUnitCreateParams < MetronomeSDK::Internal::Type::BaseModel
7
+ extend MetronomeSDK::Internal::Type::RequestParameters::Converter
8
+ include MetronomeSDK::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(
13
+ MetronomeSDK::V1::PricingUnitCreateParams,
14
+ MetronomeSDK::Internal::AnyHash
15
+ )
16
+ end
17
+
18
+ # The name of the custom pricing unit. This will appear on invoices.
19
+ sig { returns(String) }
20
+ attr_accessor :name
21
+
22
+ sig do
23
+ params(
24
+ name: String,
25
+ request_options: MetronomeSDK::RequestOptions::OrHash
26
+ ).returns(T.attached_class)
27
+ end
28
+ def self.new(
29
+ # The name of the custom pricing unit. This will appear on invoices.
30
+ name:,
31
+ request_options: {}
32
+ )
33
+ end
34
+
35
+ sig do
36
+ override.returns(
37
+ { name: String, request_options: MetronomeSDK::RequestOptions }
38
+ )
39
+ end
40
+ def to_hash
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,31 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ class PricingUnitCreateResponse < MetronomeSDK::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(
10
+ MetronomeSDK::Models::V1::PricingUnitCreateResponse,
11
+ MetronomeSDK::Internal::AnyHash
12
+ )
13
+ end
14
+
15
+ sig { returns(MetronomeSDK::ID) }
16
+ attr_reader :data
17
+
18
+ sig { params(data: MetronomeSDK::ID::OrHash).void }
19
+ attr_writer :data
20
+
21
+ sig { params(data: MetronomeSDK::ID::OrHash).returns(T.attached_class) }
22
+ def self.new(data:)
23
+ end
24
+
25
+ sig { override.returns({ data: MetronomeSDK::ID }) }
26
+ def to_hash
27
+ end
28
+ end
29
+ end
30
+ end
31
+ end
@@ -15,9 +15,11 @@ module MetronomeSDK
15
15
  )
16
16
  end
17
17
 
18
+ # Must be aligned to UTC midnight and at least one day after `starting_on`.
18
19
  sig { returns(Time) }
19
20
  attr_accessor :ending_before
20
21
 
22
+ # Must be aligned to UTC midnight, e.g. `2024-01-01T00:00:00Z`.
21
23
  sig { returns(Time) }
22
24
  attr_accessor :starting_on
23
25
 
@@ -79,7 +81,9 @@ module MetronomeSDK
79
81
  ).returns(T.attached_class)
80
82
  end
81
83
  def self.new(
84
+ # Must be aligned to UTC midnight and at least one day after `starting_on`.
82
85
  ending_before:,
86
+ # Must be aligned to UTC midnight, e.g. `2024-01-01T00:00:00Z`.
83
87
  starting_on:,
84
88
  # A window_size of "day" or "hour" will return the usage for the specified period
85
89
  # segmented into daily or hourly aggregates. A window_size of "none" will return a