metronome-sdk 0.2.0 → 1.0.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 (321) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +61 -0
  3. data/README.md +9 -9
  4. data/lib/metronome_sdk/internal/body_cursor_page.rb +86 -0
  5. data/lib/metronome_sdk/internal/cursor_page_without_limit.rb +86 -0
  6. data/lib/metronome_sdk/internal/transport/base_client.rb +1 -4
  7. data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb +1 -9
  8. data/lib/metronome_sdk/internal/type/array_of.rb +1 -0
  9. data/lib/metronome_sdk/internal/type/base_model.rb +9 -14
  10. data/lib/metronome_sdk/internal/type/converter.rb +27 -0
  11. data/lib/metronome_sdk/internal/type/hash_of.rb +1 -0
  12. data/lib/metronome_sdk/internal/type/union.rb +20 -7
  13. data/lib/metronome_sdk/internal/util.rb +1 -1
  14. data/lib/metronome_sdk/models/base_threshold_commit.rb +36 -0
  15. data/lib/metronome_sdk/models/commit.rb +26 -170
  16. data/lib/metronome_sdk/models/commit_hierarchy_configuration.rb +98 -0
  17. data/lib/metronome_sdk/models/commit_rate.rb +48 -0
  18. data/lib/metronome_sdk/models/commit_specifier.rb +42 -0
  19. data/lib/metronome_sdk/models/commit_specifier_input.rb +42 -0
  20. data/lib/metronome_sdk/models/contract.rb +404 -0
  21. data/lib/metronome_sdk/models/contract_v2.rb +2919 -0
  22. data/lib/metronome_sdk/models/contract_without_amendments.rb +36 -1126
  23. data/lib/metronome_sdk/models/credit.rb +9 -156
  24. data/lib/metronome_sdk/models/discount.rb +2 -1
  25. data/lib/metronome_sdk/models/hierarchy_configuration.rb +76 -0
  26. data/lib/metronome_sdk/models/override.rb +6 -101
  27. data/lib/metronome_sdk/models/override_tier.rb +21 -0
  28. data/lib/metronome_sdk/models/overwrite_rate.rb +82 -0
  29. data/lib/metronome_sdk/models/payment_gate_config.rb +149 -0
  30. data/lib/metronome_sdk/models/payment_gate_config_v2.rb +149 -0
  31. data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration.rb +100 -0
  32. data/lib/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rb +102 -0
  33. data/lib/metronome_sdk/models/pro_service.rb +2 -1
  34. data/lib/metronome_sdk/models/recurring_commit_subscription_config.rb +51 -0
  35. data/lib/metronome_sdk/models/schedule_point_in_time.rb +14 -1
  36. data/lib/metronome_sdk/models/scheduled_charge.rb +2 -1
  37. data/lib/metronome_sdk/models/spend_threshold_configuration.rb +44 -0
  38. data/lib/metronome_sdk/models/spend_threshold_configuration_v2.rb +44 -0
  39. data/lib/metronome_sdk/models/subscription.rb +227 -0
  40. data/lib/metronome_sdk/models/update_base_threshold_commit.rb +36 -0
  41. data/lib/metronome_sdk/models/v1/alert_create_params.rb +4 -6
  42. data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +1 -2
  43. data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +3 -3
  44. data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +4 -7
  45. data/lib/metronome_sdk/models/v1/contract_amend_params.rb +110 -415
  46. data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +7 -16
  47. data/lib/metronome_sdk/models/v1/contract_create_params.rb +287 -1480
  48. data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +6 -23
  49. data/lib/metronome_sdk/models/v1/contract_list_response.rb +3 -1153
  50. data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +2 -6
  51. data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +5 -50
  52. data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +3 -1154
  53. data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +1 -3
  54. data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +9 -1
  55. data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +8 -1
  56. data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +8 -1
  57. data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +1 -4
  58. data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +4 -7
  59. data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +10 -1
  60. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +2 -6
  61. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +5 -50
  62. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +10 -1
  63. data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +1 -3
  64. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +1 -3
  65. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +6 -61
  66. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +3 -49
  67. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +4 -51
  68. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +2 -6
  69. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +5 -49
  70. data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +103 -123
  71. data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +3 -5
  72. data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +1 -3
  73. data/lib/metronome_sdk/models/v1/custom_field_list_keys_response.rb +41 -58
  74. data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +5 -1
  75. data/lib/metronome_sdk/models/v1/customer.rb +2 -1
  76. data/lib/metronome_sdk/models/v1/customer_create_params.rb +37 -11
  77. data/lib/metronome_sdk/models/v1/customer_detail.rb +2 -1
  78. data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +3 -3
  79. data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +1 -3
  80. data/lib/metronome_sdk/models/v1/customer_retrieve_billing_configurations_params.rb +28 -0
  81. data/lib/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rb +128 -0
  82. data/lib/metronome_sdk/models/v1/customer_set_billing_configurations_params.rb +143 -0
  83. data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +1 -3
  84. data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +30 -1
  85. data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +2 -0
  86. data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +2 -0
  87. data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +20 -61
  88. data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +6 -48
  89. data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +8 -16
  90. data/lib/metronome_sdk/models/v1/customers/invoice.rb +68 -43
  91. data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +1 -4
  92. data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +2 -6
  93. data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +2 -1
  94. data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +4 -11
  95. data/lib/metronome_sdk/models/v1/plan_detail.rb +9 -5
  96. data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +2 -1
  97. data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +2 -1
  98. data/lib/metronome_sdk/models/v1/plan_list_response.rb +5 -1
  99. data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +1 -4
  100. data/lib/metronome_sdk/models/v1/usage_list_params.rb +1 -3
  101. data/lib/metronome_sdk/models/v1/usage_list_response.rb +45 -62
  102. data/lib/metronome_sdk/models/v1/usage_search_response.rb +4 -7
  103. data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +38 -58
  104. data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +35 -49
  105. data/lib/metronome_sdk/models/v2/contract_edit_params.rb +469 -2302
  106. data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +358 -2414
  107. data/lib/metronome_sdk/models/v2/contract_list_response.rb +3 -4520
  108. data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +3 -4528
  109. data/lib/metronome_sdk/models.rb +38 -0
  110. data/lib/metronome_sdk/resources/v1/alerts.rb +72 -2
  111. data/lib/metronome_sdk/resources/v1/audit_logs.rb +39 -4
  112. data/lib/metronome_sdk/resources/v1/billable_metrics.rb +54 -4
  113. data/lib/metronome_sdk/resources/v1/contracts/products.rb +27 -6
  114. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +7 -2
  115. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +10 -2
  116. data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +109 -10
  117. data/lib/metronome_sdk/resources/v1/contracts.rb +254 -18
  118. data/lib/metronome_sdk/resources/v1/credit_grants.rb +2 -1
  119. data/lib/metronome_sdk/resources/v1/custom_fields.rb +51 -14
  120. data/lib/metronome_sdk/resources/v1/customers/alerts.rb +103 -8
  121. data/lib/metronome_sdk/resources/v1/customers/commits.rb +119 -9
  122. data/lib/metronome_sdk/resources/v1/customers/credits.rb +104 -8
  123. data/lib/metronome_sdk/resources/v1/customers/invoices.rb +124 -8
  124. data/lib/metronome_sdk/resources/v1/customers.rb +169 -12
  125. data/lib/metronome_sdk/resources/v1/dashboards.rb +29 -3
  126. data/lib/metronome_sdk/resources/v1/invoices.rb +23 -2
  127. data/lib/metronome_sdk/resources/v1/pricing_units.rb +6 -1
  128. data/lib/metronome_sdk/resources/v1/services.rb +6 -4
  129. data/lib/metronome_sdk/resources/v1/usage.rb +185 -12
  130. data/lib/metronome_sdk/resources/v2/contracts.rb +118 -18
  131. data/lib/metronome_sdk/version.rb +1 -1
  132. data/lib/metronome_sdk.rb +24 -3
  133. data/rbi/metronome_sdk/errors.rbi +2 -2
  134. data/rbi/metronome_sdk/internal/body_cursor_page.rbi +22 -0
  135. data/rbi/metronome_sdk/internal/cursor_page_without_limit.rbi +22 -0
  136. data/rbi/metronome_sdk/internal/type/converter.rbi +58 -0
  137. data/rbi/metronome_sdk/internal/type/union.rbi +9 -2
  138. data/rbi/metronome_sdk/models/base_threshold_commit.rbi +58 -0
  139. data/rbi/metronome_sdk/models/commit.rbi +26 -348
  140. data/rbi/metronome_sdk/models/commit_hierarchy_configuration.rbi +280 -0
  141. data/rbi/metronome_sdk/models/commit_rate.rbi +85 -0
  142. data/rbi/metronome_sdk/models/commit_specifier.rbi +71 -0
  143. data/rbi/metronome_sdk/models/commit_specifier_input.rbi +74 -0
  144. data/rbi/metronome_sdk/models/contract.rbi +768 -0
  145. data/rbi/metronome_sdk/models/contract_v2.rbi +5822 -0
  146. data/rbi/metronome_sdk/models/contract_without_amendments.rbi +184 -2507
  147. data/rbi/metronome_sdk/models/credit.rbi +10 -348
  148. data/rbi/metronome_sdk/models/discount.rbi +2 -0
  149. data/rbi/metronome_sdk/models/hierarchy_configuration.rbi +180 -0
  150. data/rbi/metronome_sdk/models/override.rbi +8 -193
  151. data/rbi/metronome_sdk/models/override_tier.rbi +29 -0
  152. data/rbi/metronome_sdk/models/overwrite_rate.rbi +137 -0
  153. data/rbi/metronome_sdk/models/payment_gate_config.rbi +312 -0
  154. data/rbi/metronome_sdk/models/payment_gate_config_v2.rbi +321 -0
  155. data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration.rbi +183 -0
  156. data/rbi/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbi +188 -0
  157. data/rbi/metronome_sdk/models/pro_service.rbi +2 -0
  158. data/rbi/metronome_sdk/models/recurring_commit_subscription_config.rbi +125 -0
  159. data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +17 -1
  160. data/rbi/metronome_sdk/models/scheduled_charge.rbi +2 -0
  161. data/rbi/metronome_sdk/models/spend_threshold_configuration.rbi +76 -0
  162. data/rbi/metronome_sdk/models/spend_threshold_configuration_v2.rbi +78 -0
  163. data/rbi/metronome_sdk/models/subscription.rbi +460 -0
  164. data/rbi/metronome_sdk/models/update_base_threshold_commit.rbi +61 -0
  165. data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +6 -3
  166. data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +2 -0
  167. data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +2 -0
  168. data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +120 -771
  169. data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbi +2 -0
  170. data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1613 -4069
  171. data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +8 -59
  172. data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +5 -2420
  173. data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +6 -129
  174. data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +4 -2419
  175. data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +11 -0
  176. data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +2 -0
  177. data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +2 -0
  178. data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_params.rbi +2 -0
  179. data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +2 -0
  180. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +6 -129
  181. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +2 -0
  182. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +4 -129
  183. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +4 -129
  184. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +4 -129
  185. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +6 -129
  186. data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +147 -198
  187. data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +2 -0
  188. data/rbi/metronome_sdk/models/v1/custom_field_list_keys_response.rbi +117 -165
  189. data/rbi/metronome_sdk/models/v1/custom_field_set_values_params.rbi +8 -1
  190. data/rbi/metronome_sdk/models/v1/customer.rbi +2 -0
  191. data/rbi/metronome_sdk/models/v1/customer_create_params.rbi +88 -3
  192. data/rbi/metronome_sdk/models/v1/customer_detail.rbi +2 -0
  193. data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +2 -0
  194. data/rbi/metronome_sdk/models/v1/customer_retrieve_billing_configurations_params.rbi +51 -0
  195. data/rbi/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rbi +265 -0
  196. data/rbi/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbi +348 -0
  197. data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_params.rbi +60 -0
  198. data/rbi/metronome_sdk/models/v1/customers/billing_config_create_params.rbi +10 -0
  199. data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +10 -0
  200. data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +19 -90
  201. data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +6 -90
  202. data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +6 -3
  203. data/rbi/metronome_sdk/models/v1/customers/invoice.rbi +76 -0
  204. data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +2 -0
  205. data/rbi/metronome_sdk/models/v1/plan_detail.rbi +2 -0
  206. data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +2 -0
  207. data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +2 -0
  208. data/rbi/metronome_sdk/models/v1/plan_list_response.rbi +8 -1
  209. data/rbi/metronome_sdk/models/v1/usage_list_response.rbi +45 -86
  210. data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +2 -0
  211. data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +66 -76
  212. data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +66 -76
  213. data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +3563 -7329
  214. data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1181 -6070
  215. data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +5 -9867
  216. data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +6 -9866
  217. data/rbi/metronome_sdk/models.rbi +44 -0
  218. data/rbi/metronome_sdk/resources/v1/alerts.rbi +72 -2
  219. data/rbi/metronome_sdk/resources/v1/audit_logs.rbi +39 -4
  220. data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +54 -4
  221. data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +27 -5
  222. data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbi +7 -2
  223. data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +10 -3
  224. data/rbi/metronome_sdk/resources/v1/contracts/rate_cards.rbi +109 -9
  225. data/rbi/metronome_sdk/resources/v1/contracts.rbi +257 -16
  226. data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +5 -1
  227. data/rbi/metronome_sdk/resources/v1/custom_fields.rbi +57 -14
  228. data/rbi/metronome_sdk/resources/v1/customers/alerts.rbi +108 -5
  229. data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +119 -10
  230. data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +104 -9
  231. data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +123 -7
  232. data/rbi/metronome_sdk/resources/v1/customers.rbi +156 -11
  233. data/rbi/metronome_sdk/resources/v1/dashboards.rbi +29 -3
  234. data/rbi/metronome_sdk/resources/v1/invoices.rbi +23 -2
  235. data/rbi/metronome_sdk/resources/v1/pricing_units.rbi +6 -1
  236. data/rbi/metronome_sdk/resources/v1/services.rbi +6 -4
  237. data/rbi/metronome_sdk/resources/v1/usage.rbi +188 -12
  238. data/rbi/metronome_sdk/resources/v2/contracts.rbi +128 -23
  239. data/sig/metronome_sdk/internal/body_cursor_page.rbs +13 -0
  240. data/sig/metronome_sdk/internal/cursor_page_without_limit.rbs +13 -0
  241. data/sig/metronome_sdk/internal/type/converter.rbs +17 -0
  242. data/sig/metronome_sdk/internal/type/union.rbs +2 -2
  243. data/sig/metronome_sdk/models/base_threshold_commit.rbs +26 -0
  244. data/sig/metronome_sdk/models/commit.rbs +17 -170
  245. data/sig/metronome_sdk/models/commit_hierarchy_configuration.rbs +117 -0
  246. data/sig/metronome_sdk/models/commit_rate.rbs +48 -0
  247. data/sig/metronome_sdk/models/commit_specifier.rbs +47 -0
  248. data/sig/metronome_sdk/models/commit_specifier_input.rbs +47 -0
  249. data/sig/metronome_sdk/models/contract.rbs +398 -0
  250. data/sig/metronome_sdk/models/contract_v2.rbs +2881 -0
  251. data/sig/metronome_sdk/models/contract_without_amendments.rbs +54 -976
  252. data/sig/metronome_sdk/models/credit.rbs +12 -170
  253. data/sig/metronome_sdk/models/hierarchy_configuration.rbs +71 -0
  254. data/sig/metronome_sdk/models/override.rbs +12 -101
  255. data/sig/metronome_sdk/models/override_tier.rbs +17 -0
  256. data/sig/metronome_sdk/models/overwrite_rate.rbs +78 -0
  257. data/sig/metronome_sdk/models/payment_gate_config.rbs +123 -0
  258. data/sig/metronome_sdk/models/payment_gate_config_v2.rbs +123 -0
  259. data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration.rbs +82 -0
  260. data/sig/metronome_sdk/models/prepaid_balance_threshold_configuration_v2.rbs +82 -0
  261. data/sig/metronome_sdk/models/recurring_commit_subscription_config.rbs +51 -0
  262. data/sig/metronome_sdk/models/schedule_point_in_time.rbs +7 -0
  263. data/sig/metronome_sdk/models/spend_threshold_configuration.rbs +35 -0
  264. data/sig/metronome_sdk/models/spend_threshold_configuration_v2.rbs +35 -0
  265. data/sig/metronome_sdk/models/subscription.rbs +215 -0
  266. data/sig/metronome_sdk/models/update_base_threshold_commit.rbs +28 -0
  267. data/sig/metronome_sdk/models/v1/alert_create_params.rbs +4 -2
  268. data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +62 -343
  269. data/sig/metronome_sdk/models/v1/contract_create_params.rbs +218 -1234
  270. data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +4 -25
  271. data/sig/metronome_sdk/models/v1/contract_list_response.rbs +4 -1041
  272. data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +6 -54
  273. data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +4 -1041
  274. data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +7 -0
  275. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +6 -54
  276. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +6 -54
  277. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +6 -54
  278. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +6 -54
  279. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +6 -54
  280. data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +72 -94
  281. data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +53 -75
  282. data/sig/metronome_sdk/models/v1/customer_create_params.rbs +31 -4
  283. data/sig/metronome_sdk/models/v1/customer_retrieve_billing_configurations_params.rbs +32 -0
  284. data/sig/metronome_sdk/models/v1/customer_retrieve_billing_configurations_response.rbs +113 -0
  285. data/sig/metronome_sdk/models/v1/customer_set_billing_configurations_params.rbs +133 -0
  286. data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +21 -0
  287. data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +7 -1
  288. data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +6 -1
  289. data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +13 -50
  290. data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +6 -50
  291. data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +4 -2
  292. data/sig/metronome_sdk/models/v1/customers/invoice.rbs +5 -0
  293. data/sig/metronome_sdk/models/v1/usage_list_response.rbs +33 -55
  294. data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +24 -43
  295. data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +24 -43
  296. data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +400 -1911
  297. data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +256 -2249
  298. data/sig/metronome_sdk/models/v2/contract_list_response.rbs +4 -4426
  299. data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +4 -4426
  300. data/sig/metronome_sdk/models.rbs +38 -0
  301. data/sig/metronome_sdk/resources/v1/contracts/products.rbs +1 -0
  302. data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -1
  303. data/sig/metronome_sdk/resources/v1/contracts.rbs +3 -3
  304. data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -1
  305. data/sig/metronome_sdk/resources/v1/custom_fields.rbs +1 -1
  306. data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +2 -1
  307. data/sig/metronome_sdk/resources/v1/customers/commits.rbs +2 -2
  308. data/sig/metronome_sdk/resources/v1/customers/credits.rbs +2 -2
  309. data/sig/metronome_sdk/resources/v1/customers.rbs +11 -0
  310. data/sig/metronome_sdk/resources/v1/usage.rbs +1 -1
  311. data/sig/metronome_sdk/resources/v2/contracts.rbs +9 -4
  312. metadata +74 -11
  313. data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +0 -29
  314. data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +0 -26
  315. data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +0 -26
  316. data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +0 -46
  317. data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +0 -45
  318. data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +0 -45
  319. data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +0 -29
  320. data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +0 -26
  321. data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +0 -26
@@ -39,6 +39,7 @@ module MetronomeSDK
39
39
  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit] }
40
40
 
41
41
  # @!attribute custom_fields
42
+ # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
42
43
  #
43
44
  # @return [Hash{Symbol=>String}, nil]
44
45
  optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -67,18 +68,14 @@ module MetronomeSDK
67
68
  #
68
69
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::ProfessionalService>, nil]
69
70
  optional :professional_services,
70
- -> {
71
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ProfessionalService]
72
- }
71
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ProfessionalService] }
73
72
 
74
73
  # @!attribute reseller_royalties
75
74
  # This field's availability is dependent on your client's configuration.
76
75
  #
77
76
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::ResellerRoyalty>, nil]
78
77
  optional :reseller_royalties,
79
- -> {
80
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty]
81
- }
78
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty] }
82
79
 
83
80
  # @!attribute salesforce_opportunity_id
84
81
  # This field's availability is dependent on your client's configuration.
@@ -90,9 +87,7 @@ module MetronomeSDK
90
87
  #
91
88
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge>, nil]
92
89
  optional :scheduled_charges,
93
- -> {
94
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge]
95
- }
90
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge] }
96
91
 
97
92
  # @!attribute total_contract_value
98
93
  # This field's availability is dependent on your client's configuration.
@@ -111,7 +106,7 @@ module MetronomeSDK
111
106
  #
112
107
  # @param credits [Array<MetronomeSDK::Models::V1::ContractAmendParams::Credit>]
113
108
  #
114
- # @param custom_fields [Hash{Symbol=>String}]
109
+ # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
115
110
  #
116
111
  # @param discounts [Array<MetronomeSDK::Models::V1::ContractAmendParams::Discount>] This field's availability is dependent on your client's configuration.
117
112
  #
@@ -173,6 +168,7 @@ module MetronomeSDK
173
168
  optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
174
169
 
175
170
  # @!attribute custom_fields
171
+ # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
176
172
  #
177
173
  # @return [Hash{Symbol=>String}, nil]
178
174
  optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -186,9 +182,8 @@ module MetronomeSDK
186
182
  # @!attribute hierarchy_configuration
187
183
  # Optional configuration for commit hierarchy access control
188
184
  #
189
- # @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration, nil]
190
- optional :hierarchy_configuration,
191
- -> { MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration }
185
+ # @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
186
+ optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
192
187
 
193
188
  # @!attribute invoice_schedule
194
189
  # Required for "POSTPAID" commits: the true up invoice will be generated at this
@@ -215,10 +210,7 @@ module MetronomeSDK
215
210
  # optionally payment gate this commit
216
211
  #
217
212
  # @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig, nil]
218
- optional :payment_gate_config,
219
- -> {
220
- MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig
221
- }
213
+ optional :payment_gate_config, -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig }
222
214
 
223
215
  # @!attribute priority
224
216
  # If multiple commits are applicable, the one with the lower priority will apply
@@ -244,11 +236,8 @@ module MetronomeSDK
244
236
  # specifiers to contribute to a commit's or credit's drawdown. This field cannot
245
237
  # be used together with `applicable_product_ids` or `applicable_product_tags`.
246
238
  #
247
- # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit::Specifier>, nil]
248
- optional :specifiers,
249
- -> {
250
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::Specifier]
251
- }
239
+ # @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
240
+ optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
252
241
 
253
242
  # @!attribute temporary_id
254
243
  # A temporary ID for the commit that can be used to reference the commit for
@@ -273,11 +262,11 @@ module MetronomeSDK
273
262
  #
274
263
  # @param applicable_product_tags [Array<String>] Which tags the commit applies to. If applicable*product_ids, applicable_product*
275
264
  #
276
- # @param custom_fields [Hash{Symbol=>String}]
265
+ # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
277
266
  #
278
267
  # @param description [String] Used only in UI/API. It is not exposed to end customers.
279
268
  #
280
- # @param hierarchy_configuration [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration] Optional configuration for commit hierarchy access control
269
+ # @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for commit hierarchy access control
281
270
  #
282
271
  # @param invoice_schedule [MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule] Required for "POSTPAID" commits: the true up invoice will be generated at this t
283
272
  #
@@ -293,7 +282,7 @@ module MetronomeSDK
293
282
  #
294
283
  # @param rollover_fraction [Float] Fraction of unused segments that will be rolled over. Must be between 0 and 1.
295
284
  #
296
- # @param specifiers [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
285
+ # @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] List of filters that determine what kind of customer usage draws down a commit o
297
286
  #
298
287
  # @param temporary_id [String] A temporary ID for the commit that can be used to reference the commit for commi
299
288
 
@@ -314,9 +303,7 @@ module MetronomeSDK
314
303
  #
315
304
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem>]
316
305
  required :schedule_items,
317
- -> {
318
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem]
319
- }
306
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::AccessSchedule::ScheduleItem] }
320
307
 
321
308
  # @!attribute credit_type_id
322
309
  # Defaults to USD (cents) if not passed
@@ -360,117 +347,6 @@ module MetronomeSDK
360
347
  end
361
348
  end
362
349
 
363
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit#hierarchy_configuration
364
- class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
365
- # @!attribute child_access
366
- #
367
- # @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
368
- required :child_access,
369
- union: -> {
370
- MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess
371
- }
372
-
373
- # @!method initialize(child_access:)
374
- # Optional configuration for commit hierarchy access control
375
- #
376
- # @param child_access [MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
377
-
378
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration#child_access
379
- module ChildAccess
380
- extend MetronomeSDK::Internal::Type::Union
381
-
382
- variant -> {
383
- MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
384
- }
385
-
386
- variant -> {
387
- MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
388
- }
389
-
390
- variant -> {
391
- MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
392
- }
393
-
394
- class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
395
- # @!attribute type
396
- #
397
- # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
398
- required :type,
399
- enum: -> {
400
- MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
401
- }
402
-
403
- # @!method initialize(type:)
404
- # @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
405
-
406
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
407
- module Type
408
- extend MetronomeSDK::Internal::Type::Enum
409
-
410
- ALL = :ALL
411
-
412
- # @!method self.values
413
- # @return [Array<Symbol>]
414
- end
415
- end
416
-
417
- class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
418
- # @!attribute type
419
- #
420
- # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
421
- required :type,
422
- enum: -> {
423
- MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
424
- }
425
-
426
- # @!method initialize(type:)
427
- # @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
428
-
429
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
430
- module Type
431
- extend MetronomeSDK::Internal::Type::Enum
432
-
433
- NONE = :NONE
434
-
435
- # @!method self.values
436
- # @return [Array<Symbol>]
437
- end
438
- end
439
-
440
- class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
441
- # @!attribute contract_ids
442
- #
443
- # @return [Array<String>]
444
- required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
445
-
446
- # @!attribute type
447
- #
448
- # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
449
- required :type,
450
- enum: -> {
451
- MetronomeSDK::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
452
- }
453
-
454
- # @!method initialize(contract_ids:, type:)
455
- # @param contract_ids [Array<String>]
456
- # @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
457
-
458
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
459
- module Type
460
- extend MetronomeSDK::Internal::Type::Enum
461
-
462
- CONTRACT_IDS = :CONTRACT_IDS
463
-
464
- # @!method self.values
465
- # @return [Array<Symbol>]
466
- end
467
- end
468
-
469
- # @!method self.variants
470
- # @return [Array(MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Commit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
471
- end
472
- end
473
-
474
350
  # @see MetronomeSDK::Models::V1::ContractAmendParams::Commit#invoice_schedule
475
351
  class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
476
352
  # @!attribute credit_type_id
@@ -479,6 +355,13 @@ module MetronomeSDK
479
355
  # @return [String, nil]
480
356
  optional :credit_type_id, String
481
357
 
358
+ # @!attribute do_not_invoice
359
+ # This field is only applicable to commit invoice schedules. If true, this
360
+ # schedule will not generate an invoice.
361
+ #
362
+ # @return [Boolean, nil]
363
+ optional :do_not_invoice, MetronomeSDK::Internal::Type::Boolean
364
+
482
365
  # @!attribute recurring_schedule
483
366
  # Enter the unit price and quantity for the charge or instead only send the
484
367
  # amount. If amount is sent, the unit price is assumed to be the amount and
@@ -493,11 +376,9 @@ module MetronomeSDK
493
376
  #
494
377
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem>, nil]
495
378
  optional :schedule_items,
496
- -> {
497
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem]
498
- }
379
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem] }
499
380
 
500
- # @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
381
+ # @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
501
382
  # Some parameter documentations has been truncated, see
502
383
  # {MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule} for
503
384
  # more details.
@@ -509,6 +390,8 @@ module MetronomeSDK
509
390
  #
510
391
  # @param credit_type_id [String] Defaults to USD (cents) if not passed.
511
392
  #
393
+ # @param do_not_invoice [Boolean] This field is only applicable to commit invoice schedules. If true, this schedul
394
+ #
512
395
  # @param recurring_schedule [MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
513
396
  #
514
397
  # @param schedule_items [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
@@ -519,9 +402,7 @@ module MetronomeSDK
519
402
  #
520
403
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution]
521
404
  required :amount_distribution,
522
- enum: -> {
523
- MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution
524
- }
405
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::AmountDistribution }
525
406
 
526
407
  # @!attribute ending_before
527
408
  # RFC 3339 timestamp (exclusive).
@@ -533,9 +414,7 @@ module MetronomeSDK
533
414
  #
534
415
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency]
535
416
  required :frequency,
536
- enum: -> {
537
- MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency
538
- }
417
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule::Frequency }
539
418
 
540
419
  # @!attribute starting_at
541
420
  # RFC 3339 timestamp (inclusive).
@@ -672,18 +551,14 @@ module MetronomeSDK
672
551
  #
673
552
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType]
674
553
  required :payment_gate_type,
675
- enum: -> {
676
- MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType
677
- }
554
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PaymentGateType }
678
555
 
679
556
  # @!attribute precalculated_tax_config
680
557
  # Only applicable if using PRECALCULATED as your tax type.
681
558
  #
682
559
  # @return [MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig, nil]
683
560
  optional :precalculated_tax_config,
684
- -> {
685
- MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig
686
- }
561
+ -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::PrecalculatedTaxConfig }
687
562
 
688
563
  # @!attribute stripe_config
689
564
  # Only applicable if using STRIPE as your payment gate type.
@@ -698,10 +573,7 @@ module MetronomeSDK
698
573
  # will default to NONE.
699
574
  #
700
575
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType, nil]
701
- optional :tax_type,
702
- enum: -> {
703
- MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType
704
- }
576
+ optional :tax_type, enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::TaxType }
705
577
 
706
578
  # @!method initialize(payment_gate_type:, precalculated_tax_config: nil, stripe_config: nil, tax_type: nil)
707
579
  # Some parameter documentations has been truncated, see
@@ -770,9 +642,7 @@ module MetronomeSDK
770
642
  #
771
643
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType]
772
644
  required :payment_type,
773
- enum: -> {
774
- MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType
775
- }
645
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType }
776
646
 
777
647
  # @!attribute invoice_metadata
778
648
  # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
@@ -781,7 +651,20 @@ module MetronomeSDK
781
651
  # @return [Hash{Symbol=>String}, nil]
782
652
  optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
783
653
 
784
- # @!method initialize(payment_type:, invoice_metadata: nil)
654
+ # @!attribute on_session_payment
655
+ # If true, the payment will be made assuming the customer is present (i.e. on
656
+ # session).
657
+ #
658
+ # If false, the payment will be made assuming the customer is not present (i.e.
659
+ # off session). For cardholders from a country with an e-mandate requirement (e.g.
660
+ # India), the payment may be declined.
661
+ #
662
+ # If left blank, will default to false.
663
+ #
664
+ # @return [Boolean, nil]
665
+ optional :on_session_payment, MetronomeSDK::Internal::Type::Boolean
666
+
667
+ # @!method initialize(payment_type:, invoice_metadata: nil, on_session_payment: nil)
785
668
  # Some parameter documentations has been truncated, see
786
669
  # {MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig}
787
670
  # for more details.
@@ -791,6 +674,8 @@ module MetronomeSDK
791
674
  # @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
792
675
  #
793
676
  # @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
677
+ #
678
+ # @param on_session_payment [Boolean] If true, the payment will be made assuming the customer is present (i.e. on sess
794
679
 
795
680
  # If left blank, will default to INVOICE
796
681
  #
@@ -834,44 +719,6 @@ module MetronomeSDK
834
719
  # @!method self.values
835
720
  # @return [Array<Symbol>]
836
721
  end
837
-
838
- class Specifier < MetronomeSDK::Internal::Type::BaseModel
839
- # @!attribute presentation_group_values
840
- #
841
- # @return [Hash{Symbol=>String}, nil]
842
- optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
843
-
844
- # @!attribute pricing_group_values
845
- #
846
- # @return [Hash{Symbol=>String}, nil]
847
- optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
848
-
849
- # @!attribute product_id
850
- # If provided, the specifier will only apply to the product with the specified ID.
851
- #
852
- # @return [String, nil]
853
- optional :product_id, String
854
-
855
- # @!attribute product_tags
856
- # If provided, the specifier will only apply to products with all the specified
857
- # tags.
858
- #
859
- # @return [Array<String>, nil]
860
- optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
861
-
862
- # @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
863
- # Some parameter documentations has been truncated, see
864
- # {MetronomeSDK::Models::V1::ContractAmendParams::Commit::Specifier} for more
865
- # details.
866
- #
867
- # @param presentation_group_values [Hash{Symbol=>String}]
868
- #
869
- # @param pricing_group_values [Hash{Symbol=>String}]
870
- #
871
- # @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
872
- #
873
- # @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
874
- end
875
722
  end
876
723
 
877
724
  class Credit < MetronomeSDK::Internal::Type::BaseModel
@@ -901,6 +748,7 @@ module MetronomeSDK
901
748
  optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
902
749
 
903
750
  # @!attribute custom_fields
751
+ # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
904
752
  #
905
753
  # @return [Hash{Symbol=>String}, nil]
906
754
  optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -914,9 +762,8 @@ module MetronomeSDK
914
762
  # @!attribute hierarchy_configuration
915
763
  # Optional configuration for credit hierarchy access control
916
764
  #
917
- # @return [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration, nil]
918
- optional :hierarchy_configuration,
919
- -> { MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration }
765
+ # @return [MetronomeSDK::Models::CommitHierarchyConfiguration, nil]
766
+ optional :hierarchy_configuration, -> { MetronomeSDK::CommitHierarchyConfiguration }
920
767
 
921
768
  # @!attribute name
922
769
  # displayed on invoices
@@ -948,11 +795,8 @@ module MetronomeSDK
948
795
  # specifiers to contribute to a commit's or credit's drawdown. This field cannot
949
796
  # be used together with `applicable_product_ids` or `applicable_product_tags`.
950
797
  #
951
- # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Credit::Specifier>, nil]
952
- optional :specifiers,
953
- -> {
954
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit::Specifier]
955
- }
798
+ # @return [Array<MetronomeSDK::Models::CommitSpecifierInput>, nil]
799
+ optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifierInput] }
956
800
 
957
801
  # @!method initialize(access_schedule:, product_id:, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, specifiers: nil)
958
802
  # Some parameter documentations has been truncated, see
@@ -966,11 +810,11 @@ module MetronomeSDK
966
810
  #
967
811
  # @param applicable_product_tags [Array<String>] Which tags the credit applies to. If both applicable*product_ids and applicable*
968
812
  #
969
- # @param custom_fields [Hash{Symbol=>String}]
813
+ # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
970
814
  #
971
815
  # @param description [String] Used only in UI/API. It is not exposed to end customers.
972
816
  #
973
- # @param hierarchy_configuration [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration] Optional configuration for credit hierarchy access control
817
+ # @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
974
818
  #
975
819
  # @param name [String] displayed on invoices
976
820
  #
@@ -980,7 +824,7 @@ module MetronomeSDK
980
824
  #
981
825
  # @param rate_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::RateType]
982
826
  #
983
- # @param specifiers [Array<MetronomeSDK::Models::V1::ContractAmendParams::Credit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
827
+ # @param specifiers [Array<MetronomeSDK::Models::CommitSpecifierInput>] List of filters that determine what kind of customer usage draws down a commit o
984
828
 
985
829
  # @see MetronomeSDK::Models::V1::ContractAmendParams::Credit#access_schedule
986
830
  class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
@@ -988,9 +832,7 @@ module MetronomeSDK
988
832
  #
989
833
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem>]
990
834
  required :schedule_items,
991
- -> {
992
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem]
993
- }
835
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Credit::AccessSchedule::ScheduleItem] }
994
836
 
995
837
  # @!attribute credit_type_id
996
838
  # Defaults to USD (cents) if not passed
@@ -1032,117 +874,6 @@ module MetronomeSDK
1032
874
  end
1033
875
  end
1034
876
 
1035
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Credit#hierarchy_configuration
1036
- class HierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
1037
- # @!attribute child_access
1038
- #
1039
- # @return [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
1040
- required :child_access,
1041
- union: -> {
1042
- MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess
1043
- }
1044
-
1045
- # @!method initialize(child_access:)
1046
- # Optional configuration for credit hierarchy access control
1047
- #
1048
- # @param child_access [MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
1049
-
1050
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration#child_access
1051
- module ChildAccess
1052
- extend MetronomeSDK::Internal::Type::Union
1053
-
1054
- variant -> {
1055
- MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll
1056
- }
1057
-
1058
- variant -> {
1059
- MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone
1060
- }
1061
-
1062
- variant -> {
1063
- MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs
1064
- }
1065
-
1066
- class CommitHierarchyChildAccessAll < MetronomeSDK::Internal::Type::BaseModel
1067
- # @!attribute type
1068
- #
1069
- # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
1070
- required :type,
1071
- enum: -> {
1072
- MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type
1073
- }
1074
-
1075
- # @!method initialize(type:)
1076
- # @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll::Type]
1077
-
1078
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll#type
1079
- module Type
1080
- extend MetronomeSDK::Internal::Type::Enum
1081
-
1082
- ALL = :ALL
1083
-
1084
- # @!method self.values
1085
- # @return [Array<Symbol>]
1086
- end
1087
- end
1088
-
1089
- class CommitHierarchyChildAccessNone < MetronomeSDK::Internal::Type::BaseModel
1090
- # @!attribute type
1091
- #
1092
- # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
1093
- required :type,
1094
- enum: -> {
1095
- MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type
1096
- }
1097
-
1098
- # @!method initialize(type:)
1099
- # @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone::Type]
1100
-
1101
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone#type
1102
- module Type
1103
- extend MetronomeSDK::Internal::Type::Enum
1104
-
1105
- NONE = :NONE
1106
-
1107
- # @!method self.values
1108
- # @return [Array<Symbol>]
1109
- end
1110
- end
1111
-
1112
- class CommitHierarchyChildAccessContractIDs < MetronomeSDK::Internal::Type::BaseModel
1113
- # @!attribute contract_ids
1114
- #
1115
- # @return [Array<String>]
1116
- required :contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
1117
-
1118
- # @!attribute type
1119
- #
1120
- # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
1121
- required :type,
1122
- enum: -> {
1123
- MetronomeSDK::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type
1124
- }
1125
-
1126
- # @!method initialize(contract_ids:, type:)
1127
- # @param contract_ids [Array<String>]
1128
- # @param type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs::Type]
1129
-
1130
- # @see MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs#type
1131
- module Type
1132
- extend MetronomeSDK::Internal::Type::Enum
1133
-
1134
- CONTRACT_IDS = :CONTRACT_IDS
1135
-
1136
- # @!method self.values
1137
- # @return [Array<Symbol>]
1138
- end
1139
- end
1140
-
1141
- # @!method self.variants
1142
- # @return [Array(MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V1::ContractAmendParams::Credit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs)]
1143
- end
1144
- end
1145
-
1146
877
  # @see MetronomeSDK::Models::V1::ContractAmendParams::Credit#rate_type
1147
878
  module RateType
1148
879
  extend MetronomeSDK::Internal::Type::Enum
@@ -1153,44 +884,6 @@ module MetronomeSDK
1153
884
  # @!method self.values
1154
885
  # @return [Array<Symbol>]
1155
886
  end
1156
-
1157
- class Specifier < MetronomeSDK::Internal::Type::BaseModel
1158
- # @!attribute presentation_group_values
1159
- #
1160
- # @return [Hash{Symbol=>String}, nil]
1161
- optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
1162
-
1163
- # @!attribute pricing_group_values
1164
- #
1165
- # @return [Hash{Symbol=>String}, nil]
1166
- optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
1167
-
1168
- # @!attribute product_id
1169
- # If provided, the specifier will only apply to the product with the specified ID.
1170
- #
1171
- # @return [String, nil]
1172
- optional :product_id, String
1173
-
1174
- # @!attribute product_tags
1175
- # If provided, the specifier will only apply to products with all the specified
1176
- # tags.
1177
- #
1178
- # @return [Array<String>, nil]
1179
- optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
1180
-
1181
- # @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
1182
- # Some parameter documentations has been truncated, see
1183
- # {MetronomeSDK::Models::V1::ContractAmendParams::Credit::Specifier} for more
1184
- # details.
1185
- #
1186
- # @param presentation_group_values [Hash{Symbol=>String}]
1187
- #
1188
- # @param pricing_group_values [Hash{Symbol=>String}]
1189
- #
1190
- # @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
1191
- #
1192
- # @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
1193
- end
1194
887
  end
1195
888
 
1196
889
  class Discount < MetronomeSDK::Internal::Type::BaseModel
@@ -1206,6 +899,7 @@ module MetronomeSDK
1206
899
  required :schedule, -> { MetronomeSDK::V1::ContractAmendParams::Discount::Schedule }
1207
900
 
1208
901
  # @!attribute custom_fields
902
+ # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
1209
903
  #
1210
904
  # @return [Hash{Symbol=>String}, nil]
1211
905
  optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -1227,7 +921,7 @@ module MetronomeSDK
1227
921
  #
1228
922
  # @param schedule [MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule] Must provide either schedule_items or recurring_schedule.
1229
923
  #
1230
- # @param custom_fields [Hash{Symbol=>String}]
924
+ # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
1231
925
  #
1232
926
  # @param name [String] displayed on invoices
1233
927
  #
@@ -1241,6 +935,13 @@ module MetronomeSDK
1241
935
  # @return [String, nil]
1242
936
  optional :credit_type_id, String
1243
937
 
938
+ # @!attribute do_not_invoice
939
+ # This field is only applicable to commit invoice schedules. If true, this
940
+ # schedule will not generate an invoice.
941
+ #
942
+ # @return [Boolean, nil]
943
+ optional :do_not_invoice, MetronomeSDK::Internal::Type::Boolean
944
+
1244
945
  # @!attribute recurring_schedule
1245
946
  # Enter the unit price and quantity for the charge or instead only send the
1246
947
  # amount. If amount is sent, the unit price is assumed to be the amount and
@@ -1255,11 +956,9 @@ module MetronomeSDK
1255
956
  #
1256
957
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule::ScheduleItem>, nil]
1257
958
  optional :schedule_items,
1258
- -> {
1259
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::ScheduleItem]
1260
- }
959
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::ScheduleItem] }
1261
960
 
1262
- # @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
961
+ # @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
1263
962
  # Some parameter documentations has been truncated, see
1264
963
  # {MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule} for more
1265
964
  # details.
@@ -1268,6 +967,8 @@ module MetronomeSDK
1268
967
  #
1269
968
  # @param credit_type_id [String] Defaults to USD (cents) if not passed.
1270
969
  #
970
+ # @param do_not_invoice [Boolean] This field is only applicable to commit invoice schedules. If true, this schedul
971
+ #
1271
972
  # @param recurring_schedule [MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
1272
973
  #
1273
974
  # @param schedule_items [Array<MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
@@ -1278,9 +979,7 @@ module MetronomeSDK
1278
979
  #
1279
980
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::AmountDistribution]
1280
981
  required :amount_distribution,
1281
- enum: -> {
1282
- MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::AmountDistribution
1283
- }
982
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::AmountDistribution }
1284
983
 
1285
984
  # @!attribute ending_before
1286
985
  # RFC 3339 timestamp (exclusive).
@@ -1292,9 +991,7 @@ module MetronomeSDK
1292
991
  #
1293
992
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::Frequency]
1294
993
  required :frequency,
1295
- enum: -> {
1296
- MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::Frequency
1297
- }
994
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule::Frequency }
1298
995
 
1299
996
  # @!attribute starting_at
1300
997
  # RFC 3339 timestamp (inclusive).
@@ -1468,9 +1165,7 @@ module MetronomeSDK
1468
1165
  #
1469
1166
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Override::OverrideSpecifier>, nil]
1470
1167
  optional :override_specifiers,
1471
- -> {
1472
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier]
1473
- }
1168
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier] }
1474
1169
 
1475
1170
  # @!attribute overwrite_rate
1476
1171
  # Required for OVERWRITE type.
@@ -1507,9 +1202,7 @@ module MetronomeSDK
1507
1202
  #
1508
1203
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::Override::Tier>, nil]
1509
1204
  optional :tiers,
1510
- -> {
1511
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::Tier]
1512
- }
1205
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Override::Tier] }
1513
1206
 
1514
1207
  # @!attribute type
1515
1208
  # Overwrites are prioritized over multipliers and tiered overrides.
@@ -1552,14 +1245,12 @@ module MetronomeSDK
1552
1245
  #
1553
1246
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Override::OverrideSpecifier::BillingFrequency, nil]
1554
1247
  optional :billing_frequency,
1555
- enum: -> {
1556
- MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier::BillingFrequency
1557
- }
1248
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::Override::OverrideSpecifier::BillingFrequency }
1558
1249
 
1559
1250
  # @!attribute commit_ids
1560
1251
  # Can only be used for commit specific overrides. Must be used in conjunction with
1561
- # one of product_id, product_tags, pricing_group_values, or
1562
- # presentation_group_values. If provided, the override will only apply to the
1252
+ # one of `product_id`, `product_tags`, `pricing_group_values`, or
1253
+ # `presentation_group_values`. If provided, the override will only apply to the
1563
1254
  # specified commits. If not provided, the override will apply to all commits.
1564
1255
  #
1565
1256
  # @return [Array<String>, nil]
@@ -1594,18 +1285,18 @@ module MetronomeSDK
1594
1285
 
1595
1286
  # @!attribute recurring_commit_ids
1596
1287
  # Can only be used for commit specific overrides. Must be used in conjunction with
1597
- # one of product_id, product_tags, pricing_group_values, or
1598
- # presentation_group_values. If provided, the override will only apply to commits
1599
- # created by the specified recurring commit ids.
1288
+ # one of `product_id`, `product_tags`, `pricing_group_values`, or
1289
+ # `presentation_group_values`. If provided, the override will only apply to
1290
+ # commits created by the specified recurring commit ids.
1600
1291
  #
1601
1292
  # @return [Array<String>, nil]
1602
1293
  optional :recurring_commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
1603
1294
 
1604
1295
  # @!attribute recurring_credit_ids
1605
1296
  # Can only be used for commit specific overrides. Must be used in conjunction with
1606
- # one of product_id, product_tags, pricing_group_values, or
1607
- # presentation_group_values. If provided, the override will only apply to credits
1608
- # created by the specified recurring credit ids.
1297
+ # one of `product_id`, `product_tags`, `pricing_group_values`, or
1298
+ # `presentation_group_values`. If provided, the override will only apply to
1299
+ # credits created by the specified recurring credit ids.
1609
1300
  #
1610
1301
  # @return [Array<String>, nil]
1611
1302
  optional :recurring_credit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
@@ -1650,10 +1341,7 @@ module MetronomeSDK
1650
1341
  # @!attribute rate_type
1651
1342
  #
1652
1343
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Override::OverwriteRate::RateType]
1653
- required :rate_type,
1654
- enum: -> {
1655
- MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate::RateType
1656
- }
1344
+ required :rate_type, enum: -> { MetronomeSDK::V1::ContractAmendParams::Override::OverwriteRate::RateType }
1657
1345
 
1658
1346
  # @!attribute credit_type_id
1659
1347
  #
@@ -1802,6 +1490,7 @@ module MetronomeSDK
1802
1490
  required :unit_price, Float
1803
1491
 
1804
1492
  # @!attribute custom_fields
1493
+ # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
1805
1494
  #
1806
1495
  # @return [Hash{Symbol=>String}, nil]
1807
1496
  optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
@@ -1830,7 +1519,7 @@ module MetronomeSDK
1830
1519
  #
1831
1520
  # @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
1832
1521
  #
1833
- # @param custom_fields [Hash{Symbol=>String}]
1522
+ # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
1834
1523
  #
1835
1524
  # @param description [String]
1836
1525
  #
@@ -1841,10 +1530,7 @@ module MetronomeSDK
1841
1530
  # @!attribute reseller_type
1842
1531
  #
1843
1532
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::ResellerRoyalty::ResellerType]
1844
- required :reseller_type,
1845
- enum: -> {
1846
- MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::ResellerType
1847
- }
1533
+ required :reseller_type, enum: -> { MetronomeSDK::V1::ContractAmendParams::ResellerRoyalty::ResellerType }
1848
1534
 
1849
1535
  # @!attribute applicable_product_ids
1850
1536
  # Must provide at least one of applicable_product_ids or applicable_product_tags.
@@ -1981,6 +1667,12 @@ module MetronomeSDK
1981
1667
  # @return [MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule]
1982
1668
  required :schedule, -> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule }
1983
1669
 
1670
+ # @!attribute custom_fields
1671
+ # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
1672
+ #
1673
+ # @return [Hash{Symbol=>String}, nil]
1674
+ optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
1675
+
1984
1676
  # @!attribute name
1985
1677
  # displayed on invoices
1986
1678
  #
@@ -1993,11 +1685,13 @@ module MetronomeSDK
1993
1685
  # @return [String, nil]
1994
1686
  optional :netsuite_sales_order_id, String
1995
1687
 
1996
- # @!method initialize(product_id:, schedule:, name: nil, netsuite_sales_order_id: nil)
1688
+ # @!method initialize(product_id:, schedule:, custom_fields: nil, name: nil, netsuite_sales_order_id: nil)
1997
1689
  # @param product_id [String]
1998
1690
  #
1999
1691
  # @param schedule [MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule] Must provide either schedule_items or recurring_schedule.
2000
1692
  #
1693
+ # @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
1694
+ #
2001
1695
  # @param name [String] displayed on invoices
2002
1696
  #
2003
1697
  # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
@@ -2010,6 +1704,13 @@ module MetronomeSDK
2010
1704
  # @return [String, nil]
2011
1705
  optional :credit_type_id, String
2012
1706
 
1707
+ # @!attribute do_not_invoice
1708
+ # This field is only applicable to commit invoice schedules. If true, this
1709
+ # schedule will not generate an invoice.
1710
+ #
1711
+ # @return [Boolean, nil]
1712
+ optional :do_not_invoice, MetronomeSDK::Internal::Type::Boolean
1713
+
2013
1714
  # @!attribute recurring_schedule
2014
1715
  # Enter the unit price and quantity for the charge or instead only send the
2015
1716
  # amount. If amount is sent, the unit price is assumed to be the amount and
@@ -2017,20 +1718,16 @@ module MetronomeSDK
2017
1718
  #
2018
1719
  # @return [MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule, nil]
2019
1720
  optional :recurring_schedule,
2020
- -> {
2021
- MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule
2022
- }
1721
+ -> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule }
2023
1722
 
2024
1723
  # @!attribute schedule_items
2025
1724
  # Either provide amount or provide both unit_price and quantity.
2026
1725
  #
2027
1726
  # @return [Array<MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem>, nil]
2028
1727
  optional :schedule_items,
2029
- -> {
2030
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem]
2031
- }
1728
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem] }
2032
1729
 
2033
- # @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
1730
+ # @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
2034
1731
  # Some parameter documentations has been truncated, see
2035
1732
  # {MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule} for
2036
1733
  # more details.
@@ -2039,6 +1736,8 @@ module MetronomeSDK
2039
1736
  #
2040
1737
  # @param credit_type_id [String] Defaults to USD (cents) if not passed.
2041
1738
  #
1739
+ # @param do_not_invoice [Boolean] This field is only applicable to commit invoice schedules. If true, this schedul
1740
+ #
2042
1741
  # @param recurring_schedule [MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
2043
1742
  #
2044
1743
  # @param schedule_items [Array<MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
@@ -2049,9 +1748,7 @@ module MetronomeSDK
2049
1748
  #
2050
1749
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution]
2051
1750
  required :amount_distribution,
2052
- enum: -> {
2053
- MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution
2054
- }
1751
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::AmountDistribution }
2055
1752
 
2056
1753
  # @!attribute ending_before
2057
1754
  # RFC 3339 timestamp (exclusive).
@@ -2063,9 +1760,7 @@ module MetronomeSDK
2063
1760
  #
2064
1761
  # @return [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency]
2065
1762
  required :frequency,
2066
- enum: -> {
2067
- MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency
2068
- }
1763
+ enum: -> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule::Frequency }
2069
1764
 
2070
1765
  # @!attribute starting_at
2071
1766
  # RFC 3339 timestamp (inclusive).