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
@@ -5,7 +5,12 @@ module MetronomeSDK
5
5
  module V1
6
6
  module Customers
7
7
  # @see MetronomeSDK::Resources::V1::Customers::Invoices#list_breakdowns
8
- class InvoiceListBreakdownsResponse < MetronomeSDK::Models::V1::Customers::Invoice
8
+ class InvoiceListBreakdownsResponse < MetronomeSDK::Internal::Type::BaseModel
9
+ # @!attribute id
10
+ #
11
+ # @return [String]
12
+ required :id, String
13
+
9
14
  # @!attribute breakdown_end_timestamp
10
15
  #
11
16
  # @return [Time]
@@ -16,9 +21,1273 @@ module MetronomeSDK
16
21
  # @return [Time]
17
22
  required :breakdown_start_timestamp, Time
18
23
 
19
- # @!method initialize(breakdown_end_timestamp:, breakdown_start_timestamp:)
24
+ # @!attribute credit_type
25
+ #
26
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CreditType]
27
+ required :credit_type,
28
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CreditType }
29
+
30
+ # @!attribute customer_id
31
+ #
32
+ # @return [String]
33
+ required :customer_id, String
34
+
35
+ # @!attribute line_items
36
+ #
37
+ # @return [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem>]
38
+ required :line_items,
39
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem] }
40
+
41
+ # @!attribute status
42
+ #
43
+ # @return [String]
44
+ required :status, String
45
+
46
+ # @!attribute total
47
+ #
48
+ # @return [Float]
49
+ required :total, Float
50
+
51
+ # @!attribute type
52
+ #
53
+ # @return [String]
54
+ required :type, String
55
+
56
+ # @!attribute amendment_id
57
+ #
58
+ # @return [String, nil]
59
+ optional :amendment_id, String
60
+
61
+ # @!attribute billable_status
62
+ # This field's availability is dependent on your client's configuration.
63
+ #
64
+ # @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::BillableStatus, nil]
65
+ optional :billable_status,
66
+ enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::BillableStatus }
67
+
68
+ # @!attribute contract_custom_fields
69
+ #
70
+ # @return [Hash{Symbol=>String}, nil]
71
+ optional :contract_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
72
+
73
+ # @!attribute contract_id
74
+ #
75
+ # @return [String, nil]
76
+ optional :contract_id, String
77
+
78
+ # @!attribute correction_record
79
+ #
80
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord, nil]
81
+ optional :correction_record,
82
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord }
83
+
84
+ # @!attribute created_at
85
+ # When the invoice was created (UTC). This field is present for correction
86
+ # invoices only.
87
+ #
88
+ # @return [Time, nil]
89
+ optional :created_at, Time
90
+
91
+ # @!attribute custom_fields
92
+ #
93
+ # @return [Hash{Symbol=>Object}, nil]
94
+ optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
95
+
96
+ # @!attribute customer_custom_fields
97
+ #
98
+ # @return [Hash{Symbol=>String}, nil]
99
+ optional :customer_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
100
+
101
+ # @!attribute end_timestamp
102
+ # End of the usage period this invoice covers (UTC)
103
+ #
104
+ # @return [Time, nil]
105
+ optional :end_timestamp, Time
106
+
107
+ # @!attribute external_invoice
108
+ #
109
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice, nil]
110
+ optional :external_invoice,
111
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice },
112
+ nil?: true
113
+
114
+ # @!attribute invoice_adjustments
115
+ #
116
+ # @return [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::InvoiceAdjustment>, nil]
117
+ optional :invoice_adjustments,
118
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::InvoiceAdjustment] }
119
+
120
+ # @!attribute issued_at
121
+ # When the invoice was issued (UTC)
122
+ #
123
+ # @return [Time, nil]
124
+ optional :issued_at, Time
125
+
126
+ # @!attribute net_payment_terms_days
127
+ #
128
+ # @return [Float, nil]
129
+ optional :net_payment_terms_days, Float
130
+
131
+ # @!attribute netsuite_sales_order_id
132
+ # This field's availability is dependent on your client's configuration.
133
+ #
134
+ # @return [String, nil]
135
+ optional :netsuite_sales_order_id, String
136
+
137
+ # @!attribute plan_custom_fields
138
+ #
139
+ # @return [Hash{Symbol=>String}, nil]
140
+ optional :plan_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
141
+
142
+ # @!attribute plan_id
143
+ #
144
+ # @return [String, nil]
145
+ optional :plan_id, String
146
+
147
+ # @!attribute plan_name
148
+ #
149
+ # @return [String, nil]
150
+ optional :plan_name, String
151
+
152
+ # @!attribute reseller_royalty
153
+ # Only present for contract invoices with reseller royalties.
154
+ #
155
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty, nil]
156
+ optional :reseller_royalty,
157
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty }
158
+
159
+ # @!attribute salesforce_opportunity_id
160
+ # This field's availability is dependent on your client's configuration.
161
+ #
162
+ # @return [String, nil]
163
+ optional :salesforce_opportunity_id, String
164
+
165
+ # @!attribute start_timestamp
166
+ # Beginning of the usage period this invoice covers (UTC)
167
+ #
168
+ # @return [Time, nil]
169
+ optional :start_timestamp, Time
170
+
171
+ # @!attribute subtotal
172
+ #
173
+ # @return [Float, nil]
174
+ optional :subtotal, Float
175
+
176
+ # @!method initialize(id:, breakdown_end_timestamp:, breakdown_start_timestamp:, credit_type:, customer_id:, line_items:, status:, total:, type:, amendment_id: nil, billable_status: nil, contract_custom_fields: nil, contract_id: nil, correction_record: nil, created_at: nil, custom_fields: nil, customer_custom_fields: nil, end_timestamp: nil, external_invoice: nil, invoice_adjustments: nil, issued_at: nil, net_payment_terms_days: nil, netsuite_sales_order_id: nil, plan_custom_fields: nil, plan_id: nil, plan_name: nil, reseller_royalty: nil, salesforce_opportunity_id: nil, start_timestamp: nil, subtotal: nil)
177
+ # Some parameter documentations has been truncated, see
178
+ # {MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse} for more
179
+ # details.
180
+ #
181
+ # @param id [String]
182
+ #
20
183
  # @param breakdown_end_timestamp [Time]
184
+ #
21
185
  # @param breakdown_start_timestamp [Time]
186
+ #
187
+ # @param credit_type [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CreditType]
188
+ #
189
+ # @param customer_id [String]
190
+ #
191
+ # @param line_items [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem>]
192
+ #
193
+ # @param status [String]
194
+ #
195
+ # @param total [Float]
196
+ #
197
+ # @param type [String]
198
+ #
199
+ # @param amendment_id [String]
200
+ #
201
+ # @param billable_status [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::BillableStatus] This field's availability is dependent on your client's configuration.
202
+ #
203
+ # @param contract_custom_fields [Hash{Symbol=>String}]
204
+ #
205
+ # @param contract_id [String]
206
+ #
207
+ # @param correction_record [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord]
208
+ #
209
+ # @param created_at [Time] When the invoice was created (UTC). This field is present for correction invoice
210
+ #
211
+ # @param custom_fields [Hash{Symbol=>Object}]
212
+ #
213
+ # @param customer_custom_fields [Hash{Symbol=>String}]
214
+ #
215
+ # @param end_timestamp [Time] End of the usage period this invoice covers (UTC)
216
+ #
217
+ # @param external_invoice [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice, nil]
218
+ #
219
+ # @param invoice_adjustments [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::InvoiceAdjustment>]
220
+ #
221
+ # @param issued_at [Time] When the invoice was issued (UTC)
222
+ #
223
+ # @param net_payment_terms_days [Float]
224
+ #
225
+ # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
226
+ #
227
+ # @param plan_custom_fields [Hash{Symbol=>String}]
228
+ #
229
+ # @param plan_id [String]
230
+ #
231
+ # @param plan_name [String]
232
+ #
233
+ # @param reseller_royalty [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty] Only present for contract invoices with reseller royalties.
234
+ #
235
+ # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
236
+ #
237
+ # @param start_timestamp [Time] Beginning of the usage period this invoice covers (UTC)
238
+ #
239
+ # @param subtotal [Float]
240
+
241
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse#credit_type
242
+ class CreditType < MetronomeSDK::Internal::Type::BaseModel
243
+ # @!attribute id
244
+ #
245
+ # @return [String]
246
+ required :id, String
247
+
248
+ # @!attribute name
249
+ #
250
+ # @return [String]
251
+ required :name, String
252
+
253
+ # @!method initialize(id:, name:)
254
+ # @param id [String]
255
+ # @param name [String]
256
+ end
257
+
258
+ class LineItem < MetronomeSDK::Internal::Type::BaseModel
259
+ # @!attribute credit_type
260
+ #
261
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::CreditType]
262
+ required :credit_type,
263
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::CreditType }
264
+
265
+ # @!attribute name
266
+ #
267
+ # @return [String]
268
+ required :name, String
269
+
270
+ # @!attribute total
271
+ #
272
+ # @return [Float]
273
+ required :total, Float
274
+
275
+ # @!attribute applied_commit_or_credit
276
+ # Details about the credit or commit that was applied to this line item. Only
277
+ # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
278
+ # types.
279
+ #
280
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::AppliedCommitOrCredit, nil]
281
+ optional :applied_commit_or_credit,
282
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::AppliedCommitOrCredit }
283
+
284
+ # @!attribute commit_custom_fields
285
+ #
286
+ # @return [Hash{Symbol=>String}, nil]
287
+ optional :commit_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
288
+
289
+ # @!attribute commit_id
290
+ # For line items with product of `USAGE`, `SUBSCRIPTION`, or `COMPOSITE` types,
291
+ # the ID of the credit or commit that was applied to this line item. For line
292
+ # items with product type of `FIXED`, the ID of the prepaid or postpaid commit
293
+ # that is being paid for.
294
+ #
295
+ # @return [String, nil]
296
+ optional :commit_id, String
297
+
298
+ # @!attribute commit_netsuite_item_id
299
+ #
300
+ # @return [String, nil]
301
+ optional :commit_netsuite_item_id, String
302
+
303
+ # @!attribute commit_netsuite_sales_order_id
304
+ #
305
+ # @return [String, nil]
306
+ optional :commit_netsuite_sales_order_id, String
307
+
308
+ # @!attribute commit_segment_id
309
+ #
310
+ # @return [String, nil]
311
+ optional :commit_segment_id, String
312
+
313
+ # @!attribute commit_type
314
+ # `PrepaidCommit` (for commit types `PREPAID` and `CREDIT`) or `PostpaidCommit`
315
+ # (for commit type `POSTPAID`).
316
+ #
317
+ # @return [String, nil]
318
+ optional :commit_type, String
319
+
320
+ # @!attribute custom_fields
321
+ #
322
+ # @return [Hash{Symbol=>String}, nil]
323
+ optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
324
+
325
+ # @!attribute discount_custom_fields
326
+ #
327
+ # @return [Hash{Symbol=>String}, nil]
328
+ optional :discount_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
329
+
330
+ # @!attribute discount_id
331
+ # ID of the discount applied to this line item.
332
+ #
333
+ # @return [String, nil]
334
+ optional :discount_id, String
335
+
336
+ # @!attribute ending_before
337
+ # The line item's end date (exclusive).
338
+ #
339
+ # @return [Time, nil]
340
+ optional :ending_before, Time
341
+
342
+ # @!attribute group_key
343
+ #
344
+ # @return [String, nil]
345
+ optional :group_key, String
346
+
347
+ # @!attribute group_value
348
+ #
349
+ # @return [String, nil]
350
+ optional :group_value, String, nil?: true
351
+
352
+ # @!attribute is_prorated
353
+ # Indicates whether the line item is prorated for `SUBSCRIPTION` type product.
354
+ #
355
+ # @return [Boolean, nil]
356
+ optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
357
+
358
+ # @!attribute list_price
359
+ # Only present for contract invoices and when the `include_list_prices` query
360
+ # parameter is set to true. This will include the list rate for the charge if
361
+ # applicable. Only present for usage and subscription line items.
362
+ #
363
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice, nil]
364
+ optional :list_price,
365
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice }
366
+
367
+ # @!attribute metadata
368
+ #
369
+ # @return [String, nil]
370
+ optional :metadata, String
371
+
372
+ # @!attribute netsuite_invoice_billing_end
373
+ # The end date for the billing period on the invoice.
374
+ #
375
+ # @return [Time, nil]
376
+ optional :netsuite_invoice_billing_end, Time
377
+
378
+ # @!attribute netsuite_invoice_billing_start
379
+ # The start date for the billing period on the invoice.
380
+ #
381
+ # @return [Time, nil]
382
+ optional :netsuite_invoice_billing_start, Time
383
+
384
+ # @!attribute netsuite_item_id
385
+ #
386
+ # @return [String, nil]
387
+ optional :netsuite_item_id, String
388
+
389
+ # @!attribute postpaid_commit
390
+ # Only present for line items paying for a postpaid commit true-up.
391
+ #
392
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::PostpaidCommit, nil]
393
+ optional :postpaid_commit,
394
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::PostpaidCommit }
395
+
396
+ # @!attribute presentation_group_values
397
+ # Includes the presentation group values associated with this line item if
398
+ # presentation group keys are used.
399
+ #
400
+ # @return [Hash{Symbol=>String, nil}, nil]
401
+ optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String, nil?: true]
402
+
403
+ # @!attribute pricing_group_values
404
+ # Includes the pricing group values associated with this line item if dimensional
405
+ # pricing is used.
406
+ #
407
+ # @return [Hash{Symbol=>String}, nil]
408
+ optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
409
+
410
+ # @!attribute product_custom_fields
411
+ #
412
+ # @return [Hash{Symbol=>String}, nil]
413
+ optional :product_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
414
+
415
+ # @!attribute product_id
416
+ # ID of the product associated with the line item.
417
+ #
418
+ # @return [String, nil]
419
+ optional :product_id, String
420
+
421
+ # @!attribute product_tags
422
+ # The current product tags associated with the line item's `product_id`.
423
+ #
424
+ # @return [Array<String>, nil]
425
+ optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
426
+
427
+ # @!attribute product_type
428
+ # The type of the line item's product. Possible values are `FixedProductListItem`
429
+ # (for `FIXED` type products), `UsageProductListItem` (for `USAGE` type products),
430
+ # `SubscriptionProductListItem` (for `SUBSCRIPTION` type products) or
431
+ # `CompositeProductListItem` (for `COMPOSITE` type products). For scheduled
432
+ # charges, commit and credit payments, the value is `FixedProductListItem`.
433
+ #
434
+ # @return [String, nil]
435
+ optional :product_type, String
436
+
437
+ # @!attribute professional_service_custom_fields
438
+ #
439
+ # @return [Hash{Symbol=>String}, nil]
440
+ optional :professional_service_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
441
+
442
+ # @!attribute professional_service_id
443
+ #
444
+ # @return [String, nil]
445
+ optional :professional_service_id, String
446
+
447
+ # @!attribute quantity
448
+ # The quantity associated with the line item.
449
+ #
450
+ # @return [Float, nil]
451
+ optional :quantity, Float
452
+
453
+ # @!attribute reseller_type
454
+ #
455
+ # @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ResellerType, nil]
456
+ optional :reseller_type,
457
+ enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ResellerType }
458
+
459
+ # @!attribute scheduled_charge_custom_fields
460
+ #
461
+ # @return [Hash{Symbol=>String}, nil]
462
+ optional :scheduled_charge_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
463
+
464
+ # @!attribute scheduled_charge_id
465
+ # ID of scheduled charge.
466
+ #
467
+ # @return [String, nil]
468
+ optional :scheduled_charge_id, String
469
+
470
+ # @!attribute starting_at
471
+ # The line item's start date (inclusive).
472
+ #
473
+ # @return [Time, nil]
474
+ optional :starting_at, Time
475
+
476
+ # @!attribute sub_line_items
477
+ #
478
+ # @return [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem>, nil]
479
+ optional :sub_line_items,
480
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem] }
481
+
482
+ # @!attribute subscription_custom_fields
483
+ #
484
+ # @return [Hash{Symbol=>String}, nil]
485
+ optional :subscription_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
486
+
487
+ # @!attribute tier
488
+ # Populated if the line item has a tiered price.
489
+ #
490
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::Tier, nil]
491
+ optional :tier, -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::Tier }
492
+
493
+ # @!attribute unit_price
494
+ # The unit price associated with the line item.
495
+ #
496
+ # @return [Float, nil]
497
+ optional :unit_price, Float
498
+
499
+ # @!method initialize(credit_type:, name:, total:, applied_commit_or_credit: nil, commit_custom_fields: nil, commit_id: nil, commit_netsuite_item_id: nil, commit_netsuite_sales_order_id: nil, commit_segment_id: nil, commit_type: nil, custom_fields: nil, discount_custom_fields: nil, discount_id: nil, ending_before: nil, group_key: nil, group_value: nil, is_prorated: nil, list_price: nil, metadata: nil, netsuite_invoice_billing_end: nil, netsuite_invoice_billing_start: nil, netsuite_item_id: nil, postpaid_commit: nil, presentation_group_values: nil, pricing_group_values: nil, product_custom_fields: nil, product_id: nil, product_tags: nil, product_type: nil, professional_service_custom_fields: nil, professional_service_id: nil, quantity: nil, reseller_type: nil, scheduled_charge_custom_fields: nil, scheduled_charge_id: nil, starting_at: nil, sub_line_items: nil, subscription_custom_fields: nil, tier: nil, unit_price: nil)
500
+ # Some parameter documentations has been truncated, see
501
+ # {MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem}
502
+ # for more details.
503
+ #
504
+ # @param credit_type [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::CreditType]
505
+ #
506
+ # @param name [String]
507
+ #
508
+ # @param total [Float]
509
+ #
510
+ # @param applied_commit_or_credit [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::AppliedCommitOrCredit] Details about the credit or commit that was applied to this line item. Only pres
511
+ #
512
+ # @param commit_custom_fields [Hash{Symbol=>String}]
513
+ #
514
+ # @param commit_id [String] For line items with product of `USAGE`, `SUBSCRIPTION`, or `COMPOSITE` types, th
515
+ #
516
+ # @param commit_netsuite_item_id [String]
517
+ #
518
+ # @param commit_netsuite_sales_order_id [String]
519
+ #
520
+ # @param commit_segment_id [String]
521
+ #
522
+ # @param commit_type [String] `PrepaidCommit` (for commit types `PREPAID` and `CREDIT`) or `PostpaidCommit` (f
523
+ #
524
+ # @param custom_fields [Hash{Symbol=>String}]
525
+ #
526
+ # @param discount_custom_fields [Hash{Symbol=>String}]
527
+ #
528
+ # @param discount_id [String] ID of the discount applied to this line item.
529
+ #
530
+ # @param ending_before [Time] The line item's end date (exclusive).
531
+ #
532
+ # @param group_key [String]
533
+ #
534
+ # @param group_value [String, nil]
535
+ #
536
+ # @param is_prorated [Boolean] Indicates whether the line item is prorated for `SUBSCRIPTION` type product.
537
+ #
538
+ # @param list_price [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice] Only present for contract invoices and when the `include_list_prices` query para
539
+ #
540
+ # @param metadata [String]
541
+ #
542
+ # @param netsuite_invoice_billing_end [Time] The end date for the billing period on the invoice.
543
+ #
544
+ # @param netsuite_invoice_billing_start [Time] The start date for the billing period on the invoice.
545
+ #
546
+ # @param netsuite_item_id [String]
547
+ #
548
+ # @param postpaid_commit [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::PostpaidCommit] Only present for line items paying for a postpaid commit true-up.
549
+ #
550
+ # @param presentation_group_values [Hash{Symbol=>String, nil}] Includes the presentation group values associated with this line item if present
551
+ #
552
+ # @param pricing_group_values [Hash{Symbol=>String}] Includes the pricing group values associated with this line item if dimensional
553
+ #
554
+ # @param product_custom_fields [Hash{Symbol=>String}]
555
+ #
556
+ # @param product_id [String] ID of the product associated with the line item.
557
+ #
558
+ # @param product_tags [Array<String>] The current product tags associated with the line item's `product_id`.
559
+ #
560
+ # @param product_type [String] The type of the line item's product. Possible values are `FixedProductListItem`
561
+ #
562
+ # @param professional_service_custom_fields [Hash{Symbol=>String}]
563
+ #
564
+ # @param professional_service_id [String]
565
+ #
566
+ # @param quantity [Float] The quantity associated with the line item.
567
+ #
568
+ # @param reseller_type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ResellerType]
569
+ #
570
+ # @param scheduled_charge_custom_fields [Hash{Symbol=>String}]
571
+ #
572
+ # @param scheduled_charge_id [String] ID of scheduled charge.
573
+ #
574
+ # @param starting_at [Time] The line item's start date (inclusive).
575
+ #
576
+ # @param sub_line_items [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem>]
577
+ #
578
+ # @param subscription_custom_fields [Hash{Symbol=>String}]
579
+ #
580
+ # @param tier [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::Tier] Populated if the line item has a tiered price.
581
+ #
582
+ # @param unit_price [Float] The unit price associated with the line item.
583
+
584
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem#credit_type
585
+ class CreditType < MetronomeSDK::Internal::Type::BaseModel
586
+ # @!attribute id
587
+ #
588
+ # @return [String]
589
+ required :id, String
590
+
591
+ # @!attribute name
592
+ #
593
+ # @return [String]
594
+ required :name, String
595
+
596
+ # @!method initialize(id:, name:)
597
+ # @param id [String]
598
+ # @param name [String]
599
+ end
600
+
601
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem#applied_commit_or_credit
602
+ class AppliedCommitOrCredit < MetronomeSDK::Internal::Type::BaseModel
603
+ # @!attribute id
604
+ #
605
+ # @return [String]
606
+ required :id, String
607
+
608
+ # @!attribute type
609
+ #
610
+ # @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::AppliedCommitOrCredit::Type]
611
+ required :type,
612
+ enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::AppliedCommitOrCredit::Type }
613
+
614
+ # @!method initialize(id:, type:)
615
+ # Details about the credit or commit that was applied to this line item. Only
616
+ # present on line items with product of `USAGE`, `SUBSCRIPTION` or `COMPOSITE`
617
+ # types.
618
+ #
619
+ # @param id [String]
620
+ # @param type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::AppliedCommitOrCredit::Type]
621
+
622
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::AppliedCommitOrCredit#type
623
+ module Type
624
+ extend MetronomeSDK::Internal::Type::Enum
625
+
626
+ PREPAID = :PREPAID
627
+ POSTPAID = :POSTPAID
628
+ CREDIT = :CREDIT
629
+
630
+ # @!method self.values
631
+ # @return [Array<Symbol>]
632
+ end
633
+ end
634
+
635
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem#list_price
636
+ class ListPrice < MetronomeSDK::Internal::Type::BaseModel
637
+ # @!attribute rate_type
638
+ #
639
+ # @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice::RateType]
640
+ required :rate_type,
641
+ enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice::RateType }
642
+
643
+ # @!attribute credit_type
644
+ #
645
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice::CreditType, nil]
646
+ optional :credit_type,
647
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice::CreditType }
648
+
649
+ # @!attribute custom_rate
650
+ # Only set for CUSTOM rate_type. This field is interpreted by custom rate
651
+ # processors.
652
+ #
653
+ # @return [Hash{Symbol=>Object}, nil]
654
+ optional :custom_rate,
655
+ MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
656
+
657
+ # @!attribute is_prorated
658
+ # Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
659
+ # set to true.
660
+ #
661
+ # @return [Boolean, nil]
662
+ optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
663
+
664
+ # @!attribute price
665
+ # Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
666
+ # this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
667
+ #
668
+ # @return [Float, nil]
669
+ optional :price, Float
670
+
671
+ # @!attribute pricing_group_values
672
+ # if pricing groups are used, this will contain the values used to calculate the
673
+ # price
674
+ #
675
+ # @return [Hash{Symbol=>String}, nil]
676
+ optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
677
+
678
+ # @!attribute quantity
679
+ # Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
680
+ #
681
+ # @return [Float, nil]
682
+ optional :quantity, Float
683
+
684
+ # @!attribute tiers
685
+ # Only set for TIERED rate_type.
686
+ #
687
+ # @return [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice::Tier>, nil]
688
+ optional :tiers,
689
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice::Tier] }
690
+
691
+ # @!attribute use_list_prices
692
+ # Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
693
+ # using list prices rather than the standard rates for this product on the
694
+ # contract.
695
+ #
696
+ # @return [Boolean, nil]
697
+ optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
698
+
699
+ # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
700
+ # Some parameter documentations has been truncated, see
701
+ # {MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice}
702
+ # for more details.
703
+ #
704
+ # Only present for contract invoices and when the `include_list_prices` query
705
+ # parameter is set to true. This will include the list rate for the charge if
706
+ # applicable. Only present for usage and subscription line items.
707
+ #
708
+ # @param rate_type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice::RateType]
709
+ #
710
+ # @param credit_type [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice::CreditType]
711
+ #
712
+ # @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
713
+ #
714
+ # @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
715
+ #
716
+ # @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
717
+ #
718
+ # @param pricing_group_values [Hash{Symbol=>String}] if pricing groups are used, this will contain the values used to calculate the p
719
+ #
720
+ # @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
721
+ #
722
+ # @param tiers [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice::Tier>] Only set for TIERED rate_type.
723
+ #
724
+ # @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
725
+
726
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice#rate_type
727
+ module RateType
728
+ extend MetronomeSDK::Internal::Type::Enum
729
+
730
+ FLAT = :FLAT
731
+ PERCENTAGE = :PERCENTAGE
732
+ SUBSCRIPTION = :SUBSCRIPTION
733
+ CUSTOM = :CUSTOM
734
+ TIERED = :TIERED
735
+
736
+ # @!method self.values
737
+ # @return [Array<Symbol>]
738
+ end
739
+
740
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::ListPrice#credit_type
741
+ class CreditType < MetronomeSDK::Internal::Type::BaseModel
742
+ # @!attribute id
743
+ #
744
+ # @return [String]
745
+ required :id, String
746
+
747
+ # @!attribute name
748
+ #
749
+ # @return [String]
750
+ required :name, String
751
+
752
+ # @!method initialize(id:, name:)
753
+ # @param id [String]
754
+ # @param name [String]
755
+ end
756
+
757
+ class Tier < MetronomeSDK::Internal::Type::BaseModel
758
+ # @!attribute price
759
+ #
760
+ # @return [Float]
761
+ required :price, Float
762
+
763
+ # @!attribute size
764
+ #
765
+ # @return [Float, nil]
766
+ optional :size, Float
767
+
768
+ # @!method initialize(price:, size: nil)
769
+ # @param price [Float]
770
+ # @param size [Float]
771
+ end
772
+ end
773
+
774
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem#postpaid_commit
775
+ class PostpaidCommit < MetronomeSDK::Internal::Type::BaseModel
776
+ # @!attribute id
777
+ #
778
+ # @return [String]
779
+ required :id, String
780
+
781
+ # @!method initialize(id:)
782
+ # Only present for line items paying for a postpaid commit true-up.
783
+ #
784
+ # @param id [String]
785
+ end
786
+
787
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem#reseller_type
788
+ module ResellerType
789
+ extend MetronomeSDK::Internal::Type::Enum
790
+
791
+ AWS = :AWS
792
+ AWS_PRO_SERVICE = :AWS_PRO_SERVICE
793
+ GCP = :GCP
794
+ GCP_PRO_SERVICE = :GCP_PRO_SERVICE
795
+
796
+ # @!method self.values
797
+ # @return [Array<Symbol>]
798
+ end
799
+
800
+ class SubLineItem < MetronomeSDK::Internal::Type::BaseModel
801
+ # @!attribute custom_fields
802
+ #
803
+ # @return [Hash{Symbol=>String}]
804
+ required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
805
+
806
+ # @!attribute name
807
+ #
808
+ # @return [String]
809
+ required :name, String
810
+
811
+ # @!attribute quantity
812
+ #
813
+ # @return [Float]
814
+ required :quantity, Float
815
+
816
+ # @!attribute subtotal
817
+ #
818
+ # @return [Float]
819
+ required :subtotal, Float
820
+
821
+ # @!attribute charge_id
822
+ #
823
+ # @return [String, nil]
824
+ optional :charge_id, String
825
+
826
+ # @!attribute credit_grant_id
827
+ #
828
+ # @return [String, nil]
829
+ optional :credit_grant_id, String
830
+
831
+ # @!attribute end_date
832
+ # The end date for the charge (for seats charges only).
833
+ #
834
+ # @return [Time, nil]
835
+ optional :end_date, Time
836
+
837
+ # @!attribute price
838
+ # the unit price for this charge, present only if the charge is not tiered and the
839
+ # quantity is nonzero
840
+ #
841
+ # @return [Float, nil]
842
+ optional :price, Float
843
+
844
+ # @!attribute start_date
845
+ # The start date for the charge (for seats charges only).
846
+ #
847
+ # @return [Time, nil]
848
+ optional :start_date, Time
849
+
850
+ # @!attribute tier_period
851
+ # when the current tier started and ends (for tiered charges only)
852
+ #
853
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem::TierPeriod, nil]
854
+ optional :tier_period,
855
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem::TierPeriod }
856
+
857
+ # @!attribute tiers
858
+ #
859
+ # @return [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem::Tier>, nil]
860
+ optional :tiers,
861
+ -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem::Tier] }
862
+
863
+ # @!method initialize(custom_fields:, name:, quantity:, subtotal:, charge_id: nil, credit_grant_id: nil, end_date: nil, price: nil, start_date: nil, tier_period: nil, tiers: nil)
864
+ # Some parameter documentations has been truncated, see
865
+ # {MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem}
866
+ # for more details.
867
+ #
868
+ # @param custom_fields [Hash{Symbol=>String}]
869
+ #
870
+ # @param name [String]
871
+ #
872
+ # @param quantity [Float]
873
+ #
874
+ # @param subtotal [Float]
875
+ #
876
+ # @param charge_id [String]
877
+ #
878
+ # @param credit_grant_id [String]
879
+ #
880
+ # @param end_date [Time] The end date for the charge (for seats charges only).
881
+ #
882
+ # @param price [Float] the unit price for this charge, present only if the charge is not tiered and the
883
+ #
884
+ # @param start_date [Time] The start date for the charge (for seats charges only).
885
+ #
886
+ # @param tier_period [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem::TierPeriod] when the current tier started and ends (for tiered charges only)
887
+ #
888
+ # @param tiers [Array<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem::Tier>]
889
+
890
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem::SubLineItem#tier_period
891
+ class TierPeriod < MetronomeSDK::Internal::Type::BaseModel
892
+ # @!attribute starting_at
893
+ #
894
+ # @return [Time]
895
+ required :starting_at, Time
896
+
897
+ # @!attribute ending_before
898
+ #
899
+ # @return [Time, nil]
900
+ optional :ending_before, Time
901
+
902
+ # @!method initialize(starting_at:, ending_before: nil)
903
+ # when the current tier started and ends (for tiered charges only)
904
+ #
905
+ # @param starting_at [Time]
906
+ # @param ending_before [Time]
907
+ end
908
+
909
+ class Tier < MetronomeSDK::Internal::Type::BaseModel
910
+ # @!attribute price
911
+ #
912
+ # @return [Float]
913
+ required :price, Float
914
+
915
+ # @!attribute quantity
916
+ #
917
+ # @return [Float]
918
+ required :quantity, Float
919
+
920
+ # @!attribute starting_at
921
+ # at what metric amount this tier begins
922
+ #
923
+ # @return [Float]
924
+ required :starting_at, Float
925
+
926
+ # @!attribute subtotal
927
+ #
928
+ # @return [Float]
929
+ required :subtotal, Float
930
+
931
+ # @!method initialize(price:, quantity:, starting_at:, subtotal:)
932
+ # @param price [Float]
933
+ #
934
+ # @param quantity [Float]
935
+ #
936
+ # @param starting_at [Float] at what metric amount this tier begins
937
+ #
938
+ # @param subtotal [Float]
939
+ end
940
+ end
941
+
942
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::LineItem#tier
943
+ class Tier < MetronomeSDK::Internal::Type::BaseModel
944
+ # @!attribute level
945
+ #
946
+ # @return [Float]
947
+ required :level, Float
948
+
949
+ # @!attribute starting_at
950
+ #
951
+ # @return [String]
952
+ required :starting_at, String
953
+
954
+ # @!attribute size
955
+ #
956
+ # @return [String, nil]
957
+ optional :size, String, nil?: true
958
+
959
+ # @!method initialize(level:, starting_at:, size: nil)
960
+ # Populated if the line item has a tiered price.
961
+ #
962
+ # @param level [Float]
963
+ # @param starting_at [String]
964
+ # @param size [String, nil]
965
+ end
966
+ end
967
+
968
+ # This field's availability is dependent on your client's configuration.
969
+ #
970
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse#billable_status
971
+ module BillableStatus
972
+ extend MetronomeSDK::Internal::Type::Enum
973
+
974
+ BILLABLE = :billable
975
+ UNBILLABLE = :unbillable
976
+
977
+ # @!method self.values
978
+ # @return [Array<Symbol>]
979
+ end
980
+
981
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse#correction_record
982
+ class CorrectionRecord < MetronomeSDK::Internal::Type::BaseModel
983
+ # @!attribute corrected_invoice_id
984
+ #
985
+ # @return [String]
986
+ required :corrected_invoice_id, String
987
+
988
+ # @!attribute memo
989
+ #
990
+ # @return [String]
991
+ required :memo, String
992
+
993
+ # @!attribute reason
994
+ #
995
+ # @return [String]
996
+ required :reason, String
997
+
998
+ # @!attribute corrected_external_invoice
999
+ #
1000
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice, nil]
1001
+ optional :corrected_external_invoice,
1002
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice }
1003
+
1004
+ # @!method initialize(corrected_invoice_id:, memo:, reason:, corrected_external_invoice: nil)
1005
+ # @param corrected_invoice_id [String]
1006
+ # @param memo [String]
1007
+ # @param reason [String]
1008
+ # @param corrected_external_invoice [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice]
1009
+
1010
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord#corrected_external_invoice
1011
+ class CorrectedExternalInvoice < MetronomeSDK::Internal::Type::BaseModel
1012
+ # @!attribute billing_provider_type
1013
+ #
1014
+ # @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType]
1015
+ required :billing_provider_type,
1016
+ enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType }
1017
+
1018
+ # @!attribute external_status
1019
+ #
1020
+ # @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus, nil]
1021
+ optional :external_status,
1022
+ enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus }
1023
+
1024
+ # @!attribute invoice_id
1025
+ #
1026
+ # @return [String, nil]
1027
+ optional :invoice_id, String
1028
+
1029
+ # @!attribute issued_at_timestamp
1030
+ #
1031
+ # @return [Time, nil]
1032
+ optional :issued_at_timestamp, Time
1033
+
1034
+ # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
1035
+ # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice::BillingProviderType]
1036
+ # @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice::ExternalStatus]
1037
+ # @param invoice_id [String]
1038
+ # @param issued_at_timestamp [Time]
1039
+
1040
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice#billing_provider_type
1041
+ module BillingProviderType
1042
+ extend MetronomeSDK::Internal::Type::Enum
1043
+
1044
+ AWS_MARKETPLACE = :aws_marketplace
1045
+ STRIPE = :stripe
1046
+ NETSUITE = :netsuite
1047
+ CUSTOM = :custom
1048
+ AZURE_MARKETPLACE = :azure_marketplace
1049
+ QUICKBOOKS_ONLINE = :quickbooks_online
1050
+ WORKDAY = :workday
1051
+ GCP_MARKETPLACE = :gcp_marketplace
1052
+
1053
+ # @!method self.values
1054
+ # @return [Array<Symbol>]
1055
+ end
1056
+
1057
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::CorrectionRecord::CorrectedExternalInvoice#external_status
1058
+ module ExternalStatus
1059
+ extend MetronomeSDK::Internal::Type::Enum
1060
+
1061
+ DRAFT = :DRAFT
1062
+ FINALIZED = :FINALIZED
1063
+ PAID = :PAID
1064
+ UNCOLLECTIBLE = :UNCOLLECTIBLE
1065
+ VOID = :VOID
1066
+ DELETED = :DELETED
1067
+ PAYMENT_FAILED = :PAYMENT_FAILED
1068
+ INVALID_REQUEST_ERROR = :INVALID_REQUEST_ERROR
1069
+ SKIPPED = :SKIPPED
1070
+ SENT = :SENT
1071
+ QUEUED = :QUEUED
1072
+
1073
+ # @!method self.values
1074
+ # @return [Array<Symbol>]
1075
+ end
1076
+ end
1077
+ end
1078
+
1079
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse#external_invoice
1080
+ class ExternalInvoice < MetronomeSDK::Internal::Type::BaseModel
1081
+ # @!attribute billing_provider_type
1082
+ #
1083
+ # @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice::BillingProviderType]
1084
+ required :billing_provider_type,
1085
+ enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice::BillingProviderType }
1086
+
1087
+ # @!attribute external_status
1088
+ #
1089
+ # @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice::ExternalStatus, nil]
1090
+ optional :external_status,
1091
+ enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice::ExternalStatus }
1092
+
1093
+ # @!attribute invoice_id
1094
+ #
1095
+ # @return [String, nil]
1096
+ optional :invoice_id, String
1097
+
1098
+ # @!attribute issued_at_timestamp
1099
+ #
1100
+ # @return [Time, nil]
1101
+ optional :issued_at_timestamp, Time
1102
+
1103
+ # @!method initialize(billing_provider_type:, external_status: nil, invoice_id: nil, issued_at_timestamp: nil)
1104
+ # @param billing_provider_type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice::BillingProviderType]
1105
+ # @param external_status [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice::ExternalStatus]
1106
+ # @param invoice_id [String]
1107
+ # @param issued_at_timestamp [Time]
1108
+
1109
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice#billing_provider_type
1110
+ module BillingProviderType
1111
+ extend MetronomeSDK::Internal::Type::Enum
1112
+
1113
+ AWS_MARKETPLACE = :aws_marketplace
1114
+ STRIPE = :stripe
1115
+ NETSUITE = :netsuite
1116
+ CUSTOM = :custom
1117
+ AZURE_MARKETPLACE = :azure_marketplace
1118
+ QUICKBOOKS_ONLINE = :quickbooks_online
1119
+ WORKDAY = :workday
1120
+ GCP_MARKETPLACE = :gcp_marketplace
1121
+
1122
+ # @!method self.values
1123
+ # @return [Array<Symbol>]
1124
+ end
1125
+
1126
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ExternalInvoice#external_status
1127
+ module ExternalStatus
1128
+ extend MetronomeSDK::Internal::Type::Enum
1129
+
1130
+ DRAFT = :DRAFT
1131
+ FINALIZED = :FINALIZED
1132
+ PAID = :PAID
1133
+ UNCOLLECTIBLE = :UNCOLLECTIBLE
1134
+ VOID = :VOID
1135
+ DELETED = :DELETED
1136
+ PAYMENT_FAILED = :PAYMENT_FAILED
1137
+ INVALID_REQUEST_ERROR = :INVALID_REQUEST_ERROR
1138
+ SKIPPED = :SKIPPED
1139
+ SENT = :SENT
1140
+ QUEUED = :QUEUED
1141
+
1142
+ # @!method self.values
1143
+ # @return [Array<Symbol>]
1144
+ end
1145
+ end
1146
+
1147
+ class InvoiceAdjustment < MetronomeSDK::Internal::Type::BaseModel
1148
+ # @!attribute credit_type
1149
+ #
1150
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::InvoiceAdjustment::CreditType]
1151
+ required :credit_type,
1152
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::InvoiceAdjustment::CreditType }
1153
+
1154
+ # @!attribute name
1155
+ #
1156
+ # @return [String]
1157
+ required :name, String
1158
+
1159
+ # @!attribute total
1160
+ #
1161
+ # @return [Float]
1162
+ required :total, Float
1163
+
1164
+ # @!attribute credit_grant_custom_fields
1165
+ #
1166
+ # @return [Hash{Symbol=>String}, nil]
1167
+ optional :credit_grant_custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
1168
+
1169
+ # @!attribute credit_grant_id
1170
+ #
1171
+ # @return [String, nil]
1172
+ optional :credit_grant_id, String
1173
+
1174
+ # @!method initialize(credit_type:, name:, total:, credit_grant_custom_fields: nil, credit_grant_id: nil)
1175
+ # @param credit_type [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::InvoiceAdjustment::CreditType]
1176
+ # @param name [String]
1177
+ # @param total [Float]
1178
+ # @param credit_grant_custom_fields [Hash{Symbol=>String}]
1179
+ # @param credit_grant_id [String]
1180
+
1181
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::InvoiceAdjustment#credit_type
1182
+ class CreditType < MetronomeSDK::Internal::Type::BaseModel
1183
+ # @!attribute id
1184
+ #
1185
+ # @return [String]
1186
+ required :id, String
1187
+
1188
+ # @!attribute name
1189
+ #
1190
+ # @return [String]
1191
+ required :name, String
1192
+
1193
+ # @!method initialize(id:, name:)
1194
+ # @param id [String]
1195
+ # @param name [String]
1196
+ end
1197
+ end
1198
+
1199
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse#reseller_royalty
1200
+ class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
1201
+ # @!attribute fraction
1202
+ #
1203
+ # @return [String]
1204
+ required :fraction, String
1205
+
1206
+ # @!attribute netsuite_reseller_id
1207
+ #
1208
+ # @return [String]
1209
+ required :netsuite_reseller_id, String
1210
+
1211
+ # @!attribute reseller_type
1212
+ #
1213
+ # @return [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty::ResellerType]
1214
+ required :reseller_type,
1215
+ enum: -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty::ResellerType }
1216
+
1217
+ # @!attribute aws_options
1218
+ #
1219
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty::AwsOptions, nil]
1220
+ optional :aws_options,
1221
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty::AwsOptions }
1222
+
1223
+ # @!attribute gcp_options
1224
+ #
1225
+ # @return [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty::GcpOptions, nil]
1226
+ optional :gcp_options,
1227
+ -> { MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty::GcpOptions }
1228
+
1229
+ # @!method initialize(fraction:, netsuite_reseller_id:, reseller_type:, aws_options: nil, gcp_options: nil)
1230
+ # Only present for contract invoices with reseller royalties.
1231
+ #
1232
+ # @param fraction [String]
1233
+ # @param netsuite_reseller_id [String]
1234
+ # @param reseller_type [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty::ResellerType]
1235
+ # @param aws_options [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty::AwsOptions]
1236
+ # @param gcp_options [MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty::GcpOptions]
1237
+
1238
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty#reseller_type
1239
+ module ResellerType
1240
+ extend MetronomeSDK::Internal::Type::Enum
1241
+
1242
+ AWS = :AWS
1243
+ AWS_PRO_SERVICE = :AWS_PRO_SERVICE
1244
+ GCP = :GCP
1245
+ GCP_PRO_SERVICE = :GCP_PRO_SERVICE
1246
+
1247
+ # @!method self.values
1248
+ # @return [Array<Symbol>]
1249
+ end
1250
+
1251
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty#aws_options
1252
+ class AwsOptions < MetronomeSDK::Internal::Type::BaseModel
1253
+ # @!attribute aws_account_number
1254
+ #
1255
+ # @return [String, nil]
1256
+ optional :aws_account_number, String
1257
+
1258
+ # @!attribute aws_offer_id
1259
+ #
1260
+ # @return [String, nil]
1261
+ optional :aws_offer_id, String
1262
+
1263
+ # @!attribute aws_payer_reference_id
1264
+ #
1265
+ # @return [String, nil]
1266
+ optional :aws_payer_reference_id, String
1267
+
1268
+ # @!method initialize(aws_account_number: nil, aws_offer_id: nil, aws_payer_reference_id: nil)
1269
+ # @param aws_account_number [String]
1270
+ # @param aws_offer_id [String]
1271
+ # @param aws_payer_reference_id [String]
1272
+ end
1273
+
1274
+ # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse::ResellerRoyalty#gcp_options
1275
+ class GcpOptions < MetronomeSDK::Internal::Type::BaseModel
1276
+ # @!attribute gcp_account_id
1277
+ #
1278
+ # @return [String, nil]
1279
+ optional :gcp_account_id, String
1280
+
1281
+ # @!attribute gcp_offer_id
1282
+ #
1283
+ # @return [String, nil]
1284
+ optional :gcp_offer_id, String
1285
+
1286
+ # @!method initialize(gcp_account_id: nil, gcp_offer_id: nil)
1287
+ # @param gcp_account_id [String]
1288
+ # @param gcp_offer_id [String]
1289
+ end
1290
+ end
22
1291
  end
23
1292
  end
24
1293
  end