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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (417) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +56 -0
  3. data/README.md +1 -1
  4. data/lib/metronome_sdk/errors.rb +22 -0
  5. data/lib/metronome_sdk/internal/cursor_page.rb +1 -1
  6. data/lib/metronome_sdk/internal/transport/base_client.rb +10 -2
  7. data/lib/metronome_sdk/internal/type/array_of.rb +6 -1
  8. data/lib/metronome_sdk/internal/type/base_model.rb +82 -26
  9. data/lib/metronome_sdk/internal/type/boolean.rb +7 -1
  10. data/lib/metronome_sdk/internal/type/converter.rb +42 -34
  11. data/lib/metronome_sdk/internal/type/enum.rb +16 -5
  12. data/lib/metronome_sdk/internal/type/file_input.rb +6 -1
  13. data/lib/metronome_sdk/internal/type/hash_of.rb +6 -1
  14. data/lib/metronome_sdk/internal/type/union.rb +17 -9
  15. data/lib/metronome_sdk/internal/type/unknown.rb +7 -1
  16. data/lib/metronome_sdk/internal/util.rb +8 -9
  17. data/lib/metronome_sdk/models/base_usage_filter.rb +27 -0
  18. data/lib/metronome_sdk/models/commit.rb +1053 -0
  19. data/lib/metronome_sdk/models/contract_without_amendments.rb +2043 -0
  20. data/lib/metronome_sdk/models/credit.rb +677 -0
  21. data/lib/metronome_sdk/models/credit_type_data.rb +21 -0
  22. data/lib/metronome_sdk/models/discount.rb +68 -0
  23. data/lib/metronome_sdk/models/event_type_filter.rb +33 -0
  24. data/lib/metronome_sdk/models/id.rb +15 -0
  25. data/lib/metronome_sdk/models/override.rb +381 -0
  26. data/lib/metronome_sdk/models/pro_service.rb +73 -0
  27. data/lib/metronome_sdk/models/property_filter.rb +52 -0
  28. data/lib/metronome_sdk/models/rate.rb +101 -0
  29. data/lib/metronome_sdk/models/schedule_duration.rb +50 -0
  30. data/lib/metronome_sdk/models/schedule_point_in_time.rb +62 -0
  31. data/lib/metronome_sdk/models/scheduled_charge.rb +76 -0
  32. data/lib/metronome_sdk/models/tier.rb +21 -0
  33. data/lib/metronome_sdk/models/v1/alert_archive_response.rb +3 -14
  34. data/lib/metronome_sdk/models/v1/alert_create_params.rb +4 -1
  35. data/lib/metronome_sdk/models/v1/alert_create_response.rb +3 -14
  36. data/lib/metronome_sdk/models/v1/billable_metric_archive_params.rb +2 -8
  37. data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb +3 -14
  38. data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb +6 -86
  39. data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb +3 -14
  40. data/lib/metronome_sdk/models/v1/billable_metric_list_response.rb +6 -85
  41. data/lib/metronome_sdk/models/v1/billable_metric_retrieve_response.rb +8 -85
  42. data/lib/metronome_sdk/models/v1/contract_amend_params.rb +312 -35
  43. data/lib/metronome_sdk/models/v1/contract_amend_response.rb +3 -14
  44. data/lib/metronome_sdk/models/v1/contract_archive_response.rb +3 -14
  45. data/lib/metronome_sdk/models/v1/contract_create_historical_invoices_response.rb +3 -1276
  46. data/lib/metronome_sdk/models/v1/contract_create_params.rb +792 -104
  47. data/lib/metronome_sdk/models/v1/contract_create_response.rb +3 -14
  48. data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb +9 -1
  49. data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb +5 -1645
  50. data/lib/metronome_sdk/models/v1/contract_list_response.rb +253 -10692
  51. data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb +9 -295
  52. data/lib/metronome_sdk/models/v1/contract_retrieve_response.rb +254 -10721
  53. data/lib/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rb +3 -1276
  54. data/lib/metronome_sdk/models/v1/contract_update_end_date_response.rb +3 -14
  55. data/lib/metronome_sdk/models/v1/contracts/product_archive_response.rb +3 -14
  56. data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb +6 -97
  57. data/lib/metronome_sdk/models/v1/contracts/product_create_response.rb +3 -14
  58. data/lib/metronome_sdk/models/v1/contracts/product_list_item_state.rb +148 -0
  59. data/lib/metronome_sdk/models/v1/contracts/product_list_response.rb +12 -561
  60. data/lib/metronome_sdk/models/v1/contracts/product_retrieve_params.rb +2 -8
  61. data/lib/metronome_sdk/models/v1/contracts/product_retrieve_response.rb +14 -559
  62. data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb +6 -97
  63. data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb +3 -14
  64. data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb +57 -0
  65. data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb +45 -0
  66. data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_params.rb +2 -8
  67. data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb +3 -14
  68. data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb +3 -14
  69. data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb +6 -42
  70. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rb +2 -8
  71. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rb +6 -159
  72. data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rb +6 -42
  73. data/lib/metronome_sdk/models/v1/contracts/rate_card_update_response.rb +3 -14
  74. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb +3 -14
  75. data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb +3 -14
  76. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb +6 -44
  77. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb +3 -16
  78. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb +6 -44
  79. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb +9 -61
  80. data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rb +6 -158
  81. data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb +5 -77
  82. data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb +3 -14
  83. data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb +3 -14
  84. data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb +20 -1
  85. data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb +11 -153
  86. data/lib/metronome_sdk/models/v1/credit_grant_list_response.rb +14 -175
  87. data/lib/metronome_sdk/models/v1/credit_grant_void_response.rb +3 -14
  88. data/lib/metronome_sdk/models/v1/credit_ledger_entry.rb +69 -0
  89. data/lib/metronome_sdk/models/v1/customer.rb +53 -0
  90. data/lib/metronome_sdk/models/v1/customer_archive_params.rb +2 -8
  91. data/lib/metronome_sdk/models/v1/customer_archive_response.rb +3 -14
  92. data/lib/metronome_sdk/models/v1/customer_create_response.rb +3 -50
  93. data/lib/metronome_sdk/models/v1/{customer_list_response.rb → customer_detail.rb} +14 -15
  94. data/lib/metronome_sdk/models/v1/customer_list_billable_metrics_response.rb +6 -86
  95. data/lib/metronome_sdk/models/v1/customer_preview_events_params.rb +115 -0
  96. data/lib/metronome_sdk/models/v1/customer_preview_events_response.rb +18 -0
  97. data/lib/metronome_sdk/models/v1/customer_retrieve_response.rb +3 -126
  98. data/lib/metronome_sdk/models/v1/customer_set_name_response.rb +3 -50
  99. data/lib/metronome_sdk/models/v1/customers/alert_list_response.rb +5 -276
  100. data/lib/metronome_sdk/models/v1/customers/alert_retrieve_response.rb +3 -279
  101. data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb +9 -1
  102. data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb +8 -6
  103. data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb +3 -14
  104. data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb +9 -1
  105. data/lib/metronome_sdk/models/v1/customers/commit_list_response.rb +3 -1047
  106. data/lib/metronome_sdk/models/v1/customers/commit_update_end_date_response.rb +3 -14
  107. data/lib/metronome_sdk/models/v1/customers/credit_create_response.rb +3 -14
  108. data/lib/metronome_sdk/models/v1/customers/credit_list_params.rb +9 -1
  109. data/lib/metronome_sdk/models/v1/customers/credit_list_response.rb +3 -593
  110. data/lib/metronome_sdk/models/v1/customers/credit_update_end_date_response.rb +3 -14
  111. data/lib/metronome_sdk/models/v1/customers/customer_alert.rb +270 -0
  112. data/lib/metronome_sdk/models/v1/customers/{invoice_list_response.rb → invoice.rb} +119 -303
  113. data/lib/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rb +2 -1271
  114. data/lib/metronome_sdk/models/v1/customers/invoice_retrieve_response.rb +3 -1276
  115. data/lib/metronome_sdk/models/v1/customers/plan_add_response.rb +3 -14
  116. data/lib/metronome_sdk/models/v1/customers/plan_list_response.rb +3 -21
  117. data/lib/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rb +1 -0
  118. data/lib/metronome_sdk/models/v1/plan_detail.rb +200 -0
  119. data/lib/metronome_sdk/models/v1/plan_get_details_response.rb +3 -286
  120. data/lib/metronome_sdk/models/v1/plan_list_charges_response.rb +3 -20
  121. data/lib/metronome_sdk/models/v1/plan_list_customers_response.rb +3 -128
  122. data/lib/metronome_sdk/models/v1/rollover_amount_max_amount.rb +38 -0
  123. data/lib/metronome_sdk/models/v1/rollover_amount_max_percentage.rb +38 -0
  124. data/lib/metronome_sdk/models/v1/usage_search_params.rb +24 -0
  125. data/lib/metronome_sdk/models/v1/usage_search_response.rb +249 -0
  126. data/lib/metronome_sdk/models/v2/contract_edit_commit_params.rb +11 -8
  127. data/lib/metronome_sdk/models/v2/contract_edit_commit_response.rb +3 -14
  128. data/lib/metronome_sdk/models/v2/contract_edit_credit_params.rb +3 -2
  129. data/lib/metronome_sdk/models/v2/contract_edit_credit_response.rb +3 -14
  130. data/lib/metronome_sdk/models/v2/contract_edit_params.rb +1127 -105
  131. data/lib/metronome_sdk/models/v2/contract_edit_response.rb +3 -14
  132. data/lib/metronome_sdk/models/v2/contract_get_edit_history_response.rb +577 -643
  133. data/lib/metronome_sdk/models/v2/contract_list_response.rb +917 -746
  134. data/lib/metronome_sdk/models/v2/contract_retrieve_response.rb +917 -748
  135. data/lib/metronome_sdk/models.rb +36 -4
  136. data/lib/metronome_sdk/resources/v1/alerts.rb +1 -1
  137. data/lib/metronome_sdk/resources/v1/billable_metrics.rb +2 -2
  138. data/lib/metronome_sdk/resources/v1/contracts/products.rb +4 -4
  139. data/lib/metronome_sdk/resources/v1/contracts/rate_cards/rates.rb +1 -1
  140. data/lib/metronome_sdk/resources/v1/contracts.rb +11 -5
  141. data/lib/metronome_sdk/resources/v1/credit_grants.rb +4 -2
  142. data/lib/metronome_sdk/resources/v1/customers/commits.rb +5 -3
  143. data/lib/metronome_sdk/resources/v1/customers/credits.rb +3 -1
  144. data/lib/metronome_sdk/resources/v1/customers/invoices.rb +2 -2
  145. data/lib/metronome_sdk/resources/v1/customers.rb +40 -2
  146. data/lib/metronome_sdk/resources/v1/usage.rb +25 -0
  147. data/lib/metronome_sdk/resources/v2/contracts.rb +11 -9
  148. data/lib/metronome_sdk/version.rb +1 -1
  149. data/lib/metronome_sdk.rb +31 -2
  150. data/rbi/metronome_sdk/errors.rbi +16 -0
  151. data/rbi/metronome_sdk/internal/type/boolean.rbi +2 -0
  152. data/rbi/metronome_sdk/internal/type/converter.rbi +15 -15
  153. data/rbi/metronome_sdk/internal/type/union.rbi +5 -0
  154. data/rbi/metronome_sdk/internal/type/unknown.rbi +2 -0
  155. data/rbi/metronome_sdk/internal/util.rbi +2 -0
  156. data/rbi/metronome_sdk/models/base_usage_filter.rbi +46 -0
  157. data/rbi/metronome_sdk/models/commit.rbi +2046 -0
  158. data/rbi/metronome_sdk/models/contract_without_amendments.rbi +4260 -0
  159. data/rbi/metronome_sdk/models/credit.rbi +1314 -0
  160. data/rbi/metronome_sdk/models/credit_type_data.rbi +26 -0
  161. data/rbi/metronome_sdk/models/discount.rbi +106 -0
  162. data/rbi/metronome_sdk/models/event_type_filter.rbi +57 -0
  163. data/rbi/metronome_sdk/models/id.rbi +23 -0
  164. data/rbi/metronome_sdk/models/override.rbi +675 -0
  165. data/rbi/metronome_sdk/models/pro_service.rbi +98 -0
  166. data/rbi/metronome_sdk/models/property_filter.rbi +88 -0
  167. data/rbi/metronome_sdk/models/rate.rbi +155 -0
  168. data/rbi/metronome_sdk/models/schedule_duration.rbi +89 -0
  169. data/rbi/metronome_sdk/models/schedule_point_in_time.rbi +121 -0
  170. data/rbi/metronome_sdk/models/scheduled_charge.rbi +119 -0
  171. data/rbi/metronome_sdk/models/tier.rbi +29 -0
  172. data/rbi/metronome_sdk/models/v1/alert_archive_response.rbi +4 -37
  173. data/rbi/metronome_sdk/models/v1/alert_create_params.rbi +6 -0
  174. data/rbi/metronome_sdk/models/v1/alert_create_response.rbi +4 -37
  175. data/rbi/metronome_sdk/models/v1/billable_metric_archive_params.rbi +6 -12
  176. data/rbi/metronome_sdk/models/v1/billable_metric_archive_response.rbi +4 -44
  177. data/rbi/metronome_sdk/models/v1/billable_metric_create_params.rbi +8 -177
  178. data/rbi/metronome_sdk/models/v1/billable_metric_create_response.rbi +4 -43
  179. data/rbi/metronome_sdk/models/v1/billable_metric_list_response.rbi +8 -177
  180. data/rbi/metronome_sdk/models/v1/billable_metric_retrieve_response.rbi +8 -175
  181. data/rbi/metronome_sdk/models/v1/contract_amend_params.rbi +712 -68
  182. data/rbi/metronome_sdk/models/v1/contract_amend_response.rbi +4 -37
  183. data/rbi/metronome_sdk/models/v1/contract_archive_response.rbi +4 -39
  184. data/rbi/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbi +3 -2595
  185. data/rbi/metronome_sdk/models/v1/contract_create_params.rbi +1738 -210
  186. data/rbi/metronome_sdk/models/v1/contract_create_response.rbi +4 -37
  187. data/rbi/metronome_sdk/models/v1/contract_list_balances_params.rbi +11 -0
  188. data/rbi/metronome_sdk/models/v1/contract_list_balances_response.rbi +3 -3366
  189. data/rbi/metronome_sdk/models/v1/contract_list_response.rbi +375 -22523
  190. data/rbi/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbi +12 -632
  191. data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi +375 -22523
  192. data/rbi/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbi +3 -2595
  193. data/rbi/metronome_sdk/models/v1/contract_update_end_date_response.rbi +4 -44
  194. data/rbi/metronome_sdk/models/v1/contracts/product_archive_response.rbi +4 -44
  195. data/rbi/metronome_sdk/models/v1/contracts/product_create_params.rbi +8 -209
  196. data/rbi/metronome_sdk/models/v1/contracts/product_create_response.rbi +4 -44
  197. data/rbi/metronome_sdk/models/v1/contracts/product_list_item_state.rbi +237 -0
  198. data/rbi/metronome_sdk/models/v1/contracts/product_list_response.rbi +76 -1143
  199. data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_params.rbi +3 -9
  200. data/rbi/metronome_sdk/models/v1/contracts/product_retrieve_response.rbi +76 -1137
  201. data/rbi/metronome_sdk/models/v1/contracts/product_update_params.rbi +8 -209
  202. data/rbi/metronome_sdk/models/v1/contracts/product_update_response.rbi +4 -44
  203. data/rbi/metronome_sdk/models/v1/contracts/quantity_conversion.rbi +111 -0
  204. data/rbi/metronome_sdk/models/v1/contracts/quantity_rounding.rbi +94 -0
  205. data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbi +3 -9
  206. data/rbi/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbi +4 -44
  207. data/rbi/metronome_sdk/models/v1/contracts/rate_card_create_response.rbi +4 -44
  208. data/rbi/metronome_sdk/models/v1/contracts/rate_card_list_response.rbi +8 -74
  209. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbi +3 -9
  210. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi +8 -344
  211. data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbi +8 -74
  212. data/rbi/metronome_sdk/models/v1/contracts/rate_card_update_response.rbi +4 -44
  213. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbi +4 -44
  214. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbi +4 -44
  215. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbi +8 -108
  216. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbi +4 -45
  217. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi +8 -108
  218. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi +12 -149
  219. data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbi +8 -344
  220. data/rbi/metronome_sdk/models/v1/credit_grant_create_params.rbi +8 -166
  221. data/rbi/metronome_sdk/models/v1/credit_grant_create_response.rbi +4 -41
  222. data/rbi/metronome_sdk/models/v1/credit_grant_edit_response.rbi +4 -39
  223. data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi +58 -0
  224. data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi +10 -231
  225. data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi +14 -281
  226. data/rbi/metronome_sdk/models/v1/credit_grant_void_response.rbi +4 -39
  227. data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi +90 -0
  228. data/rbi/metronome_sdk/models/v1/customer.rbi +74 -0
  229. data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi +6 -12
  230. data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi +4 -39
  231. data/rbi/metronome_sdk/models/v1/customer_create_response.rbi +6 -84
  232. data/rbi/metronome_sdk/models/v1/{customer_list_response.rbi → customer_detail.rbi} +19 -26
  233. data/rbi/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbi +8 -177
  234. data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi +214 -0
  235. data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi +35 -0
  236. data/rbi/metronome_sdk/models/v1/customer_retrieve_response.rbi +6 -255
  237. data/rbi/metronome_sdk/models/v1/customer_set_name_response.rbi +6 -86
  238. data/rbi/metronome_sdk/models/v1/customers/alert_list_response.rbi +3 -623
  239. data/rbi/metronome_sdk/models/v1/customers/alert_retrieve_response.rbi +4 -622
  240. data/rbi/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbi +11 -0
  241. data/rbi/metronome_sdk/models/v1/customers/commit_create_params.rbi +12 -8
  242. data/rbi/metronome_sdk/models/v1/customers/commit_create_response.rbi +4 -44
  243. data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi +11 -0
  244. data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi +3 -2164
  245. data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbi +4 -44
  246. data/rbi/metronome_sdk/models/v1/customers/credit_create_response.rbi +4 -44
  247. data/rbi/metronome_sdk/models/v1/customers/credit_list_params.rbi +11 -0
  248. data/rbi/metronome_sdk/models/v1/customers/credit_list_response.rbi +3 -1224
  249. data/rbi/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbi +4 -44
  250. data/rbi/metronome_sdk/models/v1/customers/customer_alert.rbi +572 -0
  251. data/rbi/metronome_sdk/models/v1/customers/{invoice_list_response.rbi → invoice.rbi} +182 -589
  252. data/rbi/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbi +4 -2561
  253. data/rbi/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbi +6 -2612
  254. data/rbi/metronome_sdk/models/v1/customers/plan_add_response.rbi +4 -41
  255. data/rbi/metronome_sdk/models/v1/customers/plan_list_response.rbi +4 -39
  256. data/rbi/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbi +5 -0
  257. data/rbi/metronome_sdk/models/v1/plan_detail.rbi +349 -0
  258. data/rbi/metronome_sdk/models/v1/plan_get_details_response.rbi +6 -560
  259. data/rbi/metronome_sdk/models/v1/plan_list_charges_response.rbi +4 -37
  260. data/rbi/metronome_sdk/models/v1/plan_list_customers_response.rbi +4 -248
  261. data/rbi/metronome_sdk/models/v1/rollover_amount_max_amount.rbi +79 -0
  262. data/rbi/metronome_sdk/models/v1/rollover_amount_max_percentage.rbi +80 -0
  263. data/rbi/metronome_sdk/models/v1/usage_search_params.rbi +48 -0
  264. data/rbi/metronome_sdk/models/v1/usage_search_response.rbi +438 -0
  265. data/rbi/metronome_sdk/models/v2/contract_edit_commit_params.rbi +23 -23
  266. data/rbi/metronome_sdk/models/v2/contract_edit_commit_response.rbi +4 -41
  267. data/rbi/metronome_sdk/models/v2/contract_edit_credit_params.rbi +11 -15
  268. data/rbi/metronome_sdk/models/v2/contract_edit_credit_response.rbi +4 -41
  269. data/rbi/metronome_sdk/models/v2/contract_edit_params.rbi +2463 -206
  270. data/rbi/metronome_sdk/models/v2/contract_edit_response.rbi +4 -37
  271. data/rbi/metronome_sdk/models/v2/contract_get_edit_history_response.rbi +1381 -1550
  272. data/rbi/metronome_sdk/models/v2/contract_list_response.rbi +2017 -1466
  273. data/rbi/metronome_sdk/models/v2/contract_retrieve_response.rbi +2017 -1466
  274. data/rbi/metronome_sdk/models.rbi +32 -0
  275. data/rbi/metronome_sdk/resources/v1/alerts.rbi +3 -0
  276. data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi +2 -6
  277. data/rbi/metronome_sdk/resources/v1/contracts/products.rbi +4 -4
  278. data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbi +1 -4
  279. data/rbi/metronome_sdk/resources/v1/contracts.rbi +13 -4
  280. data/rbi/metronome_sdk/resources/v1/credit_grants.rbi +4 -0
  281. data/rbi/metronome_sdk/resources/v1/customers/commits.rbi +9 -4
  282. data/rbi/metronome_sdk/resources/v1/customers/credits.rbi +3 -0
  283. data/rbi/metronome_sdk/resources/v1/customers/invoices.rbi +1 -1
  284. data/rbi/metronome_sdk/resources/v1/customers.rbi +34 -3
  285. data/rbi/metronome_sdk/resources/v1/usage.rbi +17 -0
  286. data/rbi/metronome_sdk/resources/v2/contracts.rbi +24 -14
  287. data/sig/metronome_sdk/errors.rbs +9 -0
  288. data/sig/metronome_sdk/internal/type/converter.rbs +7 -1
  289. data/sig/metronome_sdk/models/base_usage_filter.rbs +28 -0
  290. data/sig/metronome_sdk/models/commit.rbs +1063 -0
  291. data/sig/metronome_sdk/models/contract_without_amendments.rbs +1828 -0
  292. data/sig/metronome_sdk/models/credit.rbs +686 -0
  293. data/sig/metronome_sdk/models/credit_type_data.rbs +15 -0
  294. data/sig/metronome_sdk/models/discount.rbs +63 -0
  295. data/sig/metronome_sdk/models/event_type_filter.rbs +26 -0
  296. data/sig/metronome_sdk/models/id.rbs +13 -0
  297. data/sig/metronome_sdk/models/override.rbs +399 -0
  298. data/sig/metronome_sdk/models/pro_service.rbs +61 -0
  299. data/sig/metronome_sdk/models/property_filter.rbs +41 -0
  300. data/sig/metronome_sdk/models/rate.rbs +94 -0
  301. data/sig/metronome_sdk/models/schedule_duration.rbs +56 -0
  302. data/sig/metronome_sdk/models/schedule_point_in_time.rbs +75 -0
  303. data/sig/metronome_sdk/models/scheduled_charge.rbs +70 -0
  304. data/sig/metronome_sdk/models/tier.rbs +17 -0
  305. data/sig/metronome_sdk/models/v1/alert_archive_response.rbs +4 -19
  306. data/sig/metronome_sdk/models/v1/alert_create_response.rbs +4 -19
  307. data/sig/metronome_sdk/models/v1/billable_metric_archive_params.rbs +4 -12
  308. data/sig/metronome_sdk/models/v1/billable_metric_archive_response.rbs +4 -19
  309. data/sig/metronome_sdk/models/v1/billable_metric_create_params.rbs +12 -73
  310. data/sig/metronome_sdk/models/v1/billable_metric_create_response.rbs +4 -19
  311. data/sig/metronome_sdk/models/v1/billable_metric_list_response.rbs +12 -73
  312. data/sig/metronome_sdk/models/v1/billable_metric_retrieve_response.rbs +12 -73
  313. data/sig/metronome_sdk/models/v1/contract_amend_params.rbs +291 -24
  314. data/sig/metronome_sdk/models/v1/contract_amend_response.rbs +4 -19
  315. data/sig/metronome_sdk/models/v1/contract_archive_response.rbs +4 -19
  316. data/sig/metronome_sdk/models/v1/contract_create_historical_invoices_response.rbs +4 -1291
  317. data/sig/metronome_sdk/models/v1/contract_create_params.rbs +694 -84
  318. data/sig/metronome_sdk/models/v1/contract_create_response.rbs +4 -19
  319. data/sig/metronome_sdk/models/v1/contract_list_balances_params.rbs +7 -0
  320. data/sig/metronome_sdk/models/v1/contract_list_balances_response.rbs +1 -1642
  321. data/sig/metronome_sdk/models/v1/contract_list_response.rbs +188 -10437
  322. data/sig/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rbs +15 -271
  323. data/sig/metronome_sdk/models/v1/contract_retrieve_response.rbs +188 -10437
  324. data/sig/metronome_sdk/models/v1/contract_schedule_pro_services_invoice_response.rbs +4 -1291
  325. data/sig/metronome_sdk/models/v1/contract_update_end_date_response.rbs +4 -19
  326. data/sig/metronome_sdk/models/v1/contracts/product_archive_response.rbs +4 -21
  327. data/sig/metronome_sdk/models/v1/contracts/product_create_params.rbs +8 -82
  328. data/sig/metronome_sdk/models/v1/contracts/product_create_response.rbs +4 -21
  329. data/sig/metronome_sdk/models/v1/contracts/product_list_item_state.rbs +121 -0
  330. data/sig/metronome_sdk/models/v1/contracts/product_list_response.rbs +16 -466
  331. data/sig/metronome_sdk/models/v1/contracts/product_retrieve_params.rbs +4 -12
  332. data/sig/metronome_sdk/models/v1/contracts/product_retrieve_response.rbs +16 -466
  333. data/sig/metronome_sdk/models/v1/contracts/product_update_params.rbs +8 -82
  334. data/sig/metronome_sdk/models/v1/contracts/product_update_response.rbs +4 -21
  335. data/sig/metronome_sdk/models/v1/contracts/quantity_conversion.rbs +47 -0
  336. data/sig/metronome_sdk/models/v1/contracts/quantity_rounding.rbs +41 -0
  337. data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_params.rbs +4 -12
  338. data/sig/metronome_sdk/models/v1/contracts/rate_card_archive_response.rbs +4 -21
  339. data/sig/metronome_sdk/models/v1/contracts/rate_card_create_response.rbs +4 -21
  340. data/sig/metronome_sdk/models/v1/contracts/rate_card_list_response.rbs +10 -34
  341. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rbs +4 -12
  342. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbs +10 -144
  343. data/sig/metronome_sdk/models/v1/contracts/rate_card_retrieve_response.rbs +10 -34
  344. data/sig/metronome_sdk/models/v1/contracts/rate_card_update_response.rbs +4 -21
  345. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rbs +4 -21
  346. data/sig/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rbs +4 -21
  347. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rbs +12 -40
  348. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rbs +4 -21
  349. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbs +12 -40
  350. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbs +18 -58
  351. data/sig/metronome_sdk/models/v1/contracts/rate_cards/rate_list_response.rbs +10 -144
  352. data/sig/metronome_sdk/models/v1/credit_grant_create_params.rbs +2 -66
  353. data/sig/metronome_sdk/models/v1/credit_grant_create_response.rbs +4 -19
  354. data/sig/metronome_sdk/models/v1/credit_grant_edit_response.rbs +4 -19
  355. data/sig/metronome_sdk/models/v1/credit_grant_list_entries_params.rbs +20 -0
  356. data/sig/metronome_sdk/models/v1/credit_grant_list_entries_response.rbs +12 -118
  357. data/sig/metronome_sdk/models/v1/credit_grant_list_response.rbs +16 -140
  358. data/sig/metronome_sdk/models/v1/credit_grant_void_response.rbs +4 -19
  359. data/sig/metronome_sdk/models/v1/credit_ledger_entry.rbs +52 -0
  360. data/sig/metronome_sdk/models/v1/customer.rbs +44 -0
  361. data/sig/metronome_sdk/models/v1/customer_archive_params.rbs +4 -12
  362. data/sig/metronome_sdk/models/v1/customer_archive_response.rbs +4 -19
  363. data/sig/metronome_sdk/models/v1/customer_create_response.rbs +4 -48
  364. data/sig/metronome_sdk/models/v1/{customer_list_response.rbs → customer_detail.rbs} +17 -17
  365. data/sig/metronome_sdk/models/v1/customer_list_billable_metrics_response.rbs +12 -73
  366. data/sig/metronome_sdk/models/v1/customer_preview_events_params.rbs +105 -0
  367. data/sig/metronome_sdk/models/v1/customer_preview_events_response.rbs +16 -0
  368. data/sig/metronome_sdk/models/v1/customer_retrieve_response.rbs +4 -112
  369. data/sig/metronome_sdk/models/v1/customer_set_name_response.rbs +4 -48
  370. data/sig/metronome_sdk/models/v1/customers/alert_list_response.rbs +4 -243
  371. data/sig/metronome_sdk/models/v1/customers/alert_retrieve_response.rbs +4 -247
  372. data/sig/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rbs +7 -0
  373. data/sig/metronome_sdk/models/v1/customers/commit_create_response.rbs +4 -21
  374. data/sig/metronome_sdk/models/v1/customers/commit_list_params.rbs +7 -0
  375. data/sig/metronome_sdk/models/v1/customers/commit_list_response.rbs +4 -1057
  376. data/sig/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbs +4 -21
  377. data/sig/metronome_sdk/models/v1/customers/credit_create_response.rbs +4 -21
  378. data/sig/metronome_sdk/models/v1/customers/credit_list_params.rbs +7 -0
  379. data/sig/metronome_sdk/models/v1/customers/credit_list_response.rbs +4 -596
  380. data/sig/metronome_sdk/models/v1/customers/credit_update_end_date_response.rbs +4 -21
  381. data/sig/metronome_sdk/models/v1/customers/customer_alert.rbs +234 -0
  382. data/sig/metronome_sdk/models/v1/customers/{invoice_list_response.rbs → invoice.rbs} +147 -305
  383. data/sig/metronome_sdk/models/v1/customers/invoice_list_breakdowns_response.rbs +8 -1278
  384. data/sig/metronome_sdk/models/v1/customers/invoice_retrieve_response.rbs +4 -1294
  385. data/sig/metronome_sdk/models/v1/customers/plan_add_response.rbs +4 -19
  386. data/sig/metronome_sdk/models/v1/customers/plan_list_response.rbs +4 -16
  387. data/sig/metronome_sdk/models/v1/dashboard_get_embeddable_url_params.rbs +2 -1
  388. data/sig/metronome_sdk/models/v1/plan_detail.rbs +203 -0
  389. data/sig/metronome_sdk/models/v1/plan_get_details_response.rbs +4 -267
  390. data/sig/metronome_sdk/models/v1/plan_list_charges_response.rbs +4 -16
  391. data/sig/metronome_sdk/models/v1/plan_list_customers_response.rbs +4 -108
  392. data/sig/metronome_sdk/models/v1/rollover_amount_max_amount.rbs +37 -0
  393. data/sig/metronome_sdk/models/v1/rollover_amount_max_percentage.rbs +37 -0
  394. data/sig/metronome_sdk/models/v1/usage_search_params.rbs +26 -0
  395. data/sig/metronome_sdk/models/v1/usage_search_response.rbs +230 -0
  396. data/sig/metronome_sdk/models/v2/contract_edit_commit_params.rbs +4 -8
  397. data/sig/metronome_sdk/models/v2/contract_edit_commit_response.rbs +4 -19
  398. data/sig/metronome_sdk/models/v2/contract_edit_credit_params.rbs +4 -8
  399. data/sig/metronome_sdk/models/v2/contract_edit_credit_response.rbs +4 -19
  400. data/sig/metronome_sdk/models/v2/contract_edit_params.rbs +989 -77
  401. data/sig/metronome_sdk/models/v2/contract_edit_response.rbs +4 -19
  402. data/sig/metronome_sdk/models/v2/contract_get_edit_history_response.rbs +510 -655
  403. data/sig/metronome_sdk/models/v2/contract_list_response.rbs +970 -809
  404. data/sig/metronome_sdk/models/v2/contract_retrieve_response.rbs +970 -809
  405. data/sig/metronome_sdk/models.rbs +32 -0
  406. data/sig/metronome_sdk/resources/v1/billable_metrics.rbs +2 -2
  407. data/sig/metronome_sdk/resources/v1/contracts/products.rbs +4 -4
  408. data/sig/metronome_sdk/resources/v1/contracts/rate_cards/rates.rbs +1 -1
  409. data/sig/metronome_sdk/resources/v1/contracts.rbs +4 -1
  410. data/sig/metronome_sdk/resources/v1/credit_grants.rbs +1 -0
  411. data/sig/metronome_sdk/resources/v1/customers/commits.rbs +1 -0
  412. data/sig/metronome_sdk/resources/v1/customers/credits.rbs +1 -0
  413. data/sig/metronome_sdk/resources/v1/customers/invoices.rbs +1 -1
  414. data/sig/metronome_sdk/resources/v1/customers.rbs +9 -1
  415. data/sig/metronome_sdk/resources/v1/usage.rbs +5 -0
  416. data/sig/metronome_sdk/resources/v2/contracts.rbs +3 -2
  417. metadata +97 -10
@@ -8,9 +8,8 @@ module MetronomeSDK
8
8
  class CreditListResponse < MetronomeSDK::Internal::Type::BaseModel
9
9
  # @!attribute data
10
10
  #
11
- # @return [Array<MetronomeSDK::Models::V1::Customers::CreditListResponse::Data>]
12
- required :data,
13
- -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::CreditListResponse::Data] }
11
+ # @return [Array<MetronomeSDK::Models::Credit>]
12
+ required :data, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Credit] }
14
13
 
15
14
  # @!attribute next_page
16
15
  #
@@ -18,597 +17,8 @@ module MetronomeSDK
18
17
  required :next_page, String, nil?: true
19
18
 
20
19
  # @!method initialize(data:, next_page:)
21
- # @param data [Array<MetronomeSDK::Models::V1::Customers::CreditListResponse::Data>]
20
+ # @param data [Array<MetronomeSDK::Models::Credit>]
22
21
  # @param next_page [String, nil]
23
-
24
- class Data < MetronomeSDK::Internal::Type::BaseModel
25
- # @!attribute id
26
- #
27
- # @return [String]
28
- required :id, String
29
-
30
- # @!attribute product
31
- #
32
- # @return [MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Product]
33
- required :product, -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Product }
34
-
35
- # @!attribute type
36
- #
37
- # @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Type]
38
- required :type, enum: -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Type }
39
-
40
- # @!attribute access_schedule
41
- # The schedule that the customer will gain access to the credits.
42
- #
43
- # @return [MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule, nil]
44
- optional :access_schedule,
45
- -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule }
46
-
47
- # @!attribute applicable_contract_ids
48
- #
49
- # @return [Array<String>, nil]
50
- optional :applicable_contract_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
51
-
52
- # @!attribute applicable_product_ids
53
- #
54
- # @return [Array<String>, nil]
55
- optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
56
-
57
- # @!attribute applicable_product_tags
58
- #
59
- # @return [Array<String>, nil]
60
- optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
61
-
62
- # @!attribute balance
63
- # The current balance of the credit or commit. This balance reflects the amount of
64
- # credit or commit that the customer has access to use at this moment - thus,
65
- # expired and upcoming credit or commit segments contribute 0 to the balance. The
66
- # balance will match the sum of all ledger entries with the exception of the case
67
- # where the sum of negative manual ledger entries exceeds the positive amount
68
- # remaining on the credit or commit - in that case, the balance will be 0. All
69
- # manual ledger entries associated with active credit or commit segments are
70
- # included in the balance, including future-dated manual ledger entries.
71
- #
72
- # @return [Float, nil]
73
- optional :balance, Float
74
-
75
- # @!attribute contract
76
- #
77
- # @return [MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Contract, nil]
78
- optional :contract, -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Contract }
79
-
80
- # @!attribute custom_fields
81
- #
82
- # @return [Hash{Symbol=>String}, nil]
83
- optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
84
-
85
- # @!attribute description
86
- #
87
- # @return [String, nil]
88
- optional :description, String
89
-
90
- # @!attribute ledger
91
- # A list of ordered events that impact the balance of a credit. For example, an
92
- # invoice deduction or an expiration.
93
- #
94
- # @return [Array<MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember0, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember1, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember2, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember3, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember4, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember5>, nil]
95
- optional :ledger,
96
- -> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger] }
97
-
98
- # @!attribute name
99
- #
100
- # @return [String, nil]
101
- optional :name, String
102
-
103
- # @!attribute netsuite_sales_order_id
104
- # This field's availability is dependent on your client's configuration.
105
- #
106
- # @return [String, nil]
107
- optional :netsuite_sales_order_id, String
108
-
109
- # @!attribute priority
110
- # If multiple credits or commits are applicable, the one with the lower priority
111
- # will apply first.
112
- #
113
- # @return [Float, nil]
114
- optional :priority, Float
115
-
116
- # @!attribute rate_type
117
- #
118
- # @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::RateType, nil]
119
- optional :rate_type, enum: -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::RateType }
120
-
121
- # @!attribute salesforce_opportunity_id
122
- # This field's availability is dependent on your client's configuration.
123
- #
124
- # @return [String, nil]
125
- optional :salesforce_opportunity_id, String
126
-
127
- # @!attribute specifiers
128
- # List of filters that determine what kind of customer usage draws down a commit
129
- # or credit. A customer's usage needs to meet the condition of at least one of the
130
- # specifiers to contribute to a commit's or credit's drawdown.
131
- #
132
- # @return [Array<MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Specifier>, nil]
133
- optional :specifiers,
134
- -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Specifier] }
135
-
136
- # @!attribute uniqueness_key
137
- # Prevents the creation of duplicates. If a request to create a commit or credit
138
- # is made with a uniqueness key that was previously used to create a commit or
139
- # credit, a new record will not be created and the request will fail with a 409
140
- # error.
141
- #
142
- # @return [String, nil]
143
- optional :uniqueness_key, String
144
-
145
- # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, salesforce_opportunity_id: nil, specifiers: nil, uniqueness_key: nil)
146
- # Some parameter documentations has been truncated, see
147
- # {MetronomeSDK::Models::V1::Customers::CreditListResponse::Data} for more
148
- # details.
149
- #
150
- # @param id [String]
151
- #
152
- # @param product [MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Product]
153
- #
154
- # @param type [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Type]
155
- #
156
- # @param access_schedule [MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule] The schedule that the customer will gain access to the credits.
157
- #
158
- # @param applicable_contract_ids [Array<String>]
159
- #
160
- # @param applicable_product_ids [Array<String>]
161
- #
162
- # @param applicable_product_tags [Array<String>]
163
- #
164
- # @param balance [Float] The current balance of the credit or commit. This balance reflects the amount of
165
- #
166
- # @param contract [MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Contract]
167
- #
168
- # @param custom_fields [Hash{Symbol=>String}]
169
- #
170
- # @param description [String]
171
- #
172
- # @param ledger [Array<MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember0, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember1, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember2, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember3, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember4, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember5>] A list of ordered events that impact the balance of a credit. For example, an in
173
- #
174
- # @param name [String]
175
- #
176
- # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
177
- #
178
- # @param priority [Float] If multiple credits or commits are applicable, the one with the lower priority w
179
- #
180
- # @param rate_type [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::RateType]
181
- #
182
- # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
183
- #
184
- # @param specifiers [Array<MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
185
- #
186
- # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
187
-
188
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data#product
189
- class Product < MetronomeSDK::Internal::Type::BaseModel
190
- # @!attribute id
191
- #
192
- # @return [String]
193
- required :id, String
194
-
195
- # @!attribute name
196
- #
197
- # @return [String]
198
- required :name, String
199
-
200
- # @!method initialize(id:, name:)
201
- # @param id [String]
202
- # @param name [String]
203
- end
204
-
205
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data#type
206
- module Type
207
- extend MetronomeSDK::Internal::Type::Enum
208
-
209
- CREDIT = :CREDIT
210
-
211
- # @!method self.values
212
- # @return [Array<Symbol>]
213
- end
214
-
215
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data#access_schedule
216
- class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
217
- # @!attribute schedule_items
218
- #
219
- # @return [Array<MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule::ScheduleItem>]
220
- required :schedule_items,
221
- -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule::ScheduleItem] }
222
-
223
- # @!attribute credit_type
224
- #
225
- # @return [MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule::CreditType, nil]
226
- optional :credit_type,
227
- -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule::CreditType }
228
-
229
- # @!method initialize(schedule_items:, credit_type: nil)
230
- # The schedule that the customer will gain access to the credits.
231
- #
232
- # @param schedule_items [Array<MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule::ScheduleItem>]
233
- # @param credit_type [MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule::CreditType]
234
-
235
- class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
236
- # @!attribute id
237
- #
238
- # @return [String]
239
- required :id, String
240
-
241
- # @!attribute amount
242
- #
243
- # @return [Float]
244
- required :amount, Float
245
-
246
- # @!attribute ending_before
247
- #
248
- # @return [Time]
249
- required :ending_before, Time
250
-
251
- # @!attribute starting_at
252
- #
253
- # @return [Time]
254
- required :starting_at, Time
255
-
256
- # @!method initialize(id:, amount:, ending_before:, starting_at:)
257
- # @param id [String]
258
- # @param amount [Float]
259
- # @param ending_before [Time]
260
- # @param starting_at [Time]
261
- end
262
-
263
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::AccessSchedule#credit_type
264
- class CreditType < MetronomeSDK::Internal::Type::BaseModel
265
- # @!attribute id
266
- #
267
- # @return [String]
268
- required :id, String
269
-
270
- # @!attribute name
271
- #
272
- # @return [String]
273
- required :name, String
274
-
275
- # @!method initialize(id:, name:)
276
- # @param id [String]
277
- # @param name [String]
278
- end
279
- end
280
-
281
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data#contract
282
- class Contract < MetronomeSDK::Internal::Type::BaseModel
283
- # @!attribute id
284
- #
285
- # @return [String]
286
- required :id, String
287
-
288
- # @!method initialize(id:)
289
- # @param id [String]
290
- end
291
-
292
- module Ledger
293
- extend MetronomeSDK::Internal::Type::Union
294
-
295
- variant -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember0 }
296
-
297
- variant -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember1 }
298
-
299
- variant -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember2 }
300
-
301
- variant -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember3 }
302
-
303
- variant -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember4 }
304
-
305
- variant -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember5 }
306
-
307
- class UnionMember0 < MetronomeSDK::Internal::Type::BaseModel
308
- # @!attribute amount
309
- #
310
- # @return [Float]
311
- required :amount, Float
312
-
313
- # @!attribute segment_id
314
- #
315
- # @return [String]
316
- required :segment_id, String
317
-
318
- # @!attribute timestamp
319
- #
320
- # @return [Time]
321
- required :timestamp, Time
322
-
323
- # @!attribute type
324
- #
325
- # @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember0::Type]
326
- required :type,
327
- enum: -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember0::Type }
328
-
329
- # @!method initialize(amount:, segment_id:, timestamp:, type:)
330
- # @param amount [Float]
331
- # @param segment_id [String]
332
- # @param timestamp [Time]
333
- # @param type [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember0::Type]
334
-
335
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember0#type
336
- module Type
337
- extend MetronomeSDK::Internal::Type::Enum
338
-
339
- CREDIT_SEGMENT_START = :CREDIT_SEGMENT_START
340
-
341
- # @!method self.values
342
- # @return [Array<Symbol>]
343
- end
344
- end
345
-
346
- class UnionMember1 < MetronomeSDK::Internal::Type::BaseModel
347
- # @!attribute amount
348
- #
349
- # @return [Float]
350
- required :amount, Float
351
-
352
- # @!attribute invoice_id
353
- #
354
- # @return [String]
355
- required :invoice_id, String
356
-
357
- # @!attribute segment_id
358
- #
359
- # @return [String]
360
- required :segment_id, String
361
-
362
- # @!attribute timestamp
363
- #
364
- # @return [Time]
365
- required :timestamp, Time
366
-
367
- # @!attribute type
368
- #
369
- # @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember1::Type]
370
- required :type,
371
- enum: -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember1::Type }
372
-
373
- # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
374
- # @param amount [Float]
375
- # @param invoice_id [String]
376
- # @param segment_id [String]
377
- # @param timestamp [Time]
378
- # @param type [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember1::Type]
379
-
380
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember1#type
381
- module Type
382
- extend MetronomeSDK::Internal::Type::Enum
383
-
384
- CREDIT_AUTOMATED_INVOICE_DEDUCTION = :CREDIT_AUTOMATED_INVOICE_DEDUCTION
385
-
386
- # @!method self.values
387
- # @return [Array<Symbol>]
388
- end
389
- end
390
-
391
- class UnionMember2 < MetronomeSDK::Internal::Type::BaseModel
392
- # @!attribute amount
393
- #
394
- # @return [Float]
395
- required :amount, Float
396
-
397
- # @!attribute segment_id
398
- #
399
- # @return [String]
400
- required :segment_id, String
401
-
402
- # @!attribute timestamp
403
- #
404
- # @return [Time]
405
- required :timestamp, Time
406
-
407
- # @!attribute type
408
- #
409
- # @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember2::Type]
410
- required :type,
411
- enum: -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember2::Type }
412
-
413
- # @!method initialize(amount:, segment_id:, timestamp:, type:)
414
- # @param amount [Float]
415
- # @param segment_id [String]
416
- # @param timestamp [Time]
417
- # @param type [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember2::Type]
418
-
419
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember2#type
420
- module Type
421
- extend MetronomeSDK::Internal::Type::Enum
422
-
423
- CREDIT_EXPIRATION = :CREDIT_EXPIRATION
424
-
425
- # @!method self.values
426
- # @return [Array<Symbol>]
427
- end
428
- end
429
-
430
- class UnionMember3 < MetronomeSDK::Internal::Type::BaseModel
431
- # @!attribute amount
432
- #
433
- # @return [Float]
434
- required :amount, Float
435
-
436
- # @!attribute invoice_id
437
- #
438
- # @return [String]
439
- required :invoice_id, String
440
-
441
- # @!attribute segment_id
442
- #
443
- # @return [String]
444
- required :segment_id, String
445
-
446
- # @!attribute timestamp
447
- #
448
- # @return [Time]
449
- required :timestamp, Time
450
-
451
- # @!attribute type
452
- #
453
- # @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember3::Type]
454
- required :type,
455
- enum: -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember3::Type }
456
-
457
- # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
458
- # @param amount [Float]
459
- # @param invoice_id [String]
460
- # @param segment_id [String]
461
- # @param timestamp [Time]
462
- # @param type [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember3::Type]
463
-
464
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember3#type
465
- module Type
466
- extend MetronomeSDK::Internal::Type::Enum
467
-
468
- CREDIT_CANCELED = :CREDIT_CANCELED
469
-
470
- # @!method self.values
471
- # @return [Array<Symbol>]
472
- end
473
- end
474
-
475
- class UnionMember4 < MetronomeSDK::Internal::Type::BaseModel
476
- # @!attribute amount
477
- #
478
- # @return [Float]
479
- required :amount, Float
480
-
481
- # @!attribute invoice_id
482
- #
483
- # @return [String]
484
- required :invoice_id, String
485
-
486
- # @!attribute segment_id
487
- #
488
- # @return [String]
489
- required :segment_id, String
490
-
491
- # @!attribute timestamp
492
- #
493
- # @return [Time]
494
- required :timestamp, Time
495
-
496
- # @!attribute type
497
- #
498
- # @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember4::Type]
499
- required :type,
500
- enum: -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember4::Type }
501
-
502
- # @!method initialize(amount:, invoice_id:, segment_id:, timestamp:, type:)
503
- # @param amount [Float]
504
- # @param invoice_id [String]
505
- # @param segment_id [String]
506
- # @param timestamp [Time]
507
- # @param type [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember4::Type]
508
-
509
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember4#type
510
- module Type
511
- extend MetronomeSDK::Internal::Type::Enum
512
-
513
- CREDIT_CREDITED = :CREDIT_CREDITED
514
-
515
- # @!method self.values
516
- # @return [Array<Symbol>]
517
- end
518
- end
519
-
520
- class UnionMember5 < MetronomeSDK::Internal::Type::BaseModel
521
- # @!attribute amount
522
- #
523
- # @return [Float]
524
- required :amount, Float
525
-
526
- # @!attribute reason
527
- #
528
- # @return [String]
529
- required :reason, String
530
-
531
- # @!attribute timestamp
532
- #
533
- # @return [Time]
534
- required :timestamp, Time
535
-
536
- # @!attribute type
537
- #
538
- # @return [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember5::Type]
539
- required :type,
540
- enum: -> { MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember5::Type }
541
-
542
- # @!method initialize(amount:, reason:, timestamp:, type:)
543
- # @param amount [Float]
544
- # @param reason [String]
545
- # @param timestamp [Time]
546
- # @param type [Symbol, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember5::Type]
547
-
548
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember5#type
549
- module Type
550
- extend MetronomeSDK::Internal::Type::Enum
551
-
552
- CREDIT_MANUAL = :CREDIT_MANUAL
553
-
554
- # @!method self.values
555
- # @return [Array<Symbol>]
556
- end
557
- end
558
-
559
- # @!method self.variants
560
- # @return [Array(MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember0, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember1, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember2, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember3, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember4, MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Ledger::UnionMember5)]
561
- end
562
-
563
- # @see MetronomeSDK::Models::V1::Customers::CreditListResponse::Data#rate_type
564
- module RateType
565
- extend MetronomeSDK::Internal::Type::Enum
566
-
567
- COMMIT_RATE = :COMMIT_RATE
568
- LIST_RATE = :LIST_RATE
569
-
570
- # @!method self.values
571
- # @return [Array<Symbol>]
572
- end
573
-
574
- class Specifier < MetronomeSDK::Internal::Type::BaseModel
575
- # @!attribute presentation_group_values
576
- #
577
- # @return [Hash{Symbol=>String}, nil]
578
- optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
579
-
580
- # @!attribute pricing_group_values
581
- #
582
- # @return [Hash{Symbol=>String}, nil]
583
- optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
584
-
585
- # @!attribute product_id
586
- # If provided, the specifier will only apply to the product with the specified ID.
587
- #
588
- # @return [String, nil]
589
- optional :product_id, String
590
-
591
- # @!attribute product_tags
592
- # If provided, the specifier will only apply to products with all the specified
593
- # tags.
594
- #
595
- # @return [Array<String>, nil]
596
- optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
597
-
598
- # @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
599
- # Some parameter documentations has been truncated, see
600
- # {MetronomeSDK::Models::V1::Customers::CreditListResponse::Data::Specifier} for
601
- # more details.
602
- #
603
- # @param presentation_group_values [Hash{Symbol=>String}]
604
- #
605
- # @param pricing_group_values [Hash{Symbol=>String}]
606
- #
607
- # @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
608
- #
609
- # @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
610
- end
611
- end
612
22
  end
613
23
  end
614
24
  end
@@ -8,22 +8,11 @@ module MetronomeSDK
8
8
  class CreditUpdateEndDateResponse < MetronomeSDK::Internal::Type::BaseModel
9
9
  # @!attribute data
10
10
  #
11
- # @return [MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateResponse::Data]
12
- required :data, -> { MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateResponse::Data }
11
+ # @return [MetronomeSDK::Models::ID]
12
+ required :data, -> { MetronomeSDK::ID }
13
13
 
14
14
  # @!method initialize(data:)
15
- # @param data [MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateResponse::Data]
16
-
17
- # @see MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateResponse#data
18
- class Data < MetronomeSDK::Internal::Type::BaseModel
19
- # @!attribute id
20
- #
21
- # @return [String]
22
- required :id, String
23
-
24
- # @!method initialize(id:)
25
- # @param id [String]
26
- end
15
+ # @param data [MetronomeSDK::Models::ID]
27
16
  end
28
17
  end
29
18
  end