metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

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 (475) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +85 -0
  3. data/README.md +120 -74
  4. data/SECURITY.md +2 -2
  5. data/lib/metronome_sdk/client.rb +4 -4
  6. data/lib/metronome_sdk/errors.rb +22 -0
  7. data/lib/metronome_sdk/internal/transport/base_client.rb +10 -2
  8. data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +3 -1
  9. data/lib/metronome_sdk/internal/type/array_of.rb +14 -1
  10. data/lib/metronome_sdk/internal/type/base_model.rb +92 -23
  11. data/lib/metronome_sdk/internal/type/boolean.rb +15 -1
  12. data/lib/metronome_sdk/internal/type/converter.rb +42 -34
  13. data/lib/metronome_sdk/internal/type/enum.rb +25 -2
  14. data/lib/metronome_sdk/internal/type/file_input.rb +13 -1
  15. data/lib/metronome_sdk/internal/type/hash_of.rb +14 -1
  16. data/lib/metronome_sdk/internal/type/union.rb +27 -7
  17. data/lib/metronome_sdk/internal/type/unknown.rb +15 -1
  18. data/lib/metronome_sdk/internal/util.rb +62 -10
  19. data/lib/metronome_sdk/internal.rb +3 -0
  20. data/lib/metronome_sdk/models/commit.rb +230 -87
  21. data/lib/metronome_sdk/models/contract_without_amendments.rb +551 -185
  22. data/lib/metronome_sdk/models/credit.rb +201 -51
  23. data/lib/metronome_sdk/models/discount.rb +5 -5
  24. data/lib/metronome_sdk/models/event_type_filter.rb +1 -1
  25. data/lib/metronome_sdk/models/override.rb +53 -34
  26. data/lib/metronome_sdk/models/pro_service.rb +2 -2
  27. data/lib/metronome_sdk/models/property_filter.rb +1 -1
  28. data/lib/metronome_sdk/models/rate.rb +9 -9
  29. data/lib/metronome_sdk/models/schedule_duration.rb +4 -4
  30. data/lib/metronome_sdk/models/schedule_point_in_time.rb +11 -11
  31. data/lib/metronome_sdk/models/scheduled_charge.rb +5 -5
  32. data/lib/metronome_sdk/models/v1/alert_archive_response.rb +2 -2
  33. data/lib/metronome_sdk/models/v1/alert_create_params.rb +15 -12
  34. data/lib/metronome_sdk/models/v1/alert_create_response.rb +2 -2
  35. data/lib/metronome_sdk/models/v1/audit_log_list_params.rb +2 -2
  36. data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +2 -2
  37. data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +6 -6
  38. data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +2 -2
  39. data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +4 -4
  40. data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +4 -4
  41. data/lib/metronome_sdk/models/v1/contract_amend_params.rb +577 -152
  42. data/lib/metronome_sdk/models/v1/contract_amend_response.rb +2 -2
  43. data/lib/metronome_sdk/models/v1/contract_archive_response.rb +2 -2
  44. data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +12 -12
  45. data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +2 -2
  46. data/lib/metronome_sdk/models/v1/contract_create_params.rb +1317 -341
  47. data/lib/metronome_sdk/models/v1/contract_create_response.rb +2 -2
  48. data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +3 -7
  49. data/lib/metronome_sdk/models/v1/contract_list_response.rb +421 -36
  50. data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +33 -5
  51. data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +28 -7
  52. data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +422 -36
  53. data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rb +34 -0
  54. data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rb +81 -0
  55. data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +4 -4
  56. data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +2 -2
  57. data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +2 -2
  58. data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +2 -2
  59. data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +6 -6
  60. data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +2 -2
  61. data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +5 -5
  62. data/lib/metronome_sdk/models/v1/contracts/product_list_params.rb +4 -4
  63. data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +8 -8
  64. data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +8 -8
  65. data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +4 -4
  66. data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +2 -2
  67. data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +3 -3
  68. data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +3 -3
  69. data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +2 -2
  70. data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +4 -4
  71. data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +2 -2
  72. data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +4 -4
  73. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +33 -5
  74. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +26 -5
  75. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +4 -4
  76. data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +2 -2
  77. data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +2 -2
  78. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +2 -2
  79. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +2 -2
  80. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +2 -2
  81. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +46 -18
  82. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +2 -2
  83. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +36 -12
  84. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +6 -6
  85. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +33 -5
  86. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +26 -5
  87. data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +12 -20
  88. data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +2 -2
  89. data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +2 -2
  90. data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +20 -1
  91. data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +6 -6
  92. data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +8 -8
  93. data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +2 -2
  94. data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +1 -1
  95. data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb +2 -2
  96. data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb +2 -2
  97. data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +2 -2
  98. data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb +2 -2
  99. data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +2 -2
  100. data/lib/metronome_sdk/models/v1/customer.rb +1 -1
  101. data/lib/metronome_sdk/models/v1/customer_archive_response.rb +2 -2
  102. data/lib/metronome_sdk/models/v1/customer_create_params.rb +20 -20
  103. data/lib/metronome_sdk/models/v1/customer_create_response.rb +2 -2
  104. data/lib/metronome_sdk/models/v1/customer_detail.rb +10 -10
  105. data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +4 -4
  106. data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +115 -0
  107. data/lib/metronome_sdk/models/v1/customer_preview_events_response.rb +18 -0
  108. data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +2 -2
  109. data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +2 -2
  110. data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +2 -2
  111. data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +2 -2
  112. data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +2 -2
  113. data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +2 -2
  114. data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +6 -6
  115. data/lib/metronome_sdk/models/v1/customers/billing_config_delete_params.rb +2 -2
  116. data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rb +2 -2
  117. data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +9 -1
  118. data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +86 -32
  119. data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +2 -2
  120. data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +2 -2
  121. data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +2 -2
  122. data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +59 -7
  123. data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +2 -2
  124. data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +2 -2
  125. data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +2 -2
  126. data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +24 -24
  127. data/lib/metronome_sdk/models/v1/customers/invoice.rb +74 -73
  128. data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +4 -4
  129. data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +2 -2
  130. data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +2 -2
  131. data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +16 -15
  132. data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +2 -2
  133. data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +2 -2
  134. data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +14 -13
  135. data/lib/metronome_sdk/models/v1/plan_detail.rb +18 -18
  136. data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +2 -2
  137. data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +2 -2
  138. data/lib/metronome_sdk/models/v1/plan_list_customers_params.rb +2 -2
  139. data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +2 -2
  140. data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +3 -3
  141. data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +3 -3
  142. data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +2 -2
  143. data/lib/metronome_sdk/models/v1/usage_list_params.rb +9 -8
  144. data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +5 -5
  145. data/lib/metronome_sdk/models/v1/usage_search_params.rb +24 -0
  146. data/lib/metronome_sdk/models/v1/usage_search_response.rb +249 -0
  147. data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +78 -23
  148. data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +2 -2
  149. data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +62 -9
  150. data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +2 -2
  151. data/lib/metronome_sdk/models/v2/contract_edit_params.rb +1995 -443
  152. data/lib/metronome_sdk/models/v2/contract_edit_response.rb +2 -2
  153. data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +1959 -140
  154. data/lib/metronome_sdk/models/v2/contract_list_response.rb +963 -91
  155. data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +964 -91
  156. data/lib/metronome_sdk/models.rb +30 -19
  157. data/lib/metronome_sdk/resources/v1/alerts.rb +4 -4
  158. data/lib/metronome_sdk/resources/v1/audit_logs.rb +1 -1
  159. data/lib/metronome_sdk/resources/v1/billable_metrics.rb +3 -3
  160. data/lib/metronome_sdk/resources/v1/contracts/products.rb +9 -6
  161. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +1 -1
  162. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +8 -6
  163. data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +4 -4
  164. data/lib/metronome_sdk/resources/v1/contracts.rb +59 -28
  165. data/lib/metronome_sdk/resources/v1/credit_grants.rb +7 -5
  166. data/lib/metronome_sdk/resources/v1/custom_fields.rb +5 -5
  167. data/lib/metronome_sdk/resources/v1/customers/alerts.rb +2 -2
  168. data/lib/metronome_sdk/resources/v1/customers/billing_config.rb +5 -5
  169. data/lib/metronome_sdk/resources/v1/customers/commits.rb +9 -7
  170. data/lib/metronome_sdk/resources/v1/customers/credits.rb +5 -3
  171. data/lib/metronome_sdk/resources/v1/customers/invoices.rb +4 -4
  172. data/lib/metronome_sdk/resources/v1/customers/plans.rb +3 -3
  173. data/lib/metronome_sdk/resources/v1/customers.rb +43 -4
  174. data/lib/metronome_sdk/resources/v1/dashboards.rb +4 -4
  175. data/lib/metronome_sdk/resources/v1/plans.rb +1 -1
  176. data/lib/metronome_sdk/resources/v1/usage.rb +30 -5
  177. data/lib/metronome_sdk/resources/v2/contracts.rb +45 -31
  178. data/lib/metronome_sdk/version.rb +1 -1
  179. data/lib/metronome_sdk.rb +9 -1
  180. data/rbi/metronome_sdk/errors.rbi +16 -0
  181. data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi +5 -1
  182. data/rbi/metronome_sdk/internal/type/array_of.rbi +6 -0
  183. data/rbi/metronome_sdk/internal/type/base_model.rbi +5 -0
  184. data/rbi/metronome_sdk/internal/type/boolean.rbi +8 -0
  185. data/rbi/metronome_sdk/internal/type/converter.rbi +15 -15
  186. data/rbi/metronome_sdk/internal/type/enum.rbi +5 -0
  187. data/rbi/metronome_sdk/internal/type/file_input.rbi +5 -0
  188. data/rbi/metronome_sdk/internal/type/hash_of.rbi +6 -0
  189. data/rbi/metronome_sdk/internal/type/union.rbi +10 -0
  190. data/rbi/metronome_sdk/internal/type/unknown.rbi +8 -0
  191. data/rbi/metronome_sdk/internal/util.rbi +36 -0
  192. data/rbi/metronome_sdk/internal.rbi +5 -0
  193. data/rbi/metronome_sdk/models/commit.rbi +376 -39
  194. data/rbi/metronome_sdk/models/contract_without_amendments.rbi +791 -54
  195. data/rbi/metronome_sdk/models/credit.rbi +376 -25
  196. data/rbi/metronome_sdk/models/override.rbi +66 -0
  197. data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +9 -9
  198. data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +10 -4
  199. data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +995 -17
  200. data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +2220 -136
  201. data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +9 -2
  202. data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +820 -28
  203. data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi +72 -0
  204. data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +66 -0
  205. data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +820 -28
  206. data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbi +58 -0
  207. data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbi +212 -0
  208. data/rbi/metronome_sdk/models/v1/contracts/product_list_params.rbi +3 -3
  209. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbi +72 -0
  210. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +66 -0
  211. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +72 -0
  212. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +72 -0
  213. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi +72 -0
  214. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +66 -0
  215. data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +58 -0
  216. data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi +214 -0
  217. data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi +35 -0
  218. data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +11 -0
  219. data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +121 -8
  220. data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +109 -0
  221. data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +5 -0
  222. data/rbi/metronome_sdk/models/v1/usage_search_params.rbi +48 -0
  223. data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +438 -0
  224. data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +113 -8
  225. data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +101 -0
  226. data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +3667 -315
  227. data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +5965 -2014
  228. data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +2279 -226
  229. data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +2279 -226
  230. data/rbi/metronome_sdk/resources/v1/alerts.rbi +5 -2
  231. data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +2 -1
  232. data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +5 -0
  233. data/rbi/metronome_sdk/resources/v1/contracts.rbi +36 -1
  234. data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
  235. data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +15 -4
  236. data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +9 -0
  237. data/rbi/metronome_sdk/resources/v1/customers.rbi +35 -1
  238. data/rbi/metronome_sdk/resources/v1/usage.rbi +17 -0
  239. data/rbi/metronome_sdk/resources/v2/contracts.rbi +65 -7
  240. data/sig/metronome_sdk/errors.rbs +9 -0
  241. data/sig/metronome_sdk/internal/transport/pooled_net_requester.rbs +2 -0
  242. data/sig/metronome_sdk/internal/type/array_of.rbs +3 -0
  243. data/sig/metronome_sdk/internal/type/base_model.rbs +2 -0
  244. data/sig/metronome_sdk/internal/type/boolean.rbs +3 -0
  245. data/sig/metronome_sdk/internal/type/converter.rbs +7 -1
  246. data/sig/metronome_sdk/internal/type/enum.rbs +2 -0
  247. data/sig/metronome_sdk/internal/type/file_input.rbs +2 -0
  248. data/sig/metronome_sdk/internal/type/hash_of.rbs +3 -0
  249. data/sig/metronome_sdk/internal/type/union.rbs +2 -0
  250. data/sig/metronome_sdk/internal/type/unknown.rbs +3 -0
  251. data/sig/metronome_sdk/internal/util.rbs +12 -0
  252. data/sig/metronome_sdk/internal.rbs +2 -0
  253. data/sig/metronome_sdk/models/base_usage_filter.rbs +6 -0
  254. data/sig/metronome_sdk/models/commit.rbs +374 -68
  255. data/sig/metronome_sdk/models/contract_without_amendments.rbs +620 -110
  256. data/sig/metronome_sdk/models/credit.rbs +286 -40
  257. data/sig/metronome_sdk/models/credit_type_data.rbs +2 -0
  258. data/sig/metronome_sdk/models/discount.rbs +11 -0
  259. data/sig/metronome_sdk/models/event_type_filter.rbs +5 -0
  260. data/sig/metronome_sdk/models/id.rbs +2 -0
  261. data/sig/metronome_sdk/models/override.rbs +92 -22
  262. data/sig/metronome_sdk/models/pro_service.rbs +11 -0
  263. data/sig/metronome_sdk/models/property_filter.rbs +7 -0
  264. data/sig/metronome_sdk/models/rate.rbs +16 -4
  265. data/sig/metronome_sdk/models/schedule_duration.rbs +12 -0
  266. data/sig/metronome_sdk/models/schedule_point_in_time.rbs +20 -6
  267. data/sig/metronome_sdk/models/scheduled_charge.rbs +12 -0
  268. data/sig/metronome_sdk/models/tier.rbs +2 -0
  269. data/sig/metronome_sdk/models/v1/alert_archive_params.rbs +6 -0
  270. data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +2 -0
  271. data/sig/metronome_sdk/models/v1/alert_create_params.rbs +29 -4
  272. data/sig/metronome_sdk/models/v1/alert_create_response.rbs +2 -0
  273. data/sig/metronome_sdk/models/v1/audit_log_list_params.rbs +11 -0
  274. data/sig/metronome_sdk/models/v1/audit_log_list_response.rbs +16 -0
  275. data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +2 -0
  276. data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +2 -0
  277. data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +12 -0
  278. data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +2 -0
  279. data/sig/metronome_sdk/models/v1/billable_metric_list_params.rbs +7 -0
  280. data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +13 -0
  281. data/sig/metronome_sdk/models/v1/billable_metric_retrieve_params.rbs +5 -0
  282. data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +17 -0
  283. data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +11 -0
  284. data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +719 -75
  285. data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +2 -0
  286. data/sig/metronome_sdk/models/v1/contract_archive_params.rbs +7 -0
  287. data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +2 -0
  288. data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbs +47 -12
  289. data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +2 -0
  290. data/sig/metronome_sdk/models/v1/contract_create_params.rbs +1503 -250
  291. data/sig/metronome_sdk/models/v1/contract_create_response.rbs +2 -0
  292. data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +14 -0
  293. data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +5 -0
  294. data/sig/metronome_sdk/models/v1/contract_list_params.rbs +10 -0
  295. data/sig/metronome_sdk/models/v1/contract_list_response.rbs +459 -10
  296. data/sig/metronome_sdk/models/v1/contract_retrieve_params.rbs +8 -0
  297. data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbs +39 -0
  298. data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +48 -0
  299. data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +459 -10
  300. data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbs +34 -0
  301. data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbs +101 -0
  302. data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbs +21 -0
  303. data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +2 -0
  304. data/sig/metronome_sdk/models/v1/contract_set_usage_filter_params.rbs +9 -0
  305. data/sig/metronome_sdk/models/v1/contract_update_end_date_params.rbs +8 -0
  306. data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +2 -0
  307. data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbs +7 -0
  308. data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbs +10 -0
  309. data/sig/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbs +9 -0
  310. data/sig/metronome_sdk/models/v1/contracts/product_archive_params.rbs +5 -0
  311. data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +2 -0
  312. data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +18 -0
  313. data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +2 -0
  314. data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +19 -0
  315. data/sig/metronome_sdk/models/v1/contracts/product_list_params.rbs +7 -0
  316. data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +29 -0
  317. data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +2 -0
  318. data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +33 -0
  319. data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +19 -0
  320. data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +2 -0
  321. data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +10 -4
  322. data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +9 -4
  323. data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +2 -0
  324. data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +2 -0
  325. data/sig/metronome_sdk/models/v1/contracts/rate_card_create_params.rbs +21 -0
  326. data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +2 -0
  327. data/sig/metronome_sdk/models/v1/contracts/rate_card_list_params.rbs +7 -0
  328. data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +23 -0
  329. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +2 -0
  330. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs +38 -0
  331. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +46 -0
  332. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +27 -0
  333. data/sig/metronome_sdk/models/v1/contracts/rate_card_update_params.rbs +14 -0
  334. data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +2 -0
  335. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +8 -0
  336. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbs +10 -0
  337. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +10 -0
  338. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbs +6 -0
  339. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +2 -0
  340. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbs +8 -0
  341. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +2 -0
  342. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +59 -8
  343. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +2 -0
  344. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +51 -4
  345. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +23 -0
  346. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbs +38 -0
  347. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +41 -0
  348. data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +32 -4
  349. data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +2 -0
  350. data/sig/metronome_sdk/models/v1/credit_grant_edit_params.rbs +8 -0
  351. data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +2 -0
  352. data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +29 -0
  353. data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +30 -0
  354. data/sig/metronome_sdk/models/v1/credit_grant_list_params.rbs +11 -0
  355. data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +38 -0
  356. data/sig/metronome_sdk/models/v1/credit_grant_void_params.rbs +7 -0
  357. data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +2 -0
  358. data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +10 -0
  359. data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs +7 -0
  360. data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs +7 -0
  361. data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs +12 -6
  362. data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +11 -0
  363. data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs +6 -0
  364. data/sig/metronome_sdk/models/v1/custom_field_set_values_params.rbs +7 -0
  365. data/sig/metronome_sdk/models/v1/customer.rbs +8 -0
  366. data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +2 -0
  367. data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +2 -0
  368. data/sig/metronome_sdk/models/v1/customer_create_params.rbs +52 -26
  369. data/sig/metronome_sdk/models/v1/customer_create_response.rbs +2 -0
  370. data/sig/metronome_sdk/models/v1/customer_detail.rbs +23 -4
  371. data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbs +9 -0
  372. data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +17 -0
  373. data/sig/metronome_sdk/models/v1/customer_list_costs_params.rbs +9 -0
  374. data/sig/metronome_sdk/models/v1/customer_list_costs_response.rbs +19 -0
  375. data/sig/metronome_sdk/models/v1/customer_list_params.rbs +10 -0
  376. data/sig/metronome_sdk/models/v1/customer_preview_events_params.rbs +105 -0
  377. data/sig/metronome_sdk/models/v1/customer_preview_events_response.rbs +16 -0
  378. data/sig/metronome_sdk/models/v1/customer_retrieve_params.rbs +5 -0
  379. data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +2 -0
  380. data/sig/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbs +6 -0
  381. data/sig/metronome_sdk/models/v1/customer_set_name_params.rbs +6 -0
  382. data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +2 -0
  383. data/sig/metronome_sdk/models/v1/customer_update_config_params.rbs +7 -0
  384. data/sig/metronome_sdk/models/v1/customers/alert_list_params.rbs +13 -6
  385. data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +5 -0
  386. data/sig/metronome_sdk/models/v1/customers/alert_reset_params.rbs +6 -0
  387. data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +7 -0
  388. data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +2 -0
  389. data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +10 -0
  390. data/sig/metronome_sdk/models/v1/customers/billing_config_delete_params.rbs +6 -0
  391. data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbs +6 -0
  392. data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +23 -0
  393. data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +116 -8
  394. data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +2 -0
  395. data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +14 -0
  396. data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +5 -0
  397. data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbs +8 -0
  398. data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +2 -0
  399. data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +82 -0
  400. data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +2 -0
  401. data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +14 -0
  402. data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +5 -0
  403. data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbs +7 -0
  404. data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +2 -0
  405. data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +45 -16
  406. data/sig/metronome_sdk/models/v1/customers/invoice.rbs +195 -40
  407. data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbs +11 -0
  408. data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbs +2 -0
  409. data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbs +14 -0
  410. data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +5 -0
  411. data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +13 -0
  412. data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbs +7 -0
  413. data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +2 -0
  414. data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbs +7 -0
  415. data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbs +10 -0
  416. data/sig/metronome_sdk/models/v1/customers/named_schedule_update_params.rbs +9 -0
  417. data/sig/metronome_sdk/models/v1/customers/plan_add_params.rbs +38 -4
  418. data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +2 -0
  419. data/sig/metronome_sdk/models/v1/customers/plan_end_params.rbs +9 -0
  420. data/sig/metronome_sdk/models/v1/customers/plan_end_response.rbs +2 -0
  421. data/sig/metronome_sdk/models/v1/customers/plan_list_params.rbs +7 -0
  422. data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbs +8 -0
  423. data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbs +14 -0
  424. data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +23 -0
  425. data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +30 -7
  426. data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbs +6 -0
  427. data/sig/metronome_sdk/models/v1/invoice_regenerate_params.rbs +5 -0
  428. data/sig/metronome_sdk/models/v1/invoice_regenerate_response.rbs +6 -0
  429. data/sig/metronome_sdk/models/v1/invoice_void_params.rbs +5 -0
  430. data/sig/metronome_sdk/models/v1/invoice_void_response.rbs +6 -0
  431. data/sig/metronome_sdk/models/v1/plan_detail.rbs +38 -0
  432. data/sig/metronome_sdk/models/v1/plan_get_details_params.rbs +5 -0
  433. data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +2 -0
  434. data/sig/metronome_sdk/models/v1/plan_list_charges_params.rbs +7 -0
  435. data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +28 -0
  436. data/sig/metronome_sdk/models/v1/plan_list_customers_params.rbs +8 -0
  437. data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +14 -0
  438. data/sig/metronome_sdk/models/v1/plan_list_params.rbs +6 -0
  439. data/sig/metronome_sdk/models/v1/plan_list_response.rbs +7 -0
  440. data/sig/metronome_sdk/models/v1/pricing_unit_list_params.rbs +6 -0
  441. data/sig/metronome_sdk/models/v1/pricing_unit_list_response.rbs +2 -0
  442. data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +12 -4
  443. data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +9 -4
  444. data/sig/metronome_sdk/models/v1/service_list_params.rbs +2 -0
  445. data/sig/metronome_sdk/models/v1/service_list_response.rbs +10 -0
  446. data/sig/metronome_sdk/models/v1/usage_ingest_params.rbs +13 -0
  447. data/sig/metronome_sdk/models/v1/usage_list_params.rbs +17 -0
  448. data/sig/metronome_sdk/models/v1/usage_list_response.rbs +15 -0
  449. data/sig/metronome_sdk/models/v1/usage_list_with_groups_params.rbs +15 -0
  450. data/sig/metronome_sdk/models/v1/usage_list_with_groups_response.rbs +8 -0
  451. data/sig/metronome_sdk/models/v1/usage_search_params.rbs +26 -0
  452. data/sig/metronome_sdk/models/v1/usage_search_response.rbs +230 -0
  453. data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +106 -1
  454. data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +2 -0
  455. data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +81 -1
  456. data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +2 -0
  457. data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +2233 -303
  458. data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +2 -0
  459. data/sig/metronome_sdk/models/v2/contract_get_edit_history_params.rbs +6 -0
  460. data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +2475 -453
  461. data/sig/metronome_sdk/models/v2/contract_list_params.rbs +10 -0
  462. data/sig/metronome_sdk/models/v2/contract_list_response.rbs +1400 -43
  463. data/sig/metronome_sdk/models/v2/contract_retrieve_params.rbs +9 -0
  464. data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +1400 -43
  465. data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -0
  466. data/sig/metronome_sdk/resources/v1/contracts.rbs +10 -0
  467. data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
  468. data/sig/metronome_sdk/resources/v1/custom_fields.rbs +1 -1
  469. data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +1 -1
  470. data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
  471. data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -0
  472. data/sig/metronome_sdk/resources/v1/customers.rbs +8 -0
  473. data/sig/metronome_sdk/resources/v1/usage.rbs +5 -0
  474. data/sig/metronome_sdk/resources/v2/contracts.rbs +8 -1
  475. metadata +20 -2
@@ -28,7 +28,7 @@ module MetronomeSDK
28
28
 
29
29
  # @!attribute current
30
30
  #
31
- # @return [MetronomeSDK::ContractWithoutAmendments]
31
+ # @return [MetronomeSDK::Models::ContractWithoutAmendments]
32
32
  required :current, -> { MetronomeSDK::ContractWithoutAmendments }
33
33
 
34
34
  # @!attribute customer_id
@@ -38,7 +38,7 @@ module MetronomeSDK
38
38
 
39
39
  # @!attribute initial
40
40
  #
41
- # @return [MetronomeSDK::ContractWithoutAmendments]
41
+ # @return [MetronomeSDK::Models::ContractWithoutAmendments]
42
42
  required :initial, -> { MetronomeSDK::ContractWithoutAmendments }
43
43
 
44
44
  # @!attribute archived_at
@@ -66,6 +66,12 @@ module MetronomeSDK
66
66
  optional :prepaid_balance_threshold_configuration,
67
67
  -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration }
68
68
 
69
+ # @!attribute priority
70
+ # Priority of the contract.
71
+ #
72
+ # @return [Float, nil]
73
+ optional :priority, Float
74
+
69
75
  # @!attribute scheduled_charges_on_usage_invoices
70
76
  # Determines which scheduled and commit charges to consolidate onto the Contract's
71
77
  # usage invoice. The charge's `timestamp` must match the usage invoice's
@@ -83,6 +89,13 @@ module MetronomeSDK
83
89
  optional :spend_threshold_configuration,
84
90
  -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration }
85
91
 
92
+ # @!attribute subscriptions
93
+ # List of subscriptions on the contract.
94
+ #
95
+ # @return [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription>, nil]
96
+ optional :subscriptions,
97
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription] }
98
+
86
99
  # @!attribute uniqueness_key
87
100
  # Prevents the creation of duplicates. If a request to create a record is made
88
101
  # with a previously used uniqueness key, a new record will not be created and the
@@ -91,7 +104,7 @@ module MetronomeSDK
91
104
  # @return [String, nil]
92
105
  optional :uniqueness_key, String
93
106
 
94
- # @!method initialize(id:, amendments:, current:, customer_id:, initial:, archived_at: nil, custom_fields: nil, customer_billing_provider_configuration: nil, prepaid_balance_threshold_configuration: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, uniqueness_key: nil)
107
+ # @!method initialize(id:, amendments:, current:, customer_id:, initial:, archived_at: nil, custom_fields: nil, customer_billing_provider_configuration: nil, prepaid_balance_threshold_configuration: nil, priority: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, subscriptions: nil, uniqueness_key: nil)
95
108
  # Some parameter documentations has been truncated, see
96
109
  # {MetronomeSDK::Models::V1::ContractListResponse::Data} for more details.
97
110
  #
@@ -99,11 +112,11 @@ module MetronomeSDK
99
112
  #
100
113
  # @param amendments [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment>]
101
114
  #
102
- # @param current [MetronomeSDK::ContractWithoutAmendments]
115
+ # @param current [MetronomeSDK::Models::ContractWithoutAmendments]
103
116
  #
104
117
  # @param customer_id [String]
105
118
  #
106
- # @param initial [MetronomeSDK::ContractWithoutAmendments]
119
+ # @param initial [MetronomeSDK::Models::ContractWithoutAmendments]
107
120
  #
108
121
  # @param archived_at [Time] RFC 3339 timestamp indicating when the contract was archived. If not returned, t
109
122
  #
@@ -113,10 +126,14 @@ module MetronomeSDK
113
126
  #
114
127
  # @param prepaid_balance_threshold_configuration [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration]
115
128
  #
129
+ # @param priority [Float] Priority of the contract.
130
+ #
116
131
  # @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::ScheduledChargesOnUsageInvoices] Determines which scheduled and commit charges to consolidate onto the Contract's
117
132
  #
118
133
  # @param spend_threshold_configuration [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration]
119
134
  #
135
+ # @param subscriptions [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription>] List of subscriptions on the contract.
136
+ #
120
137
  # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
121
138
 
122
139
  class Amendment < MetronomeSDK::Internal::Type::BaseModel
@@ -127,7 +144,7 @@ module MetronomeSDK
127
144
 
128
145
  # @!attribute commits
129
146
  #
130
- # @return [Array<MetronomeSDK::Commit>]
147
+ # @return [Array<MetronomeSDK::Models::Commit>]
131
148
  required :commits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Commit] }
132
149
 
133
150
  # @!attribute created_at
@@ -142,12 +159,12 @@ module MetronomeSDK
142
159
 
143
160
  # @!attribute overrides
144
161
  #
145
- # @return [Array<MetronomeSDK::Override>]
162
+ # @return [Array<MetronomeSDK::Models::Override>]
146
163
  required :overrides, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override] }
147
164
 
148
165
  # @!attribute scheduled_charges
149
166
  #
150
- # @return [Array<MetronomeSDK::ScheduledCharge>]
167
+ # @return [Array<MetronomeSDK::Models::ScheduledCharge>]
151
168
  required :scheduled_charges,
152
169
  -> {
153
170
  MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ScheduledCharge]
@@ -160,13 +177,13 @@ module MetronomeSDK
160
177
 
161
178
  # @!attribute credits
162
179
  #
163
- # @return [Array<MetronomeSDK::Credit>, nil]
180
+ # @return [Array<MetronomeSDK::Models::Credit>, nil]
164
181
  optional :credits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Credit] }
165
182
 
166
183
  # @!attribute discounts
167
184
  # This field's availability is dependent on your client's configuration.
168
185
  #
169
- # @return [Array<MetronomeSDK::Discount>, nil]
186
+ # @return [Array<MetronomeSDK::Models::Discount>, nil]
170
187
  optional :discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Discount] }
171
188
 
172
189
  # @!attribute netsuite_sales_order_id
@@ -178,7 +195,7 @@ module MetronomeSDK
178
195
  # @!attribute professional_services
179
196
  # This field's availability is dependent on your client's configuration.
180
197
  #
181
- # @return [Array<MetronomeSDK::ProService>, nil]
198
+ # @return [Array<MetronomeSDK::Models::ProService>, nil]
182
199
  optional :professional_services,
183
200
  -> {
184
201
  MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ProService]
@@ -200,25 +217,25 @@ module MetronomeSDK
200
217
  # @!method initialize(id:, commits:, created_at:, created_by:, overrides:, scheduled_charges:, starting_at:, credits: nil, discounts: nil, netsuite_sales_order_id: nil, professional_services: nil, reseller_royalties: nil, salesforce_opportunity_id: nil)
201
218
  # @param id [String]
202
219
  #
203
- # @param commits [Array<MetronomeSDK::Commit>]
220
+ # @param commits [Array<MetronomeSDK::Models::Commit>]
204
221
  #
205
222
  # @param created_at [Time]
206
223
  #
207
224
  # @param created_by [String]
208
225
  #
209
- # @param overrides [Array<MetronomeSDK::Override>]
226
+ # @param overrides [Array<MetronomeSDK::Models::Override>]
210
227
  #
211
- # @param scheduled_charges [Array<MetronomeSDK::ScheduledCharge>]
228
+ # @param scheduled_charges [Array<MetronomeSDK::Models::ScheduledCharge>]
212
229
  #
213
230
  # @param starting_at [Time]
214
231
  #
215
- # @param credits [Array<MetronomeSDK::Credit>]
232
+ # @param credits [Array<MetronomeSDK::Models::Credit>]
216
233
  #
217
- # @param discounts [Array<MetronomeSDK::Discount>] This field's availability is dependent on your client's configuration.
234
+ # @param discounts [Array<MetronomeSDK::Models::Discount>] This field's availability is dependent on your client's configuration.
218
235
  #
219
236
  # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
220
237
  #
221
- # @param professional_services [Array<MetronomeSDK::ProService>] This field's availability is dependent on your client's configuration.
238
+ # @param professional_services [Array<MetronomeSDK::Models::ProService>] This field's availability is dependent on your client's configuration.
222
239
  #
223
240
  # @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
224
241
  #
@@ -417,7 +434,14 @@ module MetronomeSDK
417
434
  # @return [Float]
418
435
  required :threshold_amount, Float
419
436
 
420
- # @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:)
437
+ # @!attribute custom_credit_type_id
438
+ # If provided, the threshold, recharge-to amount, and the resulting threshold
439
+ # commit amount will be in terms of this credit type instead of the fiat currency.
440
+ #
441
+ # @return [String, nil]
442
+ optional :custom_credit_type_id, String
443
+
444
+ # @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:, custom_credit_type_id: nil)
421
445
  # Some parameter documentations has been truncated, see
422
446
  # {MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration}
423
447
  # for more details.
@@ -431,6 +455,8 @@ module MetronomeSDK
431
455
  # @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
432
456
  #
433
457
  # @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's prepaid
458
+ #
459
+ # @param custom_credit_type_id [String] If provided, the threshold, recharge-to amount, and the resulting threshold comm
434
460
 
435
461
  # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration#commit
436
462
  class Commit < MetronomeSDK::Internal::Type::BaseModel
@@ -442,16 +468,17 @@ module MetronomeSDK
442
468
  required :product_id, String
443
469
 
444
470
  # @!attribute applicable_product_ids
445
- # Which products the threshold commit applies to. If both applicable_product_ids
446
- # and applicable_product_tags are not provided, the commit applies to all
447
- # products.
471
+ # Which products the threshold commit applies to. If applicable_product_ids,
472
+ # applicable_product_tags or specifiers are not provided, the commit applies to
473
+ # all products.
448
474
  #
449
475
  # @return [Array<String>, nil]
450
476
  optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
451
477
 
452
478
  # @!attribute applicable_product_tags
453
- # Which tags the threshold commit applies to. If both applicable_product_ids and
454
- # applicable_product_tags are not provided, the commit applies to all products.
479
+ # Which tags the threshold commit applies to. If applicable_product_ids,
480
+ # applicable_product_tags or specifiers are not provided, the commit applies to
481
+ # all products.
455
482
  #
456
483
  # @return [Array<String>, nil]
457
484
  optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
@@ -468,20 +495,74 @@ module MetronomeSDK
468
495
  # @return [String, nil]
469
496
  optional :name, String
470
497
 
471
- # @!method initialize(product_id:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, name: nil)
498
+ # @!attribute specifiers
499
+ # List of filters that determine what kind of customer usage draws down a commit
500
+ # or credit. A customer's usage needs to meet the condition of at least one of the
501
+ # specifiers to contribute to a commit's or credit's drawdown. This field cannot
502
+ # be used together with `applicable_product_ids` or `applicable_product_tags`.
503
+ #
504
+ # @return [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::Commit::Specifier>, nil]
505
+ optional :specifiers,
506
+ -> do
507
+ MetronomeSDK::Internal::Type::ArrayOf[
508
+ MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::Commit::Specifier
509
+ ]
510
+ end
511
+
512
+ # @!method initialize(product_id:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, name: nil, specifiers: nil)
472
513
  # Some parameter documentations has been truncated, see
473
514
  # {MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::Commit}
474
515
  # for more details.
475
516
  #
476
517
  # @param product_id [String] The commit product that will be used to generate the line item for commit paymen
477
518
  #
478
- # @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If both applicable_product_ids a
519
+ # @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If applicable_product_ids, appli
479
520
  #
480
- # @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If both applicable_product_ids and a
521
+ # @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If applicable_product_ids, applicabl
481
522
  #
482
523
  # @param description [String]
483
524
  #
484
525
  # @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
526
+ #
527
+ # @param specifiers [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::Commit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
528
+
529
+ class Specifier < MetronomeSDK::Internal::Type::BaseModel
530
+ # @!attribute presentation_group_values
531
+ #
532
+ # @return [Hash{Symbol=>String}, nil]
533
+ optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
534
+
535
+ # @!attribute pricing_group_values
536
+ #
537
+ # @return [Hash{Symbol=>String}, nil]
538
+ optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
539
+
540
+ # @!attribute product_id
541
+ # If provided, the specifier will only apply to the product with the specified ID.
542
+ #
543
+ # @return [String, nil]
544
+ optional :product_id, String
545
+
546
+ # @!attribute product_tags
547
+ # If provided, the specifier will only apply to products with all the specified
548
+ # tags.
549
+ #
550
+ # @return [Array<String>, nil]
551
+ optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
552
+
553
+ # @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
554
+ # Some parameter documentations has been truncated, see
555
+ # {MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::Commit::Specifier}
556
+ # for more details.
557
+ #
558
+ # @param presentation_group_values [Hash{Symbol=>String}]
559
+ #
560
+ # @param pricing_group_values [Hash{Symbol=>String}]
561
+ #
562
+ # @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
563
+ #
564
+ # @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
565
+ end
485
566
  end
486
567
 
487
568
  # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration#payment_gate_config
@@ -496,8 +577,15 @@ module MetronomeSDK
496
577
  required :payment_gate_type,
497
578
  enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType }
498
579
 
580
+ # @!attribute precalculated_tax_config
581
+ # Only applicable if using PRECALCULATED as your tax type.
582
+ #
583
+ # @return [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig, nil]
584
+ optional :precalculated_tax_config,
585
+ -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig }
586
+
499
587
  # @!attribute stripe_config
500
- # Only applicable if using Stripe as your payment gateway through Metronome.
588
+ # Only applicable if using STRIPE as your payment gate type.
501
589
  #
502
590
  # @return [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
503
591
  optional :stripe_config,
@@ -512,14 +600,16 @@ module MetronomeSDK
512
600
  optional :tax_type,
513
601
  enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType }
514
602
 
515
- # @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
603
+ # @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
516
604
  # Some parameter documentations has been truncated, see
517
605
  # {MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig}
518
606
  # for more details.
519
607
  #
520
608
  # @param payment_gate_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
521
609
  #
522
- # @param stripe_config [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
610
+ # @param precalculated_tax_config [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
611
+ #
612
+ # @param stripe_config [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gate type.
523
613
  #
524
614
  # @param tax_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
525
615
 
@@ -540,6 +630,34 @@ module MetronomeSDK
540
630
  # @return [Array<Symbol>]
541
631
  end
542
632
 
633
+ # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#precalculated_tax_config
634
+ class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
635
+ # @!attribute tax_amount
636
+ # Amount of tax to be applied. This should be in the same currency and
637
+ # denomination as the commit's invoice schedule
638
+ #
639
+ # @return [Float]
640
+ required :tax_amount, Float
641
+
642
+ # @!attribute tax_name
643
+ # Name of the tax to be applied. This may be used in an invoice line item
644
+ # description.
645
+ #
646
+ # @return [String, nil]
647
+ optional :tax_name, String
648
+
649
+ # @!method initialize(tax_amount:, tax_name: nil)
650
+ # Some parameter documentations has been truncated, see
651
+ # {MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig}
652
+ # for more details.
653
+ #
654
+ # Only applicable if using PRECALCULATED as your tax type.
655
+ #
656
+ # @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
657
+ #
658
+ # @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
659
+ end
660
+
543
661
  # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#stripe_config
544
662
  class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
545
663
  # @!attribute payment_type
@@ -549,10 +667,23 @@ module MetronomeSDK
549
667
  required :payment_type,
550
668
  enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType }
551
669
 
552
- # @!method initialize(payment_type:)
553
- # Only applicable if using Stripe as your payment gateway through Metronome.
670
+ # @!attribute invoice_metadata
671
+ # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
672
+ # your payment type.
673
+ #
674
+ # @return [Hash{Symbol=>String}, nil]
675
+ optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
676
+
677
+ # @!method initialize(payment_type:, invoice_metadata: nil)
678
+ # Some parameter documentations has been truncated, see
679
+ # {MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig}
680
+ # for more details.
681
+ #
682
+ # Only applicable if using STRIPE as your payment gate type.
554
683
  #
555
684
  # @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
685
+ #
686
+ # @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
556
687
 
557
688
  # If left blank, will default to INVOICE
558
689
  #
@@ -578,6 +709,8 @@ module MetronomeSDK
578
709
 
579
710
  NONE = :NONE
580
711
  STRIPE = :STRIPE
712
+ ANROK = :ANROK
713
+ PRECALCULATED = :PRECALCULATED
581
714
 
582
715
  # @!method self.values
583
716
  # @return [Array<Symbol>]
@@ -688,8 +821,15 @@ module MetronomeSDK
688
821
  required :payment_gate_type,
689
822
  enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType }
690
823
 
824
+ # @!attribute precalculated_tax_config
825
+ # Only applicable if using PRECALCULATED as your tax type.
826
+ #
827
+ # @return [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig, nil]
828
+ optional :precalculated_tax_config,
829
+ -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig }
830
+
691
831
  # @!attribute stripe_config
692
- # Only applicable if using Stripe as your payment gateway through Metronome.
832
+ # Only applicable if using STRIPE as your payment gate type.
693
833
  #
694
834
  # @return [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
695
835
  optional :stripe_config,
@@ -704,14 +844,16 @@ module MetronomeSDK
704
844
  optional :tax_type,
705
845
  enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::TaxType }
706
846
 
707
- # @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
847
+ # @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
708
848
  # Some parameter documentations has been truncated, see
709
849
  # {MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig}
710
850
  # for more details.
711
851
  #
712
852
  # @param payment_gate_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
713
853
  #
714
- # @param stripe_config [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
854
+ # @param precalculated_tax_config [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig] Only applicable if using PRECALCULATED as your tax type.
855
+ #
856
+ # @param stripe_config [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using STRIPE as your payment gate type.
715
857
  #
716
858
  # @param tax_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
717
859
 
@@ -732,6 +874,34 @@ module MetronomeSDK
732
874
  # @return [Array<Symbol>]
733
875
  end
734
876
 
877
+ # @see MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig#precalculated_tax_config
878
+ class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
879
+ # @!attribute tax_amount
880
+ # Amount of tax to be applied. This should be in the same currency and
881
+ # denomination as the commit's invoice schedule
882
+ #
883
+ # @return [Float]
884
+ required :tax_amount, Float
885
+
886
+ # @!attribute tax_name
887
+ # Name of the tax to be applied. This may be used in an invoice line item
888
+ # description.
889
+ #
890
+ # @return [String, nil]
891
+ optional :tax_name, String
892
+
893
+ # @!method initialize(tax_amount:, tax_name: nil)
894
+ # Some parameter documentations has been truncated, see
895
+ # {MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig}
896
+ # for more details.
897
+ #
898
+ # Only applicable if using PRECALCULATED as your tax type.
899
+ #
900
+ # @param tax_amount [Float] Amount of tax to be applied. This should be in the same currency and denominatio
901
+ #
902
+ # @param tax_name [String] Name of the tax to be applied. This may be used in an invoice line item descript
903
+ end
904
+
735
905
  # @see MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig#stripe_config
736
906
  class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
737
907
  # @!attribute payment_type
@@ -741,10 +911,23 @@ module MetronomeSDK
741
911
  required :payment_type,
742
912
  enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType }
743
913
 
744
- # @!method initialize(payment_type:)
745
- # Only applicable if using Stripe as your payment gateway through Metronome.
914
+ # @!attribute invoice_metadata
915
+ # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
916
+ # your payment type.
917
+ #
918
+ # @return [Hash{Symbol=>String}, nil]
919
+ optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
920
+
921
+ # @!method initialize(payment_type:, invoice_metadata: nil)
922
+ # Some parameter documentations has been truncated, see
923
+ # {MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig}
924
+ # for more details.
925
+ #
926
+ # Only applicable if using STRIPE as your payment gate type.
746
927
  #
747
928
  # @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
929
+ #
930
+ # @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
748
931
 
749
932
  # If left blank, will default to INVOICE
750
933
  #
@@ -770,11 +953,213 @@ module MetronomeSDK
770
953
 
771
954
  NONE = :NONE
772
955
  STRIPE = :STRIPE
956
+ ANROK = :ANROK
957
+ PRECALCULATED = :PRECALCULATED
958
+
959
+ # @!method self.values
960
+ # @return [Array<Symbol>]
961
+ end
962
+ end
963
+ end
964
+
965
+ class Subscription < MetronomeSDK::Internal::Type::BaseModel
966
+ # @!attribute collection_schedule
967
+ #
968
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::CollectionSchedule]
969
+ required :collection_schedule,
970
+ enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::CollectionSchedule }
971
+
972
+ # @!attribute proration
973
+ #
974
+ # @return [MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::Proration]
975
+ required :proration, -> { MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::Proration }
976
+
977
+ # @!attribute quantity_schedule
978
+ # List of quantity schedule items for the subscription. Only includes the current
979
+ # quantity and future quantity changes.
980
+ #
981
+ # @return [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::QuantitySchedule>]
982
+ required :quantity_schedule,
983
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::QuantitySchedule] }
984
+
985
+ # @!attribute starting_at
986
+ #
987
+ # @return [Time]
988
+ required :starting_at, Time
989
+
990
+ # @!attribute subscription_rate
991
+ #
992
+ # @return [MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate]
993
+ required :subscription_rate,
994
+ -> { MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate }
995
+
996
+ # @!attribute id
997
+ #
998
+ # @return [String, nil]
999
+ optional :id, String
1000
+
1001
+ # @!attribute custom_fields
1002
+ #
1003
+ # @return [Hash{Symbol=>String}, nil]
1004
+ optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
1005
+
1006
+ # @!attribute description
1007
+ #
1008
+ # @return [String, nil]
1009
+ optional :description, String
1010
+
1011
+ # @!attribute ending_before
1012
+ #
1013
+ # @return [Time, nil]
1014
+ optional :ending_before, Time
1015
+
1016
+ # @!attribute fiat_credit_type_id
1017
+ #
1018
+ # @return [String, nil]
1019
+ optional :fiat_credit_type_id, String
1020
+
1021
+ # @!attribute name
1022
+ #
1023
+ # @return [String, nil]
1024
+ optional :name, String
1025
+
1026
+ # @!method initialize(collection_schedule:, proration:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil)
1027
+ # Some parameter documentations has been truncated, see
1028
+ # {MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription} for more
1029
+ # details.
1030
+ #
1031
+ # @param collection_schedule [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::CollectionSchedule]
1032
+ #
1033
+ # @param proration [MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::Proration]
1034
+ #
1035
+ # @param quantity_schedule [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::QuantitySchedule>] List of quantity schedule items for the subscription. Only includes the current
1036
+ #
1037
+ # @param starting_at [Time]
1038
+ #
1039
+ # @param subscription_rate [MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate]
1040
+ #
1041
+ # @param id [String]
1042
+ #
1043
+ # @param custom_fields [Hash{Symbol=>String}]
1044
+ #
1045
+ # @param description [String]
1046
+ #
1047
+ # @param ending_before [Time]
1048
+ #
1049
+ # @param fiat_credit_type_id [String]
1050
+ #
1051
+ # @param name [String]
1052
+
1053
+ # @see MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription#collection_schedule
1054
+ module CollectionSchedule
1055
+ extend MetronomeSDK::Internal::Type::Enum
1056
+
1057
+ ADVANCE = :ADVANCE
1058
+ ARREARS = :ARREARS
1059
+
1060
+ # @!method self.values
1061
+ # @return [Array<Symbol>]
1062
+ end
1063
+
1064
+ # @see MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription#proration
1065
+ class Proration < MetronomeSDK::Internal::Type::BaseModel
1066
+ # @!attribute invoice_behavior
1067
+ #
1068
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::Proration::InvoiceBehavior]
1069
+ required :invoice_behavior,
1070
+ enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::Proration::InvoiceBehavior }
1071
+
1072
+ # @!attribute is_prorated
1073
+ #
1074
+ # @return [Boolean]
1075
+ required :is_prorated, MetronomeSDK::Internal::Type::Boolean
1076
+
1077
+ # @!method initialize(invoice_behavior:, is_prorated:)
1078
+ # @param invoice_behavior [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::Proration::InvoiceBehavior]
1079
+ # @param is_prorated [Boolean]
1080
+
1081
+ # @see MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::Proration#invoice_behavior
1082
+ module InvoiceBehavior
1083
+ extend MetronomeSDK::Internal::Type::Enum
1084
+
1085
+ BILL_IMMEDIATELY = :BILL_IMMEDIATELY
1086
+ BILL_ON_NEXT_COLLECTION_DATE = :BILL_ON_NEXT_COLLECTION_DATE
773
1087
 
774
1088
  # @!method self.values
775
1089
  # @return [Array<Symbol>]
776
1090
  end
777
1091
  end
1092
+
1093
+ class QuantitySchedule < MetronomeSDK::Internal::Type::BaseModel
1094
+ # @!attribute quantity
1095
+ #
1096
+ # @return [Float]
1097
+ required :quantity, Float
1098
+
1099
+ # @!attribute starting_at
1100
+ #
1101
+ # @return [Time]
1102
+ required :starting_at, Time
1103
+
1104
+ # @!attribute ending_before
1105
+ #
1106
+ # @return [Time, nil]
1107
+ optional :ending_before, Time
1108
+
1109
+ # @!method initialize(quantity:, starting_at:, ending_before: nil)
1110
+ # @param quantity [Float]
1111
+ # @param starting_at [Time]
1112
+ # @param ending_before [Time]
1113
+ end
1114
+
1115
+ # @see MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription#subscription_rate
1116
+ class SubscriptionRate < MetronomeSDK::Internal::Type::BaseModel
1117
+ # @!attribute billing_frequency
1118
+ #
1119
+ # @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate::BillingFrequency]
1120
+ required :billing_frequency,
1121
+ enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate::BillingFrequency }
1122
+
1123
+ # @!attribute product
1124
+ #
1125
+ # @return [MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate::Product]
1126
+ required :product,
1127
+ -> { MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate::Product }
1128
+
1129
+ # @!method initialize(billing_frequency:, product:)
1130
+ # @param billing_frequency [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate::BillingFrequency]
1131
+ # @param product [MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate::Product]
1132
+
1133
+ # @see MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate#billing_frequency
1134
+ module BillingFrequency
1135
+ extend MetronomeSDK::Internal::Type::Enum
1136
+
1137
+ MONTHLY = :MONTHLY
1138
+ QUARTERLY = :QUARTERLY
1139
+ ANNUAL = :ANNUAL
1140
+ WEEKLY = :WEEKLY
1141
+
1142
+ # @!method self.values
1143
+ # @return [Array<Symbol>]
1144
+ end
1145
+
1146
+ # @see MetronomeSDK::Models::V1::ContractListResponse::Data::Subscription::SubscriptionRate#product
1147
+ class Product < MetronomeSDK::Internal::Type::BaseModel
1148
+ # @!attribute id
1149
+ #
1150
+ # @return [String]
1151
+ required :id, String
1152
+
1153
+ # @!attribute name
1154
+ #
1155
+ # @return [String]
1156
+ required :name, String
1157
+
1158
+ # @!method initialize(id:, name:)
1159
+ # @param id [String]
1160
+ # @param name [String]
1161
+ end
1162
+ end
778
1163
  end
779
1164
  end
780
1165
  end