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
@@ -561,19 +561,34 @@ module MetronomeSDK
561
561
  required :schedule_items,
562
562
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Commit::AccessSchedule::ScheduleItem] }
563
563
 
564
+ # @!attribute access_type
565
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
566
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
567
+ # omitted.
568
+ #
569
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::AccessSchedule::AccessType, nil]
570
+ optional :access_type,
571
+ enum: -> { MetronomeSDK::V1::ContractCreateParams::Commit::AccessSchedule::AccessType }
572
+
564
573
  # @!attribute credit_type_id
565
574
  # Defaults to USD (cents) if not passed
566
575
  #
567
576
  # @return [String, nil]
568
577
  optional :credit_type_id, String
569
578
 
570
- # @!method initialize(schedule_items:, credit_type_id: nil)
579
+ # @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
580
+ # Some parameter documentations has been truncated, see
581
+ # {MetronomeSDK::Models::V1::ContractCreateParams::Commit::AccessSchedule} for
582
+ # more details.
583
+ #
571
584
  # Required: Schedule for distributing the commit to the customer. For "POSTPAID"
572
585
  # commits only one schedule item is allowed and amount must match invoice_schedule
573
586
  # total.
574
587
  #
575
588
  # @param schedule_items [Array<MetronomeSDK::Models::V1::ContractCreateParams::Commit::AccessSchedule::ScheduleItem>]
576
589
  #
590
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
591
+ #
577
592
  # @param credit_type_id [String] Defaults to USD (cents) if not passed
578
593
 
579
594
  class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
@@ -601,6 +616,21 @@ module MetronomeSDK
601
616
  #
602
617
  # @param starting_at [Time] RFC 3339 timestamp (inclusive)
603
618
  end
619
+
620
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
621
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
622
+ # omitted.
623
+ #
624
+ # @see MetronomeSDK::Models::V1::ContractCreateParams::Commit::AccessSchedule#access_type
625
+ module AccessType
626
+ extend MetronomeSDK::Internal::Type::Enum
627
+
628
+ SPEND = :SPEND
629
+ QUANTITY = :QUANTITY
630
+
631
+ # @!method self.values
632
+ # @return [Array<Symbol>]
633
+ end
604
634
  end
605
635
 
606
636
  # @see MetronomeSDK::Models::V1::ContractCreateParams::Commit#invoice_schedule
@@ -949,17 +979,32 @@ module MetronomeSDK
949
979
  required :schedule_items,
950
980
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Credit::AccessSchedule::ScheduleItem] }
951
981
 
982
+ # @!attribute access_type
983
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
984
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
985
+ # omitted.
986
+ #
987
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Credit::AccessSchedule::AccessType, nil]
988
+ optional :access_type,
989
+ enum: -> { MetronomeSDK::V1::ContractCreateParams::Credit::AccessSchedule::AccessType }
990
+
952
991
  # @!attribute credit_type_id
953
992
  # Defaults to USD (cents) if not passed
954
993
  #
955
994
  # @return [String, nil]
956
995
  optional :credit_type_id, String
957
996
 
958
- # @!method initialize(schedule_items:, credit_type_id: nil)
997
+ # @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
998
+ # Some parameter documentations has been truncated, see
999
+ # {MetronomeSDK::Models::V1::ContractCreateParams::Credit::AccessSchedule} for
1000
+ # more details.
1001
+ #
959
1002
  # Schedule for distributing the credit to the customer.
960
1003
  #
961
1004
  # @param schedule_items [Array<MetronomeSDK::Models::V1::ContractCreateParams::Credit::AccessSchedule::ScheduleItem>]
962
1005
  #
1006
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Credit::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
1007
+ #
963
1008
  # @param credit_type_id [String] Defaults to USD (cents) if not passed
964
1009
 
965
1010
  class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
@@ -987,6 +1032,21 @@ module MetronomeSDK
987
1032
  #
988
1033
  # @param starting_at [Time] RFC 3339 timestamp (inclusive)
989
1034
  end
1035
+
1036
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
1037
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
1038
+ # omitted.
1039
+ #
1040
+ # @see MetronomeSDK::Models::V1::ContractCreateParams::Credit::AccessSchedule#access_type
1041
+ module AccessType
1042
+ extend MetronomeSDK::Internal::Type::Enum
1043
+
1044
+ SPEND = :SPEND
1045
+ QUANTITY = :QUANTITY
1046
+
1047
+ # @!method self.values
1048
+ # @return [Array<Symbol>]
1049
+ end
990
1050
  end
991
1051
 
992
1052
  # @see MetronomeSDK::Models::V1::ContractCreateParams::Credit#rate_type
@@ -1997,16 +2057,25 @@ module MetronomeSDK
1997
2057
 
1998
2058
  # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit#access_amount
1999
2059
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
2000
- # @!attribute credit_type_id
2001
- #
2002
- # @return [String]
2003
- required :credit_type_id, String
2004
-
2005
2060
  # @!attribute unit_price
2006
2061
  #
2007
2062
  # @return [Float]
2008
2063
  required :unit_price, Float
2009
2064
 
2065
+ # @!attribute access_type
2066
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2067
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2068
+ #
2069
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::AccessAmount::AccessType, nil]
2070
+ optional :access_type,
2071
+ enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCommit::AccessAmount::AccessType }
2072
+
2073
+ # @!attribute credit_type_id
2074
+ # Defaults to USD (cents) if not passed
2075
+ #
2076
+ # @return [String, nil]
2077
+ optional :credit_type_id, String
2078
+
2010
2079
  # @!attribute quantity
2011
2080
  # This field is required unless a subscription is attached via
2012
2081
  # `subscription_config`.
@@ -2014,18 +2083,34 @@ module MetronomeSDK
2014
2083
  # @return [Float, nil]
2015
2084
  optional :quantity, Float
2016
2085
 
2017
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
2086
+ # @!method initialize(unit_price:, access_type: nil, credit_type_id: nil, quantity: nil)
2018
2087
  # Some parameter documentations has been truncated, see
2019
2088
  # {MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::AccessAmount}
2020
2089
  # for more details.
2021
2090
  #
2022
2091
  # The amount of commit to grant.
2023
2092
  #
2024
- # @param credit_type_id [String]
2025
- #
2026
2093
  # @param unit_price [Float]
2027
2094
  #
2095
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
2096
+ #
2097
+ # @param credit_type_id [String] Defaults to USD (cents) if not passed
2098
+ #
2028
2099
  # @param quantity [Float] This field is required unless a subscription is attached via `subscription_confi
2100
+
2101
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2102
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2103
+ #
2104
+ # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::AccessAmount#access_type
2105
+ module AccessType
2106
+ extend MetronomeSDK::Internal::Type::Enum
2107
+
2108
+ SPEND = :SPEND
2109
+ QUANTITY = :QUANTITY
2110
+
2111
+ # @!method self.values
2112
+ # @return [Array<Symbol>]
2113
+ end
2029
2114
  end
2030
2115
 
2031
2116
  # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit#commit_duration
@@ -2480,16 +2565,25 @@ module MetronomeSDK
2480
2565
 
2481
2566
  # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit#access_amount
2482
2567
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
2483
- # @!attribute credit_type_id
2484
- #
2485
- # @return [String]
2486
- required :credit_type_id, String
2487
-
2488
2568
  # @!attribute unit_price
2489
2569
  #
2490
2570
  # @return [Float]
2491
2571
  required :unit_price, Float
2492
2572
 
2573
+ # @!attribute access_type
2574
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2575
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2576
+ #
2577
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::AccessAmount::AccessType, nil]
2578
+ optional :access_type,
2579
+ enum: -> { MetronomeSDK::V1::ContractCreateParams::RecurringCredit::AccessAmount::AccessType }
2580
+
2581
+ # @!attribute credit_type_id
2582
+ # Defaults to USD (cents) if not passed
2583
+ #
2584
+ # @return [String, nil]
2585
+ optional :credit_type_id, String
2586
+
2493
2587
  # @!attribute quantity
2494
2588
  # This field is required unless a subscription is attached via
2495
2589
  # `subscription_config`.
@@ -2497,18 +2591,34 @@ module MetronomeSDK
2497
2591
  # @return [Float, nil]
2498
2592
  optional :quantity, Float
2499
2593
 
2500
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
2594
+ # @!method initialize(unit_price:, access_type: nil, credit_type_id: nil, quantity: nil)
2501
2595
  # Some parameter documentations has been truncated, see
2502
2596
  # {MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::AccessAmount}
2503
2597
  # for more details.
2504
2598
  #
2505
2599
  # The amount of commit to grant.
2506
2600
  #
2507
- # @param credit_type_id [String]
2508
- #
2509
2601
  # @param unit_price [Float]
2510
2602
  #
2603
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
2604
+ #
2605
+ # @param credit_type_id [String] Defaults to USD (cents) if not passed
2606
+ #
2511
2607
  # @param quantity [Float] This field is required unless a subscription is attached via `subscription_confi
2608
+
2609
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
2610
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
2611
+ #
2612
+ # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::AccessAmount#access_type
2613
+ module AccessType
2614
+ extend MetronomeSDK::Internal::Type::Enum
2615
+
2616
+ SPEND = :SPEND
2617
+ QUANTITY = :QUANTITY
2618
+
2619
+ # @!method self.values
2620
+ # @return [Array<Symbol>]
2621
+ end
2512
2622
  end
2513
2623
 
2514
2624
  # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit#commit_duration
@@ -534,6 +534,12 @@ module MetronomeSDK
534
534
  required :access_amount,
535
535
  -> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit::AccessAmount }
536
536
 
537
+ # @!attribute anchor_date
538
+ # The date this recurring commit's billing periods are anchored to.
539
+ #
540
+ # @return [Time]
541
+ required :anchor_date, Time
542
+
537
543
  # @!attribute commit_duration
538
544
  # The amount of time the created commits will be valid for
539
545
  #
@@ -671,7 +677,7 @@ module MetronomeSDK
671
677
  # @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
672
678
  optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
673
679
 
674
- # @!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)
680
+ # @!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)
675
681
  # Some parameter documentations has been truncated, see
676
682
  # {MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit}
677
683
  # for more details.
@@ -680,6 +686,8 @@ module MetronomeSDK
680
686
  #
681
687
  # @param access_amount [MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit::AccessAmount] The amount of commit to grant.
682
688
  #
689
+ # @param anchor_date [Time] The date this recurring commit's billing periods are anchored to.
690
+ #
683
691
  # @param commit_duration [MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit::CommitDuration] The amount of time the created commits will be valid for
684
692
  #
685
693
  # @param priority [Float] Will be passed down to the individual commits
@@ -723,6 +731,8 @@ module MetronomeSDK
723
731
  # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit#access_amount
724
732
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
725
733
  # @!attribute credit_type_id
734
+ # This ID identifies the credit type for the access amount. Quantity-based
735
+ # recurring commits and credits return the null credit type UUID.
726
736
  #
727
737
  # @return [String]
728
738
  required :credit_type_id, String
@@ -732,17 +742,47 @@ module MetronomeSDK
732
742
  # @return [Float]
733
743
  required :unit_price, Float
734
744
 
745
+ # @!attribute access_type
746
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
747
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
748
+ #
749
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit::AccessAmount::AccessType, nil]
750
+ optional :access_type,
751
+ enum: -> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit::AccessAmount::AccessType }
752
+
735
753
  # @!attribute quantity
736
754
  #
737
755
  # @return [Float, nil]
738
756
  optional :quantity, Float
739
757
 
740
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
758
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
759
+ # Some parameter documentations has been truncated, see
760
+ # {MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit::AccessAmount}
761
+ # for more details.
762
+ #
741
763
  # The amount of commit to grant.
742
764
  #
743
- # @param credit_type_id [String]
765
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
766
+ #
744
767
  # @param unit_price [Float]
768
+ #
769
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
770
+ #
745
771
  # @param quantity [Float]
772
+
773
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
774
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
775
+ #
776
+ # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit::AccessAmount#access_type
777
+ module AccessType
778
+ extend MetronomeSDK::Internal::Type::Enum
779
+
780
+ SPEND = :SPEND
781
+ QUANTITY = :QUANTITY
782
+
783
+ # @!method self.values
784
+ # @return [Array<Symbol>]
785
+ end
746
786
  end
747
787
 
748
788
  # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCommit#commit_duration
@@ -991,6 +1031,12 @@ module MetronomeSDK
991
1031
  required :access_amount,
992
1032
  -> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit::AccessAmount }
993
1033
 
1034
+ # @!attribute anchor_date
1035
+ # The date this recurring commit's billing periods are anchored to.
1036
+ #
1037
+ # @return [Time]
1038
+ required :anchor_date, Time
1039
+
994
1040
  # @!attribute commit_duration
995
1041
  # The amount of time the created commits will be valid for
996
1042
  #
@@ -1121,7 +1167,7 @@ module MetronomeSDK
1121
1167
  # @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
1122
1168
  optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
1123
1169
 
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, name: nil, netsuite_sales_order_id: nil, proration: nil, proration_rounding: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil)
1170
+ # @!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)
1125
1171
  # Some parameter documentations has been truncated, see
1126
1172
  # {MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit}
1127
1173
  # for more details.
@@ -1130,6 +1176,8 @@ module MetronomeSDK
1130
1176
  #
1131
1177
  # @param access_amount [MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit::AccessAmount] The amount of commit to grant.
1132
1178
  #
1179
+ # @param anchor_date [Time] The date this recurring commit's billing periods are anchored to.
1180
+ #
1133
1181
  # @param commit_duration [MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit::CommitDuration] The amount of time the created commits will be valid for
1134
1182
  #
1135
1183
  # @param priority [Float] Will be passed down to the individual commits
@@ -1171,6 +1219,8 @@ module MetronomeSDK
1171
1219
  # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit#access_amount
1172
1220
  class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
1173
1221
  # @!attribute credit_type_id
1222
+ # This ID identifies the credit type for the access amount. Quantity-based
1223
+ # recurring commits and credits return the null credit type UUID.
1174
1224
  #
1175
1225
  # @return [String]
1176
1226
  required :credit_type_id, String
@@ -1180,17 +1230,47 @@ module MetronomeSDK
1180
1230
  # @return [Float]
1181
1231
  required :unit_price, Float
1182
1232
 
1233
+ # @!attribute access_type
1234
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1235
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1236
+ #
1237
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit::AccessAmount::AccessType, nil]
1238
+ optional :access_type,
1239
+ enum: -> { MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit::AccessAmount::AccessType }
1240
+
1183
1241
  # @!attribute quantity
1184
1242
  #
1185
1243
  # @return [Float, nil]
1186
1244
  optional :quantity, Float
1187
1245
 
1188
- # @!method initialize(credit_type_id:, unit_price:, quantity: nil)
1246
+ # @!method initialize(credit_type_id:, unit_price:, access_type: nil, quantity: nil)
1247
+ # Some parameter documentations has been truncated, see
1248
+ # {MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit::AccessAmount}
1249
+ # for more details.
1250
+ #
1189
1251
  # The amount of commit to grant.
1190
1252
  #
1191
- # @param credit_type_id [String]
1253
+ # @param credit_type_id [String] This ID identifies the credit type for the access amount. Quantity-based recurri
1254
+ #
1192
1255
  # @param unit_price [Float]
1256
+ #
1257
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit::AccessAmount::AccessType] Indicates how the balance of child commits is drawn down. `SPEND` deducts the do
1258
+ #
1193
1259
  # @param quantity [Float]
1260
+
1261
+ # Indicates how the balance of child commits is drawn down. `SPEND` deducts the
1262
+ # dollar cost of usage. `QUANTITY` deducts the number of units used.
1263
+ #
1264
+ # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit::AccessAmount#access_type
1265
+ module AccessType
1266
+ extend MetronomeSDK::Internal::Type::Enum
1267
+
1268
+ SPEND = :SPEND
1269
+ QUANTITY = :QUANTITY
1270
+
1271
+ # @!method self.values
1272
+ # @return [Array<Symbol>]
1273
+ end
1194
1274
  end
1195
1275
 
1196
1276
  # @see MetronomeSDK::Models::V1::ContractCreateResponse::Data::Contract::RecurringCredit#commit_duration
@@ -14,6 +14,13 @@ module MetronomeSDK
14
14
  # @return [String]
15
15
  required :customer_id, String
16
16
 
17
+ # @!attribute access_type
18
+ # Filters balances by how they are drawn down. Defaults to `SPEND`. If set to
19
+ # `QUANTITY`, `credit_type_id` must not be provided.
20
+ #
21
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractGetNetBalanceParams::AccessType, nil]
22
+ optional :access_type, enum: -> { MetronomeSDK::V1::ContractGetNetBalanceParams::AccessType }
23
+
17
24
  # @!attribute credit_type_id
18
25
  # The ID of the credit type (can be fiat or a custom pricing unit) to get the
19
26
  # balance for. Defaults to USD (cents) if not specified.
@@ -37,12 +44,14 @@ module MetronomeSDK
37
44
  optional :invoice_inclusion_mode,
38
45
  enum: -> { MetronomeSDK::V1::ContractGetNetBalanceParams::InvoiceInclusionMode }
39
46
 
40
- # @!method initialize(customer_id:, credit_type_id: nil, filters: nil, invoice_inclusion_mode: nil, request_options: {})
47
+ # @!method initialize(customer_id:, access_type: nil, credit_type_id: nil, filters: nil, invoice_inclusion_mode: nil, request_options: {})
41
48
  # Some parameter documentations has been truncated, see
42
49
  # {MetronomeSDK::Models::V1::ContractGetNetBalanceParams} for more details.
43
50
  #
44
51
  # @param customer_id [String] The ID of the customer.
45
52
  #
53
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractGetNetBalanceParams::AccessType] Filters balances by how they are drawn down. Defaults to `SPEND`. If set to `QUA
54
+ #
46
55
  # @param credit_type_id [String] The ID of the credit type (can be fiat or a custom pricing unit) to get the bala
47
56
  #
48
57
  # @param filters [Array<MetronomeSDK::Models::BalanceFilter>] Balance filters are OR'd together, so if a given commit or credit matches any of
@@ -51,6 +60,18 @@ module MetronomeSDK
51
60
  #
52
61
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
53
62
 
63
+ # Filters balances by how they are drawn down. Defaults to `SPEND`. If set to
64
+ # `QUANTITY`, `credit_type_id` must not be provided.
65
+ module AccessType
66
+ extend MetronomeSDK::Internal::Type::Enum
67
+
68
+ SPEND = :SPEND
69
+ QUANTITY = :QUANTITY
70
+
71
+ # @!method self.values
72
+ # @return [Array<Symbol>]
73
+ end
74
+
54
75
  # Controls which invoices are considered when calculating the remaining balance.
55
76
  # `FINALIZED` considers only deductions from finalized invoices.
56
77
  # `FINALIZED_AND_DRAFT` also includes deductions from pending draft invoices.
@@ -23,8 +23,9 @@ module MetronomeSDK
23
23
  required :balance, Float
24
24
 
25
25
  # @!attribute credit_type_id
26
- # The ID of the credit type (can be fiat or a custom pricing unit) that the
27
- # balance is for.
26
+ # This ID identifies the credit type for the balance. The credit type can be fiat
27
+ # or a custom pricing unit. Quantity-based balances return the null credit type
28
+ # UUID.
28
29
  #
29
30
  # @return [String]
30
31
  required :credit_type_id, String
@@ -36,7 +37,7 @@ module MetronomeSDK
36
37
  #
37
38
  # @param balance [Float] The combined net balance that the customer has access to use at this moment acro
38
39
  #
39
- # @param credit_type_id [String] The ID of the credit type (can be fiat or a custom pricing unit) that the balanc
40
+ # @param credit_type_id [String] This ID identifies the credit type for the balance. The credit type can be fiat
40
41
  end
41
42
  end
42
43
  end
@@ -18,6 +18,13 @@ module MetronomeSDK
18
18
  # @return [String, nil]
19
19
  optional :id, String
20
20
 
21
+ # @!attribute access_type
22
+ # Filters balances by how they are drawn down. `SPEND` deducts the dollar cost of
23
+ # usage. `QUANTITY` deducts the number of units used.
24
+ #
25
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractListBalancesParams::AccessType, nil]
26
+ optional :access_type, enum: -> { MetronomeSDK::V1::ContractListBalancesParams::AccessType }
27
+
21
28
  # @!attribute covering_date
22
29
  # Return only balances that have access schedules that "cover" the provided date
23
30
  #
@@ -80,7 +87,7 @@ module MetronomeSDK
80
87
  # @return [Time, nil]
81
88
  optional :starting_at, Time
82
89
 
83
- # @!method initialize(customer_id:, id: nil, covering_date: nil, effective_before: nil, exclude_zero_balances: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
90
+ # @!method initialize(customer_id:, id: nil, access_type: nil, covering_date: nil, effective_before: nil, exclude_zero_balances: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, limit: nil, next_page: nil, starting_at: nil, request_options: {})
84
91
  # Some parameter documentations has been truncated, see
85
92
  # {MetronomeSDK::Models::V1::ContractListBalancesParams} for more details.
86
93
  #
@@ -88,6 +95,8 @@ module MetronomeSDK
88
95
  #
89
96
  # @param id [String]
90
97
  #
98
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractListBalancesParams::AccessType] Filters balances by how they are drawn down. `SPEND` deducts the dollar cost of
99
+ #
91
100
  # @param covering_date [Time] Return only balances that have access schedules that "cover" the provided date
92
101
  #
93
102
  # @param effective_before [Time] Include only balances that have any access before the provided date (exclusive)
@@ -109,6 +118,18 @@ module MetronomeSDK
109
118
  # @param starting_at [Time] Include only balances that have any access on or after the provided date
110
119
  #
111
120
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
121
+
122
+ # Filters balances by how they are drawn down. `SPEND` deducts the dollar cost of
123
+ # usage. `QUANTITY` deducts the number of units used.
124
+ module AccessType
125
+ extend MetronomeSDK::Internal::Type::Enum
126
+
127
+ SPEND = :SPEND
128
+ QUANTITY = :QUANTITY
129
+
130
+ # @!method self.values
131
+ # @return [Array<Symbol>]
132
+ end
112
133
  end
113
134
  end
114
135
  end
@@ -21,6 +21,12 @@ module MetronomeSDK
21
21
  # @return [Time, nil]
22
22
  optional :covering_date, Time
23
23
 
24
+ # @!attribute cursor
25
+ # Cursor from a previous response to fetch the next page of contracts.
26
+ #
27
+ # @return [String, nil]
28
+ optional :cursor, String
29
+
24
30
  # @!attribute include_archived
25
31
  # Include archived contracts in the response
26
32
  #
@@ -41,15 +47,21 @@ module MetronomeSDK
41
47
  # @return [Boolean, nil]
42
48
  optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean
43
49
 
50
+ # @!attribute limit
51
+ # Max number of contracts to return per page. Range: 1-20. Default: 20.
52
+ #
53
+ # @return [Integer, nil]
54
+ optional :limit, Integer
55
+
44
56
  # @!attribute starting_at
45
57
  # Optional RFC 3339 timestamp. If provided, the response will include only
46
- # contracts where effective_at is on or after the provided date. This cannot be
58
+ # contracts where starting_at is on or after the provided date. This cannot be
47
59
  # provided if the covering_date filter is provided.
48
60
  #
49
61
  # @return [Time, nil]
50
62
  optional :starting_at, Time
51
63
 
52
- # @!method initialize(customer_id:, covering_date: nil, include_archived: nil, include_balance: nil, include_ledgers: nil, starting_at: nil, request_options: {})
64
+ # @!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: {})
53
65
  # Some parameter documentations has been truncated, see
54
66
  # {MetronomeSDK::Models::V1::ContractListParams} for more details.
55
67
  #
@@ -57,12 +69,16 @@ module MetronomeSDK
57
69
  #
58
70
  # @param covering_date [Time] Optional RFC 3339 timestamp. If provided, the response will include only contrac
59
71
  #
72
+ # @param cursor [String] Cursor from a previous response to fetch the next page of contracts.
73
+ #
60
74
  # @param include_archived [Boolean] Include archived contracts in the response
61
75
  #
62
76
  # @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma
63
77
  #
64
78
  # @param include_ledgers [Boolean] Include commit ledgers in the response. Setting this flag may cause the query to
65
79
  #
80
+ # @param limit [Integer] Max number of contracts to return per page. Range: 1-20. Default: 20.
81
+ #
66
82
  # @param starting_at [Time] Optional RFC 3339 timestamp. If provided, the response will include only contrac
67
83
  #
68
84
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]