spartera_api_sdk 0.3.6

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 (499) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +9 -0
  3. data/Gemfile +9 -0
  4. data/LICENSE +21 -0
  5. data/README.md +372 -0
  6. data/Rakefile +10 -0
  7. data/docs/APIKeysApi.md +537 -0
  8. data/docs/Alerts.md +30 -0
  9. data/docs/AlertsApi.md +525 -0
  10. data/docs/AlertsInput.md +24 -0
  11. data/docs/AlertsUpdate.md +24 -0
  12. data/docs/ApiKeys.md +40 -0
  13. data/docs/ApiKeysInput.md +34 -0
  14. data/docs/ApiKeysUpdate.md +34 -0
  15. data/docs/AssetPriceHistory.md +30 -0
  16. data/docs/AssetPriceHistoryApi.md +597 -0
  17. data/docs/AssetPriceHistoryInput.md +24 -0
  18. data/docs/AssetPriceHistoryUpdate.md +24 -0
  19. data/docs/AssetUsecases.md +28 -0
  20. data/docs/AssetUsecasesApi.md +157 -0
  21. data/docs/Assets.md +142 -0
  22. data/docs/AssetsApi.md +1197 -0
  23. data/docs/AssetsInput.md +128 -0
  24. data/docs/AssetsUpdate.md +128 -0
  25. data/docs/CloudProviders.md +28 -0
  26. data/docs/CloudProvidersApi.md +157 -0
  27. data/docs/CloudProvidersInput.md +22 -0
  28. data/docs/CloudProvidersUpdate.md +22 -0
  29. data/docs/Companies.md +46 -0
  30. data/docs/CompaniesApi.md +805 -0
  31. data/docs/CompaniesInput.md +40 -0
  32. data/docs/CompaniesUpdate.md +40 -0
  33. data/docs/Connections.md +38 -0
  34. data/docs/ConnectionsApi.md +607 -0
  35. data/docs/ConnectionsInput.md +32 -0
  36. data/docs/ConnectionsUpdate.md +32 -0
  37. data/docs/CreateAlerts200Response.md +20 -0
  38. data/docs/CreateAlerts200ResponseData.md +18 -0
  39. data/docs/CreateApiKeys200Response.md +20 -0
  40. data/docs/CreateApiKeys200ResponseData.md +18 -0
  41. data/docs/CreateAssetPriceHistory200Response.md +20 -0
  42. data/docs/CreateAssetPriceHistory200ResponseData.md +18 -0
  43. data/docs/CreateAssetsAnalyze200Response.md +20 -0
  44. data/docs/CreateAssetsAnalyze200ResponseData.md +18 -0
  45. data/docs/CreateConnections200Response.md +20 -0
  46. data/docs/CreateConnections200ResponseData.md +18 -0
  47. data/docs/CreateEndpoints200Response.md +20 -0
  48. data/docs/CreateEndpoints200ResponseData.md +18 -0
  49. data/docs/CreateFavorites200Response.md +20 -0
  50. data/docs/CreateFavorites200ResponseData.md +18 -0
  51. data/docs/CreatePostgenIntegrations200Response.md +20 -0
  52. data/docs/CreatePostgenIntegrations200ResponseData.md +18 -0
  53. data/docs/CreatePosts200Response.md +20 -0
  54. data/docs/CreatePosts200ResponseData.md +18 -0
  55. data/docs/CreateUsers200Response.md +20 -0
  56. data/docs/CreateUsers200ResponseData.md +18 -0
  57. data/docs/DeleteAlerts200Response.md +20 -0
  58. data/docs/DeleteAlerts200ResponseData.md +18 -0
  59. data/docs/DeleteApiKeys200Response.md +20 -0
  60. data/docs/DeleteApiKeys200ResponseData.md +18 -0
  61. data/docs/DeleteAssetPriceHistory200Response.md +20 -0
  62. data/docs/DeleteAssetPriceHistory200ResponseData.md +18 -0
  63. data/docs/DeleteAssets200Response.md +20 -0
  64. data/docs/DeleteAssets200ResponseData.md +18 -0
  65. data/docs/DeleteConnections200Response.md +20 -0
  66. data/docs/DeleteConnections200ResponseData.md +18 -0
  67. data/docs/DeleteEndpoints200Response.md +20 -0
  68. data/docs/DeleteEndpoints200ResponseData.md +18 -0
  69. data/docs/DeleteFavorites200Response.md +20 -0
  70. data/docs/DeleteFavorites200ResponseData.md +18 -0
  71. data/docs/DeletePostgenIntegrations200Response.md +20 -0
  72. data/docs/DeletePostgenIntegrations200ResponseData.md +18 -0
  73. data/docs/DeletePosts200Response.md +20 -0
  74. data/docs/DeletePosts200ResponseData.md +18 -0
  75. data/docs/DeleteUsers200Response.md +20 -0
  76. data/docs/DeleteUsers200ResponseData.md +18 -0
  77. data/docs/Endpoints.md +96 -0
  78. data/docs/EndpointsApi.md +1189 -0
  79. data/docs/EndpointsInput.md +94 -0
  80. data/docs/EndpointsUpdate.md +94 -0
  81. data/docs/Error.md +24 -0
  82. data/docs/Favorites.md +34 -0
  83. data/docs/FavoritesApi.md +597 -0
  84. data/docs/FavoritesInput.md +28 -0
  85. data/docs/FavoritesUpdate.md +28 -0
  86. data/docs/GetAlertsById200Response.md +20 -0
  87. data/docs/GetApiKeysById200Response.md +20 -0
  88. data/docs/GetAssetPriceHistoryById200Response.md +20 -0
  89. data/docs/GetAssetUsecasesById200Response.md +20 -0
  90. data/docs/GetAssetsByIdAnalyze200Response.md +20 -0
  91. data/docs/GetCloudProvidersById200Response.md +20 -0
  92. data/docs/GetCompaniesById200Response.md +20 -0
  93. data/docs/GetConnectionsById200Response.md +20 -0
  94. data/docs/GetEndpointsByIdConnectionsDescribe200Response.md +20 -0
  95. data/docs/GetFavoritesById200Response.md +20 -0
  96. data/docs/GetIndustriesById200Response.md +20 -0
  97. data/docs/GetJobFunctionsById200Response.md +20 -0
  98. data/docs/GetPostgenIntegrationsById200Response.md +20 -0
  99. data/docs/GetPostsById200Response.md +20 -0
  100. data/docs/GetStorageEnginesById200Response.md +20 -0
  101. data/docs/GetUsersById200Response.md +20 -0
  102. data/docs/Industries.md +32 -0
  103. data/docs/IndustriesApi.md +237 -0
  104. data/docs/InlineObject.md +22 -0
  105. data/docs/InlineObject1.md +20 -0
  106. data/docs/InlineObject2.md +20 -0
  107. data/docs/InlineObject3.md +20 -0
  108. data/docs/InlineObject4.md +20 -0
  109. data/docs/InlineObject5.md +20 -0
  110. data/docs/InlineObject6.md +22 -0
  111. data/docs/InlineObject7.md +20 -0
  112. data/docs/JobFunctions.md +24 -0
  113. data/docs/JobFunctionsApi.md +157 -0
  114. data/docs/JobFunctionsInput.md +18 -0
  115. data/docs/JobFunctionsUpdate.md +18 -0
  116. data/docs/ListApiKeys200Response.md +20 -0
  117. data/docs/ListAssetUsecases200Response.md +20 -0
  118. data/docs/ListAssets200Response.md +20 -0
  119. data/docs/ListCloudProviders200Response.md +20 -0
  120. data/docs/ListCompaniesAnalyticsAssets200Response.md +20 -0
  121. data/docs/ListConnections200Response.md +20 -0
  122. data/docs/ListEndpoints200Response.md +20 -0
  123. data/docs/ListIndustries200Response.md +20 -0
  124. data/docs/ListJobFunctions200Response.md +20 -0
  125. data/docs/ListPostgenIntegrations200Response.md +20 -0
  126. data/docs/ListPosts200Response.md +20 -0
  127. data/docs/ListStorageEngines200Response.md +20 -0
  128. data/docs/ListUsers200Response.md +20 -0
  129. data/docs/PostPublications.md +40 -0
  130. data/docs/PostPublicationsInput.md +34 -0
  131. data/docs/PostPublicationsUpdate.md +34 -0
  132. data/docs/PostgenIntegrations.md +36 -0
  133. data/docs/PostgenIntegrationsApi.md +463 -0
  134. data/docs/PostgenIntegrationsInput.md +30 -0
  135. data/docs/PostgenIntegrationsUpdate.md +30 -0
  136. data/docs/Posts.md +68 -0
  137. data/docs/PostsApi.md +843 -0
  138. data/docs/PostsInput.md +62 -0
  139. data/docs/PostsUpdate.md +62 -0
  140. data/docs/StorageEngines.md +32 -0
  141. data/docs/StorageEnginesApi.md +161 -0
  142. data/docs/UpdateAlerts200Response.md +20 -0
  143. data/docs/UpdateAlerts200ResponseData.md +18 -0
  144. data/docs/UpdateApiKeys200Response.md +20 -0
  145. data/docs/UpdateApiKeys200ResponseData.md +18 -0
  146. data/docs/UpdateAssetPriceHistory200Response.md +20 -0
  147. data/docs/UpdateAssetPriceHistory200ResponseData.md +18 -0
  148. data/docs/UpdateAssets200Response.md +20 -0
  149. data/docs/UpdateAssets200ResponseData.md +18 -0
  150. data/docs/UpdateCompanies200Response.md +20 -0
  151. data/docs/UpdateCompanies200ResponseData.md +18 -0
  152. data/docs/UpdateConnections200Response.md +20 -0
  153. data/docs/UpdateConnections200ResponseData.md +18 -0
  154. data/docs/UpdateEndpoints200Response.md +20 -0
  155. data/docs/UpdateEndpoints200ResponseData.md +18 -0
  156. data/docs/UpdateFavorites200Response.md +20 -0
  157. data/docs/UpdateFavorites200ResponseData.md +18 -0
  158. data/docs/UpdatePostgenIntegrations200Response.md +20 -0
  159. data/docs/UpdatePostgenIntegrations200ResponseData.md +18 -0
  160. data/docs/UpdatePosts200Response.md +20 -0
  161. data/docs/UpdatePosts200ResponseData.md +18 -0
  162. data/docs/UpdateUsers200Response.md +20 -0
  163. data/docs/UpdateUsers200ResponseData.md +18 -0
  164. data/docs/Users.md +36 -0
  165. data/docs/UsersApi.md +639 -0
  166. data/docs/UsersInput.md +30 -0
  167. data/docs/UsersUpdate.md +30 -0
  168. data/git_push.sh +57 -0
  169. data/lib/spartera_api_sdk/api/alerts_api.rb +790 -0
  170. data/lib/spartera_api_sdk/api/api_keys_api.rb +746 -0
  171. data/lib/spartera_api_sdk/api/asset_price_history_api.rb +867 -0
  172. data/lib/spartera_api_sdk/api/asset_usecases_api.rb +190 -0
  173. data/lib/spartera_api_sdk/api/assets_api.rb +1554 -0
  174. data/lib/spartera_api_sdk/api/cloud_providers_api.rb +190 -0
  175. data/lib/spartera_api_sdk/api/companies_api.rb +1085 -0
  176. data/lib/spartera_api_sdk/api/connections_api.rb +828 -0
  177. data/lib/spartera_api_sdk/api/endpoints_api.rb +1613 -0
  178. data/lib/spartera_api_sdk/api/favorites_api.rb +870 -0
  179. data/lib/spartera_api_sdk/api/industries_api.rb +284 -0
  180. data/lib/spartera_api_sdk/api/job_functions_api.rb +190 -0
  181. data/lib/spartera_api_sdk/api/postgen_integrations_api.rb +634 -0
  182. data/lib/spartera_api_sdk/api/posts_api.rb +1190 -0
  183. data/lib/spartera_api_sdk/api/storage_engines_api.rb +228 -0
  184. data/lib/spartera_api_sdk/api/users_api.rb +891 -0
  185. data/lib/spartera_api_sdk/api_client.rb +397 -0
  186. data/lib/spartera_api_sdk/api_error.rb +58 -0
  187. data/lib/spartera_api_sdk/api_model_base.rb +88 -0
  188. data/lib/spartera_api_sdk/configuration.rb +312 -0
  189. data/lib/spartera_api_sdk/models/alerts.rb +260 -0
  190. data/lib/spartera_api_sdk/models/alerts_input.rb +213 -0
  191. data/lib/spartera_api_sdk/models/alerts_update.rb +179 -0
  192. data/lib/spartera_api_sdk/models/api_keys.rb +344 -0
  193. data/lib/spartera_api_sdk/models/api_keys_input.rb +263 -0
  194. data/lib/spartera_api_sdk/models/api_keys_update.rb +229 -0
  195. data/lib/spartera_api_sdk/models/asset_price_history.rb +209 -0
  196. data/lib/spartera_api_sdk/models/asset_price_history_input.rb +179 -0
  197. data/lib/spartera_api_sdk/models/asset_price_history_update.rb +179 -0
  198. data/lib/spartera_api_sdk/models/asset_usecases.rb +216 -0
  199. data/lib/spartera_api_sdk/models/assets.rb +1068 -0
  200. data/lib/spartera_api_sdk/models/assets_input.rb +918 -0
  201. data/lib/spartera_api_sdk/models/assets_update.rb +877 -0
  202. data/lib/spartera_api_sdk/models/cloud_providers.rb +216 -0
  203. data/lib/spartera_api_sdk/models/cloud_providers_input.rb +186 -0
  204. data/lib/spartera_api_sdk/models/cloud_providers_update.rb +169 -0
  205. data/lib/spartera_api_sdk/models/companies.rb +374 -0
  206. data/lib/spartera_api_sdk/models/companies_input.rb +327 -0
  207. data/lib/spartera_api_sdk/models/companies_update.rb +293 -0
  208. data/lib/spartera_api_sdk/models/connections.rb +317 -0
  209. data/lib/spartera_api_sdk/models/connections_input.rb +287 -0
  210. data/lib/spartera_api_sdk/models/connections_update.rb +253 -0
  211. data/lib/spartera_api_sdk/models/create_alerts200_response.rb +191 -0
  212. data/lib/spartera_api_sdk/models/create_alerts200_response_data.rb +165 -0
  213. data/lib/spartera_api_sdk/models/create_api_keys200_response.rb +191 -0
  214. data/lib/spartera_api_sdk/models/create_api_keys200_response_data.rb +165 -0
  215. data/lib/spartera_api_sdk/models/create_asset_price_history200_response.rb +191 -0
  216. data/lib/spartera_api_sdk/models/create_asset_price_history200_response_data.rb +165 -0
  217. data/lib/spartera_api_sdk/models/create_assets_analyze200_response.rb +191 -0
  218. data/lib/spartera_api_sdk/models/create_assets_analyze200_response_data.rb +165 -0
  219. data/lib/spartera_api_sdk/models/create_connections200_response.rb +191 -0
  220. data/lib/spartera_api_sdk/models/create_connections200_response_data.rb +165 -0
  221. data/lib/spartera_api_sdk/models/create_endpoints200_response.rb +191 -0
  222. data/lib/spartera_api_sdk/models/create_endpoints200_response_data.rb +165 -0
  223. data/lib/spartera_api_sdk/models/create_favorites200_response.rb +191 -0
  224. data/lib/spartera_api_sdk/models/create_favorites200_response_data.rb +165 -0
  225. data/lib/spartera_api_sdk/models/create_postgen_integrations200_response.rb +191 -0
  226. data/lib/spartera_api_sdk/models/create_postgen_integrations200_response_data.rb +165 -0
  227. data/lib/spartera_api_sdk/models/create_posts200_response.rb +191 -0
  228. data/lib/spartera_api_sdk/models/create_posts200_response_data.rb +165 -0
  229. data/lib/spartera_api_sdk/models/create_users200_response.rb +191 -0
  230. data/lib/spartera_api_sdk/models/create_users200_response_data.rb +165 -0
  231. data/lib/spartera_api_sdk/models/delete_alerts200_response.rb +191 -0
  232. data/lib/spartera_api_sdk/models/delete_alerts200_response_data.rb +165 -0
  233. data/lib/spartera_api_sdk/models/delete_api_keys200_response.rb +191 -0
  234. data/lib/spartera_api_sdk/models/delete_api_keys200_response_data.rb +165 -0
  235. data/lib/spartera_api_sdk/models/delete_asset_price_history200_response.rb +191 -0
  236. data/lib/spartera_api_sdk/models/delete_asset_price_history200_response_data.rb +165 -0
  237. data/lib/spartera_api_sdk/models/delete_assets200_response.rb +191 -0
  238. data/lib/spartera_api_sdk/models/delete_assets200_response_data.rb +165 -0
  239. data/lib/spartera_api_sdk/models/delete_connections200_response.rb +191 -0
  240. data/lib/spartera_api_sdk/models/delete_connections200_response_data.rb +165 -0
  241. data/lib/spartera_api_sdk/models/delete_endpoints200_response.rb +191 -0
  242. data/lib/spartera_api_sdk/models/delete_endpoints200_response_data.rb +165 -0
  243. data/lib/spartera_api_sdk/models/delete_favorites200_response.rb +191 -0
  244. data/lib/spartera_api_sdk/models/delete_favorites200_response_data.rb +165 -0
  245. data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response.rb +191 -0
  246. data/lib/spartera_api_sdk/models/delete_postgen_integrations200_response_data.rb +165 -0
  247. data/lib/spartera_api_sdk/models/delete_posts200_response.rb +191 -0
  248. data/lib/spartera_api_sdk/models/delete_posts200_response_data.rb +165 -0
  249. data/lib/spartera_api_sdk/models/delete_users200_response.rb +191 -0
  250. data/lib/spartera_api_sdk/models/delete_users200_response_data.rb +165 -0
  251. data/lib/spartera_api_sdk/models/endpoints.rb +788 -0
  252. data/lib/spartera_api_sdk/models/endpoints_input.rb +686 -0
  253. data/lib/spartera_api_sdk/models/endpoints_update.rb +635 -0
  254. data/lib/spartera_api_sdk/models/error.rb +212 -0
  255. data/lib/spartera_api_sdk/models/favorites.rb +280 -0
  256. data/lib/spartera_api_sdk/models/favorites_input.rb +233 -0
  257. data/lib/spartera_api_sdk/models/favorites_update.rb +199 -0
  258. data/lib/spartera_api_sdk/models/get_alerts_by_id200_response.rb +191 -0
  259. data/lib/spartera_api_sdk/models/get_api_keys_by_id200_response.rb +191 -0
  260. data/lib/spartera_api_sdk/models/get_asset_price_history_by_id200_response.rb +191 -0
  261. data/lib/spartera_api_sdk/models/get_asset_usecases_by_id200_response.rb +191 -0
  262. data/lib/spartera_api_sdk/models/get_assets_by_id_analyze200_response.rb +191 -0
  263. data/lib/spartera_api_sdk/models/get_cloud_providers_by_id200_response.rb +191 -0
  264. data/lib/spartera_api_sdk/models/get_companies_by_id200_response.rb +191 -0
  265. data/lib/spartera_api_sdk/models/get_connections_by_id200_response.rb +191 -0
  266. data/lib/spartera_api_sdk/models/get_endpoints_by_id_connections_describe200_response.rb +191 -0
  267. data/lib/spartera_api_sdk/models/get_favorites_by_id200_response.rb +191 -0
  268. data/lib/spartera_api_sdk/models/get_industries_by_id200_response.rb +191 -0
  269. data/lib/spartera_api_sdk/models/get_job_functions_by_id200_response.rb +191 -0
  270. data/lib/spartera_api_sdk/models/get_postgen_integrations_by_id200_response.rb +191 -0
  271. data/lib/spartera_api_sdk/models/get_posts_by_id200_response.rb +191 -0
  272. data/lib/spartera_api_sdk/models/get_storage_engines_by_id200_response.rb +191 -0
  273. data/lib/spartera_api_sdk/models/get_users_by_id200_response.rb +191 -0
  274. data/lib/spartera_api_sdk/models/industries.rb +253 -0
  275. data/lib/spartera_api_sdk/models/inline_object.rb +167 -0
  276. data/lib/spartera_api_sdk/models/inline_object1.rb +156 -0
  277. data/lib/spartera_api_sdk/models/inline_object2.rb +156 -0
  278. data/lib/spartera_api_sdk/models/inline_object3.rb +156 -0
  279. data/lib/spartera_api_sdk/models/inline_object4.rb +156 -0
  280. data/lib/spartera_api_sdk/models/inline_object5.rb +156 -0
  281. data/lib/spartera_api_sdk/models/inline_object6.rb +166 -0
  282. data/lib/spartera_api_sdk/models/inline_object7.rb +156 -0
  283. data/lib/spartera_api_sdk/models/job_functions.rb +213 -0
  284. data/lib/spartera_api_sdk/models/job_functions_input.rb +166 -0
  285. data/lib/spartera_api_sdk/models/job_functions_update.rb +149 -0
  286. data/lib/spartera_api_sdk/models/list_api_keys200_response.rb +193 -0
  287. data/lib/spartera_api_sdk/models/list_asset_usecases200_response.rb +193 -0
  288. data/lib/spartera_api_sdk/models/list_assets200_response.rb +193 -0
  289. data/lib/spartera_api_sdk/models/list_cloud_providers200_response.rb +193 -0
  290. data/lib/spartera_api_sdk/models/list_companies_analytics_assets200_response.rb +193 -0
  291. data/lib/spartera_api_sdk/models/list_connections200_response.rb +193 -0
  292. data/lib/spartera_api_sdk/models/list_endpoints200_response.rb +193 -0
  293. data/lib/spartera_api_sdk/models/list_industries200_response.rb +193 -0
  294. data/lib/spartera_api_sdk/models/list_job_functions200_response.rb +193 -0
  295. data/lib/spartera_api_sdk/models/list_postgen_integrations200_response.rb +193 -0
  296. data/lib/spartera_api_sdk/models/list_posts200_response.rb +193 -0
  297. data/lib/spartera_api_sdk/models/list_storage_engines200_response.rb +193 -0
  298. data/lib/spartera_api_sdk/models/list_users200_response.rb +193 -0
  299. data/lib/spartera_api_sdk/models/post_publications.rb +327 -0
  300. data/lib/spartera_api_sdk/models/post_publications_input.rb +280 -0
  301. data/lib/spartera_api_sdk/models/post_publications_update.rb +229 -0
  302. data/lib/spartera_api_sdk/models/postgen_integrations.rb +341 -0
  303. data/lib/spartera_api_sdk/models/postgen_integrations_input.rb +294 -0
  304. data/lib/spartera_api_sdk/models/postgen_integrations_update.rb +209 -0
  305. data/lib/spartera_api_sdk/models/posts.rb +586 -0
  306. data/lib/spartera_api_sdk/models/posts_input.rb +437 -0
  307. data/lib/spartera_api_sdk/models/posts_update.rb +369 -0
  308. data/lib/spartera_api_sdk/models/storage_engines.rb +294 -0
  309. data/lib/spartera_api_sdk/models/update_alerts200_response.rb +191 -0
  310. data/lib/spartera_api_sdk/models/update_alerts200_response_data.rb +165 -0
  311. data/lib/spartera_api_sdk/models/update_api_keys200_response.rb +191 -0
  312. data/lib/spartera_api_sdk/models/update_api_keys200_response_data.rb +165 -0
  313. data/lib/spartera_api_sdk/models/update_asset_price_history200_response.rb +191 -0
  314. data/lib/spartera_api_sdk/models/update_asset_price_history200_response_data.rb +165 -0
  315. data/lib/spartera_api_sdk/models/update_assets200_response.rb +191 -0
  316. data/lib/spartera_api_sdk/models/update_assets200_response_data.rb +165 -0
  317. data/lib/spartera_api_sdk/models/update_companies200_response.rb +191 -0
  318. data/lib/spartera_api_sdk/models/update_companies200_response_data.rb +165 -0
  319. data/lib/spartera_api_sdk/models/update_connections200_response.rb +191 -0
  320. data/lib/spartera_api_sdk/models/update_connections200_response_data.rb +165 -0
  321. data/lib/spartera_api_sdk/models/update_endpoints200_response.rb +191 -0
  322. data/lib/spartera_api_sdk/models/update_endpoints200_response_data.rb +165 -0
  323. data/lib/spartera_api_sdk/models/update_favorites200_response.rb +191 -0
  324. data/lib/spartera_api_sdk/models/update_favorites200_response_data.rb +165 -0
  325. data/lib/spartera_api_sdk/models/update_postgen_integrations200_response.rb +191 -0
  326. data/lib/spartera_api_sdk/models/update_postgen_integrations200_response_data.rb +165 -0
  327. data/lib/spartera_api_sdk/models/update_posts200_response.rb +191 -0
  328. data/lib/spartera_api_sdk/models/update_posts200_response_data.rb +165 -0
  329. data/lib/spartera_api_sdk/models/update_users200_response.rb +191 -0
  330. data/lib/spartera_api_sdk/models/update_users200_response_data.rb +165 -0
  331. data/lib/spartera_api_sdk/models/users.rb +331 -0
  332. data/lib/spartera_api_sdk/models/users_input.rb +260 -0
  333. data/lib/spartera_api_sdk/models/users_update.rb +243 -0
  334. data/lib/spartera_api_sdk/version.rb +15 -0
  335. data/lib/spartera_api_sdk.rb +201 -0
  336. data/spartera_api_sdk.gemspec +39 -0
  337. data/spec/api/alerts_api_spec.rb +126 -0
  338. data/spec/api/api_keys_api_spec.rb +130 -0
  339. data/spec/api/asset_price_history_api_spec.rb +138 -0
  340. data/spec/api/asset_usecases_api_spec.rb +61 -0
  341. data/spec/api/assets_api_spec.rb +243 -0
  342. data/spec/api/cloud_providers_api_spec.rb +61 -0
  343. data/spec/api/companies_api_spec.rb +186 -0
  344. data/spec/api/connections_api_spec.rb +141 -0
  345. data/spec/api/endpoints_api_spec.rb +240 -0
  346. data/spec/api/favorites_api_spec.rb +138 -0
  347. data/spec/api/industries_api_spec.rb +76 -0
  348. data/spec/api/job_functions_api_spec.rb +61 -0
  349. data/spec/api/postgen_integrations_api_spec.rb +117 -0
  350. data/spec/api/posts_api_spec.rb +186 -0
  351. data/spec/api/storage_engines_api_spec.rb +63 -0
  352. data/spec/api/users_api_spec.rb +154 -0
  353. data/spec/models/alerts_input_spec.rb +54 -0
  354. data/spec/models/alerts_spec.rb +72 -0
  355. data/spec/models/alerts_update_spec.rb +54 -0
  356. data/spec/models/api_keys_input_spec.rb +84 -0
  357. data/spec/models/api_keys_spec.rb +102 -0
  358. data/spec/models/api_keys_update_spec.rb +84 -0
  359. data/spec/models/asset_price_history_input_spec.rb +54 -0
  360. data/spec/models/asset_price_history_spec.rb +72 -0
  361. data/spec/models/asset_price_history_update_spec.rb +54 -0
  362. data/spec/models/asset_usecases_spec.rb +66 -0
  363. data/spec/models/assets_input_spec.rb +418 -0
  364. data/spec/models/assets_spec.rb +464 -0
  365. data/spec/models/assets_update_spec.rb +418 -0
  366. data/spec/models/cloud_providers_input_spec.rb +48 -0
  367. data/spec/models/cloud_providers_spec.rb +66 -0
  368. data/spec/models/cloud_providers_update_spec.rb +48 -0
  369. data/spec/models/companies_input_spec.rb +106 -0
  370. data/spec/models/companies_spec.rb +124 -0
  371. data/spec/models/companies_update_spec.rb +106 -0
  372. data/spec/models/connections_input_spec.rb +82 -0
  373. data/spec/models/connections_spec.rb +100 -0
  374. data/spec/models/connections_update_spec.rb +82 -0
  375. data/spec/models/create_alerts200_response_data_spec.rb +36 -0
  376. data/spec/models/create_alerts200_response_spec.rb +42 -0
  377. data/spec/models/create_api_keys200_response_data_spec.rb +36 -0
  378. data/spec/models/create_api_keys200_response_spec.rb +42 -0
  379. data/spec/models/create_asset_price_history200_response_data_spec.rb +36 -0
  380. data/spec/models/create_asset_price_history200_response_spec.rb +42 -0
  381. data/spec/models/create_assets_analyze200_response_data_spec.rb +36 -0
  382. data/spec/models/create_assets_analyze200_response_spec.rb +42 -0
  383. data/spec/models/create_connections200_response_data_spec.rb +36 -0
  384. data/spec/models/create_connections200_response_spec.rb +42 -0
  385. data/spec/models/create_endpoints200_response_data_spec.rb +36 -0
  386. data/spec/models/create_endpoints200_response_spec.rb +42 -0
  387. data/spec/models/create_favorites200_response_data_spec.rb +36 -0
  388. data/spec/models/create_favorites200_response_spec.rb +42 -0
  389. data/spec/models/create_postgen_integrations200_response_data_spec.rb +36 -0
  390. data/spec/models/create_postgen_integrations200_response_spec.rb +42 -0
  391. data/spec/models/create_posts200_response_data_spec.rb +36 -0
  392. data/spec/models/create_posts200_response_spec.rb +42 -0
  393. data/spec/models/create_users200_response_data_spec.rb +36 -0
  394. data/spec/models/create_users200_response_spec.rb +42 -0
  395. data/spec/models/delete_alerts200_response_data_spec.rb +36 -0
  396. data/spec/models/delete_alerts200_response_spec.rb +42 -0
  397. data/spec/models/delete_api_keys200_response_data_spec.rb +36 -0
  398. data/spec/models/delete_api_keys200_response_spec.rb +42 -0
  399. data/spec/models/delete_asset_price_history200_response_data_spec.rb +36 -0
  400. data/spec/models/delete_asset_price_history200_response_spec.rb +42 -0
  401. data/spec/models/delete_assets200_response_data_spec.rb +36 -0
  402. data/spec/models/delete_assets200_response_spec.rb +42 -0
  403. data/spec/models/delete_connections200_response_data_spec.rb +36 -0
  404. data/spec/models/delete_connections200_response_spec.rb +42 -0
  405. data/spec/models/delete_endpoints200_response_data_spec.rb +36 -0
  406. data/spec/models/delete_endpoints200_response_spec.rb +42 -0
  407. data/spec/models/delete_favorites200_response_data_spec.rb +36 -0
  408. data/spec/models/delete_favorites200_response_spec.rb +42 -0
  409. data/spec/models/delete_postgen_integrations200_response_data_spec.rb +36 -0
  410. data/spec/models/delete_postgen_integrations200_response_spec.rb +42 -0
  411. data/spec/models/delete_posts200_response_data_spec.rb +36 -0
  412. data/spec/models/delete_posts200_response_spec.rb +42 -0
  413. data/spec/models/delete_users200_response_data_spec.rb +36 -0
  414. data/spec/models/delete_users200_response_spec.rb +42 -0
  415. data/spec/models/endpoints_input_spec.rb +292 -0
  416. data/spec/models/endpoints_spec.rb +298 -0
  417. data/spec/models/endpoints_update_spec.rb +292 -0
  418. data/spec/models/error_spec.rb +54 -0
  419. data/spec/models/favorites_input_spec.rb +66 -0
  420. data/spec/models/favorites_spec.rb +84 -0
  421. data/spec/models/favorites_update_spec.rb +66 -0
  422. data/spec/models/get_alerts_by_id200_response_spec.rb +42 -0
  423. data/spec/models/get_api_keys_by_id200_response_spec.rb +42 -0
  424. data/spec/models/get_asset_price_history_by_id200_response_spec.rb +42 -0
  425. data/spec/models/get_asset_usecases_by_id200_response_spec.rb +42 -0
  426. data/spec/models/get_assets_by_id_analyze200_response_spec.rb +42 -0
  427. data/spec/models/get_cloud_providers_by_id200_response_spec.rb +42 -0
  428. data/spec/models/get_companies_by_id200_response_spec.rb +42 -0
  429. data/spec/models/get_connections_by_id200_response_spec.rb +42 -0
  430. data/spec/models/get_endpoints_by_id_connections_describe200_response_spec.rb +42 -0
  431. data/spec/models/get_favorites_by_id200_response_spec.rb +42 -0
  432. data/spec/models/get_industries_by_id200_response_spec.rb +42 -0
  433. data/spec/models/get_job_functions_by_id200_response_spec.rb +42 -0
  434. data/spec/models/get_postgen_integrations_by_id200_response_spec.rb +42 -0
  435. data/spec/models/get_posts_by_id200_response_spec.rb +42 -0
  436. data/spec/models/get_storage_engines_by_id200_response_spec.rb +42 -0
  437. data/spec/models/get_users_by_id200_response_spec.rb +42 -0
  438. data/spec/models/industries_spec.rb +78 -0
  439. data/spec/models/inline_object1_spec.rb +42 -0
  440. data/spec/models/inline_object2_spec.rb +42 -0
  441. data/spec/models/inline_object3_spec.rb +42 -0
  442. data/spec/models/inline_object4_spec.rb +42 -0
  443. data/spec/models/inline_object5_spec.rb +42 -0
  444. data/spec/models/inline_object6_spec.rb +48 -0
  445. data/spec/models/inline_object7_spec.rb +42 -0
  446. data/spec/models/inline_object_spec.rb +48 -0
  447. data/spec/models/job_functions_input_spec.rb +36 -0
  448. data/spec/models/job_functions_spec.rb +54 -0
  449. data/spec/models/job_functions_update_spec.rb +36 -0
  450. data/spec/models/list_api_keys200_response_spec.rb +42 -0
  451. data/spec/models/list_asset_usecases200_response_spec.rb +42 -0
  452. data/spec/models/list_assets200_response_spec.rb +42 -0
  453. data/spec/models/list_cloud_providers200_response_spec.rb +42 -0
  454. data/spec/models/list_companies_analytics_assets200_response_spec.rb +42 -0
  455. data/spec/models/list_connections200_response_spec.rb +42 -0
  456. data/spec/models/list_endpoints200_response_spec.rb +42 -0
  457. data/spec/models/list_industries200_response_spec.rb +42 -0
  458. data/spec/models/list_job_functions200_response_spec.rb +42 -0
  459. data/spec/models/list_postgen_integrations200_response_spec.rb +42 -0
  460. data/spec/models/list_posts200_response_spec.rb +42 -0
  461. data/spec/models/list_storage_engines200_response_spec.rb +42 -0
  462. data/spec/models/list_users200_response_spec.rb +42 -0
  463. data/spec/models/post_publications_input_spec.rb +84 -0
  464. data/spec/models/post_publications_spec.rb +102 -0
  465. data/spec/models/post_publications_update_spec.rb +84 -0
  466. data/spec/models/postgen_integrations_input_spec.rb +72 -0
  467. data/spec/models/postgen_integrations_spec.rb +90 -0
  468. data/spec/models/postgen_integrations_update_spec.rb +72 -0
  469. data/spec/models/posts_input_spec.rb +168 -0
  470. data/spec/models/posts_spec.rb +186 -0
  471. data/spec/models/posts_update_spec.rb +168 -0
  472. data/spec/models/storage_engines_spec.rb +82 -0
  473. data/spec/models/update_alerts200_response_data_spec.rb +36 -0
  474. data/spec/models/update_alerts200_response_spec.rb +42 -0
  475. data/spec/models/update_api_keys200_response_data_spec.rb +36 -0
  476. data/spec/models/update_api_keys200_response_spec.rb +42 -0
  477. data/spec/models/update_asset_price_history200_response_data_spec.rb +36 -0
  478. data/spec/models/update_asset_price_history200_response_spec.rb +42 -0
  479. data/spec/models/update_assets200_response_data_spec.rb +36 -0
  480. data/spec/models/update_assets200_response_spec.rb +42 -0
  481. data/spec/models/update_companies200_response_data_spec.rb +36 -0
  482. data/spec/models/update_companies200_response_spec.rb +42 -0
  483. data/spec/models/update_connections200_response_data_spec.rb +36 -0
  484. data/spec/models/update_connections200_response_spec.rb +42 -0
  485. data/spec/models/update_endpoints200_response_data_spec.rb +36 -0
  486. data/spec/models/update_endpoints200_response_spec.rb +42 -0
  487. data/spec/models/update_favorites200_response_data_spec.rb +36 -0
  488. data/spec/models/update_favorites200_response_spec.rb +42 -0
  489. data/spec/models/update_postgen_integrations200_response_data_spec.rb +36 -0
  490. data/spec/models/update_postgen_integrations200_response_spec.rb +42 -0
  491. data/spec/models/update_posts200_response_data_spec.rb +36 -0
  492. data/spec/models/update_posts200_response_spec.rb +42 -0
  493. data/spec/models/update_users200_response_data_spec.rb +36 -0
  494. data/spec/models/update_users200_response_spec.rb +42 -0
  495. data/spec/models/users_input_spec.rb +76 -0
  496. data/spec/models/users_spec.rb +94 -0
  497. data/spec/models/users_update_spec.rb +76 -0
  498. data/spec/spec_helper.rb +111 -0
  499. metadata +742 -0
@@ -0,0 +1,597 @@
1
+ # SparteraApiSdk::FavoritesApi
2
+
3
+ All URIs are relative to *https://api.spartera.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_favorites**](FavoritesApi.md#create_favorites) | **POST** /companies/{company_id}/users/{user_id}/favorites | POST /companies/{company_id}/users/{user_id}/favorites |
8
+ | [**delete_favorites**](FavoritesApi.md#delete_favorites) | **DELETE** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Delete single favorite by ID (unfavorite an asset) |
9
+ | [**get_favorites_by_id**](FavoritesApi.md#get_favorites_by_id) | **GET** /companies/{company_id}/users/{user_id}/favorites | Get a list of all favorites for a specific user |
10
+ | [**get_favorites_by_id_users**](FavoritesApi.md#get_favorites_by_id_users) | **GET** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Get single favorite by ID |
11
+ | [**get_favorites_by_id_users_category**](FavoritesApi.md#get_favorites_by_id_users_category) | **GET** /companies/{company_id}/users/{user_id}/favorites/category/{category} | Get all favorites for the specified user in a specific category |
12
+ | [**get_favorites_by_id_users_check**](FavoritesApi.md#get_favorites_by_id_users_check) | **GET** /companies/{company_id}/users/{user_id}/favorites/check/{asset_id} | Check if the specified user has favorited a specific asset |
13
+ | [**get_favorites_by_id_users_uncategorized**](FavoritesApi.md#get_favorites_by_id_users_uncategorized) | **GET** /companies/{company_id}/users/{user_id}/favorites/uncategorized | Get all favorites for the specified user that don't have a category |
14
+ | [**update_favorites**](FavoritesApi.md#update_favorites) | **PATCH** /companies/{company_id}/users/{user_id}/favorites/{favorite_id} | Update an existing favorite by ID |
15
+
16
+
17
+ ## create_favorites
18
+
19
+ > <CreateFavorites200Response> create_favorites(company_id, user_id, favorites_input)
20
+
21
+ POST /companies/{company_id}/users/{user_id}/favorites
22
+
23
+ ### Examples
24
+
25
+ ```ruby
26
+ require 'time'
27
+ require 'spartera_api_sdk'
28
+ # setup authorization
29
+ SparteraApiSdk.configure do |config|
30
+ # Configure API key authorization: ApiKeyAuth
31
+ config.api_key['x-api-key'] = 'YOUR API KEY'
32
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
33
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
34
+ end
35
+
36
+ api_instance = SparteraApiSdk::FavoritesApi.new
37
+ company_id = 'company_id_example' # String | Unique identifier for the Company
38
+ user_id = 'user_id_example' # String | Unique identifier for the User
39
+ favorites_input = SparteraApiSdk::FavoritesInput.new({asset_id: 'asset_id_abc123', company_id: 'company_id_abc123'}) # FavoritesInput |
40
+
41
+ begin
42
+ # POST /companies/{company_id}/users/{user_id}/favorites
43
+ result = api_instance.create_favorites(company_id, user_id, favorites_input)
44
+ p result
45
+ rescue SparteraApiSdk::ApiError => e
46
+ puts "Error when calling FavoritesApi->create_favorites: #{e}"
47
+ end
48
+ ```
49
+
50
+ #### Using the create_favorites_with_http_info variant
51
+
52
+ This returns an Array which contains the response data, status code and headers.
53
+
54
+ > <Array(<CreateFavorites200Response>, Integer, Hash)> create_favorites_with_http_info(company_id, user_id, favorites_input)
55
+
56
+ ```ruby
57
+ begin
58
+ # POST /companies/{company_id}/users/{user_id}/favorites
59
+ data, status_code, headers = api_instance.create_favorites_with_http_info(company_id, user_id, favorites_input)
60
+ p status_code # => 2xx
61
+ p headers # => { ... }
62
+ p data # => <CreateFavorites200Response>
63
+ rescue SparteraApiSdk::ApiError => e
64
+ puts "Error when calling FavoritesApi->create_favorites_with_http_info: #{e}"
65
+ end
66
+ ```
67
+
68
+ ### Parameters
69
+
70
+ | Name | Type | Description | Notes |
71
+ | ---- | ---- | ----------- | ----- |
72
+ | **company_id** | **String** | Unique identifier for the Company | |
73
+ | **user_id** | **String** | Unique identifier for the User | |
74
+ | **favorites_input** | [**FavoritesInput**](FavoritesInput.md) | | |
75
+
76
+ ### Return type
77
+
78
+ [**CreateFavorites200Response**](CreateFavorites200Response.md)
79
+
80
+ ### Authorization
81
+
82
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
83
+
84
+ ### HTTP request headers
85
+
86
+ - **Content-Type**: application/json
87
+ - **Accept**: application/json
88
+
89
+
90
+ ## delete_favorites
91
+
92
+ > <DeleteFavorites200Response> delete_favorites(company_id, user_id, favorite_id)
93
+
94
+ Delete single favorite by ID (unfavorite an asset)
95
+
96
+ ### Examples
97
+
98
+ ```ruby
99
+ require 'time'
100
+ require 'spartera_api_sdk'
101
+ # setup authorization
102
+ SparteraApiSdk.configure do |config|
103
+ # Configure API key authorization: ApiKeyAuth
104
+ config.api_key['x-api-key'] = 'YOUR API KEY'
105
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
106
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
107
+ end
108
+
109
+ api_instance = SparteraApiSdk::FavoritesApi.new
110
+ company_id = 'company_id_example' # String | Unique identifier for the Company
111
+ user_id = 'user_id_example' # String | Unique identifier for the User
112
+ favorite_id = 'favorite_id_example' # String | Unique identifier for the Favorite
113
+
114
+ begin
115
+ # Delete single favorite by ID (unfavorite an asset)
116
+ result = api_instance.delete_favorites(company_id, user_id, favorite_id)
117
+ p result
118
+ rescue SparteraApiSdk::ApiError => e
119
+ puts "Error when calling FavoritesApi->delete_favorites: #{e}"
120
+ end
121
+ ```
122
+
123
+ #### Using the delete_favorites_with_http_info variant
124
+
125
+ This returns an Array which contains the response data, status code and headers.
126
+
127
+ > <Array(<DeleteFavorites200Response>, Integer, Hash)> delete_favorites_with_http_info(company_id, user_id, favorite_id)
128
+
129
+ ```ruby
130
+ begin
131
+ # Delete single favorite by ID (unfavorite an asset)
132
+ data, status_code, headers = api_instance.delete_favorites_with_http_info(company_id, user_id, favorite_id)
133
+ p status_code # => 2xx
134
+ p headers # => { ... }
135
+ p data # => <DeleteFavorites200Response>
136
+ rescue SparteraApiSdk::ApiError => e
137
+ puts "Error when calling FavoritesApi->delete_favorites_with_http_info: #{e}"
138
+ end
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+ | Name | Type | Description | Notes |
144
+ | ---- | ---- | ----------- | ----- |
145
+ | **company_id** | **String** | Unique identifier for the Company | |
146
+ | **user_id** | **String** | Unique identifier for the User | |
147
+ | **favorite_id** | **String** | Unique identifier for the Favorite | |
148
+
149
+ ### Return type
150
+
151
+ [**DeleteFavorites200Response**](DeleteFavorites200Response.md)
152
+
153
+ ### Authorization
154
+
155
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
156
+
157
+ ### HTTP request headers
158
+
159
+ - **Content-Type**: Not defined
160
+ - **Accept**: application/json
161
+
162
+
163
+ ## get_favorites_by_id
164
+
165
+ > <GetFavoritesById200Response> get_favorites_by_id(company_id, user_id)
166
+
167
+ Get a list of all favorites for a specific user
168
+
169
+ ### Examples
170
+
171
+ ```ruby
172
+ require 'time'
173
+ require 'spartera_api_sdk'
174
+ # setup authorization
175
+ SparteraApiSdk.configure do |config|
176
+ # Configure API key authorization: ApiKeyAuth
177
+ config.api_key['x-api-key'] = 'YOUR API KEY'
178
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
179
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
180
+ end
181
+
182
+ api_instance = SparteraApiSdk::FavoritesApi.new
183
+ company_id = 'company_id_example' # String | Unique identifier for the Company
184
+ user_id = 'user_id_example' # String | Unique identifier for the User
185
+
186
+ begin
187
+ # Get a list of all favorites for a specific user
188
+ result = api_instance.get_favorites_by_id(company_id, user_id)
189
+ p result
190
+ rescue SparteraApiSdk::ApiError => e
191
+ puts "Error when calling FavoritesApi->get_favorites_by_id: #{e}"
192
+ end
193
+ ```
194
+
195
+ #### Using the get_favorites_by_id_with_http_info variant
196
+
197
+ This returns an Array which contains the response data, status code and headers.
198
+
199
+ > <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_with_http_info(company_id, user_id)
200
+
201
+ ```ruby
202
+ begin
203
+ # Get a list of all favorites for a specific user
204
+ data, status_code, headers = api_instance.get_favorites_by_id_with_http_info(company_id, user_id)
205
+ p status_code # => 2xx
206
+ p headers # => { ... }
207
+ p data # => <GetFavoritesById200Response>
208
+ rescue SparteraApiSdk::ApiError => e
209
+ puts "Error when calling FavoritesApi->get_favorites_by_id_with_http_info: #{e}"
210
+ end
211
+ ```
212
+
213
+ ### Parameters
214
+
215
+ | Name | Type | Description | Notes |
216
+ | ---- | ---- | ----------- | ----- |
217
+ | **company_id** | **String** | Unique identifier for the Company | |
218
+ | **user_id** | **String** | Unique identifier for the User | |
219
+
220
+ ### Return type
221
+
222
+ [**GetFavoritesById200Response**](GetFavoritesById200Response.md)
223
+
224
+ ### Authorization
225
+
226
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
227
+
228
+ ### HTTP request headers
229
+
230
+ - **Content-Type**: Not defined
231
+ - **Accept**: application/json
232
+
233
+
234
+ ## get_favorites_by_id_users
235
+
236
+ > <GetFavoritesById200Response> get_favorites_by_id_users(company_id, user_id, favorite_id)
237
+
238
+ Get single favorite by ID
239
+
240
+ ### Examples
241
+
242
+ ```ruby
243
+ require 'time'
244
+ require 'spartera_api_sdk'
245
+ # setup authorization
246
+ SparteraApiSdk.configure do |config|
247
+ # Configure API key authorization: ApiKeyAuth
248
+ config.api_key['x-api-key'] = 'YOUR API KEY'
249
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
250
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
251
+ end
252
+
253
+ api_instance = SparteraApiSdk::FavoritesApi.new
254
+ company_id = 'company_id_example' # String | Unique identifier for the Company
255
+ user_id = 'user_id_example' # String | Unique identifier for the User
256
+ favorite_id = 'favorite_id_example' # String | Unique identifier for the Favorite
257
+
258
+ begin
259
+ # Get single favorite by ID
260
+ result = api_instance.get_favorites_by_id_users(company_id, user_id, favorite_id)
261
+ p result
262
+ rescue SparteraApiSdk::ApiError => e
263
+ puts "Error when calling FavoritesApi->get_favorites_by_id_users: #{e}"
264
+ end
265
+ ```
266
+
267
+ #### Using the get_favorites_by_id_users_with_http_info variant
268
+
269
+ This returns an Array which contains the response data, status code and headers.
270
+
271
+ > <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_with_http_info(company_id, user_id, favorite_id)
272
+
273
+ ```ruby
274
+ begin
275
+ # Get single favorite by ID
276
+ data, status_code, headers = api_instance.get_favorites_by_id_users_with_http_info(company_id, user_id, favorite_id)
277
+ p status_code # => 2xx
278
+ p headers # => { ... }
279
+ p data # => <GetFavoritesById200Response>
280
+ rescue SparteraApiSdk::ApiError => e
281
+ puts "Error when calling FavoritesApi->get_favorites_by_id_users_with_http_info: #{e}"
282
+ end
283
+ ```
284
+
285
+ ### Parameters
286
+
287
+ | Name | Type | Description | Notes |
288
+ | ---- | ---- | ----------- | ----- |
289
+ | **company_id** | **String** | Unique identifier for the Company | |
290
+ | **user_id** | **String** | Unique identifier for the User | |
291
+ | **favorite_id** | **String** | Unique identifier for the Favorite | |
292
+
293
+ ### Return type
294
+
295
+ [**GetFavoritesById200Response**](GetFavoritesById200Response.md)
296
+
297
+ ### Authorization
298
+
299
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
300
+
301
+ ### HTTP request headers
302
+
303
+ - **Content-Type**: Not defined
304
+ - **Accept**: application/json
305
+
306
+
307
+ ## get_favorites_by_id_users_category
308
+
309
+ > <GetFavoritesById200Response> get_favorites_by_id_users_category(company_id, user_id, category)
310
+
311
+ Get all favorites for the specified user in a specific category
312
+
313
+ ### Examples
314
+
315
+ ```ruby
316
+ require 'time'
317
+ require 'spartera_api_sdk'
318
+ # setup authorization
319
+ SparteraApiSdk.configure do |config|
320
+ # Configure API key authorization: ApiKeyAuth
321
+ config.api_key['x-api-key'] = 'YOUR API KEY'
322
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
323
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
324
+ end
325
+
326
+ api_instance = SparteraApiSdk::FavoritesApi.new
327
+ company_id = 'company_id_example' # String | Unique identifier for the Company
328
+ user_id = 'user_id_example' # String | Unique identifier for the User
329
+ category = 'category_example' # String | Parameter for category
330
+
331
+ begin
332
+ # Get all favorites for the specified user in a specific category
333
+ result = api_instance.get_favorites_by_id_users_category(company_id, user_id, category)
334
+ p result
335
+ rescue SparteraApiSdk::ApiError => e
336
+ puts "Error when calling FavoritesApi->get_favorites_by_id_users_category: #{e}"
337
+ end
338
+ ```
339
+
340
+ #### Using the get_favorites_by_id_users_category_with_http_info variant
341
+
342
+ This returns an Array which contains the response data, status code and headers.
343
+
344
+ > <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_category_with_http_info(company_id, user_id, category)
345
+
346
+ ```ruby
347
+ begin
348
+ # Get all favorites for the specified user in a specific category
349
+ data, status_code, headers = api_instance.get_favorites_by_id_users_category_with_http_info(company_id, user_id, category)
350
+ p status_code # => 2xx
351
+ p headers # => { ... }
352
+ p data # => <GetFavoritesById200Response>
353
+ rescue SparteraApiSdk::ApiError => e
354
+ puts "Error when calling FavoritesApi->get_favorites_by_id_users_category_with_http_info: #{e}"
355
+ end
356
+ ```
357
+
358
+ ### Parameters
359
+
360
+ | Name | Type | Description | Notes |
361
+ | ---- | ---- | ----------- | ----- |
362
+ | **company_id** | **String** | Unique identifier for the Company | |
363
+ | **user_id** | **String** | Unique identifier for the User | |
364
+ | **category** | **String** | Parameter for category | |
365
+
366
+ ### Return type
367
+
368
+ [**GetFavoritesById200Response**](GetFavoritesById200Response.md)
369
+
370
+ ### Authorization
371
+
372
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
373
+
374
+ ### HTTP request headers
375
+
376
+ - **Content-Type**: Not defined
377
+ - **Accept**: application/json
378
+
379
+
380
+ ## get_favorites_by_id_users_check
381
+
382
+ > <GetFavoritesById200Response> get_favorites_by_id_users_check(company_id, user_id, asset_id)
383
+
384
+ Check if the specified user has favorited a specific asset
385
+
386
+ ### Examples
387
+
388
+ ```ruby
389
+ require 'time'
390
+ require 'spartera_api_sdk'
391
+ # setup authorization
392
+ SparteraApiSdk.configure do |config|
393
+ # Configure API key authorization: ApiKeyAuth
394
+ config.api_key['x-api-key'] = 'YOUR API KEY'
395
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
396
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
397
+ end
398
+
399
+ api_instance = SparteraApiSdk::FavoritesApi.new
400
+ company_id = 'company_id_example' # String | Unique identifier for the Company
401
+ user_id = 'user_id_example' # String | Unique identifier for the User
402
+ asset_id = 'asset_id_example' # String | Unique identifier for the Asset
403
+
404
+ begin
405
+ # Check if the specified user has favorited a specific asset
406
+ result = api_instance.get_favorites_by_id_users_check(company_id, user_id, asset_id)
407
+ p result
408
+ rescue SparteraApiSdk::ApiError => e
409
+ puts "Error when calling FavoritesApi->get_favorites_by_id_users_check: #{e}"
410
+ end
411
+ ```
412
+
413
+ #### Using the get_favorites_by_id_users_check_with_http_info variant
414
+
415
+ This returns an Array which contains the response data, status code and headers.
416
+
417
+ > <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_check_with_http_info(company_id, user_id, asset_id)
418
+
419
+ ```ruby
420
+ begin
421
+ # Check if the specified user has favorited a specific asset
422
+ data, status_code, headers = api_instance.get_favorites_by_id_users_check_with_http_info(company_id, user_id, asset_id)
423
+ p status_code # => 2xx
424
+ p headers # => { ... }
425
+ p data # => <GetFavoritesById200Response>
426
+ rescue SparteraApiSdk::ApiError => e
427
+ puts "Error when calling FavoritesApi->get_favorites_by_id_users_check_with_http_info: #{e}"
428
+ end
429
+ ```
430
+
431
+ ### Parameters
432
+
433
+ | Name | Type | Description | Notes |
434
+ | ---- | ---- | ----------- | ----- |
435
+ | **company_id** | **String** | Unique identifier for the Company | |
436
+ | **user_id** | **String** | Unique identifier for the User | |
437
+ | **asset_id** | **String** | Unique identifier for the Asset | |
438
+
439
+ ### Return type
440
+
441
+ [**GetFavoritesById200Response**](GetFavoritesById200Response.md)
442
+
443
+ ### Authorization
444
+
445
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
446
+
447
+ ### HTTP request headers
448
+
449
+ - **Content-Type**: Not defined
450
+ - **Accept**: application/json
451
+
452
+
453
+ ## get_favorites_by_id_users_uncategorized
454
+
455
+ > <GetFavoritesById200Response> get_favorites_by_id_users_uncategorized(company_id, user_id)
456
+
457
+ Get all favorites for the specified user that don't have a category
458
+
459
+ ### Examples
460
+
461
+ ```ruby
462
+ require 'time'
463
+ require 'spartera_api_sdk'
464
+ # setup authorization
465
+ SparteraApiSdk.configure do |config|
466
+ # Configure API key authorization: ApiKeyAuth
467
+ config.api_key['x-api-key'] = 'YOUR API KEY'
468
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
469
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
470
+ end
471
+
472
+ api_instance = SparteraApiSdk::FavoritesApi.new
473
+ company_id = 'company_id_example' # String | Unique identifier for the Company
474
+ user_id = 'user_id_example' # String | Unique identifier for the User
475
+
476
+ begin
477
+ # Get all favorites for the specified user that don't have a category
478
+ result = api_instance.get_favorites_by_id_users_uncategorized(company_id, user_id)
479
+ p result
480
+ rescue SparteraApiSdk::ApiError => e
481
+ puts "Error when calling FavoritesApi->get_favorites_by_id_users_uncategorized: #{e}"
482
+ end
483
+ ```
484
+
485
+ #### Using the get_favorites_by_id_users_uncategorized_with_http_info variant
486
+
487
+ This returns an Array which contains the response data, status code and headers.
488
+
489
+ > <Array(<GetFavoritesById200Response>, Integer, Hash)> get_favorites_by_id_users_uncategorized_with_http_info(company_id, user_id)
490
+
491
+ ```ruby
492
+ begin
493
+ # Get all favorites for the specified user that don't have a category
494
+ data, status_code, headers = api_instance.get_favorites_by_id_users_uncategorized_with_http_info(company_id, user_id)
495
+ p status_code # => 2xx
496
+ p headers # => { ... }
497
+ p data # => <GetFavoritesById200Response>
498
+ rescue SparteraApiSdk::ApiError => e
499
+ puts "Error when calling FavoritesApi->get_favorites_by_id_users_uncategorized_with_http_info: #{e}"
500
+ end
501
+ ```
502
+
503
+ ### Parameters
504
+
505
+ | Name | Type | Description | Notes |
506
+ | ---- | ---- | ----------- | ----- |
507
+ | **company_id** | **String** | Unique identifier for the Company | |
508
+ | **user_id** | **String** | Unique identifier for the User | |
509
+
510
+ ### Return type
511
+
512
+ [**GetFavoritesById200Response**](GetFavoritesById200Response.md)
513
+
514
+ ### Authorization
515
+
516
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
517
+
518
+ ### HTTP request headers
519
+
520
+ - **Content-Type**: Not defined
521
+ - **Accept**: application/json
522
+
523
+
524
+ ## update_favorites
525
+
526
+ > <UpdateFavorites200Response> update_favorites(company_id, user_id, favorite_id, favorites_update)
527
+
528
+ Update an existing favorite by ID
529
+
530
+ ### Examples
531
+
532
+ ```ruby
533
+ require 'time'
534
+ require 'spartera_api_sdk'
535
+ # setup authorization
536
+ SparteraApiSdk.configure do |config|
537
+ # Configure API key authorization: ApiKeyAuth
538
+ config.api_key['x-api-key'] = 'YOUR API KEY'
539
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
540
+ # config.api_key_prefix['x-api-key'] = 'Bearer'
541
+ end
542
+
543
+ api_instance = SparteraApiSdk::FavoritesApi.new
544
+ company_id = 'company_id_example' # String | Unique identifier for the Company
545
+ user_id = 'user_id_example' # String | Unique identifier for the User
546
+ favorite_id = 'favorite_id_example' # String | Unique identifier for the Favorite
547
+ favorites_update = SparteraApiSdk::FavoritesUpdate.new # FavoritesUpdate |
548
+
549
+ begin
550
+ # Update an existing favorite by ID
551
+ result = api_instance.update_favorites(company_id, user_id, favorite_id, favorites_update)
552
+ p result
553
+ rescue SparteraApiSdk::ApiError => e
554
+ puts "Error when calling FavoritesApi->update_favorites: #{e}"
555
+ end
556
+ ```
557
+
558
+ #### Using the update_favorites_with_http_info variant
559
+
560
+ This returns an Array which contains the response data, status code and headers.
561
+
562
+ > <Array(<UpdateFavorites200Response>, Integer, Hash)> update_favorites_with_http_info(company_id, user_id, favorite_id, favorites_update)
563
+
564
+ ```ruby
565
+ begin
566
+ # Update an existing favorite by ID
567
+ data, status_code, headers = api_instance.update_favorites_with_http_info(company_id, user_id, favorite_id, favorites_update)
568
+ p status_code # => 2xx
569
+ p headers # => { ... }
570
+ p data # => <UpdateFavorites200Response>
571
+ rescue SparteraApiSdk::ApiError => e
572
+ puts "Error when calling FavoritesApi->update_favorites_with_http_info: #{e}"
573
+ end
574
+ ```
575
+
576
+ ### Parameters
577
+
578
+ | Name | Type | Description | Notes |
579
+ | ---- | ---- | ----------- | ----- |
580
+ | **company_id** | **String** | Unique identifier for the Company | |
581
+ | **user_id** | **String** | Unique identifier for the User | |
582
+ | **favorite_id** | **String** | Unique identifier for the Favorite | |
583
+ | **favorites_update** | [**FavoritesUpdate**](FavoritesUpdate.md) | | |
584
+
585
+ ### Return type
586
+
587
+ [**UpdateFavorites200Response**](UpdateFavorites200Response.md)
588
+
589
+ ### Authorization
590
+
591
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
592
+
593
+ ### HTTP request headers
594
+
595
+ - **Content-Type**: application/json
596
+ - **Accept**: application/json
597
+
@@ -0,0 +1,28 @@
1
+ # SparteraApiSdk::FavoritesInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **asset_id** | **String** | References assets.asset_id — A published analytics asset — a calculation or visualization built on a data connection. See GET /assets for valid values. Required. | |
8
+ | **user_id** | **String** | References users.user_id — An individual user account within a company. See GET /users for valid values. Optional. | [optional] |
9
+ | **company_id** | **String** | References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required. | |
10
+ | **notes** | **String** | Optional user notes about this favorite | [optional] |
11
+ | **category** | **String** | Optional category for organizing favorites (e.g., &#39;Work&#39;, &#39;Research&#39;) | [optional] |
12
+ | **priority** | **Integer** | User-defined priority for sorting (higher &#x3D; more important) | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'spartera_api_sdk'
18
+
19
+ instance = SparteraApiSdk::FavoritesInput.new(
20
+ asset_id: asset_id_abc123,
21
+ user_id: user_id_abc123,
22
+ company_id: company_id_abc123,
23
+ notes: example_value,
24
+ category: example_value,
25
+ priority: 1
26
+ )
27
+ ```
28
+
@@ -0,0 +1,28 @@
1
+ # SparteraApiSdk::FavoritesUpdate
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **asset_id** | **String** | References assets.asset_id — A published analytics asset — a calculation or visualization built on a data connection. See GET /assets for valid values. Required. | [optional] |
8
+ | **user_id** | **String** | References users.user_id — An individual user account within a company. See GET /users for valid values. Optional. | [optional] |
9
+ | **company_id** | **String** | References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required. | [optional] |
10
+ | **notes** | **String** | Optional user notes about this favorite | [optional] |
11
+ | **category** | **String** | Optional category for organizing favorites (e.g., &#39;Work&#39;, &#39;Research&#39;) | [optional] |
12
+ | **priority** | **Integer** | User-defined priority for sorting (higher &#x3D; more important) | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'spartera_api_sdk'
18
+
19
+ instance = SparteraApiSdk::FavoritesUpdate.new(
20
+ asset_id: asset_id_abc123,
21
+ user_id: user_id_abc123,
22
+ company_id: company_id_abc123,
23
+ notes: example_value,
24
+ category: example_value,
25
+ priority: 1
26
+ )
27
+ ```
28
+
@@ -0,0 +1,20 @@
1
+ # SparteraApiSdk::GetAlertsById200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Response status message | |
8
+ | **data** | [**Alerts**](Alerts.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'spartera_api_sdk'
14
+
15
+ instance = SparteraApiSdk::GetAlertsById200Response.new(
16
+ message: success,
17
+ data: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # SparteraApiSdk::GetApiKeysById200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **message** | **String** | Response status message | |
8
+ | **data** | [**ApiKeys**](ApiKeys.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'spartera_api_sdk'
14
+
15
+ instance = SparteraApiSdk::GetApiKeysById200Response.new(
16
+ message: success,
17
+ data: null
18
+ )
19
+ ```
20
+