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

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 (551) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +45 -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/internal/transport/pooled_net_requester.rb +3 -1
  7. data/lib/metronome_sdk/internal/type/array_of.rb +8 -0
  8. data/lib/metronome_sdk/internal/type/base_model.rb +13 -0
  9. data/lib/metronome_sdk/internal/type/boolean.rb +8 -0
  10. data/lib/metronome_sdk/internal/type/enum.rb +12 -0
  11. data/lib/metronome_sdk/internal/type/file_input.rb +7 -0
  12. data/lib/metronome_sdk/internal/type/hash_of.rb +8 -0
  13. data/lib/metronome_sdk/internal/type/union.rb +12 -0
  14. data/lib/metronome_sdk/internal/type/unknown.rb +8 -0
  15. data/lib/metronome_sdk/internal/util.rb +54 -1
  16. data/lib/metronome_sdk/internal.rb +3 -0
  17. data/lib/metronome_sdk/models/v1/alert_archive_response.rb +14 -3
  18. data/lib/metronome_sdk/models/v1/alert_create_params.rb +11 -11
  19. data/lib/metronome_sdk/models/v1/alert_create_response.rb +14 -3
  20. data/lib/metronome_sdk/models/v1/audit_log_list_params.rb +2 -2
  21. data/lib/metronome_sdk/models/v1/billable_metric_archive_params.rb +8 -2
  22. data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +14 -3
  23. data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +88 -8
  24. data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +14 -3
  25. data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +85 -6
  26. data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +85 -8
  27. data/lib/metronome_sdk/models/v1/contract_amend_params.rb +291 -143
  28. data/lib/metronome_sdk/models/v1/contract_amend_response.rb +14 -3
  29. data/lib/metronome_sdk/models/v1/contract_archive_response.rb +14 -3
  30. data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_params.rb +12 -12
  31. data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +1276 -3
  32. data/lib/metronome_sdk/models/v1/contract_create_params.rb +827 -299
  33. data/lib/metronome_sdk/models/v1/contract_create_response.rb +14 -3
  34. data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +1644 -8
  35. data/lib/metronome_sdk/models/v1/contract_list_response.rb +10879 -55
  36. data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb +33 -5
  37. data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +317 -10
  38. data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +10908 -55
  39. data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rb +34 -0
  40. data/lib/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rb +81 -0
  41. data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rb +4 -4
  42. data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +1276 -3
  43. data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +14 -3
  44. data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +14 -3
  45. data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +99 -8
  46. data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +14 -3
  47. data/lib/metronome_sdk/models/v1/contracts/product_list_params.rb +4 -4
  48. data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +561 -12
  49. data/lib/metronome_sdk/models/v1/contracts/product_retrieve_params.rb +8 -2
  50. data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +559 -14
  51. data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +97 -6
  52. data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +14 -3
  53. data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_params.rb +8 -2
  54. data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +14 -3
  55. data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb +4 -4
  56. data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +14 -3
  57. data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +42 -6
  58. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rb +8 -2
  59. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb +33 -5
  60. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +181 -7
  61. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +42 -6
  62. data/lib/metronome_sdk/models/v1/contracts/rate_card_update_params.rb +2 -2
  63. data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +14 -3
  64. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +14 -3
  65. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb +2 -2
  66. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +14 -3
  67. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +86 -20
  68. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +16 -3
  69. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +76 -14
  70. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +61 -9
  71. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rb +33 -5
  72. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +180 -7
  73. data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +85 -21
  74. data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +14 -3
  75. data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +14 -3
  76. data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +153 -11
  77. data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +175 -14
  78. data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +14 -3
  79. data/lib/metronome_sdk/models/v1/custom_field_add_key_params.rb +2 -2
  80. data/lib/metronome_sdk/models/v1/custom_field_delete_values_params.rb +2 -2
  81. data/lib/metronome_sdk/models/v1/custom_field_list_keys_params.rb +2 -2
  82. data/lib/metronome_sdk/models/v1/custom_field_remove_key_params.rb +2 -2
  83. data/lib/metronome_sdk/models/v1/custom_field_set_values_params.rb +2 -2
  84. data/lib/metronome_sdk/models/v1/customer_archive_params.rb +8 -2
  85. data/lib/metronome_sdk/models/v1/customer_archive_response.rb +14 -3
  86. data/lib/metronome_sdk/models/v1/customer_create_params.rb +20 -20
  87. data/lib/metronome_sdk/models/v1/customer_create_response.rb +50 -3
  88. data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +86 -6
  89. data/lib/metronome_sdk/models/v1/{customer_detail.rb → customer_list_response.rb} +15 -14
  90. data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +126 -3
  91. data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +50 -3
  92. data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb +2 -2
  93. data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +276 -5
  94. data/lib/metronome_sdk/models/v1/customers/alert_retrieve_params.rb +2 -2
  95. data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +279 -3
  96. data/lib/metronome_sdk/models/v1/customers/billing_config_create_params.rb +6 -6
  97. data/lib/metronome_sdk/models/v1/customers/billing_config_delete_params.rb +2 -2
  98. data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rb +2 -2
  99. data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +78 -26
  100. data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +14 -3
  101. data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +1047 -3
  102. data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +14 -3
  103. data/lib/metronome_sdk/models/v1/customers/credit_create_params.rb +59 -7
  104. data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +14 -3
  105. data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +593 -3
  106. data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +14 -3
  107. data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rb +4 -4
  108. data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rb +1271 -2
  109. data/lib/metronome_sdk/models/v1/customers/invoice_list_params.rb +2 -2
  110. data/lib/metronome_sdk/models/v1/customers/{invoice.rb → invoice_list_response.rb} +303 -118
  111. data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +1276 -3
  112. data/lib/metronome_sdk/models/v1/customers/plan_add_params.rb +16 -15
  113. data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +14 -3
  114. data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +21 -3
  115. data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +13 -13
  116. data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +286 -3
  117. data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +20 -3
  118. data/lib/metronome_sdk/models/v1/plan_list_customers_params.rb +2 -2
  119. data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +128 -3
  120. data/lib/metronome_sdk/models/v1/usage_ingest_params.rb +2 -2
  121. data/lib/metronome_sdk/models/v1/usage_list_params.rb +9 -8
  122. data/lib/metronome_sdk/models/v1/usage_list_with_groups_params.rb +5 -5
  123. data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +69 -17
  124. data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +14 -3
  125. data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +61 -9
  126. data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +14 -3
  127. data/lib/metronome_sdk/models/v2/contract_edit_params.rb +1147 -377
  128. data/lib/metronome_sdk/models/v2/contract_edit_response.rb +14 -3
  129. data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +2212 -119
  130. data/lib/metronome_sdk/models/v2/contract_list_response.rb +1233 -202
  131. data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +1235 -201
  132. data/lib/metronome_sdk/models.rb +28 -49
  133. data/lib/metronome_sdk/resources/v1/alerts.rb +3 -3
  134. data/lib/metronome_sdk/resources/v1/audit_logs.rb +1 -1
  135. data/lib/metronome_sdk/resources/v1/billable_metrics.rb +3 -3
  136. data/lib/metronome_sdk/resources/v1/contracts/products.rb +9 -6
  137. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rb +1 -1
  138. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +8 -6
  139. data/lib/metronome_sdk/resources/v1/contracts/rate_cards.rb +4 -4
  140. data/lib/metronome_sdk/resources/v1/contracts.rb +55 -28
  141. data/lib/metronome_sdk/resources/v1/credit_grants.rb +3 -3
  142. data/lib/metronome_sdk/resources/v1/custom_fields.rb +5 -5
  143. data/lib/metronome_sdk/resources/v1/customers/alerts.rb +2 -2
  144. data/lib/metronome_sdk/resources/v1/customers/billing_config.rb +5 -5
  145. data/lib/metronome_sdk/resources/v1/customers/commits.rb +7 -5
  146. data/lib/metronome_sdk/resources/v1/customers/credits.rb +5 -3
  147. data/lib/metronome_sdk/resources/v1/customers/invoices.rb +5 -5
  148. data/lib/metronome_sdk/resources/v1/customers/plans.rb +3 -3
  149. data/lib/metronome_sdk/resources/v1/customers.rb +6 -5
  150. data/lib/metronome_sdk/resources/v1/dashboards.rb +4 -4
  151. data/lib/metronome_sdk/resources/v1/plans.rb +1 -1
  152. data/lib/metronome_sdk/resources/v1/usage.rb +5 -5
  153. data/lib/metronome_sdk/resources/v2/contracts.rb +39 -27
  154. data/lib/metronome_sdk/version.rb +1 -1
  155. data/lib/metronome_sdk.rb +7 -28
  156. data/rbi/metronome_sdk/internal/transport/pooled_net_requester.rbi +5 -1
  157. data/rbi/metronome_sdk/internal/type/array_of.rbi +6 -0
  158. data/rbi/metronome_sdk/internal/type/base_model.rbi +5 -0
  159. data/rbi/metronome_sdk/internal/type/boolean.rbi +6 -0
  160. data/rbi/metronome_sdk/internal/type/enum.rbi +5 -0
  161. data/rbi/metronome_sdk/internal/type/file_input.rbi +5 -0
  162. data/rbi/metronome_sdk/internal/type/hash_of.rbi +6 -0
  163. data/rbi/metronome_sdk/internal/type/union.rbi +5 -0
  164. data/rbi/metronome_sdk/internal/type/unknown.rbi +6 -0
  165. data/rbi/metronome_sdk/internal/util.rbi +34 -0
  166. data/rbi/metronome_sdk/internal.rbi +5 -0
  167. data/rbi/metronome_sdk/models/v1/alert_archive_response.rbi +37 -4
  168. data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +4 -4
  169. data/rbi/metronome_sdk/models/v1/alert_create_response.rbi +37 -4
  170. data/rbi/metronome_sdk/models/v1/billable_metric_archive_params.rbi +12 -6
  171. data/rbi/metronome_sdk/models/v1/billable_metric_archive_response.rbi +44 -4
  172. data/rbi/metronome_sdk/models/v1/billable_metric_create_params.rbi +177 -8
  173. data/rbi/metronome_sdk/models/v1/billable_metric_create_response.rbi +43 -4
  174. data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +177 -8
  175. data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +175 -8
  176. data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +341 -7
  177. data/rbi/metronome_sdk/models/v1/contract_amend_response.rbi +37 -4
  178. data/rbi/metronome_sdk/models/v1/contract_archive_response.rbi +39 -4
  179. data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbi +2595 -3
  180. data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1230 -74
  181. data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +37 -4
  182. data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +3375 -5
  183. data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +23626 -686
  184. data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbi +72 -0
  185. data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +698 -12
  186. data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +23626 -686
  187. data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbi +58 -0
  188. data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbi +212 -0
  189. data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbi +2595 -3
  190. data/rbi/metronome_sdk/models/v1/contract_update_end_date_response.rbi +44 -4
  191. data/rbi/metronome_sdk/models/v1/contracts/product_archive_response.rbi +44 -4
  192. data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +209 -8
  193. data/rbi/metronome_sdk/models/v1/contracts/product_create_response.rbi +44 -4
  194. data/rbi/metronome_sdk/models/v1/contracts/product_list_params.rbi +3 -3
  195. data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +1143 -76
  196. data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_params.rbi +9 -3
  197. data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +1137 -76
  198. data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +209 -8
  199. data/rbi/metronome_sdk/models/v1/contracts/product_update_response.rbi +44 -4
  200. data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbi +9 -3
  201. data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbi +44 -4
  202. data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_response.rbi +44 -4
  203. data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +74 -8
  204. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbi +9 -3
  205. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbi +72 -0
  206. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +410 -8
  207. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +74 -8
  208. data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_response.rbi +44 -4
  209. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbi +44 -4
  210. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbi +44 -4
  211. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +180 -8
  212. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbi +45 -4
  213. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +180 -8
  214. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +149 -12
  215. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi +72 -0
  216. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +410 -8
  217. data/rbi/metronome_sdk/models/v1/credit_grant_create_params.rbi +166 -8
  218. data/rbi/metronome_sdk/models/v1/credit_grant_create_response.rbi +41 -4
  219. data/rbi/metronome_sdk/models/v1/credit_grant_edit_response.rbi +39 -4
  220. data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +231 -10
  221. data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +281 -14
  222. data/rbi/metronome_sdk/models/v1/credit_grant_void_response.rbi +39 -4
  223. data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi +12 -6
  224. data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi +39 -4
  225. data/rbi/metronome_sdk/models/v1/customer_create_response.rbi +84 -6
  226. data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +177 -8
  227. data/rbi/metronome_sdk/models/v1/{customer_detail.rbi → customer_list_response.rbi} +26 -19
  228. data/rbi/metronome_sdk/models/v1/customer_retrieve_response.rbi +255 -6
  229. data/rbi/metronome_sdk/models/v1/customer_set_name_response.rbi +86 -6
  230. data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +623 -3
  231. data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_response.rbi +622 -4
  232. data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +109 -0
  233. data/rbi/metronome_sdk/models/v1/customers/commit_create_response.rbi +44 -4
  234. data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +2164 -3
  235. data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbi +44 -4
  236. data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi +109 -0
  237. data/rbi/metronome_sdk/models/v1/customers/credit_create_response.rbi +44 -4
  238. data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +1224 -3
  239. data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbi +44 -4
  240. data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbi +2561 -4
  241. data/rbi/metronome_sdk/models/v1/customers/{invoice.rbi → invoice_list_response.rbi} +589 -182
  242. data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbi +2612 -6
  243. data/rbi/metronome_sdk/models/v1/customers/plan_add_response.rbi +41 -4
  244. data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +39 -4
  245. data/rbi/metronome_sdk/models/v1/plan_get_details_response.rbi +560 -6
  246. data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +37 -4
  247. data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +248 -4
  248. data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +105 -0
  249. data/rbi/metronome_sdk/models/v2/contract_edit_commit_response.rbi +41 -4
  250. data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +105 -0
  251. data/rbi/metronome_sdk/models/v2/contract_edit_credit_response.rbi +41 -4
  252. data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +1980 -285
  253. data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +37 -4
  254. data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +7604 -2906
  255. data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +3855 -1534
  256. data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +3855 -1534
  257. data/rbi/metronome_sdk/models.rbi +0 -32
  258. data/rbi/metronome_sdk/resources/v1/alerts.rbi +2 -2
  259. data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +6 -2
  260. data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +6 -5
  261. data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +9 -1
  262. data/rbi/metronome_sdk/resources/v1/contracts.rbi +30 -1
  263. data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +9 -0
  264. data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +9 -0
  265. data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +1 -1
  266. data/rbi/metronome_sdk/resources/v1/customers.rbi +5 -2
  267. data/rbi/metronome_sdk/resources/v2/contracts.rbi +49 -1
  268. data/sig/metronome_sdk/internal/transport/pooled_net_requester.rbs +2 -0
  269. data/sig/metronome_sdk/internal/type/array_of.rbs +3 -0
  270. data/sig/metronome_sdk/internal/type/base_model.rbs +2 -0
  271. data/sig/metronome_sdk/internal/type/boolean.rbs +3 -0
  272. data/sig/metronome_sdk/internal/type/enum.rbs +2 -0
  273. data/sig/metronome_sdk/internal/type/file_input.rbs +2 -0
  274. data/sig/metronome_sdk/internal/type/hash_of.rbs +3 -0
  275. data/sig/metronome_sdk/internal/type/union.rbs +2 -0
  276. data/sig/metronome_sdk/internal/type/unknown.rbs +3 -0
  277. data/sig/metronome_sdk/internal/util.rbs +12 -0
  278. data/sig/metronome_sdk/internal.rbs +2 -0
  279. data/sig/metronome_sdk/models/v1/alert_archive_params.rbs +6 -0
  280. data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +20 -3
  281. data/sig/metronome_sdk/models/v1/alert_create_params.rbs +29 -4
  282. data/sig/metronome_sdk/models/v1/alert_create_response.rbs +20 -3
  283. data/sig/metronome_sdk/models/v1/audit_log_list_params.rbs +11 -0
  284. data/sig/metronome_sdk/models/v1/audit_log_list_response.rbs +16 -0
  285. data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +13 -3
  286. data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +20 -3
  287. data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +83 -10
  288. data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +20 -3
  289. data/sig/metronome_sdk/models/v1/billable_metric_list_params.rbs +7 -0
  290. data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +84 -10
  291. data/sig/metronome_sdk/models/v1/billable_metric_retrieve_params.rbs +5 -0
  292. data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +88 -10
  293. data/sig/metronome_sdk/models/v1/contract_add_manual_balance_entry_params.rbs +11 -0
  294. data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +456 -79
  295. data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +20 -3
  296. data/sig/metronome_sdk/models/v1/contract_archive_params.rbs +7 -0
  297. data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +20 -3
  298. data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_params.rbs +47 -12
  299. data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +1292 -3
  300. data/sig/metronome_sdk/models/v1/contract_create_params.rbs +1087 -198
  301. data/sig/metronome_sdk/models/v1/contract_create_response.rbs +20 -3
  302. data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +14 -0
  303. data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +1647 -1
  304. data/sig/metronome_sdk/models/v1/contract_list_params.rbs +10 -0
  305. data/sig/metronome_sdk/models/v1/contract_list_response.rbs +10802 -104
  306. data/sig/metronome_sdk/models/v1/contract_retrieve_params.rbs +8 -0
  307. data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rbs +39 -0
  308. data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +316 -12
  309. data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +10802 -104
  310. data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbs +34 -0
  311. data/sig/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbs +101 -0
  312. data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_params.rbs +21 -0
  313. data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +1292 -3
  314. data/sig/metronome_sdk/models/v1/contract_set_usage_filter_params.rbs +9 -0
  315. data/sig/metronome_sdk/models/v1/contract_update_end_date_params.rbs +8 -0
  316. data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +20 -3
  317. data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_params.rbs +7 -0
  318. data/sig/metronome_sdk/models/v1/contracts/named_schedule_retrieve_response.rbs +10 -0
  319. data/sig/metronome_sdk/models/v1/contracts/named_schedule_update_params.rbs +9 -0
  320. data/sig/metronome_sdk/models/v1/contracts/product_archive_params.rbs +5 -0
  321. data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +22 -3
  322. data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +98 -6
  323. data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +22 -3
  324. data/sig/metronome_sdk/models/v1/contracts/product_list_params.rbs +7 -0
  325. data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +491 -12
  326. data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +13 -3
  327. data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +495 -12
  328. data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +99 -6
  329. data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +22 -3
  330. data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +13 -3
  331. data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +22 -3
  332. data/sig/metronome_sdk/models/v1/contracts/rate_card_create_params.rbs +21 -0
  333. data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +22 -3
  334. data/sig/metronome_sdk/models/v1/contracts/rate_card_list_params.rbs +7 -0
  335. data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +55 -8
  336. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +13 -3
  337. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbs +38 -0
  338. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +188 -8
  339. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +59 -8
  340. data/sig/metronome_sdk/models/v1/contracts/rate_card_update_params.rbs +14 -0
  341. data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +22 -3
  342. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_params.rbs +8 -0
  343. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_retrieve_response.rbs +10 -0
  344. data/sig/metronome_sdk/models/v1/contracts/rate_cards/named_schedule_update_params.rbs +10 -0
  345. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_params.rbs +6 -0
  346. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +22 -3
  347. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rbs +8 -0
  348. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +22 -3
  349. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +97 -18
  350. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +22 -3
  351. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +89 -14
  352. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +78 -15
  353. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbs +38 -0
  354. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +183 -8
  355. data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +98 -6
  356. data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +20 -3
  357. data/sig/metronome_sdk/models/v1/credit_grant_edit_params.rbs +8 -0
  358. data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +20 -3
  359. data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +9 -0
  360. data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +145 -9
  361. data/sig/metronome_sdk/models/v1/credit_grant_list_params.rbs +11 -0
  362. data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +174 -12
  363. data/sig/metronome_sdk/models/v1/credit_grant_void_params.rbs +7 -0
  364. data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +20 -3
  365. data/sig/metronome_sdk/models/v1/custom_field_add_key_params.rbs +7 -0
  366. data/sig/metronome_sdk/models/v1/custom_field_delete_values_params.rbs +7 -0
  367. data/sig/metronome_sdk/models/v1/custom_field_list_keys_params.rbs +12 -6
  368. data/sig/metronome_sdk/models/v1/custom_field_list_keys_response.rbs +11 -0
  369. data/sig/metronome_sdk/models/v1/custom_field_remove_key_params.rbs +6 -0
  370. data/sig/metronome_sdk/models/v1/custom_field_set_values_params.rbs +7 -0
  371. data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +13 -3
  372. data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +20 -3
  373. data/sig/metronome_sdk/models/v1/customer_create_params.rbs +52 -26
  374. data/sig/metronome_sdk/models/v1/customer_create_response.rbs +49 -3
  375. data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_params.rbs +9 -0
  376. data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +88 -10
  377. data/sig/metronome_sdk/models/v1/customer_list_costs_params.rbs +9 -0
  378. data/sig/metronome_sdk/models/v1/customer_list_costs_response.rbs +19 -0
  379. data/sig/metronome_sdk/models/v1/customer_list_params.rbs +10 -0
  380. data/sig/metronome_sdk/models/v1/customer_list_response.rbs +109 -0
  381. data/sig/metronome_sdk/models/v1/customer_retrieve_params.rbs +5 -0
  382. data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +113 -3
  383. data/sig/metronome_sdk/models/v1/customer_set_ingest_aliases_params.rbs +6 -0
  384. data/sig/metronome_sdk/models/v1/customer_set_name_params.rbs +6 -0
  385. data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +49 -3
  386. data/sig/metronome_sdk/models/v1/customer_update_config_params.rbs +7 -0
  387. data/sig/metronome_sdk/models/v1/customers/alert_list_params.rbs +13 -6
  388. data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +247 -3
  389. data/sig/metronome_sdk/models/v1/customers/alert_reset_params.rbs +6 -0
  390. data/sig/metronome_sdk/models/v1/customers/alert_retrieve_params.rbs +7 -0
  391. data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +248 -3
  392. data/sig/metronome_sdk/models/v1/customers/billing_config_create_params.rbs +10 -0
  393. data/sig/metronome_sdk/models/v1/customers/billing_config_delete_params.rbs +6 -0
  394. data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_params.rbs +6 -0
  395. data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +16 -0
  396. data/sig/metronome_sdk/models/v1/customers/commit_create_params.rbs +116 -8
  397. data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +22 -3
  398. data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +14 -0
  399. data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +1061 -3
  400. data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbs +8 -0
  401. data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +22 -3
  402. data/sig/metronome_sdk/models/v1/customers/credit_create_params.rbs +82 -0
  403. data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +22 -3
  404. data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +14 -0
  405. data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +600 -3
  406. data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_params.rbs +7 -0
  407. data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +22 -3
  408. data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_params.rbs +11 -0
  409. data/sig/metronome_sdk/models/v1/customers/invoice_add_charge_response.rbs +2 -0
  410. data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_params.rbs +14 -0
  411. data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +1282 -7
  412. data/sig/metronome_sdk/models/v1/customers/invoice_list_params.rbs +13 -0
  413. data/sig/metronome_sdk/models/v1/customers/invoice_list_response.rbs +1290 -0
  414. data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_params.rbs +7 -0
  415. data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +1295 -3
  416. data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_params.rbs +7 -0
  417. data/sig/metronome_sdk/models/v1/customers/named_schedule_retrieve_response.rbs +10 -0
  418. data/sig/metronome_sdk/models/v1/customers/named_schedule_update_params.rbs +9 -0
  419. data/sig/metronome_sdk/models/v1/customers/plan_add_params.rbs +38 -4
  420. data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +20 -3
  421. data/sig/metronome_sdk/models/v1/customers/plan_end_params.rbs +9 -0
  422. data/sig/metronome_sdk/models/v1/customers/plan_end_response.rbs +2 -0
  423. data/sig/metronome_sdk/models/v1/customers/plan_list_params.rbs +7 -0
  424. data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_params.rbs +8 -0
  425. data/sig/metronome_sdk/models/v1/customers/plan_list_price_adjustments_response.rbs +14 -0
  426. data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +38 -3
  427. data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +28 -6
  428. data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_response.rbs +6 -0
  429. data/sig/metronome_sdk/models/v1/invoice_regenerate_params.rbs +5 -0
  430. data/sig/metronome_sdk/models/v1/invoice_regenerate_response.rbs +6 -0
  431. data/sig/metronome_sdk/models/v1/invoice_void_params.rbs +5 -0
  432. data/sig/metronome_sdk/models/v1/invoice_void_response.rbs +6 -0
  433. data/sig/metronome_sdk/models/v1/plan_get_details_params.rbs +5 -0
  434. data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +268 -3
  435. data/sig/metronome_sdk/models/v1/plan_list_charges_params.rbs +7 -0
  436. data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +43 -3
  437. data/sig/metronome_sdk/models/v1/plan_list_customers_params.rbs +8 -0
  438. data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +121 -3
  439. data/sig/metronome_sdk/models/v1/plan_list_params.rbs +6 -0
  440. data/sig/metronome_sdk/models/v1/plan_list_response.rbs +7 -0
  441. data/sig/metronome_sdk/models/v1/pricing_unit_list_params.rbs +6 -0
  442. data/sig/metronome_sdk/models/v1/pricing_unit_list_response.rbs +2 -0
  443. data/sig/metronome_sdk/models/v1/service_list_params.rbs +2 -0
  444. data/sig/metronome_sdk/models/v1/service_list_response.rbs +10 -0
  445. data/sig/metronome_sdk/models/v1/usage_ingest_params.rbs +13 -0
  446. data/sig/metronome_sdk/models/v1/usage_list_params.rbs +17 -0
  447. data/sig/metronome_sdk/models/v1/usage_list_response.rbs +15 -0
  448. data/sig/metronome_sdk/models/v1/usage_list_with_groups_params.rbs +15 -0
  449. data/sig/metronome_sdk/models/v1/usage_list_with_groups_response.rbs +8 -0
  450. data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +110 -1
  451. data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +20 -3
  452. data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +85 -1
  453. data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +20 -3
  454. data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +1476 -212
  455. data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +20 -3
  456. data/sig/metronome_sdk/models/v2/contract_get_edit_history_params.rbs +6 -0
  457. data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +2855 -442
  458. data/sig/metronome_sdk/models/v2/contract_list_params.rbs +10 -0
  459. data/sig/metronome_sdk/models/v2/contract_list_response.rbs +1743 -194
  460. data/sig/metronome_sdk/models/v2/contract_retrieve_params.rbs +9 -0
  461. data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +1743 -194
  462. data/sig/metronome_sdk/models.rbs +0 -32
  463. data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +2 -2
  464. data/sig/metronome_sdk/resources/v1/contracts/products.rbs +4 -4
  465. data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +2 -1
  466. data/sig/metronome_sdk/resources/v1/contracts.rbs +9 -1
  467. data/sig/metronome_sdk/resources/v1/custom_fields.rbs +1 -1
  468. data/sig/metronome_sdk/resources/v1/customers/alerts.rbs +1 -1
  469. data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
  470. data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -0
  471. data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -1
  472. data/sig/metronome_sdk/resources/v1/customers.rbs +1 -1
  473. data/sig/metronome_sdk/resources/v2/contracts.rbs +7 -1
  474. metadata +14 -83
  475. data/lib/metronome_sdk/models/base_usage_filter.rb +0 -27
  476. data/lib/metronome_sdk/models/commit.rb +0 -867
  477. data/lib/metronome_sdk/models/contract_without_amendments.rb +0 -1437
  478. data/lib/metronome_sdk/models/credit.rb +0 -484
  479. data/lib/metronome_sdk/models/credit_type_data.rb +0 -21
  480. data/lib/metronome_sdk/models/discount.rb +0 -68
  481. data/lib/metronome_sdk/models/event_type_filter.rb +0 -33
  482. data/lib/metronome_sdk/models/id.rb +0 -15
  483. data/lib/metronome_sdk/models/override.rb +0 -362
  484. data/lib/metronome_sdk/models/pro_service.rb +0 -73
  485. data/lib/metronome_sdk/models/property_filter.rb +0 -52
  486. data/lib/metronome_sdk/models/rate.rb +0 -101
  487. data/lib/metronome_sdk/models/schedule_duration.rb +0 -50
  488. data/lib/metronome_sdk/models/schedule_point_in_time.rb +0 -62
  489. data/lib/metronome_sdk/models/scheduled_charge.rb +0 -76
  490. data/lib/metronome_sdk/models/tier.rb +0 -21
  491. data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +0 -148
  492. data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +0 -57
  493. data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +0 -45
  494. data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +0 -69
  495. data/lib/metronome_sdk/models/v1/customer.rb +0 -53
  496. data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +0 -270
  497. data/lib/metronome_sdk/models/v1/plan_detail.rb +0 -200
  498. data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +0 -38
  499. data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +0 -38
  500. data/rbi/metronome_sdk/models/base_usage_filter.rbi +0 -46
  501. data/rbi/metronome_sdk/models/commit.rbi +0 -1625
  502. data/rbi/metronome_sdk/models/contract_without_amendments.rbi +0 -2939
  503. data/rbi/metronome_sdk/models/credit.rbi +0 -879
  504. data/rbi/metronome_sdk/models/credit_type_data.rbi +0 -26
  505. data/rbi/metronome_sdk/models/discount.rbi +0 -106
  506. data/rbi/metronome_sdk/models/event_type_filter.rbi +0 -57
  507. data/rbi/metronome_sdk/models/id.rbi +0 -23
  508. data/rbi/metronome_sdk/models/override.rbi +0 -609
  509. data/rbi/metronome_sdk/models/pro_service.rbi +0 -98
  510. data/rbi/metronome_sdk/models/property_filter.rbi +0 -88
  511. data/rbi/metronome_sdk/models/rate.rbi +0 -155
  512. data/rbi/metronome_sdk/models/schedule_duration.rbi +0 -89
  513. data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +0 -121
  514. data/rbi/metronome_sdk/models/scheduled_charge.rbi +0 -119
  515. data/rbi/metronome_sdk/models/tier.rbi +0 -29
  516. data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +0 -237
  517. data/rbi/metronome_sdk/models/v1/contracts/quantity_conversion.rbi +0 -111
  518. data/rbi/metronome_sdk/models/v1/contracts/quantity_rounding.rbi +0 -94
  519. data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi +0 -90
  520. data/rbi/metronome_sdk/models/v1/customer.rbi +0 -74
  521. data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +0 -572
  522. data/rbi/metronome_sdk/models/v1/plan_detail.rbi +0 -349
  523. data/rbi/metronome_sdk/models/v1/rollover_amount_max_amount.rbi +0 -79
  524. data/rbi/metronome_sdk/models/v1/rollover_amount_max_percentage.rbi +0 -80
  525. data/sig/metronome_sdk/models/base_usage_filter.rbs +0 -22
  526. data/sig/metronome_sdk/models/commit.rbs +0 -714
  527. data/sig/metronome_sdk/models/contract_without_amendments.rbs +0 -1072
  528. data/sig/metronome_sdk/models/credit.rbs +0 -397
  529. data/sig/metronome_sdk/models/credit_type_data.rbs +0 -13
  530. data/sig/metronome_sdk/models/discount.rbs +0 -52
  531. data/sig/metronome_sdk/models/event_type_filter.rbs +0 -21
  532. data/sig/metronome_sdk/models/id.rbs +0 -11
  533. data/sig/metronome_sdk/models/override.rbs +0 -329
  534. data/sig/metronome_sdk/models/pro_service.rbs +0 -50
  535. data/sig/metronome_sdk/models/property_filter.rbs +0 -34
  536. data/sig/metronome_sdk/models/rate.rbs +0 -82
  537. data/sig/metronome_sdk/models/schedule_duration.rbs +0 -44
  538. data/sig/metronome_sdk/models/schedule_point_in_time.rbs +0 -61
  539. data/sig/metronome_sdk/models/scheduled_charge.rbs +0 -58
  540. data/sig/metronome_sdk/models/tier.rbs +0 -15
  541. data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +0 -102
  542. data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +0 -41
  543. data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +0 -36
  544. data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +0 -42
  545. data/sig/metronome_sdk/models/v1/customer.rbs +0 -36
  546. data/sig/metronome_sdk/models/v1/customer_detail.rbs +0 -90
  547. data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +0 -205
  548. data/sig/metronome_sdk/models/v1/customers/invoice.rbs +0 -977
  549. data/sig/metronome_sdk/models/v1/plan_detail.rbs +0 -165
  550. data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +0 -29
  551. data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +0 -32
@@ -1,1437 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module MetronomeSDK
4
- module Models
5
- class ContractWithoutAmendments < MetronomeSDK::Internal::Type::BaseModel
6
- # @!attribute commits
7
- #
8
- # @return [Array<MetronomeSDK::Commit>]
9
- required :commits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Commit] }
10
-
11
- # @!attribute created_at
12
- #
13
- # @return [Time]
14
- required :created_at, Time
15
-
16
- # @!attribute created_by
17
- #
18
- # @return [String]
19
- required :created_by, String
20
-
21
- # @!attribute overrides
22
- #
23
- # @return [Array<MetronomeSDK::Override>]
24
- required :overrides, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override] }
25
-
26
- # @!attribute scheduled_charges
27
- #
28
- # @return [Array<MetronomeSDK::ScheduledCharge>]
29
- required :scheduled_charges, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ScheduledCharge] }
30
-
31
- # @!attribute starting_at
32
- #
33
- # @return [Time]
34
- required :starting_at, Time
35
-
36
- # @!attribute transitions
37
- #
38
- # @return [Array<MetronomeSDK::ContractWithoutAmendments::Transition>]
39
- required :transitions,
40
- -> {
41
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractWithoutAmendments::Transition]
42
- }
43
-
44
- # @!attribute usage_statement_schedule
45
- #
46
- # @return [MetronomeSDK::ContractWithoutAmendments::UsageStatementSchedule]
47
- required :usage_statement_schedule,
48
- -> {
49
- MetronomeSDK::ContractWithoutAmendments::UsageStatementSchedule
50
- }
51
-
52
- # @!attribute credits
53
- #
54
- # @return [Array<MetronomeSDK::Credit>, nil]
55
- optional :credits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Credit] }
56
-
57
- # @!attribute discounts
58
- # This field's availability is dependent on your client's configuration.
59
- #
60
- # @return [Array<MetronomeSDK::Discount>, nil]
61
- optional :discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Discount] }
62
-
63
- # @!attribute ending_before
64
- #
65
- # @return [Time, nil]
66
- optional :ending_before, Time
67
-
68
- # @!attribute name
69
- #
70
- # @return [String, nil]
71
- optional :name, String
72
-
73
- # @!attribute net_payment_terms_days
74
- #
75
- # @return [Float, nil]
76
- optional :net_payment_terms_days, Float
77
-
78
- # @!attribute netsuite_sales_order_id
79
- # This field's availability is dependent on your client's configuration.
80
- #
81
- # @return [String, nil]
82
- optional :netsuite_sales_order_id, String
83
-
84
- # @!attribute prepaid_balance_threshold_configuration
85
- #
86
- # @return [MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration, nil]
87
- optional :prepaid_balance_threshold_configuration,
88
- -> { MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration }
89
-
90
- # @!attribute professional_services
91
- # This field's availability is dependent on your client's configuration.
92
- #
93
- # @return [Array<MetronomeSDK::ProService>, nil]
94
- optional :professional_services, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ProService] }
95
-
96
- # @!attribute rate_card_id
97
- #
98
- # @return [String, nil]
99
- optional :rate_card_id, String
100
-
101
- # @!attribute recurring_commits
102
- #
103
- # @return [Array<MetronomeSDK::ContractWithoutAmendments::RecurringCommit>, nil]
104
- optional :recurring_commits,
105
- -> {
106
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractWithoutAmendments::RecurringCommit]
107
- }
108
-
109
- # @!attribute recurring_credits
110
- #
111
- # @return [Array<MetronomeSDK::ContractWithoutAmendments::RecurringCredit>, nil]
112
- optional :recurring_credits,
113
- -> {
114
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractWithoutAmendments::RecurringCredit]
115
- }
116
-
117
- # @!attribute reseller_royalties
118
- # This field's availability is dependent on your client's configuration.
119
- #
120
- # @return [Array<MetronomeSDK::ContractWithoutAmendments::ResellerRoyalty>, nil]
121
- optional :reseller_royalties,
122
- -> {
123
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractWithoutAmendments::ResellerRoyalty]
124
- }
125
-
126
- # @!attribute salesforce_opportunity_id
127
- # This field's availability is dependent on your client's configuration.
128
- #
129
- # @return [String, nil]
130
- optional :salesforce_opportunity_id, String
131
-
132
- # @!attribute scheduled_charges_on_usage_invoices
133
- # Determines which scheduled and commit charges to consolidate onto the Contract's
134
- # usage invoice. The charge's `timestamp` must match the usage invoice's
135
- # `ending_before` date for consolidation to occur. This field cannot be modified
136
- # after a Contract has been created. If this field is omitted, charges will appear
137
- # on a separate invoice from usage charges.
138
- #
139
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::ScheduledChargesOnUsageInvoices, nil]
140
- optional :scheduled_charges_on_usage_invoices,
141
- enum: -> { MetronomeSDK::ContractWithoutAmendments::ScheduledChargesOnUsageInvoices }
142
-
143
- # @!attribute spend_threshold_configuration
144
- #
145
- # @return [MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration, nil]
146
- optional :spend_threshold_configuration,
147
- -> { MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration }
148
-
149
- # @!attribute total_contract_value
150
- # This field's availability is dependent on your client's configuration.
151
- #
152
- # @return [Float, nil]
153
- optional :total_contract_value, Float
154
-
155
- # @!attribute usage_filter
156
- #
157
- # @return [MetronomeSDK::ContractWithoutAmendments::UsageFilter, nil]
158
- optional :usage_filter, -> { MetronomeSDK::ContractWithoutAmendments::UsageFilter }
159
-
160
- # @!method initialize(commits:, created_at:, created_by:, overrides:, scheduled_charges:, starting_at:, transitions:, usage_statement_schedule:, credits: nil, discounts: nil, ending_before: nil, name: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, prepaid_balance_threshold_configuration: nil, professional_services: nil, rate_card_id: nil, recurring_commits: nil, recurring_credits: nil, reseller_royalties: nil, salesforce_opportunity_id: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, total_contract_value: nil, usage_filter: nil)
161
- # Some parameter documentations has been truncated, see
162
- # {MetronomeSDK::ContractWithoutAmendments} for more details.
163
- #
164
- # @param commits [Array<MetronomeSDK::Commit>]
165
- #
166
- # @param created_at [Time]
167
- #
168
- # @param created_by [String]
169
- #
170
- # @param overrides [Array<MetronomeSDK::Override>]
171
- #
172
- # @param scheduled_charges [Array<MetronomeSDK::ScheduledCharge>]
173
- #
174
- # @param starting_at [Time]
175
- #
176
- # @param transitions [Array<MetronomeSDK::ContractWithoutAmendments::Transition>]
177
- #
178
- # @param usage_statement_schedule [MetronomeSDK::ContractWithoutAmendments::UsageStatementSchedule]
179
- #
180
- # @param credits [Array<MetronomeSDK::Credit>]
181
- #
182
- # @param discounts [Array<MetronomeSDK::Discount>] This field's availability is dependent on your client's configuration.
183
- #
184
- # @param ending_before [Time]
185
- #
186
- # @param name [String]
187
- #
188
- # @param net_payment_terms_days [Float]
189
- #
190
- # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
191
- #
192
- # @param prepaid_balance_threshold_configuration [MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration]
193
- #
194
- # @param professional_services [Array<MetronomeSDK::ProService>] This field's availability is dependent on your client's configuration.
195
- #
196
- # @param rate_card_id [String]
197
- #
198
- # @param recurring_commits [Array<MetronomeSDK::ContractWithoutAmendments::RecurringCommit>]
199
- #
200
- # @param recurring_credits [Array<MetronomeSDK::ContractWithoutAmendments::RecurringCredit>]
201
- #
202
- # @param reseller_royalties [Array<MetronomeSDK::ContractWithoutAmendments::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
203
- #
204
- # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
205
- #
206
- # @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::ContractWithoutAmendments::ScheduledChargesOnUsageInvoices] Determines which scheduled and commit charges to consolidate onto the Contract's
207
- #
208
- # @param spend_threshold_configuration [MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration]
209
- #
210
- # @param total_contract_value [Float] This field's availability is dependent on your client's configuration.
211
- #
212
- # @param usage_filter [MetronomeSDK::ContractWithoutAmendments::UsageFilter]
213
-
214
- class Transition < MetronomeSDK::Internal::Type::BaseModel
215
- # @!attribute from_contract_id
216
- #
217
- # @return [String]
218
- required :from_contract_id, String
219
-
220
- # @!attribute to_contract_id
221
- #
222
- # @return [String]
223
- required :to_contract_id, String
224
-
225
- # @!attribute type
226
- #
227
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::Transition::Type]
228
- required :type, enum: -> { MetronomeSDK::ContractWithoutAmendments::Transition::Type }
229
-
230
- # @!method initialize(from_contract_id:, to_contract_id:, type:)
231
- # @param from_contract_id [String]
232
- # @param to_contract_id [String]
233
- # @param type [Symbol, MetronomeSDK::ContractWithoutAmendments::Transition::Type]
234
-
235
- # @see MetronomeSDK::ContractWithoutAmendments::Transition#type
236
- module Type
237
- extend MetronomeSDK::Internal::Type::Enum
238
-
239
- SUPERSEDE = :SUPERSEDE
240
- RENEWAL = :RENEWAL
241
-
242
- # @!method self.values
243
- # @return [Array<Symbol>]
244
- end
245
- end
246
-
247
- # @see MetronomeSDK::ContractWithoutAmendments#usage_statement_schedule
248
- class UsageStatementSchedule < MetronomeSDK::Internal::Type::BaseModel
249
- # @!attribute billing_anchor_date
250
- # Contract usage statements follow a selected cadence based on this date.
251
- #
252
- # @return [Time]
253
- required :billing_anchor_date, Time
254
-
255
- # @!attribute frequency
256
- #
257
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::UsageStatementSchedule::Frequency]
258
- required :frequency,
259
- enum: -> { MetronomeSDK::ContractWithoutAmendments::UsageStatementSchedule::Frequency }
260
-
261
- # @!method initialize(billing_anchor_date:, frequency:)
262
- # @param billing_anchor_date [Time] Contract usage statements follow a selected cadence based on this date.
263
- #
264
- # @param frequency [Symbol, MetronomeSDK::ContractWithoutAmendments::UsageStatementSchedule::Frequency]
265
-
266
- # @see MetronomeSDK::ContractWithoutAmendments::UsageStatementSchedule#frequency
267
- module Frequency
268
- extend MetronomeSDK::Internal::Type::Enum
269
-
270
- MONTHLY = :MONTHLY
271
- QUARTERLY = :QUARTERLY
272
- ANNUAL = :ANNUAL
273
- WEEKLY = :WEEKLY
274
-
275
- # @!method self.values
276
- # @return [Array<Symbol>]
277
- end
278
- end
279
-
280
- # @see MetronomeSDK::ContractWithoutAmendments#prepaid_balance_threshold_configuration
281
- class PrepaidBalanceThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
282
- # @!attribute commit
283
- #
284
- # @return [MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::Commit]
285
- required :commit,
286
- -> { MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::Commit }
287
-
288
- # @!attribute is_enabled
289
- # When set to false, the contract will not be evaluated against the
290
- # threshold_amount. Toggling to true will result an immediate evaluation,
291
- # regardless of prior state.
292
- #
293
- # @return [Boolean]
294
- required :is_enabled, MetronomeSDK::Internal::Type::Boolean
295
-
296
- # @!attribute payment_gate_config
297
- #
298
- # @return [MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig]
299
- required :payment_gate_config,
300
- -> {
301
- MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig
302
- }
303
-
304
- # @!attribute recharge_to_amount
305
- # Specify the amount the balance should be recharged to.
306
- #
307
- # @return [Float]
308
- required :recharge_to_amount, Float
309
-
310
- # @!attribute threshold_amount
311
- # Specify the threshold amount for the contract. Each time the contract's prepaid
312
- # balance lowers to this amount, a threshold charge will be initiated.
313
- #
314
- # @return [Float]
315
- required :threshold_amount, Float
316
-
317
- # @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:)
318
- # Some parameter documentations has been truncated, see
319
- # {MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration}
320
- # for more details.
321
- #
322
- # @param commit [MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::Commit]
323
- #
324
- # @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
325
- #
326
- # @param payment_gate_config [MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig]
327
- #
328
- # @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
329
- #
330
- # @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's prepaid
331
-
332
- # @see MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration#commit
333
- class Commit < MetronomeSDK::Internal::Type::BaseModel
334
- # @!attribute product_id
335
- # The commit product that will be used to generate the line item for commit
336
- # payment.
337
- #
338
- # @return [String]
339
- required :product_id, String
340
-
341
- # @!attribute applicable_product_ids
342
- # Which products the threshold commit applies to. If both applicable_product_ids
343
- # and applicable_product_tags are not provided, the commit applies to all
344
- # products.
345
- #
346
- # @return [Array<String>, nil]
347
- optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
348
-
349
- # @!attribute applicable_product_tags
350
- # Which tags the threshold commit applies to. If both applicable_product_ids and
351
- # applicable_product_tags are not provided, the commit applies to all products.
352
- #
353
- # @return [Array<String>, nil]
354
- optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
355
-
356
- # @!attribute description
357
- #
358
- # @return [String, nil]
359
- optional :description, String
360
-
361
- # @!attribute name
362
- # Specify the name of the line item for the threshold charge. If left blank, it
363
- # will default to the commit product name.
364
- #
365
- # @return [String, nil]
366
- optional :name, String
367
-
368
- # @!method initialize(product_id:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, name: nil)
369
- # Some parameter documentations has been truncated, see
370
- # {MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::Commit}
371
- # for more details.
372
- #
373
- # @param product_id [String] The commit product that will be used to generate the line item for commit paymen
374
- #
375
- # @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If both applicable_product_ids a
376
- #
377
- # @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If both applicable_product_ids and a
378
- #
379
- # @param description [String]
380
- #
381
- # @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
382
- end
383
-
384
- # @see MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration#payment_gate_config
385
- class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
386
- # @!attribute payment_gate_type
387
- # Gate access to the commit balance based on successful collection of payment.
388
- # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
389
- # facilitate payment using your own payment integration. Select NONE if you do not
390
- # wish to payment gate the commit balance.
391
- #
392
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType]
393
- required :payment_gate_type,
394
- enum: -> {
395
- MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType
396
- }
397
-
398
- # @!attribute stripe_config
399
- # Only applicable if using Stripe as your payment gateway through Metronome.
400
- #
401
- # @return [MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
402
- optional :stripe_config,
403
- -> {
404
- MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig
405
- }
406
-
407
- # @!attribute tax_type
408
- # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
409
- # not wish Metronome to calculate tax on your behalf. Leaving this field blank
410
- # will default to NONE.
411
- #
412
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType, nil]
413
- optional :tax_type,
414
- enum: -> {
415
- MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType
416
- }
417
-
418
- # @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
419
- # Some parameter documentations has been truncated, see
420
- # {MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig}
421
- # for more details.
422
- #
423
- # @param payment_gate_type [Symbol, MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
424
- #
425
- # @param stripe_config [MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
426
- #
427
- # @param tax_type [Symbol, MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
428
-
429
- # Gate access to the commit balance based on successful collection of payment.
430
- # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
431
- # facilitate payment using your own payment integration. Select NONE if you do not
432
- # wish to payment gate the commit balance.
433
- #
434
- # @see MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#payment_gate_type
435
- module PaymentGateType
436
- extend MetronomeSDK::Internal::Type::Enum
437
-
438
- NONE = :NONE
439
- STRIPE = :STRIPE
440
- EXTERNAL = :EXTERNAL
441
-
442
- # @!method self.values
443
- # @return [Array<Symbol>]
444
- end
445
-
446
- # @see MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#stripe_config
447
- class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
448
- # @!attribute payment_type
449
- # If left blank, will default to INVOICE
450
- #
451
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
452
- required :payment_type,
453
- enum: -> {
454
- MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType
455
- }
456
-
457
- # @!method initialize(payment_type:)
458
- # Only applicable if using Stripe as your payment gateway through Metronome.
459
- #
460
- # @param payment_type [Symbol, MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
461
-
462
- # If left blank, will default to INVOICE
463
- #
464
- # @see MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
465
- module PaymentType
466
- extend MetronomeSDK::Internal::Type::Enum
467
-
468
- INVOICE = :INVOICE
469
- PAYMENT_INTENT = :PAYMENT_INTENT
470
-
471
- # @!method self.values
472
- # @return [Array<Symbol>]
473
- end
474
- end
475
-
476
- # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
477
- # not wish Metronome to calculate tax on your behalf. Leaving this field blank
478
- # will default to NONE.
479
- #
480
- # @see MetronomeSDK::ContractWithoutAmendments::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#tax_type
481
- module TaxType
482
- extend MetronomeSDK::Internal::Type::Enum
483
-
484
- NONE = :NONE
485
- STRIPE = :STRIPE
486
-
487
- # @!method self.values
488
- # @return [Array<Symbol>]
489
- end
490
- end
491
- end
492
-
493
- class RecurringCommit < MetronomeSDK::Internal::Type::BaseModel
494
- # @!attribute id
495
- #
496
- # @return [String]
497
- required :id, String
498
-
499
- # @!attribute access_amount
500
- # The amount of commit to grant.
501
- #
502
- # @return [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount]
503
- required :access_amount, -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount }
504
-
505
- # @!attribute commit_duration
506
- # The amount of time the created commits will be valid for
507
- #
508
- # @return [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::CommitDuration]
509
- required :commit_duration,
510
- -> {
511
- MetronomeSDK::ContractWithoutAmendments::RecurringCommit::CommitDuration
512
- }
513
-
514
- # @!attribute priority
515
- # Will be passed down to the individual commits
516
- #
517
- # @return [Float]
518
- required :priority, Float
519
-
520
- # @!attribute product
521
- #
522
- # @return [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Product]
523
- required :product, -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Product }
524
-
525
- # @!attribute rate_type
526
- # Whether the created commits will use the commit rate or list rate
527
- #
528
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RateType]
529
- required :rate_type, enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RateType }
530
-
531
- # @!attribute starting_at
532
- # Determines the start time for the first commit
533
- #
534
- # @return [Time]
535
- required :starting_at, Time
536
-
537
- # @!attribute applicable_product_ids
538
- # Will be passed down to the individual commits
539
- #
540
- # @return [Array<String>, nil]
541
- optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
542
-
543
- # @!attribute applicable_product_tags
544
- # Will be passed down to the individual commits
545
- #
546
- # @return [Array<String>, nil]
547
- optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
548
-
549
- # @!attribute contract
550
- #
551
- # @return [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Contract, nil]
552
- optional :contract, -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Contract }
553
-
554
- # @!attribute description
555
- # Will be passed down to the individual commits
556
- #
557
- # @return [String, nil]
558
- optional :description, String
559
-
560
- # @!attribute ending_before
561
- # Determines when the contract will stop creating recurring commits. Optional
562
- #
563
- # @return [Time, nil]
564
- optional :ending_before, Time
565
-
566
- # @!attribute invoice_amount
567
- # The amount the customer should be billed for the commit. Not required.
568
- #
569
- # @return [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::InvoiceAmount, nil]
570
- optional :invoice_amount,
571
- -> {
572
- MetronomeSDK::ContractWithoutAmendments::RecurringCommit::InvoiceAmount
573
- }
574
-
575
- # @!attribute name
576
- # Displayed on invoices. Will be passed through to the individual commits
577
- #
578
- # @return [String, nil]
579
- optional :name, String
580
-
581
- # @!attribute netsuite_sales_order_id
582
- # Will be passed down to the individual commits
583
- #
584
- # @return [String, nil]
585
- optional :netsuite_sales_order_id, String
586
-
587
- # @!attribute proration
588
- # Determines whether the first and last commit will be prorated. If not provided,
589
- # the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
590
- #
591
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Proration, nil]
592
- optional :proration, enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Proration }
593
-
594
- # @!attribute recurrence_frequency
595
- # The frequency at which the recurring commits will be created. If not provided: -
596
- # The commits will be created on the usage invoice frequency. If provided: - The
597
- # period defined in the duration will correspond to this frequency. - Commits will
598
- # be created aligned with the recurring commit's start_date rather than the usage
599
- # invoice dates.
600
- #
601
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RecurrenceFrequency, nil]
602
- optional :recurrence_frequency,
603
- enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RecurrenceFrequency }
604
-
605
- # @!attribute rollover_fraction
606
- # Will be passed down to the individual commits. This controls how much of an
607
- # individual unexpired commit will roll over upon contract transition. Must be
608
- # between 0 and 1.
609
- #
610
- # @return [Float, nil]
611
- optional :rollover_fraction, Float
612
-
613
- # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil)
614
- # Some parameter documentations has been truncated, see
615
- # {MetronomeSDK::ContractWithoutAmendments::RecurringCommit} for more details.
616
- #
617
- # @param id [String]
618
- #
619
- # @param access_amount [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::AccessAmount] The amount of commit to grant.
620
- #
621
- # @param commit_duration [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::CommitDuration] The amount of time the created commits will be valid for
622
- #
623
- # @param priority [Float] Will be passed down to the individual commits
624
- #
625
- # @param product [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Product]
626
- #
627
- # @param rate_type [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RateType] Whether the created commits will use the commit rate or list rate
628
- #
629
- # @param starting_at [Time] Determines the start time for the first commit
630
- #
631
- # @param applicable_product_ids [Array<String>] Will be passed down to the individual commits
632
- #
633
- # @param applicable_product_tags [Array<String>] Will be passed down to the individual commits
634
- #
635
- # @param contract [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Contract]
636
- #
637
- # @param description [String] Will be passed down to the individual commits
638
- #
639
- # @param ending_before [Time] Determines when the contract will stop creating recurring commits. Optional
640
- #
641
- # @param invoice_amount [MetronomeSDK::ContractWithoutAmendments::RecurringCommit::InvoiceAmount] The amount the customer should be billed for the commit. Not required.
642
- #
643
- # @param name [String] Displayed on invoices. Will be passed through to the individual commits
644
- #
645
- # @param netsuite_sales_order_id [String] Will be passed down to the individual commits
646
- #
647
- # @param proration [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCommit::Proration] Determines whether the first and last commit will be prorated. If not provided,
648
- #
649
- # @param recurrence_frequency [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCommit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided:
650
- #
651
- # @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
652
-
653
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCommit#access_amount
654
- class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
655
- # @!attribute credit_type_id
656
- #
657
- # @return [String]
658
- required :credit_type_id, String
659
-
660
- # @!attribute quantity
661
- #
662
- # @return [Float]
663
- required :quantity, Float
664
-
665
- # @!attribute unit_price
666
- #
667
- # @return [Float]
668
- required :unit_price, Float
669
-
670
- # @!method initialize(credit_type_id:, quantity:, unit_price:)
671
- # The amount of commit to grant.
672
- #
673
- # @param credit_type_id [String]
674
- # @param quantity [Float]
675
- # @param unit_price [Float]
676
- end
677
-
678
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCommit#commit_duration
679
- class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
680
- # @!attribute value
681
- #
682
- # @return [Float]
683
- required :value, Float
684
-
685
- # @!attribute unit
686
- #
687
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCommit::CommitDuration::Unit, nil]
688
- optional :unit,
689
- enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCommit::CommitDuration::Unit }
690
-
691
- # @!method initialize(value:, unit: nil)
692
- # The amount of time the created commits will be valid for
693
- #
694
- # @param value [Float]
695
- # @param unit [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCommit::CommitDuration::Unit]
696
-
697
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCommit::CommitDuration#unit
698
- module Unit
699
- extend MetronomeSDK::Internal::Type::Enum
700
-
701
- PERIODS = :PERIODS
702
-
703
- # @!method self.values
704
- # @return [Array<Symbol>]
705
- end
706
- end
707
-
708
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCommit#product
709
- class Product < MetronomeSDK::Internal::Type::BaseModel
710
- # @!attribute id
711
- #
712
- # @return [String]
713
- required :id, String
714
-
715
- # @!attribute name
716
- #
717
- # @return [String]
718
- required :name, String
719
-
720
- # @!method initialize(id:, name:)
721
- # @param id [String]
722
- # @param name [String]
723
- end
724
-
725
- # Whether the created commits will use the commit rate or list rate
726
- #
727
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCommit#rate_type
728
- module RateType
729
- extend MetronomeSDK::Internal::Type::Enum
730
-
731
- COMMIT_RATE = :COMMIT_RATE
732
- LIST_RATE = :LIST_RATE
733
-
734
- # @!method self.values
735
- # @return [Array<Symbol>]
736
- end
737
-
738
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCommit#contract
739
- class Contract < MetronomeSDK::Internal::Type::BaseModel
740
- # @!attribute id
741
- #
742
- # @return [String]
743
- required :id, String
744
-
745
- # @!method initialize(id:)
746
- # @param id [String]
747
- end
748
-
749
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCommit#invoice_amount
750
- class InvoiceAmount < MetronomeSDK::Internal::Type::BaseModel
751
- # @!attribute credit_type_id
752
- #
753
- # @return [String]
754
- required :credit_type_id, String
755
-
756
- # @!attribute quantity
757
- #
758
- # @return [Float]
759
- required :quantity, Float
760
-
761
- # @!attribute unit_price
762
- #
763
- # @return [Float]
764
- required :unit_price, Float
765
-
766
- # @!method initialize(credit_type_id:, quantity:, unit_price:)
767
- # The amount the customer should be billed for the commit. Not required.
768
- #
769
- # @param credit_type_id [String]
770
- # @param quantity [Float]
771
- # @param unit_price [Float]
772
- end
773
-
774
- # Determines whether the first and last commit will be prorated. If not provided,
775
- # the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
776
- #
777
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCommit#proration
778
- module Proration
779
- extend MetronomeSDK::Internal::Type::Enum
780
-
781
- NONE = :NONE
782
- FIRST = :FIRST
783
- LAST = :LAST
784
- FIRST_AND_LAST = :FIRST_AND_LAST
785
-
786
- # @!method self.values
787
- # @return [Array<Symbol>]
788
- end
789
-
790
- # The frequency at which the recurring commits will be created. If not provided: -
791
- # The commits will be created on the usage invoice frequency. If provided: - The
792
- # period defined in the duration will correspond to this frequency. - Commits will
793
- # be created aligned with the recurring commit's start_date rather than the usage
794
- # invoice dates.
795
- #
796
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCommit#recurrence_frequency
797
- module RecurrenceFrequency
798
- extend MetronomeSDK::Internal::Type::Enum
799
-
800
- MONTHLY = :MONTHLY
801
- QUARTERLY = :QUARTERLY
802
- ANNUAL = :ANNUAL
803
- WEEKLY = :WEEKLY
804
-
805
- # @!method self.values
806
- # @return [Array<Symbol>]
807
- end
808
- end
809
-
810
- class RecurringCredit < MetronomeSDK::Internal::Type::BaseModel
811
- # @!attribute id
812
- #
813
- # @return [String]
814
- required :id, String
815
-
816
- # @!attribute access_amount
817
- # The amount of commit to grant.
818
- #
819
- # @return [MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount]
820
- required :access_amount, -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount }
821
-
822
- # @!attribute commit_duration
823
- # The amount of time the created commits will be valid for
824
- #
825
- # @return [MetronomeSDK::ContractWithoutAmendments::RecurringCredit::CommitDuration]
826
- required :commit_duration,
827
- -> {
828
- MetronomeSDK::ContractWithoutAmendments::RecurringCredit::CommitDuration
829
- }
830
-
831
- # @!attribute priority
832
- # Will be passed down to the individual commits
833
- #
834
- # @return [Float]
835
- required :priority, Float
836
-
837
- # @!attribute product
838
- #
839
- # @return [MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Product]
840
- required :product, -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Product }
841
-
842
- # @!attribute rate_type
843
- # Whether the created commits will use the commit rate or list rate
844
- #
845
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RateType]
846
- required :rate_type, enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RateType }
847
-
848
- # @!attribute starting_at
849
- # Determines the start time for the first commit
850
- #
851
- # @return [Time]
852
- required :starting_at, Time
853
-
854
- # @!attribute applicable_product_ids
855
- # Will be passed down to the individual commits
856
- #
857
- # @return [Array<String>, nil]
858
- optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
859
-
860
- # @!attribute applicable_product_tags
861
- # Will be passed down to the individual commits
862
- #
863
- # @return [Array<String>, nil]
864
- optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
865
-
866
- # @!attribute contract
867
- #
868
- # @return [MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Contract, nil]
869
- optional :contract, -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Contract }
870
-
871
- # @!attribute description
872
- # Will be passed down to the individual commits
873
- #
874
- # @return [String, nil]
875
- optional :description, String
876
-
877
- # @!attribute ending_before
878
- # Determines when the contract will stop creating recurring commits. Optional
879
- #
880
- # @return [Time, nil]
881
- optional :ending_before, Time
882
-
883
- # @!attribute name
884
- # Displayed on invoices. Will be passed through to the individual commits
885
- #
886
- # @return [String, nil]
887
- optional :name, String
888
-
889
- # @!attribute netsuite_sales_order_id
890
- # Will be passed down to the individual commits
891
- #
892
- # @return [String, nil]
893
- optional :netsuite_sales_order_id, String
894
-
895
- # @!attribute proration
896
- # Determines whether the first and last commit will be prorated. If not provided,
897
- # the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
898
- #
899
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Proration, nil]
900
- optional :proration, enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Proration }
901
-
902
- # @!attribute recurrence_frequency
903
- # The frequency at which the recurring commits will be created. If not provided: -
904
- # The commits will be created on the usage invoice frequency. If provided: - The
905
- # period defined in the duration will correspond to this frequency. - Commits will
906
- # be created aligned with the recurring commit's start_date rather than the usage
907
- # invoice dates.
908
- #
909
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RecurrenceFrequency, nil]
910
- optional :recurrence_frequency,
911
- enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RecurrenceFrequency }
912
-
913
- # @!attribute rollover_fraction
914
- # Will be passed down to the individual commits. This controls how much of an
915
- # individual unexpired commit will roll over upon contract transition. Must be
916
- # between 0 and 1.
917
- #
918
- # @return [Float, nil]
919
- optional :rollover_fraction, Float
920
-
921
- # @!method initialize(id:, access_amount:, commit_duration:, priority:, product:, rate_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, contract: nil, description: nil, ending_before: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, recurrence_frequency: nil, rollover_fraction: nil)
922
- # Some parameter documentations has been truncated, see
923
- # {MetronomeSDK::ContractWithoutAmendments::RecurringCredit} for more details.
924
- #
925
- # @param id [String]
926
- #
927
- # @param access_amount [MetronomeSDK::ContractWithoutAmendments::RecurringCredit::AccessAmount] The amount of commit to grant.
928
- #
929
- # @param commit_duration [MetronomeSDK::ContractWithoutAmendments::RecurringCredit::CommitDuration] The amount of time the created commits will be valid for
930
- #
931
- # @param priority [Float] Will be passed down to the individual commits
932
- #
933
- # @param product [MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Product]
934
- #
935
- # @param rate_type [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RateType] Whether the created commits will use the commit rate or list rate
936
- #
937
- # @param starting_at [Time] Determines the start time for the first commit
938
- #
939
- # @param applicable_product_ids [Array<String>] Will be passed down to the individual commits
940
- #
941
- # @param applicable_product_tags [Array<String>] Will be passed down to the individual commits
942
- #
943
- # @param contract [MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Contract]
944
- #
945
- # @param description [String] Will be passed down to the individual commits
946
- #
947
- # @param ending_before [Time] Determines when the contract will stop creating recurring commits. Optional
948
- #
949
- # @param name [String] Displayed on invoices. Will be passed through to the individual commits
950
- #
951
- # @param netsuite_sales_order_id [String] Will be passed down to the individual commits
952
- #
953
- # @param proration [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCredit::Proration] Determines whether the first and last commit will be prorated. If not provided,
954
- #
955
- # @param recurrence_frequency [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCredit::RecurrenceFrequency] The frequency at which the recurring commits will be created. If not provided:
956
- #
957
- # @param rollover_fraction [Float] Will be passed down to the individual commits. This controls how much of an indi
958
-
959
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCredit#access_amount
960
- class AccessAmount < MetronomeSDK::Internal::Type::BaseModel
961
- # @!attribute credit_type_id
962
- #
963
- # @return [String]
964
- required :credit_type_id, String
965
-
966
- # @!attribute quantity
967
- #
968
- # @return [Float]
969
- required :quantity, Float
970
-
971
- # @!attribute unit_price
972
- #
973
- # @return [Float]
974
- required :unit_price, Float
975
-
976
- # @!method initialize(credit_type_id:, quantity:, unit_price:)
977
- # The amount of commit to grant.
978
- #
979
- # @param credit_type_id [String]
980
- # @param quantity [Float]
981
- # @param unit_price [Float]
982
- end
983
-
984
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCredit#commit_duration
985
- class CommitDuration < MetronomeSDK::Internal::Type::BaseModel
986
- # @!attribute value
987
- #
988
- # @return [Float]
989
- required :value, Float
990
-
991
- # @!attribute unit
992
- #
993
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCredit::CommitDuration::Unit, nil]
994
- optional :unit,
995
- enum: -> { MetronomeSDK::ContractWithoutAmendments::RecurringCredit::CommitDuration::Unit }
996
-
997
- # @!method initialize(value:, unit: nil)
998
- # The amount of time the created commits will be valid for
999
- #
1000
- # @param value [Float]
1001
- # @param unit [Symbol, MetronomeSDK::ContractWithoutAmendments::RecurringCredit::CommitDuration::Unit]
1002
-
1003
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCredit::CommitDuration#unit
1004
- module Unit
1005
- extend MetronomeSDK::Internal::Type::Enum
1006
-
1007
- PERIODS = :PERIODS
1008
-
1009
- # @!method self.values
1010
- # @return [Array<Symbol>]
1011
- end
1012
- end
1013
-
1014
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCredit#product
1015
- class Product < MetronomeSDK::Internal::Type::BaseModel
1016
- # @!attribute id
1017
- #
1018
- # @return [String]
1019
- required :id, String
1020
-
1021
- # @!attribute name
1022
- #
1023
- # @return [String]
1024
- required :name, String
1025
-
1026
- # @!method initialize(id:, name:)
1027
- # @param id [String]
1028
- # @param name [String]
1029
- end
1030
-
1031
- # Whether the created commits will use the commit rate or list rate
1032
- #
1033
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCredit#rate_type
1034
- module RateType
1035
- extend MetronomeSDK::Internal::Type::Enum
1036
-
1037
- COMMIT_RATE = :COMMIT_RATE
1038
- LIST_RATE = :LIST_RATE
1039
-
1040
- # @!method self.values
1041
- # @return [Array<Symbol>]
1042
- end
1043
-
1044
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCredit#contract
1045
- class Contract < MetronomeSDK::Internal::Type::BaseModel
1046
- # @!attribute id
1047
- #
1048
- # @return [String]
1049
- required :id, String
1050
-
1051
- # @!method initialize(id:)
1052
- # @param id [String]
1053
- end
1054
-
1055
- # Determines whether the first and last commit will be prorated. If not provided,
1056
- # the default is FIRST_AND_LAST (i.e. prorate both the first and last commits).
1057
- #
1058
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCredit#proration
1059
- module Proration
1060
- extend MetronomeSDK::Internal::Type::Enum
1061
-
1062
- NONE = :NONE
1063
- FIRST = :FIRST
1064
- LAST = :LAST
1065
- FIRST_AND_LAST = :FIRST_AND_LAST
1066
-
1067
- # @!method self.values
1068
- # @return [Array<Symbol>]
1069
- end
1070
-
1071
- # The frequency at which the recurring commits will be created. If not provided: -
1072
- # The commits will be created on the usage invoice frequency. If provided: - The
1073
- # period defined in the duration will correspond to this frequency. - Commits will
1074
- # be created aligned with the recurring commit's start_date rather than the usage
1075
- # invoice dates.
1076
- #
1077
- # @see MetronomeSDK::ContractWithoutAmendments::RecurringCredit#recurrence_frequency
1078
- module RecurrenceFrequency
1079
- extend MetronomeSDK::Internal::Type::Enum
1080
-
1081
- MONTHLY = :MONTHLY
1082
- QUARTERLY = :QUARTERLY
1083
- ANNUAL = :ANNUAL
1084
- WEEKLY = :WEEKLY
1085
-
1086
- # @!method self.values
1087
- # @return [Array<Symbol>]
1088
- end
1089
- end
1090
-
1091
- class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
1092
- # @!attribute fraction
1093
- #
1094
- # @return [Float]
1095
- required :fraction, Float
1096
-
1097
- # @!attribute netsuite_reseller_id
1098
- #
1099
- # @return [String]
1100
- required :netsuite_reseller_id, String
1101
-
1102
- # @!attribute reseller_type
1103
- #
1104
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::ResellerRoyalty::ResellerType]
1105
- required :reseller_type,
1106
- enum: -> { MetronomeSDK::ContractWithoutAmendments::ResellerRoyalty::ResellerType }
1107
-
1108
- # @!attribute starting_at
1109
- #
1110
- # @return [Time]
1111
- required :starting_at, Time
1112
-
1113
- # @!attribute applicable_product_ids
1114
- #
1115
- # @return [Array<String>, nil]
1116
- optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
1117
-
1118
- # @!attribute applicable_product_tags
1119
- #
1120
- # @return [Array<String>, nil]
1121
- optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
1122
-
1123
- # @!attribute aws_account_number
1124
- #
1125
- # @return [String, nil]
1126
- optional :aws_account_number, String
1127
-
1128
- # @!attribute aws_offer_id
1129
- #
1130
- # @return [String, nil]
1131
- optional :aws_offer_id, String
1132
-
1133
- # @!attribute aws_payer_reference_id
1134
- #
1135
- # @return [String, nil]
1136
- optional :aws_payer_reference_id, String
1137
-
1138
- # @!attribute ending_before
1139
- #
1140
- # @return [Time, nil]
1141
- optional :ending_before, Time
1142
-
1143
- # @!attribute gcp_account_id
1144
- #
1145
- # @return [String, nil]
1146
- optional :gcp_account_id, String
1147
-
1148
- # @!attribute gcp_offer_id
1149
- #
1150
- # @return [String, nil]
1151
- optional :gcp_offer_id, String
1152
-
1153
- # @!attribute reseller_contract_value
1154
- #
1155
- # @return [Float, nil]
1156
- optional :reseller_contract_value, Float
1157
-
1158
- # @!method initialize(fraction:, netsuite_reseller_id:, reseller_type:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, aws_account_number: nil, aws_offer_id: nil, aws_payer_reference_id: nil, ending_before: nil, gcp_account_id: nil, gcp_offer_id: nil, reseller_contract_value: nil)
1159
- # @param fraction [Float]
1160
- # @param netsuite_reseller_id [String]
1161
- # @param reseller_type [Symbol, MetronomeSDK::ContractWithoutAmendments::ResellerRoyalty::ResellerType]
1162
- # @param starting_at [Time]
1163
- # @param applicable_product_ids [Array<String>]
1164
- # @param applicable_product_tags [Array<String>]
1165
- # @param aws_account_number [String]
1166
- # @param aws_offer_id [String]
1167
- # @param aws_payer_reference_id [String]
1168
- # @param ending_before [Time]
1169
- # @param gcp_account_id [String]
1170
- # @param gcp_offer_id [String]
1171
- # @param reseller_contract_value [Float]
1172
-
1173
- # @see MetronomeSDK::ContractWithoutAmendments::ResellerRoyalty#reseller_type
1174
- module ResellerType
1175
- extend MetronomeSDK::Internal::Type::Enum
1176
-
1177
- AWS = :AWS
1178
- AWS_PRO_SERVICE = :AWS_PRO_SERVICE
1179
- GCP = :GCP
1180
- GCP_PRO_SERVICE = :GCP_PRO_SERVICE
1181
-
1182
- # @!method self.values
1183
- # @return [Array<Symbol>]
1184
- end
1185
- end
1186
-
1187
- # Determines which scheduled and commit charges to consolidate onto the Contract's
1188
- # usage invoice. The charge's `timestamp` must match the usage invoice's
1189
- # `ending_before` date for consolidation to occur. This field cannot be modified
1190
- # after a Contract has been created. If this field is omitted, charges will appear
1191
- # on a separate invoice from usage charges.
1192
- #
1193
- # @see MetronomeSDK::ContractWithoutAmendments#scheduled_charges_on_usage_invoices
1194
- module ScheduledChargesOnUsageInvoices
1195
- extend MetronomeSDK::Internal::Type::Enum
1196
-
1197
- ALL = :ALL
1198
-
1199
- # @!method self.values
1200
- # @return [Array<Symbol>]
1201
- end
1202
-
1203
- # @see MetronomeSDK::ContractWithoutAmendments#spend_threshold_configuration
1204
- class SpendThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
1205
- # @!attribute commit
1206
- #
1207
- # @return [MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::Commit]
1208
- required :commit, -> { MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::Commit }
1209
-
1210
- # @!attribute is_enabled
1211
- # When set to false, the contract will not be evaluated against the
1212
- # threshold_amount. Toggling to true will result an immediate evaluation,
1213
- # regardless of prior state.
1214
- #
1215
- # @return [Boolean]
1216
- required :is_enabled, MetronomeSDK::Internal::Type::Boolean
1217
-
1218
- # @!attribute payment_gate_config
1219
- #
1220
- # @return [MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig]
1221
- required :payment_gate_config,
1222
- -> {
1223
- MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig
1224
- }
1225
-
1226
- # @!attribute threshold_amount
1227
- # Specify the threshold amount for the contract. Each time the contract's usage
1228
- # hits this amount, a threshold charge will be initiated.
1229
- #
1230
- # @return [Float]
1231
- required :threshold_amount, Float
1232
-
1233
- # @!method initialize(commit:, is_enabled:, payment_gate_config:, threshold_amount:)
1234
- # Some parameter documentations has been truncated, see
1235
- # {MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration} for more
1236
- # details.
1237
- #
1238
- # @param commit [MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::Commit]
1239
- #
1240
- # @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
1241
- #
1242
- # @param payment_gate_config [MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig]
1243
- #
1244
- # @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's usage hi
1245
-
1246
- # @see MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration#commit
1247
- class Commit < MetronomeSDK::Internal::Type::BaseModel
1248
- # @!attribute product_id
1249
- # The commit product that will be used to generate the line item for commit
1250
- # payment.
1251
- #
1252
- # @return [String]
1253
- required :product_id, String
1254
-
1255
- # @!attribute description
1256
- #
1257
- # @return [String, nil]
1258
- optional :description, String
1259
-
1260
- # @!attribute name
1261
- # Specify the name of the line item for the threshold charge. If left blank, it
1262
- # will default to the commit product name.
1263
- #
1264
- # @return [String, nil]
1265
- optional :name, String
1266
-
1267
- # @!method initialize(product_id:, description: nil, name: nil)
1268
- # Some parameter documentations has been truncated, see
1269
- # {MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::Commit}
1270
- # for more details.
1271
- #
1272
- # @param product_id [String] The commit product that will be used to generate the line item for commit paymen
1273
- #
1274
- # @param description [String]
1275
- #
1276
- # @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
1277
- end
1278
-
1279
- # @see MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration#payment_gate_config
1280
- class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
1281
- # @!attribute payment_gate_type
1282
- # Gate access to the commit balance based on successful collection of payment.
1283
- # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
1284
- # facilitate payment using your own payment integration. Select NONE if you do not
1285
- # wish to payment gate the commit balance.
1286
- #
1287
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType]
1288
- required :payment_gate_type,
1289
- enum: -> {
1290
- MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType
1291
- }
1292
-
1293
- # @!attribute stripe_config
1294
- # Only applicable if using Stripe as your payment gateway through Metronome.
1295
- #
1296
- # @return [MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
1297
- optional :stripe_config,
1298
- -> {
1299
- MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig
1300
- }
1301
-
1302
- # @!attribute tax_type
1303
- # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
1304
- # not wish Metronome to calculate tax on your behalf. Leaving this field blank
1305
- # will default to NONE.
1306
- #
1307
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::TaxType, nil]
1308
- optional :tax_type,
1309
- enum: -> {
1310
- MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::TaxType
1311
- }
1312
-
1313
- # @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
1314
- # Some parameter documentations has been truncated, see
1315
- # {MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig}
1316
- # for more details.
1317
- #
1318
- # @param payment_gate_type [Symbol, MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
1319
- #
1320
- # @param stripe_config [MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
1321
- #
1322
- # @param tax_type [Symbol, MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
1323
-
1324
- # Gate access to the commit balance based on successful collection of payment.
1325
- # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
1326
- # facilitate payment using your own payment integration. Select NONE if you do not
1327
- # wish to payment gate the commit balance.
1328
- #
1329
- # @see MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig#payment_gate_type
1330
- module PaymentGateType
1331
- extend MetronomeSDK::Internal::Type::Enum
1332
-
1333
- NONE = :NONE
1334
- STRIPE = :STRIPE
1335
- EXTERNAL = :EXTERNAL
1336
-
1337
- # @!method self.values
1338
- # @return [Array<Symbol>]
1339
- end
1340
-
1341
- # @see MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig#stripe_config
1342
- class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
1343
- # @!attribute payment_type
1344
- # If left blank, will default to INVOICE
1345
- #
1346
- # @return [Symbol, MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
1347
- required :payment_type,
1348
- enum: -> {
1349
- MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType
1350
- }
1351
-
1352
- # @!method initialize(payment_type:)
1353
- # Only applicable if using Stripe as your payment gateway through Metronome.
1354
- #
1355
- # @param payment_type [Symbol, MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
1356
-
1357
- # If left blank, will default to INVOICE
1358
- #
1359
- # @see MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
1360
- module PaymentType
1361
- extend MetronomeSDK::Internal::Type::Enum
1362
-
1363
- INVOICE = :INVOICE
1364
- PAYMENT_INTENT = :PAYMENT_INTENT
1365
-
1366
- # @!method self.values
1367
- # @return [Array<Symbol>]
1368
- end
1369
- end
1370
-
1371
- # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
1372
- # not wish Metronome to calculate tax on your behalf. Leaving this field blank
1373
- # will default to NONE.
1374
- #
1375
- # @see MetronomeSDK::ContractWithoutAmendments::SpendThresholdConfiguration::PaymentGateConfig#tax_type
1376
- module TaxType
1377
- extend MetronomeSDK::Internal::Type::Enum
1378
-
1379
- NONE = :NONE
1380
- STRIPE = :STRIPE
1381
-
1382
- # @!method self.values
1383
- # @return [Array<Symbol>]
1384
- end
1385
- end
1386
- end
1387
-
1388
- # @see MetronomeSDK::ContractWithoutAmendments#usage_filter
1389
- class UsageFilter < MetronomeSDK::Internal::Type::BaseModel
1390
- # @!attribute current
1391
- #
1392
- # @return [MetronomeSDK::BaseUsageFilter, nil]
1393
- required :current, -> { MetronomeSDK::BaseUsageFilter }, nil?: true
1394
-
1395
- # @!attribute initial
1396
- #
1397
- # @return [MetronomeSDK::BaseUsageFilter]
1398
- required :initial, -> { MetronomeSDK::BaseUsageFilter }
1399
-
1400
- # @!attribute updates
1401
- #
1402
- # @return [Array<MetronomeSDK::ContractWithoutAmendments::UsageFilter::Update>]
1403
- required :updates,
1404
- -> {
1405
- MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractWithoutAmendments::UsageFilter::Update]
1406
- }
1407
-
1408
- # @!method initialize(current:, initial:, updates:)
1409
- # @param current [MetronomeSDK::BaseUsageFilter, nil]
1410
- # @param initial [MetronomeSDK::BaseUsageFilter]
1411
- # @param updates [Array<MetronomeSDK::ContractWithoutAmendments::UsageFilter::Update>]
1412
-
1413
- class Update < MetronomeSDK::Internal::Type::BaseModel
1414
- # @!attribute group_key
1415
- #
1416
- # @return [String]
1417
- required :group_key, String
1418
-
1419
- # @!attribute group_values
1420
- #
1421
- # @return [Array<String>]
1422
- required :group_values, MetronomeSDK::Internal::Type::ArrayOf[String]
1423
-
1424
- # @!attribute starting_at
1425
- #
1426
- # @return [Time]
1427
- required :starting_at, Time
1428
-
1429
- # @!method initialize(group_key:, group_values:, starting_at:)
1430
- # @param group_key [String]
1431
- # @param group_values [Array<String>]
1432
- # @param starting_at [Time]
1433
- end
1434
- end
1435
- end
1436
- end
1437
- end