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
@@ -93,6 +93,26 @@ module MetronomeSDK
93
93
  # @return [Array<String>, nil]
94
94
  optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
95
95
 
96
+ # @!attribute duration
97
+ # The length of time the created commit will be valid, starting from the end of
98
+ # the invoice's service period. If not provided, defaults to one year.
99
+ #
100
+ # @return [MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit::Duration, nil]
101
+ optional :duration, -> { MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration }
102
+
103
+ # @!attribute rate_type
104
+ # Whether the created commits will be charged at commit rate or list rate.
105
+ #
106
+ # @return [Symbol, MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit::RateType, nil]
107
+ optional :rate_type, enum: -> { MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::RateType }
108
+
109
+ # @!attribute rollover_fraction
110
+ # Fraction of the created commit's unused balance that will roll over. Must be
111
+ # between 0 and 1.
112
+ #
113
+ # @return [Float, nil]
114
+ optional :rollover_fraction, Float
115
+
96
116
  # @!attribute specifiers
97
117
  # List of filters that determine what kind of customer usage draws down a commit
98
118
  # or credit. A customer's usage needs to meet the condition of at least one of the
@@ -102,7 +122,7 @@ module MetronomeSDK
102
122
  # @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
103
123
  optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
104
124
 
105
- # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, specifiers: nil)
125
+ # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, duration: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil)
106
126
  # Some parameter documentations has been truncated, see
107
127
  # {MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit} for more
108
128
  # details.
@@ -111,7 +131,56 @@ module MetronomeSDK
111
131
  #
112
132
  # @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If applicable_product_ids, applicabl
113
133
  #
134
+ # @param duration [MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit::Duration] The length of time the created commit will be valid, starting from the end of th
135
+ #
136
+ # @param rate_type [Symbol, MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit::RateType] Whether the created commits will be charged at commit rate or list rate.
137
+ #
138
+ # @param rollover_fraction [Float] Fraction of the created commit's unused balance that will roll over. Must be bet
139
+ #
114
140
  # @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] List of filters that determine what kind of customer usage draws down a commit o
141
+
142
+ class Duration < MetronomeSDK::Internal::Type::BaseModel
143
+ # @!attribute unit
144
+ #
145
+ # @return [Symbol, MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit]
146
+ required :unit, enum: -> { MetronomeSDK::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit }
147
+
148
+ # @!attribute value
149
+ #
150
+ # @return [Integer]
151
+ required :value, Integer
152
+
153
+ # @!method initialize(unit:, value:)
154
+ # The length of time the created commit will be valid, starting from the end of
155
+ # the invoice's service period. If not provided, defaults to one year.
156
+ #
157
+ # @param unit [Symbol, MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit::Duration::Unit]
158
+ # @param value [Integer]
159
+
160
+ # @see MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration::Commit::Duration#unit
161
+ module Unit
162
+ extend MetronomeSDK::Internal::Type::Enum
163
+
164
+ DAYS = :DAYS
165
+ WEEKS = :WEEKS
166
+ MONTHS = :MONTHS
167
+ YEARS = :YEARS
168
+
169
+ # @!method self.values
170
+ # @return [Array<Symbol>]
171
+ end
172
+ end
173
+
174
+ # Whether the created commits will be charged at commit rate or list rate.
175
+ module RateType
176
+ extend MetronomeSDK::Internal::Type::Enum
177
+
178
+ COMMIT_RATE = :COMMIT_RATE
179
+ LIST_RATE = :LIST_RATE
180
+
181
+ # @!method self.values
182
+ # @return [Array<Symbol>]
183
+ end
115
184
  end
116
185
 
117
186
  # @see MetronomeSDK::Models::PrepaidBalanceThresholdConfiguration#discount_configuration
@@ -93,6 +93,26 @@ module MetronomeSDK
93
93
  # @return [Array<String>, nil]
94
94
  optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
95
95
 
96
+ # @!attribute duration
97
+ # The length of time the created commit will be valid, starting from the end of
98
+ # the invoice's service period. If not provided, defaults to one year.
99
+ #
100
+ # @return [MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit::Duration, nil]
101
+ optional :duration, -> { MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::Commit::Duration }
102
+
103
+ # @!attribute rate_type
104
+ # Whether the created commits will be charged at commit rate or list rate.
105
+ #
106
+ # @return [Symbol, MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit::RateType, nil]
107
+ optional :rate_type, enum: -> { MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::Commit::RateType }
108
+
109
+ # @!attribute rollover_fraction
110
+ # Fraction of the created commit's unused balance that will roll over. Must be
111
+ # between 0 and 1.
112
+ #
113
+ # @return [Float, nil]
114
+ optional :rollover_fraction, Float
115
+
96
116
  # @!attribute specifiers
97
117
  # List of filters that determine what kind of customer usage draws down a commit
98
118
  # or credit. A customer's usage needs to meet the condition of at least one of the
@@ -104,7 +124,7 @@ module MetronomeSDK
104
124
  # @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
105
125
  optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
106
126
 
107
- # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, specifiers: nil)
127
+ # @!method initialize(applicable_product_ids: nil, applicable_product_tags: nil, duration: nil, rate_type: nil, rollover_fraction: nil, specifiers: nil)
108
128
  # Some parameter documentations has been truncated, see
109
129
  # {MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit} for more
110
130
  # details.
@@ -113,7 +133,56 @@ module MetronomeSDK
113
133
  #
114
134
  # @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If applicable_product_ids, applicabl
115
135
  #
136
+ # @param duration [MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit::Duration] The length of time the created commit will be valid, starting from the end of th
137
+ #
138
+ # @param rate_type [Symbol, MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit::RateType] Whether the created commits will be charged at commit rate or list rate.
139
+ #
140
+ # @param rollover_fraction [Float] Fraction of the created commit's unused balance that will roll over. Must be bet
141
+ #
116
142
  # @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] List of filters that determine what kind of customer usage draws down a commit o
143
+
144
+ class Duration < MetronomeSDK::Internal::Type::BaseModel
145
+ # @!attribute unit
146
+ #
147
+ # @return [Symbol, MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit::Duration::Unit]
148
+ required :unit, enum: -> { MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::Commit::Duration::Unit }
149
+
150
+ # @!attribute value
151
+ #
152
+ # @return [Integer]
153
+ required :value, Integer
154
+
155
+ # @!method initialize(unit:, value:)
156
+ # The length of time the created commit will be valid, starting from the end of
157
+ # the invoice's service period. If not provided, defaults to one year.
158
+ #
159
+ # @param unit [Symbol, MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit::Duration::Unit]
160
+ # @param value [Integer]
161
+
162
+ # @see MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2::Commit::Duration#unit
163
+ module Unit
164
+ extend MetronomeSDK::Internal::Type::Enum
165
+
166
+ DAYS = :DAYS
167
+ WEEKS = :WEEKS
168
+ MONTHS = :MONTHS
169
+ YEARS = :YEARS
170
+
171
+ # @!method self.values
172
+ # @return [Array<Symbol>]
173
+ end
174
+ end
175
+
176
+ # Whether the created commits will be charged at commit rate or list rate.
177
+ module RateType
178
+ extend MetronomeSDK::Internal::Type::Enum
179
+
180
+ COMMIT_RATE = :COMMIT_RATE
181
+ LIST_RATE = :LIST_RATE
182
+
183
+ # @!method self.values
184
+ # @return [Array<Symbol>]
185
+ end
117
186
  end
118
187
 
119
188
  # @see MetronomeSDK::Models::PrepaidBalanceThresholdConfigurationV2#discount_configuration
@@ -9,13 +9,26 @@ module MetronomeSDK
9
9
  required :schedule_items,
10
10
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ScheduleDuration::ScheduleItem] }
11
11
 
12
+ # @!attribute access_type
13
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
14
+ # usage. `QUANTITY` deducts the number of units used.
15
+ #
16
+ # @return [Symbol, MetronomeSDK::Models::ScheduleDuration::AccessType, nil]
17
+ optional :access_type, enum: -> { MetronomeSDK::ScheduleDuration::AccessType }
18
+
12
19
  # @!attribute credit_type
13
20
  #
14
21
  # @return [MetronomeSDK::Models::CreditTypeData, nil]
15
22
  optional :credit_type, -> { MetronomeSDK::CreditTypeData }
16
23
 
17
- # @!method initialize(schedule_items:, credit_type: nil)
24
+ # @!method initialize(schedule_items:, access_type: nil, credit_type: nil)
25
+ # Some parameter documentations has been truncated, see
26
+ # {MetronomeSDK::Models::ScheduleDuration} for more details.
27
+ #
18
28
  # @param schedule_items [Array<MetronomeSDK::Models::ScheduleDuration::ScheduleItem>]
29
+ #
30
+ # @param access_type [Symbol, MetronomeSDK::Models::ScheduleDuration::AccessType] Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of usag
31
+ #
19
32
  # @param credit_type [MetronomeSDK::Models::CreditTypeData]
20
33
 
21
34
  class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
@@ -45,6 +58,20 @@ module MetronomeSDK
45
58
  # @param ending_before [Time]
46
59
  # @param starting_at [Time]
47
60
  end
61
+
62
+ # Indicates how the balance is drawn down. `SPEND` deducts the dollar cost of
63
+ # usage. `QUANTITY` deducts the number of units used.
64
+ #
65
+ # @see MetronomeSDK::Models::ScheduleDuration#access_type
66
+ module AccessType
67
+ extend MetronomeSDK::Internal::Type::Enum
68
+
69
+ SPEND = :SPEND
70
+ QUANTITY = :QUANTITY
71
+
72
+ # @!method self.values
73
+ # @return [Array<Symbol>]
74
+ end
48
75
  end
49
76
  end
50
77
  end
@@ -14,6 +14,11 @@ module MetronomeSDK
14
14
  # @return [Symbol, MetronomeSDK::Models::Subscription::CollectionSchedule]
15
15
  required :collection_schedule, enum: -> { MetronomeSDK::Subscription::CollectionSchedule }
16
16
 
17
+ # @!attribute created_at
18
+ #
19
+ # @return [Time]
20
+ required :created_at, Time
21
+
17
22
  # @!attribute proration
18
23
  #
19
24
  # @return [MetronomeSDK::Models::Subscription::Proration]
@@ -61,6 +66,13 @@ module MetronomeSDK
61
66
  # @return [MetronomeSDK::Models::Subscription::BillingCycleConfig, nil]
62
67
  optional :billing_cycle_config, -> { MetronomeSDK::Subscription::BillingCycleConfig }
63
68
 
69
+ # @!attribute custom_credit_type_id
70
+ # If provided, the subscription's price will be in terms of this custom pricing
71
+ # unit instead of the fiat currency.
72
+ #
73
+ # @return [String, nil]
74
+ optional :custom_credit_type_id, String
75
+
64
76
  # @!attribute custom_fields
65
77
  # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
66
78
  #
@@ -87,12 +99,20 @@ module MetronomeSDK
87
99
  # @return [String, nil]
88
100
  optional :name, String
89
101
 
102
+ # @!attribute product_custom_fields
103
+ # Custom fields from the subscription product referenced by
104
+ # `subscription_rate.product`. These are distinct from the subscription instance's
105
+ # `custom_fields`.
106
+ #
107
+ # @return [Hash{Symbol=>String}, nil]
108
+ optional :product_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
109
+
90
110
  # @!attribute seat_config
91
111
  #
92
112
  # @return [MetronomeSDK::Models::Subscription::SeatConfig, nil]
93
113
  optional :seat_config, -> { MetronomeSDK::Subscription::SeatConfig }
94
114
 
95
- # @!method initialize(billing_periods:, collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, seat_config: nil)
115
+ # @!method initialize(billing_periods:, collection_schedule:, created_at:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, billing_cycle_config: nil, custom_credit_type_id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, product_custom_fields: nil, seat_config: nil)
96
116
  # Some parameter documentations has been truncated, see
97
117
  # {MetronomeSDK::Models::Subscription} for more details.
98
118
  #
@@ -100,6 +120,8 @@ module MetronomeSDK
100
120
  #
101
121
  # @param collection_schedule [Symbol, MetronomeSDK::Models::Subscription::CollectionSchedule]
102
122
  #
123
+ # @param created_at [Time]
124
+ #
103
125
  # @param proration [MetronomeSDK::Models::Subscription::Proration]
104
126
  #
105
127
  # @param quantity_management_mode [Symbol, MetronomeSDK::Models::Subscription::QuantityManagementMode] Determines how the subscription's quantity is controlled. Defaults to QUANTITY_O
@@ -114,6 +136,8 @@ module MetronomeSDK
114
136
  #
115
137
  # @param billing_cycle_config [MetronomeSDK::Models::Subscription::BillingCycleConfig]
116
138
  #
139
+ # @param custom_credit_type_id [String] If provided, the subscription's price will be in terms of this custom pricing un
140
+ #
117
141
  # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
118
142
  #
119
143
  # @param description [String]
@@ -124,6 +148,8 @@ module MetronomeSDK
124
148
  #
125
149
  # @param name [String]
126
150
  #
151
+ # @param product_custom_fields [Hash{Symbol=>String}] Custom fields from the subscription product referenced by `subscription_rate.pro
152
+ #
127
153
  # @param seat_config [MetronomeSDK::Models::Subscription::SeatConfig]
128
154
 
129
155
  # @see MetronomeSDK::Models::Subscription#billing_periods
@@ -28,10 +28,25 @@ module MetronomeSDK
28
28
  # @return [Float]
29
29
  required :threshold, Float
30
30
 
31
+ # @!attribute access_type
32
+ # Filters the notification to commits/credits with this access type. Only
33
+ # supported for `low_remaining_commit_balance_reached`,
34
+ # `low_remaining_commit_percentage_reached`,
35
+ # `low_remaining_contract_credit_and_commit_balance_reached`,
36
+ # `low_remaining_contract_credit_and_commit_percentage_reached`,
37
+ # `low_remaining_contract_credit_balance_reached`,
38
+ # `low_remaining_contract_credit_percentage_reached`, and
39
+ # `low_remaining_seat_balance_reached` notifications. Credit type cannot be
40
+ # specified if using QUANTITY access type.
41
+ #
42
+ # @return [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AccessType, nil]
43
+ optional :access_type, enum: -> { MetronomeSDK::V1::AlertCreateParams::AccessType }
44
+
31
45
  # @!attribute alert_specifiers
32
- # Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
33
- # notifications. Defines the balances that are considered when evaluating the
34
- # alert.
46
+ # Can be used only with `low_remaining_contract_credit_and_commit_balance_reached`
47
+ # and `low_remaining_contract_credit_and_commit_percentage_reached` notifications.
48
+ # Defines the commits and credits used to calculate the remaining balance or
49
+ # percentage.
35
50
  #
36
51
  # @return [Array<MetronomeSDK::Models::V1::AlertCreateParams::AlertSpecifier>, nil]
37
52
  optional :alert_specifiers,
@@ -121,7 +136,7 @@ module MetronomeSDK
121
136
  # @return [String, nil]
122
137
  optional :uniqueness_key, String
123
138
 
124
- # @!method initialize(alert_type:, name:, threshold:, alert_specifiers: nil, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, seat_filter: nil, uniqueness_key: nil, request_options: {})
139
+ # @!method initialize(alert_type:, name:, threshold:, access_type: nil, alert_specifiers: nil, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_values: nil, invoice_types_filter: nil, plan_id: nil, seat_filter: nil, uniqueness_key: nil, request_options: {})
125
140
  # Some parameter documentations has been truncated, see
126
141
  # {MetronomeSDK::Models::V1::AlertCreateParams} for more details.
127
142
  #
@@ -131,7 +146,9 @@ module MetronomeSDK
131
146
  #
132
147
  # @param threshold [Float] Threshold value of the notification policy. Depending upon the notification typ
133
148
  #
134
- # @param alert_specifiers [Array<MetronomeSDK::Models::V1::AlertCreateParams::AlertSpecifier>] Can be used with only `low_remaining_contract_credit_and_commit_balance_reached`
149
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AccessType] Filters the notification to commits/credits with this access type. Only supporte
150
+ #
151
+ # @param alert_specifiers [Array<MetronomeSDK::Models::V1::AlertCreateParams::AlertSpecifier>] Can be used only with `low_remaining_contract_credit_and_commit_balance_reached`
135
152
  #
136
153
  # @param billable_metric_id [String] For threshold notifications of type `usage_threshold_reached`, specifies which b
137
154
  #
@@ -176,6 +193,8 @@ module MetronomeSDK
176
193
  LOW_REMAINING_CONTRACT_CREDIT_PERCENTAGE_REACHED = :low_remaining_contract_credit_percentage_reached
177
194
  LOW_REMAINING_CONTRACT_CREDIT_AND_COMMIT_BALANCE_REACHED =
178
195
  :low_remaining_contract_credit_and_commit_balance_reached
196
+ LOW_REMAINING_CONTRACT_CREDIT_AND_COMMIT_PERCENTAGE_REACHED =
197
+ :low_remaining_contract_credit_and_commit_percentage_reached
179
198
  INVOICE_TOTAL_REACHED = :invoice_total_reached
180
199
  LOW_REMAINING_SEAT_BALANCE_REACHED = :low_remaining_seat_balance_reached
181
200
 
@@ -183,6 +202,25 @@ module MetronomeSDK
183
202
  # @return [Array<Symbol>]
184
203
  end
185
204
 
205
+ # Filters the notification to commits/credits with this access type. Only
206
+ # supported for `low_remaining_commit_balance_reached`,
207
+ # `low_remaining_commit_percentage_reached`,
208
+ # `low_remaining_contract_credit_and_commit_balance_reached`,
209
+ # `low_remaining_contract_credit_and_commit_percentage_reached`,
210
+ # `low_remaining_contract_credit_balance_reached`,
211
+ # `low_remaining_contract_credit_percentage_reached`, and
212
+ # `low_remaining_seat_balance_reached` notifications. Credit type cannot be
213
+ # specified if using QUANTITY access type.
214
+ module AccessType
215
+ extend MetronomeSDK::Internal::Type::Enum
216
+
217
+ SPEND = :SPEND
218
+ QUANTITY = :QUANTITY
219
+
220
+ # @!method self.values
221
+ # @return [Array<Symbol>]
222
+ end
223
+
186
224
  class AlertSpecifier < MetronomeSDK::Internal::Type::BaseModel
187
225
  # @!attribute custom_field_filters
188
226
  # A list of custom field filters for notification types that support advanced
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ # @see MetronomeSDK::Resources::V1::BillableMetrics#update
7
+ class BillableMetricUpdateParams < MetronomeSDK::Internal::Type::BaseModel
8
+ extend MetronomeSDK::Internal::Type::RequestParameters::Converter
9
+ include MetronomeSDK::Internal::Type::RequestParameters
10
+
11
+ # @!attribute billable_metric_id
12
+ #
13
+ # @return [String]
14
+ required :billable_metric_id, String
15
+
16
+ # @!attribute name
17
+ # The new name of the metric
18
+ #
19
+ # @return [String]
20
+ required :name, String
21
+
22
+ # @!method initialize(billable_metric_id:, name:, request_options: {})
23
+ # @param billable_metric_id [String]
24
+ #
25
+ # @param name [String] The new name of the metric
26
+ #
27
+ # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module MetronomeSDK
4
+ module Models
5
+ module V1
6
+ # @see MetronomeSDK::Resources::V1::BillableMetrics#update
7
+ class BillableMetricUpdateResponse < MetronomeSDK::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ #
10
+ # @return [MetronomeSDK::Models::ID]
11
+ required :data, -> { MetronomeSDK::ID }
12
+
13
+ # @!method initialize(data:)
14
+ # @param data [MetronomeSDK::Models::ID]
15
+ end
16
+ end
17
+ end
18
+ end
@@ -58,7 +58,15 @@ module MetronomeSDK
58
58
  # @return [Time, nil]
59
59
  optional :timestamp, Time
60
60
 
61
- # @!method initialize(id:, amount:, customer_id:, reason:, segment_id:, contract_id: nil, per_group_amounts: nil, timestamp: nil, request_options: {})
61
+ # @!attribute uniqueness_key
62
+ # Prevents the creation of duplicates. If a request to create a record is made
63
+ # with a previously used uniqueness key, a new record will not be created and the
64
+ # request will fail with a 409 error.
65
+ #
66
+ # @return [String, nil]
67
+ optional :uniqueness_key, String
68
+
69
+ # @!method initialize(id:, amount:, customer_id:, reason:, segment_id:, contract_id: nil, per_group_amounts: nil, timestamp: nil, uniqueness_key: nil, request_options: {})
62
70
  # Some parameter documentations has been truncated, see
63
71
  # {MetronomeSDK::Models::V1::ContractAddManualBalanceEntryParams} for more
64
72
  # details.
@@ -79,6 +87,8 @@ module MetronomeSDK
79
87
  #
80
88
  # @param timestamp [Time] RFC 3339 timestamp indicating when the manual adjustment takes place. If not pro
81
89
  #
90
+ # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
91
+ #
82
92
  # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
83
93
  end
84
94
  end
@@ -306,19 +306,34 @@ module MetronomeSDK
306
306
  required :schedule_items,
307
307
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem] }
308
308
 
309
+ # @!attribute access_type
310
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
311
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
312
+ # omitted.
313
+ #
314
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::AccessSchedule::AccessType, nil]
315
+ optional :access_type,
316
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule::AccessType }
317
+
309
318
  # @!attribute credit_type_id
310
319
  # Defaults to USD (cents) if not passed
311
320
  #
312
321
  # @return [String, nil]
313
322
  optional :credit_type_id, String
314
323
 
315
- # @!method initialize(schedule_items:, credit_type_id: nil)
324
+ # @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
325
+ # Some parameter documentations has been truncated, see
326
+ # {MetronomeSDK::Models::V1::ContractAmendParams::Commit::AccessSchedule} for more
327
+ # details.
328
+ #
316
329
  # Required: Schedule for distributing the commit to the customer. For "POSTPAID"
317
330
  # commits only one schedule item is allowed and amount must match invoice_schedule
318
331
  # total.
319
332
  #
320
333
  # @param schedule_items [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem>]
321
334
  #
335
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
336
+ #
322
337
  # @param credit_type_id [String] Defaults to USD (cents) if not passed
323
338
 
324
339
  class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
@@ -346,6 +361,21 @@ module MetronomeSDK
346
361
  #
347
362
  # @param starting_at [Time] RFC 3339 timestamp (inclusive)
348
363
  end
364
+
365
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
366
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
367
+ # omitted.
368
+ #
369
+ # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::AccessSchedule#access_type
370
+ module AccessType
371
+ extend MetronomeSDK::Internal::Type::Enum
372
+
373
+ SPEND = :SPEND
374
+ QUANTITY = :QUANTITY
375
+
376
+ # @!method self.values
377
+ # @return [Array<Symbol>]
378
+ end
349
379
  end
350
380
 
351
381
  # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit#invoice_schedule
@@ -694,17 +724,32 @@ module MetronomeSDK
694
724
  required :schedule_items,
695
725
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem] }
696
726
 
727
+ # @!attribute access_type
728
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
729
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
730
+ # omitted.
731
+ #
732
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::AccessSchedule::AccessType, nil]
733
+ optional :access_type,
734
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule::AccessType }
735
+
697
736
  # @!attribute credit_type_id
698
737
  # Defaults to USD (cents) if not passed
699
738
  #
700
739
  # @return [String, nil]
701
740
  optional :credit_type_id, String
702
741
 
703
- # @!method initialize(schedule_items:, credit_type_id: nil)
742
+ # @!method initialize(schedule_items:, access_type: nil, credit_type_id: nil)
743
+ # Some parameter documentations has been truncated, see
744
+ # {MetronomeSDK::Models::V1::ContractAmendParams::Credit::AccessSchedule} for more
745
+ # details.
746
+ #
704
747
  # Schedule for distributing the credit to the customer.
705
748
  #
706
749
  # @param schedule_items [Array<MetronomeSDK::Models::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem>]
707
750
  #
751
+ # @param access_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::AccessSchedule::AccessType] Determines how the balance is drawn down. `SPEND` deducts the dollar cost of usa
752
+ #
708
753
  # @param credit_type_id [String] Defaults to USD (cents) if not passed
709
754
 
710
755
  class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
@@ -732,6 +777,21 @@ module MetronomeSDK
732
777
  #
733
778
  # @param starting_at [Time] RFC 3339 timestamp (inclusive)
734
779
  end
780
+
781
+ # Determines how the balance is drawn down. `SPEND` deducts the dollar cost of
782
+ # usage. `QUANTITY` deducts the number of units used. Defaults to `SPEND` if
783
+ # omitted.
784
+ #
785
+ # @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::AccessSchedule#access_type
786
+ module AccessType
787
+ extend MetronomeSDK::Internal::Type::Enum
788
+
789
+ SPEND = :SPEND
790
+ QUANTITY = :QUANTITY
791
+
792
+ # @!method self.values
793
+ # @return [Array<Symbol>]
794
+ end
735
795
  end
736
796
 
737
797
  # @see MetronomeSDK::Models::V1::ContractAmendParams::Credit#rate_type