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
@@ -188,6 +188,8 @@ module MetronomeSDK
188
188
  sig { returns(Float) }
189
189
  attr_accessor :balance
190
190
 
191
+ # This ID identifies the credit type for the balance. Quantity-based balances
192
+ # return the null credit type UUID.
191
193
  sig { returns(String) }
192
194
  attr_accessor :credit_type_id
193
195
 
@@ -196,21 +198,47 @@ module MetronomeSDK
196
198
  sig { returns(Float) }
197
199
  attr_accessor :starting_balance
198
200
 
201
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
202
+ # usage. `QUANTITY` deducts the number of units used.
203
+ sig do
204
+ returns(
205
+ T.nilable(
206
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType::TaggedSymbol
207
+ )
208
+ )
209
+ end
210
+ attr_reader :access_type
211
+
212
+ sig do
213
+ params(
214
+ access_type:
215
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType::OrSymbol
216
+ ).void
217
+ end
218
+ attr_writer :access_type
219
+
199
220
  sig do
200
221
  params(
201
222
  balance: Float,
202
223
  credit_type_id: String,
203
- starting_balance: Float
224
+ starting_balance: Float,
225
+ access_type:
226
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType::OrSymbol
204
227
  ).returns(T.attached_class)
205
228
  end
206
229
  def self.new(
207
230
  # The total balance across all commits and credits for this seat, of this credit
208
231
  # type.
209
232
  balance:,
233
+ # This ID identifies the credit type for the balance. Quantity-based balances
234
+ # return the null credit type UUID.
210
235
  credit_type_id:,
211
236
  # The total initial balances of all commits and credits for this seat, of this
212
237
  # credit type.
213
- starting_balance:
238
+ starting_balance:,
239
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
240
+ # usage. `QUANTITY` deducts the number of units used.
241
+ access_type: nil
214
242
  )
215
243
  end
216
244
 
@@ -219,12 +247,50 @@ module MetronomeSDK
219
247
  {
220
248
  balance: Float,
221
249
  credit_type_id: String,
222
- starting_balance: Float
250
+ starting_balance: Float,
251
+ access_type:
252
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType::TaggedSymbol
223
253
  }
224
254
  )
225
255
  end
226
256
  def to_hash
227
257
  end
258
+
259
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
260
+ # usage. `QUANTITY` deducts the number of units used.
261
+ module AccessType
262
+ extend MetronomeSDK::Internal::Type::Enum
263
+
264
+ TaggedSymbol =
265
+ T.type_alias do
266
+ T.all(
267
+ Symbol,
268
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType
269
+ )
270
+ end
271
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
272
+
273
+ SPEND =
274
+ T.let(
275
+ :SPEND,
276
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType::TaggedSymbol
277
+ )
278
+ QUANTITY =
279
+ T.let(
280
+ :QUANTITY,
281
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType::TaggedSymbol
282
+ )
283
+
284
+ sig do
285
+ override.returns(
286
+ T::Array[
287
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance::AccessType::TaggedSymbol
288
+ ]
289
+ )
290
+ end
291
+ def self.values
292
+ end
293
+ end
228
294
  end
229
295
 
230
296
  class Commit < MetronomeSDK::Internal::Type::BaseModel
@@ -248,6 +314,33 @@ module MetronomeSDK
248
314
  sig { returns(Time) }
249
315
  attr_accessor :start_date
250
316
 
317
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
318
+ # usage. `QUANTITY` deducts the number of units used.
319
+ sig do
320
+ returns(
321
+ T.nilable(
322
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType::TaggedSymbol
323
+ )
324
+ )
325
+ end
326
+ attr_reader :access_type
327
+
328
+ sig do
329
+ params(
330
+ access_type:
331
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType::OrSymbol
332
+ ).void
333
+ end
334
+ attr_writer :access_type
335
+
336
+ # The credit type for this commit. Quantity-based commits return the null credit
337
+ # type UUID.
338
+ sig { returns(T.nilable(String)) }
339
+ attr_reader :credit_type_id
340
+
341
+ sig { params(credit_type_id: String).void }
342
+ attr_writer :credit_type_id
343
+
251
344
  # The datetime when the commit expires
252
345
  sig { returns(T.nilable(Time)) }
253
346
  attr_accessor :end_date
@@ -280,6 +373,9 @@ module MetronomeSDK
280
373
  id: String,
281
374
  balance: Float,
282
375
  start_date: Time,
376
+ access_type:
377
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType::OrSymbol,
378
+ credit_type_id: String,
283
379
  end_date: T.nilable(Time),
284
380
  ledger_entries:
285
381
  T::Array[
@@ -294,6 +390,12 @@ module MetronomeSDK
294
390
  balance:,
295
391
  # The datetime when the commit becomes active
296
392
  start_date:,
393
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
394
+ # usage. `QUANTITY` deducts the number of units used.
395
+ access_type: nil,
396
+ # The credit type for this commit. Quantity-based commits return the null credit
397
+ # type UUID.
398
+ credit_type_id: nil,
297
399
  # The datetime when the commit expires
298
400
  end_date: nil,
299
401
  # Transaction history for this commit for this seat (only included if
@@ -308,6 +410,9 @@ module MetronomeSDK
308
410
  id: String,
309
411
  balance: Float,
310
412
  start_date: Time,
413
+ access_type:
414
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType::TaggedSymbol,
415
+ credit_type_id: String,
311
416
  end_date: T.nilable(Time),
312
417
  ledger_entries:
313
418
  T::Array[
@@ -319,6 +424,42 @@ module MetronomeSDK
319
424
  def to_hash
320
425
  end
321
426
 
427
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
428
+ # usage. `QUANTITY` deducts the number of units used.
429
+ module AccessType
430
+ extend MetronomeSDK::Internal::Type::Enum
431
+
432
+ TaggedSymbol =
433
+ T.type_alias do
434
+ T.all(
435
+ Symbol,
436
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType
437
+ )
438
+ end
439
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
440
+
441
+ SPEND =
442
+ T.let(
443
+ :SPEND,
444
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType::TaggedSymbol
445
+ )
446
+ QUANTITY =
447
+ T.let(
448
+ :QUANTITY,
449
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType::TaggedSymbol
450
+ )
451
+
452
+ sig do
453
+ override.returns(
454
+ T::Array[
455
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::AccessType::TaggedSymbol
456
+ ]
457
+ )
458
+ end
459
+ def self.values
460
+ end
461
+ end
462
+
322
463
  class LedgerEntry < MetronomeSDK::Internal::Type::BaseModel
323
464
  OrHash =
324
465
  T.type_alias do
@@ -463,6 +604,33 @@ module MetronomeSDK
463
604
  sig { returns(Time) }
464
605
  attr_accessor :start_date
465
606
 
607
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
608
+ # usage. `QUANTITY` deducts the number of units used.
609
+ sig do
610
+ returns(
611
+ T.nilable(
612
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType::TaggedSymbol
613
+ )
614
+ )
615
+ end
616
+ attr_reader :access_type
617
+
618
+ sig do
619
+ params(
620
+ access_type:
621
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType::OrSymbol
622
+ ).void
623
+ end
624
+ attr_writer :access_type
625
+
626
+ # The credit type for this credit. Quantity-based credits return the null credit
627
+ # type UUID.
628
+ sig { returns(T.nilable(String)) }
629
+ attr_reader :credit_type_id
630
+
631
+ sig { params(credit_type_id: String).void }
632
+ attr_writer :credit_type_id
633
+
466
634
  # The datetime when the credit expires
467
635
  sig { returns(T.nilable(Time)) }
468
636
  attr_accessor :end_date
@@ -495,6 +663,9 @@ module MetronomeSDK
495
663
  id: String,
496
664
  balance: Float,
497
665
  start_date: Time,
666
+ access_type:
667
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType::OrSymbol,
668
+ credit_type_id: String,
498
669
  end_date: T.nilable(Time),
499
670
  ledger_entries:
500
671
  T::Array[
@@ -509,6 +680,12 @@ module MetronomeSDK
509
680
  balance:,
510
681
  # The datetime when the credit becomes active
511
682
  start_date:,
683
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
684
+ # usage. `QUANTITY` deducts the number of units used.
685
+ access_type: nil,
686
+ # The credit type for this credit. Quantity-based credits return the null credit
687
+ # type UUID.
688
+ credit_type_id: nil,
512
689
  # The datetime when the credit expires
513
690
  end_date: nil,
514
691
  # Transaction history for this credit for this seat (only included if
@@ -523,6 +700,9 @@ module MetronomeSDK
523
700
  id: String,
524
701
  balance: Float,
525
702
  start_date: Time,
703
+ access_type:
704
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType::TaggedSymbol,
705
+ credit_type_id: String,
526
706
  end_date: T.nilable(Time),
527
707
  ledger_entries:
528
708
  T::Array[
@@ -534,6 +714,42 @@ module MetronomeSDK
534
714
  def to_hash
535
715
  end
536
716
 
717
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
718
+ # usage. `QUANTITY` deducts the number of units used.
719
+ module AccessType
720
+ extend MetronomeSDK::Internal::Type::Enum
721
+
722
+ TaggedSymbol =
723
+ T.type_alias do
724
+ T.all(
725
+ Symbol,
726
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType
727
+ )
728
+ end
729
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
730
+
731
+ SPEND =
732
+ T.let(
733
+ :SPEND,
734
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType::TaggedSymbol
735
+ )
736
+ QUANTITY =
737
+ T.let(
738
+ :QUANTITY,
739
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType::TaggedSymbol
740
+ )
741
+
742
+ sig do
743
+ override.returns(
744
+ T::Array[
745
+ MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::AccessType::TaggedSymbol
746
+ ]
747
+ )
748
+ end
749
+ def self.values
750
+ end
751
+ end
752
+
537
753
  class LedgerEntry < MetronomeSDK::Internal::Type::BaseModel
538
754
  OrHash =
539
755
  T.type_alias do
@@ -56,6 +56,14 @@ module MetronomeSDK
56
56
  )
57
57
  end
58
58
 
59
+ # The pricing unit for history prices when present. Otherwise prices use
60
+ # fiat_credit_type_id.
61
+ sig { returns(T.nilable(String)) }
62
+ attr_reader :custom_credit_type_id
63
+
64
+ sig { params(custom_credit_type_id: String).void }
65
+ attr_writer :custom_credit_type_id
66
+
59
67
  sig { returns(T.nilable(String)) }
60
68
  attr_reader :fiat_credit_type_id
61
69
 
@@ -91,6 +99,7 @@ module MetronomeSDK
91
99
 
92
100
  sig do
93
101
  params(
102
+ custom_credit_type_id: String,
94
103
  fiat_credit_type_id: String,
95
104
  history:
96
105
  T::Array[
@@ -100,6 +109,9 @@ module MetronomeSDK
100
109
  ).returns(T.attached_class)
101
110
  end
102
111
  def self.new(
112
+ # The pricing unit for history prices when present. Otherwise prices use
113
+ # fiat_credit_type_id.
114
+ custom_credit_type_id: nil,
103
115
  fiat_credit_type_id: nil,
104
116
  history: nil,
105
117
  subscription_id: nil
@@ -109,6 +121,7 @@ module MetronomeSDK
109
121
  sig do
110
122
  override.returns(
111
123
  {
124
+ custom_credit_type_id: String,
112
125
  fiat_credit_type_id: String,
113
126
  history:
114
127
  T::Array[
@@ -63,6 +63,14 @@ module MetronomeSDK
63
63
  sig { params(exclude_free_usage: T::Boolean).void }
64
64
  attr_writer :exclude_free_usage
65
65
 
66
+ # Only for composite products. If true, allows a composite to incorporate spend
67
+ # from other composite products. Defaults to false
68
+ sig { returns(T.nilable(T::Boolean)) }
69
+ attr_reader :include_composite_spend
70
+
71
+ sig { params(include_composite_spend: T::Boolean).void }
72
+ attr_writer :include_composite_spend
73
+
66
74
  # This field's availability is dependent on your client's configuration. Defaults
67
75
  # to true.
68
76
  sig { returns(T.nilable(T::Boolean)) }
@@ -182,6 +190,7 @@ module MetronomeSDK
182
190
  composite_tags: T::Array[String],
183
191
  custom_fields: T::Hash[Symbol, String],
184
192
  exclude_free_usage: T::Boolean,
193
+ include_composite_spend: T::Boolean,
185
194
  is_refundable: T::Boolean,
186
195
  netsuite_internal_item_id: String,
187
196
  netsuite_overage_item_id: String,
@@ -216,6 +225,9 @@ module MetronomeSDK
216
225
  # Beta feature only available for composite products. If true, products with $0
217
226
  # will not be included when computing composite usage. Defaults to false
218
227
  exclude_free_usage: nil,
228
+ # Only for composite products. If true, allows a composite to incorporate spend
229
+ # from other composite products. Defaults to false
230
+ include_composite_spend: nil,
219
231
  # This field's availability is dependent on your client's configuration. Defaults
220
232
  # to true.
221
233
  is_refundable: nil,
@@ -268,6 +280,7 @@ module MetronomeSDK
268
280
  composite_tags: T::Array[String],
269
281
  custom_fields: T::Hash[Symbol, String],
270
282
  exclude_free_usage: T::Boolean,
283
+ include_composite_spend: T::Boolean,
271
284
  is_refundable: T::Boolean,
272
285
  netsuite_internal_item_id: String,
273
286
  netsuite_overage_item_id: String,
@@ -46,6 +46,14 @@ module MetronomeSDK
46
46
  sig { params(exclude_free_usage: T::Boolean).void }
47
47
  attr_writer :exclude_free_usage
48
48
 
49
+ # Only for composite products. If true, allows a composite to incorporate spend
50
+ # from other composite products. Defaults to false
51
+ sig { returns(T.nilable(T::Boolean)) }
52
+ attr_reader :include_composite_spend
53
+
54
+ sig { params(include_composite_spend: T::Boolean).void }
55
+ attr_writer :include_composite_spend
56
+
49
57
  # This field's availability is dependent on your client's configuration.
50
58
  sig { returns(T.nilable(T::Boolean)) }
51
59
  attr_reader :is_refundable
@@ -146,6 +154,7 @@ module MetronomeSDK
146
154
  composite_product_ids: T::Array[String],
147
155
  composite_tags: T::Array[String],
148
156
  exclude_free_usage: T::Boolean,
157
+ include_composite_spend: T::Boolean,
149
158
  is_refundable: T::Boolean,
150
159
  netsuite_internal_item_id: String,
151
160
  netsuite_overage_item_id: String,
@@ -171,6 +180,9 @@ module MetronomeSDK
171
180
  composite_product_ids: nil,
172
181
  composite_tags: nil,
173
182
  exclude_free_usage: nil,
183
+ # Only for composite products. If true, allows a composite to incorporate spend
184
+ # from other composite products. Defaults to false
185
+ include_composite_spend: nil,
174
186
  # This field's availability is dependent on your client's configuration.
175
187
  is_refundable: nil,
176
188
  # This field's availability is dependent on your client's configuration.
@@ -214,6 +226,7 @@ module MetronomeSDK
214
226
  composite_product_ids: T::Array[String],
215
227
  composite_tags: T::Array[String],
216
228
  exclude_free_usage: T::Boolean,
229
+ include_composite_spend: T::Boolean,
217
230
  is_refundable: T::Boolean,
218
231
  netsuite_internal_item_id: String,
219
232
  netsuite_overage_item_id: String,
@@ -199,6 +199,14 @@ module MetronomeSDK
199
199
  sig { params(exclude_free_usage: T::Boolean).void }
200
200
  attr_writer :exclude_free_usage
201
201
 
202
+ # Only for composite products. If true, allows a composite to incorporate spend
203
+ # from other composite products. Defaults to false
204
+ sig { returns(T.nilable(T::Boolean)) }
205
+ attr_reader :include_composite_spend
206
+
207
+ sig { params(include_composite_spend: T::Boolean).void }
208
+ attr_writer :include_composite_spend
209
+
202
210
  sig { returns(T.nilable(T::Boolean)) }
203
211
  attr_reader :is_refundable
204
212
 
@@ -307,6 +315,7 @@ module MetronomeSDK
307
315
  composite_product_ids: T::Array[String],
308
316
  composite_tags: T::Array[String],
309
317
  exclude_free_usage: T::Boolean,
318
+ include_composite_spend: T::Boolean,
310
319
  is_refundable: T::Boolean,
311
320
  name: String,
312
321
  netsuite_internal_item_id: String,
@@ -332,6 +341,9 @@ module MetronomeSDK
332
341
  composite_product_ids: nil,
333
342
  composite_tags: nil,
334
343
  exclude_free_usage: nil,
344
+ # Only for composite products. If true, allows a composite to incorporate spend
345
+ # from other composite products. Defaults to false
346
+ include_composite_spend: nil,
335
347
  is_refundable: nil,
336
348
  name: nil,
337
349
  # This field's availability is dependent on your client's configuration.
@@ -374,6 +386,7 @@ module MetronomeSDK
374
386
  composite_product_ids: T::Array[String],
375
387
  composite_tags: T::Array[String],
376
388
  exclude_free_usage: T::Boolean,
389
+ include_composite_spend: T::Boolean,
377
390
  is_refundable: T::Boolean,
378
391
  name: String,
379
392
  netsuite_internal_item_id: String,
@@ -245,6 +245,14 @@ module MetronomeSDK
245
245
  sig { params(exclude_free_usage: T::Boolean).void }
246
246
  attr_writer :exclude_free_usage
247
247
 
248
+ # Only for composite products. If true, allows a composite to incorporate spend
249
+ # from other composite products. Defaults to false
250
+ sig { returns(T.nilable(T::Boolean)) }
251
+ attr_reader :include_composite_spend
252
+
253
+ sig { params(include_composite_spend: T::Boolean).void }
254
+ attr_writer :include_composite_spend
255
+
248
256
  sig { returns(T.nilable(T::Boolean)) }
249
257
  attr_reader :is_refundable
250
258
 
@@ -355,6 +363,7 @@ module MetronomeSDK
355
363
  composite_product_ids: T::Array[String],
356
364
  composite_tags: T::Array[String],
357
365
  exclude_free_usage: T::Boolean,
366
+ include_composite_spend: T::Boolean,
358
367
  is_refundable: T::Boolean,
359
368
  name: String,
360
369
  netsuite_internal_item_id: String,
@@ -380,6 +389,9 @@ module MetronomeSDK
380
389
  composite_product_ids: nil,
381
390
  composite_tags: nil,
382
391
  exclude_free_usage: nil,
392
+ # Only for composite products. If true, allows a composite to incorporate spend
393
+ # from other composite products. Defaults to false
394
+ include_composite_spend: nil,
383
395
  is_refundable: nil,
384
396
  name: nil,
385
397
  # This field's availability is dependent on your client's configuration.
@@ -422,6 +434,7 @@ module MetronomeSDK
422
434
  composite_product_ids: T::Array[String],
423
435
  composite_tags: T::Array[String],
424
436
  exclude_free_usage: T::Boolean,
437
+ include_composite_spend: T::Boolean,
425
438
  is_refundable: T::Boolean,
426
439
  name: String,
427
440
  netsuite_internal_item_id: String,
@@ -57,6 +57,14 @@ module MetronomeSDK
57
57
  sig { params(exclude_free_usage: T::Boolean).void }
58
58
  attr_writer :exclude_free_usage
59
59
 
60
+ # Only for composite products. If true, allows a composite to incorporate spend
61
+ # from other composite products. Defaults to false
62
+ sig { returns(T.nilable(T::Boolean)) }
63
+ attr_reader :include_composite_spend
64
+
65
+ sig { params(include_composite_spend: T::Boolean).void }
66
+ attr_writer :include_composite_spend
67
+
60
68
  # Defaults to product's current refundability status. This field's availability is
61
69
  # dependent on your client's configuration.
62
70
  sig { returns(T.nilable(T::Boolean)) }
@@ -185,6 +193,7 @@ module MetronomeSDK
185
193
  composite_product_ids: T::Array[String],
186
194
  composite_tags: T::Array[String],
187
195
  exclude_free_usage: T::Boolean,
196
+ include_composite_spend: T::Boolean,
188
197
  is_refundable: T::Boolean,
189
198
  name: String,
190
199
  netsuite_internal_item_id: String,
@@ -223,6 +232,9 @@ module MetronomeSDK
223
232
  # Beta feature only available for composite products. If true, products with $0
224
233
  # will not be included when computing composite usage. Defaults to false
225
234
  exclude_free_usage: nil,
235
+ # Only for composite products. If true, allows a composite to incorporate spend
236
+ # from other composite products. Defaults to false
237
+ include_composite_spend: nil,
226
238
  # Defaults to product's current refundability status. This field's availability is
227
239
  # dependent on your client's configuration.
228
240
  is_refundable: nil,
@@ -279,6 +291,7 @@ module MetronomeSDK
279
291
  composite_product_ids: T::Array[String],
280
292
  composite_tags: T::Array[String],
281
293
  exclude_free_usage: T::Boolean,
294
+ include_composite_spend: T::Boolean,
282
295
  is_refundable: T::Boolean,
283
296
  name: String,
284
297
  netsuite_internal_item_id: String,
@@ -0,0 +1,122 @@
1
+ # typed: strong
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ module Contracts
7
+ module RateCards
8
+ class NamedScheduleListParams < MetronomeSDK::Internal::Type::BaseModel
9
+ extend MetronomeSDK::Internal::Type::RequestParameters::Converter
10
+ include MetronomeSDK::Internal::Type::RequestParameters
11
+
12
+ OrHash =
13
+ T.type_alias do
14
+ T.any(
15
+ MetronomeSDK::V1::Contracts::RateCards::NamedScheduleListParams,
16
+ MetronomeSDK::Internal::AnyHash
17
+ )
18
+ end
19
+
20
+ # ID of the customer to list contract named schedules for
21
+ sig { returns(String) }
22
+ attr_accessor :customer_id
23
+
24
+ # Optional ID of a contract to scope the results to a single contract
25
+ sig { returns(T.nilable(String)) }
26
+ attr_reader :contract_id
27
+
28
+ sig { params(contract_id: String).void }
29
+ attr_writer :contract_id
30
+
31
+ # If provided, result contains at most one segment covering this date for each
32
+ # schedule.
33
+ sig { returns(T.nilable(Time)) }
34
+ attr_reader :covering_date
35
+
36
+ sig { params(covering_date: Time).void }
37
+ attr_writer :covering_date
38
+
39
+ # Maximum number of named schedules to return.
40
+ sig { returns(T.nilable(Integer)) }
41
+ attr_reader :limit
42
+
43
+ sig { params(limit: Integer).void }
44
+ attr_writer :limit
45
+
46
+ # Cursor for pagination. Use the value from a previous response's next_page.
47
+ sig { returns(T.nilable(String)) }
48
+ attr_reader :next_page
49
+
50
+ sig { params(next_page: String).void }
51
+ attr_writer :next_page
52
+
53
+ # Optional key-value filters. A schedule matches when it contains at least this
54
+ # subset of properties.
55
+ sig { returns(T.nilable(T::Hash[Symbol, String])) }
56
+ attr_reader :properties
57
+
58
+ sig { params(properties: T::Hash[Symbol, String]).void }
59
+ attr_writer :properties
60
+
61
+ # Optional filter to scope the results to a single schedule name
62
+ sig { returns(T.nilable(String)) }
63
+ attr_reader :schedule_name
64
+
65
+ sig { params(schedule_name: String).void }
66
+ attr_writer :schedule_name
67
+
68
+ sig do
69
+ params(
70
+ customer_id: String,
71
+ contract_id: String,
72
+ covering_date: Time,
73
+ limit: Integer,
74
+ next_page: String,
75
+ properties: T::Hash[Symbol, String],
76
+ schedule_name: String,
77
+ request_options: MetronomeSDK::RequestOptions::OrHash
78
+ ).returns(T.attached_class)
79
+ end
80
+ def self.new(
81
+ # ID of the customer to list contract named schedules for
82
+ customer_id:,
83
+ # Optional ID of a contract to scope the results to a single contract
84
+ contract_id: nil,
85
+ # If provided, result contains at most one segment covering this date for each
86
+ # schedule.
87
+ covering_date: nil,
88
+ # Maximum number of named schedules to return.
89
+ limit: nil,
90
+ # Cursor for pagination. Use the value from a previous response's next_page.
91
+ next_page: nil,
92
+ # Optional key-value filters. A schedule matches when it contains at least this
93
+ # subset of properties.
94
+ properties: nil,
95
+ # Optional filter to scope the results to a single schedule name
96
+ schedule_name: nil,
97
+ request_options: {}
98
+ )
99
+ end
100
+
101
+ sig do
102
+ override.returns(
103
+ {
104
+ customer_id: String,
105
+ contract_id: String,
106
+ covering_date: Time,
107
+ limit: Integer,
108
+ next_page: String,
109
+ properties: T::Hash[Symbol, String],
110
+ schedule_name: String,
111
+ request_options: MetronomeSDK::RequestOptions
112
+ }
113
+ )
114
+ end
115
+ def to_hash
116
+ end
117
+ end
118
+ end
119
+ end
120
+ end
121
+ end
122
+ end