diff --git a/packages/approval/doc/classes/ActionApi.md b/packages/approval/doc/classes/ActionApi.md index 731a2b2a2..c143f066c 100644 --- a/packages/approval/doc/classes/ActionApi.md +++ b/packages/approval/doc/classes/ActionApi.md @@ -98,7 +98,7 @@ BaseAPI.configuration ### createAction -▸ **createAction**(`requestId`, `action`, `options?`): `Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md), `any`\>\> +▸ **createAction**(`requestId`, `action`, `options?`): `Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md)\>\> Create an action under a request identified by its id. Admin can create approve, deny, memo, and cancel operations; approver can create approve, deny, and memo operations; while requester can create only cancel operation. @@ -122,7 +122,7 @@ ActionApi #### Returns -`Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md)\>\> #### Defined in @@ -132,7 +132,7 @@ ___ ### listActionsByRequest -▸ **listActionsByRequest**(`requestId`, `options?`): `Promise`<`AxiosResponse`<[`ActionCollection`](../interfaces/ActionCollection.md), `any`\>\> +▸ **listActionsByRequest**(`requestId`, `options?`): `Promise`<`AxiosResponse`<[`ActionCollection`](../interfaces/ActionCollection.md)\>\> Find actions of a request identified by its id, available to everyone @@ -155,7 +155,7 @@ ActionApi #### Returns -`Promise`<`AxiosResponse`<[`ActionCollection`](../interfaces/ActionCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ActionCollection`](../interfaces/ActionCollection.md)\>\> #### Defined in @@ -165,7 +165,7 @@ ___ ### showAction -▸ **showAction**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md), `any`\>\> +▸ **showAction**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md)\>\> Find an action by its id, available to everyone @@ -188,7 +188,7 @@ ActionApi #### Returns -`Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Action`](../interfaces/Action.md)\>\> #### Defined in diff --git a/packages/approval/doc/classes/DefaultApi.md b/packages/approval/doc/classes/DefaultApi.md index d9e625956..98b55a91d 100644 --- a/packages/approval/doc/classes/DefaultApi.md +++ b/packages/approval/doc/classes/DefaultApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### getDocumentation -▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\> +▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`\>\> **`Summary`** @@ -116,7 +116,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`object`, `any`\>\> +`Promise`<`AxiosResponse`<`object`\>\> #### Defined in diff --git a/packages/approval/doc/classes/GraphqlApi.md b/packages/approval/doc/classes/GraphqlApi.md index 3e471848d..9b281923e 100644 --- a/packages/approval/doc/classes/GraphqlApi.md +++ b/packages/approval/doc/classes/GraphqlApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### postGraphql -▸ **postGraphql**(`graphqlIn`, `options?`): `Promise`<`AxiosResponse`<[`GraphqlOut`](../interfaces/GraphqlOut.md), `any`\>\> +▸ **postGraphql**(`graphqlIn`, `options?`): `Promise`<`AxiosResponse`<[`GraphqlOut`](../interfaces/GraphqlOut.md)\>\> Perform a GraphQL query @@ -119,7 +119,7 @@ GraphqlApi #### Returns -`Promise`<`AxiosResponse`<[`GraphqlOut`](../interfaces/GraphqlOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GraphqlOut`](../interfaces/GraphqlOut.md)\>\> #### Defined in diff --git a/packages/approval/doc/classes/RequestApi.md b/packages/approval/doc/classes/RequestApi.md index 4134601da..acfe777f8 100644 --- a/packages/approval/doc/classes/RequestApi.md +++ b/packages/approval/doc/classes/RequestApi.md @@ -100,7 +100,7 @@ BaseAPI.configuration ### createRequest -▸ **createRequest**(`requestIn`, `options?`): `Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md), `any`\>\> +▸ **createRequest**(`requestIn`, `options?`): `Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md)\>\> Create an approval request using given parameters, available to everyone @@ -123,7 +123,7 @@ RequestApi #### Returns -`Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md)\>\> #### Defined in @@ -133,7 +133,7 @@ ___ ### listRequests -▸ **listRequests**(`xRhPersona?`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md), `any`\>\> +▸ **listRequests**(`xRhPersona?`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md)\>\> The result depends on the x-rh-persona header (approval/admin, approval/requester, or approval/approver). Program generated child requests are not included. @@ -160,7 +160,7 @@ RequestApi #### Returns -`Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md)\>\> #### Defined in @@ -170,7 +170,7 @@ ___ ### listRequestsByRequest -▸ **listRequestsByRequest**(`requestId`, `xRhPersona?`, `options?`): `Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md), `any`\>\> +▸ **listRequestsByRequest**(`requestId`, `xRhPersona?`, `options?`): `Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md)\>\> Find child requests based on the parent request id. The result depends on the x-rh-persona header (approval/admin, approval/requester, or approval/approver). @@ -194,7 +194,7 @@ RequestApi #### Returns -`Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RequestCollection`](../interfaces/RequestCollection.md)\>\> #### Defined in @@ -204,7 +204,7 @@ ___ ### showRequest -▸ **showRequest**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md), `any`\>\> +▸ **showRequest**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md)\>\> Find an approval request by its id, available to anyone who can access the request @@ -227,7 +227,7 @@ RequestApi #### Returns -`Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Request`](../interfaces/Request.md)\>\> #### Defined in @@ -237,7 +237,7 @@ ___ ### showRequestContent -▸ **showRequestContent**(`requestId`, `options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\> +▸ **showRequestContent**(`requestId`, `options?`): `Promise`<`AxiosResponse`<`object`\>\> Find the request content based on a request id, available to everyone @@ -260,7 +260,7 @@ RequestApi #### Returns -`Promise`<`AxiosResponse`<`object`, `any`\>\> +`Promise`<`AxiosResponse`<`object`\>\> #### Defined in diff --git a/packages/approval/doc/classes/TemplateApi.md b/packages/approval/doc/classes/TemplateApi.md index 39942371f..aafb41b97 100644 --- a/packages/approval/doc/classes/TemplateApi.md +++ b/packages/approval/doc/classes/TemplateApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### listTemplates -▸ **listTemplates**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TemplateCollection`](../interfaces/TemplateCollection.md), `any`\>\> +▸ **listTemplates**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TemplateCollection`](../interfaces/TemplateCollection.md)\>\> Find all templates, available to admin only @@ -123,7 +123,7 @@ TemplateApi #### Returns -`Promise`<`AxiosResponse`<[`TemplateCollection`](../interfaces/TemplateCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TemplateCollection`](../interfaces/TemplateCollection.md)\>\> #### Defined in @@ -133,7 +133,7 @@ ___ ### showTemplate -▸ **showTemplate**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Template`](../interfaces/Template.md), `any`\>\> +▸ **showTemplate**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Template`](../interfaces/Template.md)\>\> Find a template by its id, available to admin only @@ -156,7 +156,7 @@ TemplateApi #### Returns -`Promise`<`AxiosResponse`<[`Template`](../interfaces/Template.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Template`](../interfaces/Template.md)\>\> #### Defined in diff --git a/packages/approval/doc/classes/WorkflowApi.md b/packages/approval/doc/classes/WorkflowApi.md index 4180ef984..7b7331f51 100644 --- a/packages/approval/doc/classes/WorkflowApi.md +++ b/packages/approval/doc/classes/WorkflowApi.md @@ -104,7 +104,7 @@ BaseAPI.configuration ### addWorkflowToTemplate -▸ **addWorkflowToTemplate**(`templateId`, `workflow`, `options?`): `Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md), `any`\>\> +▸ **addWorkflowToTemplate**(`templateId`, `workflow`, `options?`): `Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md)\>\> Create a workflow from a template identified by its id, available to admin only @@ -128,7 +128,7 @@ WorkflowApi #### Returns -`Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md)\>\> #### Defined in @@ -138,7 +138,7 @@ ___ ### destroyWorkflow -▸ **destroyWorkflow**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **destroyWorkflow**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete an approval workflow by its id, available to admin only @@ -161,7 +161,7 @@ WorkflowApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -171,7 +171,7 @@ ___ ### linkWorkflow -▸ **linkWorkflow**(`id`, `resourceObject`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **linkWorkflow**(`id`, `resourceObject`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Link a resource object to a workflow identified by its id, available to admin only @@ -195,7 +195,7 @@ WorkflowApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -205,7 +205,7 @@ ___ ### listWorkflows -▸ **listWorkflows**(`appName?`, `objectId?`, `objectType?`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`WorkflowCollection`](../interfaces/WorkflowCollection.md), `any`\>\> +▸ **listWorkflows**(`appName?`, `objectId?`, `objectType?`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`WorkflowCollection`](../interfaces/WorkflowCollection.md)\>\> Find approval workflows matching search parameters, available to admin only. Optionally select workflows linked to a resource object whose app_name, object_type and object_id are specified by query parameters. Default sorting is by sequence number in ascending order. @@ -234,7 +234,7 @@ WorkflowApi #### Returns -`Promise`<`AxiosResponse`<[`WorkflowCollection`](../interfaces/WorkflowCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`WorkflowCollection`](../interfaces/WorkflowCollection.md)\>\> #### Defined in @@ -244,7 +244,7 @@ ___ ### listWorkflowsByTemplate -▸ **listWorkflowsByTemplate**(`templateId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`WorkflowCollection`](../interfaces/WorkflowCollection.md), `any`\>\> +▸ **listWorkflowsByTemplate**(`templateId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`WorkflowCollection`](../interfaces/WorkflowCollection.md)\>\> Find workflows based on the template id, available to admin only @@ -271,7 +271,7 @@ WorkflowApi #### Returns -`Promise`<`AxiosResponse`<[`WorkflowCollection`](../interfaces/WorkflowCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`WorkflowCollection`](../interfaces/WorkflowCollection.md)\>\> #### Defined in @@ -281,7 +281,7 @@ ___ ### reposition -▸ **reposition**(`id`, `reposition`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **reposition**(`id`, `reposition`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Adjust the position of a workflow related to others by an offset number @@ -305,7 +305,7 @@ WorkflowApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -315,7 +315,7 @@ ___ ### showWorkflow -▸ **showWorkflow**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md), `any`\>\> +▸ **showWorkflow**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md)\>\> Find an approval workflow by its id, available to admin only @@ -338,7 +338,7 @@ WorkflowApi #### Returns -`Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md)\>\> #### Defined in @@ -348,7 +348,7 @@ ___ ### unlinkWorkflow -▸ **unlinkWorkflow**(`id`, `resourceObject`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **unlinkWorkflow**(`id`, `resourceObject`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Break the link between a resource object selected by the body and a workflow by its id, available to admin only @@ -372,7 +372,7 @@ WorkflowApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -382,7 +382,7 @@ ___ ### updateWorkflow -▸ **updateWorkflow**(`id`, `workflow`, `options?`): `Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md), `any`\>\> +▸ **updateWorkflow**(`id`, `workflow`, `options?`): `Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md)\>\> Find an approval workflow by its id and update its content, available to admin only @@ -406,7 +406,7 @@ WorkflowApi #### Returns -`Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Workflow`](../interfaces/Workflow.md)\>\> #### Defined in diff --git a/packages/catalog/doc/classes/DefaultApi.md b/packages/catalog/doc/classes/DefaultApi.md index a13eff514..a4492f934 100644 --- a/packages/catalog/doc/classes/DefaultApi.md +++ b/packages/catalog/doc/classes/DefaultApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### getDocumentation -▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\> +▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`\>\> **`Summary`** @@ -117,7 +117,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`object`, `any`\>\> +`Promise`<`AxiosResponse`<`object`\>\> #### Defined in @@ -127,7 +127,7 @@ ___ ### postGraphQL -▸ **postGraphQL**(`graphQLRequest`, `options?`): `Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md), `any`\>\> +▸ **postGraphQL**(`graphQLRequest`, `options?`): `Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md)\>\> Performs a GraphQL Query @@ -150,7 +150,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md)\>\> #### Defined in diff --git a/packages/catalog/doc/classes/IconApi.md b/packages/catalog/doc/classes/IconApi.md index ededd73ca..cbbb6cb05 100644 --- a/packages/catalog/doc/classes/IconApi.md +++ b/packages/catalog/doc/classes/IconApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### createIcon -▸ **createIcon**(`content?`, `portfolioId?`, `portfolioItemId?`, `options?`): `Promise`<`AxiosResponse`<[`Icon`](../interfaces/Icon.md), `any`\>\> +▸ **createIcon**(`content?`, `portfolioId?`, `portfolioItemId?`, `options?`): `Promise`<`AxiosResponse`<[`Icon`](../interfaces/Icon.md)\>\> Creates an Icon from the specified parameters @@ -122,7 +122,7 @@ IconApi #### Returns -`Promise`<`AxiosResponse`<[`Icon`](../interfaces/Icon.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Icon`](../interfaces/Icon.md)\>\> #### Defined in @@ -132,7 +132,7 @@ ___ ### destroyIcon -▸ **destroyIcon**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **destroyIcon**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Deletes the icon based on the icon ID passed @@ -155,7 +155,7 @@ IconApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/catalog/doc/classes/OrderApi.md b/packages/catalog/doc/classes/OrderApi.md index 1552d3be4..f578fc119 100644 --- a/packages/catalog/doc/classes/OrderApi.md +++ b/packages/catalog/doc/classes/OrderApi.md @@ -106,7 +106,7 @@ BaseAPI.configuration ### addToOrder -▸ **addToOrder**(`orderId`, `orderItem`, `options?`): `Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md), `any`\>\> +▸ **addToOrder**(`orderId`, `orderItem`, `options?`): `Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md)\>\> Adds an order item to an order in pending state @@ -130,7 +130,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md)\>\> #### Defined in @@ -140,7 +140,7 @@ ___ ### cancelOrder -▸ **cancelOrder**(`orderId`, `options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +▸ **cancelOrder**(`orderId`, `options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> Returns an updated order. @@ -163,7 +163,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> #### Defined in @@ -173,7 +173,7 @@ ___ ### createOrder -▸ **createOrder**(`options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +▸ **createOrder**(`options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> Creates a new order. @@ -195,7 +195,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> #### Defined in @@ -205,7 +205,7 @@ ___ ### destroyOrder -▸ **destroyOrder**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md), `any`\>\> +▸ **destroyOrder**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md)\>\> Deletes the Order based on order ID passed @@ -228,7 +228,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md)\>\> #### Defined in @@ -238,7 +238,7 @@ ___ ### listOrderItemsFromOrder -▸ **listOrderItemsFromOrder**(`orderId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrderItemsCollection`](../interfaces/OrderItemsCollection.md), `any`\>\> +▸ **listOrderItemsFromOrder**(`orderId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrderItemsCollection`](../interfaces/OrderItemsCollection.md)\>\> Gets a list of items associated with an order. @@ -265,7 +265,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`OrderItemsCollection`](../interfaces/OrderItemsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderItemsCollection`](../interfaces/OrderItemsCollection.md)\>\> #### Defined in @@ -275,7 +275,7 @@ ___ ### listOrderProgressMessages -▸ **listOrderProgressMessages**(`orderId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ProgressMessagesCollection`](../interfaces/ProgressMessagesCollection.md), `any`\>\> +▸ **listOrderProgressMessages**(`orderId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ProgressMessagesCollection`](../interfaces/ProgressMessagesCollection.md)\>\> Gets a list of progress messages associated with an order. As the order is being processed the provider can update the progress messages. @@ -302,7 +302,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`ProgressMessagesCollection`](../interfaces/ProgressMessagesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ProgressMessagesCollection`](../interfaces/ProgressMessagesCollection.md)\>\> #### Defined in @@ -312,7 +312,7 @@ ___ ### listOrders -▸ **listOrders**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrdersCollection`](../interfaces/OrdersCollection.md), `any`\>\> +▸ **listOrders**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrdersCollection`](../interfaces/OrdersCollection.md)\>\> Gets a list of orders associated with the logged in user. @@ -338,7 +338,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`OrdersCollection`](../interfaces/OrdersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrdersCollection`](../interfaces/OrdersCollection.md)\>\> #### Defined in @@ -348,7 +348,7 @@ ___ ### restoreOrder -▸ **restoreOrder**(`id`, `restoreKey`, `options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +▸ **restoreOrder**(`id`, `restoreKey`, `options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> Restores the order specified by the order ID. @@ -372,7 +372,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> #### Defined in @@ -382,7 +382,7 @@ ___ ### showOrder -▸ **showOrder**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +▸ **showOrder**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> Get a specific order based on the order ID @@ -405,7 +405,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> #### Defined in @@ -415,7 +415,7 @@ ___ ### showOrderItemFromOrder -▸ **showOrderItemFromOrder**(`orderId`, `id`, `options?`): `Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md), `any`\>\> +▸ **showOrderItemFromOrder**(`orderId`, `id`, `options?`): `Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md)\>\> Gets an order item associated with an order. @@ -439,7 +439,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md)\>\> #### Defined in @@ -449,7 +449,7 @@ ___ ### submitOrder -▸ **submitOrder**(`orderId`, `options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +▸ **submitOrder**(`orderId`, `options?`): `Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> Returns an updated order. @@ -472,7 +472,7 @@ OrderApi #### Returns -`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Order`](../interfaces/Order.md)\>\> #### Defined in diff --git a/packages/catalog/doc/classes/OrderItemApi.md b/packages/catalog/doc/classes/OrderItemApi.md index 5d9a1b877..5ab248f73 100644 --- a/packages/catalog/doc/classes/OrderItemApi.md +++ b/packages/catalog/doc/classes/OrderItemApi.md @@ -101,7 +101,7 @@ BaseAPI.configuration ### destroyOrderItem -▸ **destroyOrderItem**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md), `any`\>\> +▸ **destroyOrderItem**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md)\>\> Deletes the order item based on order item ID passed @@ -124,7 +124,7 @@ OrderItemApi #### Returns -`Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md)\>\> #### Defined in @@ -134,7 +134,7 @@ ___ ### listApprovalRequests -▸ **listApprovalRequests**(`orderItemId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApprovalRequestsCollection`](../interfaces/ApprovalRequestsCollection.md), `any`\>\> +▸ **listApprovalRequests**(`orderItemId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApprovalRequestsCollection`](../interfaces/ApprovalRequestsCollection.md)\>\> Gets a list of approval request associated with an order item. As the item is being approved one can check the status of the approvals. @@ -161,7 +161,7 @@ OrderItemApi #### Returns -`Promise`<`AxiosResponse`<[`ApprovalRequestsCollection`](../interfaces/ApprovalRequestsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ApprovalRequestsCollection`](../interfaces/ApprovalRequestsCollection.md)\>\> #### Defined in @@ -171,7 +171,7 @@ ___ ### listOrderItemProgressMessages -▸ **listOrderItemProgressMessages**(`orderItemId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ProgressMessagesCollection`](../interfaces/ProgressMessagesCollection.md), `any`\>\> +▸ **listOrderItemProgressMessages**(`orderItemId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ProgressMessagesCollection`](../interfaces/ProgressMessagesCollection.md)\>\> Gets a list of progress messages associated with an order item. As the item is being processed the provider can update the progress messages. @@ -198,7 +198,7 @@ OrderItemApi #### Returns -`Promise`<`AxiosResponse`<[`ProgressMessagesCollection`](../interfaces/ProgressMessagesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ProgressMessagesCollection`](../interfaces/ProgressMessagesCollection.md)\>\> #### Defined in @@ -208,7 +208,7 @@ ___ ### listOrderItems -▸ **listOrderItems**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrderItemsCollection`](../interfaces/OrderItemsCollection.md), `any`\>\> +▸ **listOrderItems**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrderItemsCollection`](../interfaces/OrderItemsCollection.md)\>\> Gets a list of order items. @@ -234,7 +234,7 @@ OrderItemApi #### Returns -`Promise`<`AxiosResponse`<[`OrderItemsCollection`](../interfaces/OrderItemsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderItemsCollection`](../interfaces/OrderItemsCollection.md)\>\> #### Defined in @@ -244,7 +244,7 @@ ___ ### restoreOrderItem -▸ **restoreOrderItem**(`id`, `restoreKey`, `options?`): `Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md), `any`\>\> +▸ **restoreOrderItem**(`id`, `restoreKey`, `options?`): `Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md)\>\> Restores the order item specified by the order item ID. @@ -268,7 +268,7 @@ OrderItemApi #### Returns -`Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md)\>\> #### Defined in @@ -278,7 +278,7 @@ ___ ### showOrderItem -▸ **showOrderItem**(`id`, `options?`): `Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md), `any`\>\> +▸ **showOrderItem**(`id`, `options?`): `Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md)\>\> Gets a specific order item based on the order item ID passed @@ -301,7 +301,7 @@ OrderItemApi #### Returns -`Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderItem`](../interfaces/OrderItem.md)\>\> #### Defined in diff --git a/packages/catalog/doc/classes/OrderProcessApi.md b/packages/catalog/doc/classes/OrderProcessApi.md index bbd822ebb..4bb7bb20c 100644 --- a/packages/catalog/doc/classes/OrderProcessApi.md +++ b/packages/catalog/doc/classes/OrderProcessApi.md @@ -107,7 +107,7 @@ BaseAPI.configuration ### addOrderProcessAfterItem -▸ **addOrderProcessAfterItem**(`id`, `orderProcessPortfolioItemId`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +▸ **addOrderProcessAfterItem**(`id`, `orderProcessPortfolioItemId`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> Defines the product that will be executed after ordering when using this Order Process @@ -131,7 +131,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> #### Defined in @@ -141,7 +141,7 @@ ___ ### addOrderProcessBeforeItem -▸ **addOrderProcessBeforeItem**(`id`, `orderProcessPortfolioItemId`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +▸ **addOrderProcessBeforeItem**(`id`, `orderProcessPortfolioItemId`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> Defines the product that will be executed before ordering when using this Order Process @@ -165,7 +165,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> #### Defined in @@ -175,7 +175,7 @@ ___ ### addOrderProcessReturnItem -▸ **addOrderProcessReturnItem**(`id`, `orderProcessPortfolioItemId`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +▸ **addOrderProcessReturnItem**(`id`, `orderProcessPortfolioItemId`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> Defines the product that will be executed on return when using this Order Process @@ -199,7 +199,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> #### Defined in @@ -209,7 +209,7 @@ ___ ### createOrderProcess -▸ **createOrderProcess**(`orderProcess`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +▸ **createOrderProcess**(`orderProcess`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> Adds an order process. @@ -232,7 +232,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> #### Defined in @@ -242,7 +242,7 @@ ___ ### destroyOrderProcess -▸ **destroyOrderProcess**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **destroyOrderProcess**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Deletes the order process specified by the ID. @@ -265,7 +265,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -275,7 +275,7 @@ ___ ### linkTagToOrderProcess -▸ **linkTagToOrderProcess**(`id`, `resourceObject`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **linkTagToOrderProcess**(`id`, `resourceObject`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Links a tag to an order process @@ -299,7 +299,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -309,7 +309,7 @@ ___ ### listOrderProcesses -▸ **listOrderProcesses**(`appName?`, `objectId?`, `objectType?`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcessCollection`](../interfaces/OrderProcessCollection.md), `any`\>\> +▸ **listOrderProcesses**(`appName?`, `objectId?`, `objectType?`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcessCollection`](../interfaces/OrderProcessCollection.md)\>\> Gets a list of order processes. Optionally select order processes linked to a resource object whose app_name, object_type and object_id are specified by query parameters. @@ -338,7 +338,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<[`OrderProcessCollection`](../interfaces/OrderProcessCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderProcessCollection`](../interfaces/OrderProcessCollection.md)\>\> #### Defined in @@ -348,7 +348,7 @@ ___ ### removeOrderProcessAssociation -▸ **removeOrderProcessAssociation**(`id`, `orderProcessAssociationsToRemove`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +▸ **removeOrderProcessAssociation**(`id`, `orderProcessAssociationsToRemove`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> Removes the association to the product(s) defined in the \'before\' and/or \'after\' that would be executed when using this Order Process @@ -372,7 +372,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> #### Defined in @@ -382,7 +382,7 @@ ___ ### reposition -▸ **reposition**(`id`, `reposition`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **reposition**(`id`, `reposition`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Adjust the position of an order process related to others by an offset number @@ -406,7 +406,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -416,7 +416,7 @@ ___ ### showOrderProcess -▸ **showOrderProcess**(`id`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +▸ **showOrderProcess**(`id`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> Gets the order process specified by the order process ID. @@ -439,7 +439,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> #### Defined in @@ -449,7 +449,7 @@ ___ ### unlinkTagFromOrderProcess -▸ **unlinkTagFromOrderProcess**(`id`, `resourceObject`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **unlinkTagFromOrderProcess**(`id`, `resourceObject`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Unlinks a tag from an order process @@ -473,7 +473,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -483,7 +483,7 @@ ___ ### updateOrderProcess -▸ **updateOrderProcess**(`id`, `orderProcess`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +▸ **updateOrderProcess**(`id`, `orderProcess`, `options?`): `Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> Returns the edited order process. @@ -507,7 +507,7 @@ OrderProcessApi #### Returns -`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrderProcess`](../interfaces/OrderProcess.md)\>\> #### Defined in diff --git a/packages/catalog/doc/classes/PortfolioApi.md b/packages/catalog/doc/classes/PortfolioApi.md index 5ca5c676e..45daea454 100644 --- a/packages/catalog/doc/classes/PortfolioApi.md +++ b/packages/catalog/doc/classes/PortfolioApi.md @@ -110,7 +110,7 @@ BaseAPI.configuration ### addPortfolioTag -▸ **addPortfolioTag**(`id`, `tag`, `options?`): `Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)[], `any`\>\> +▸ **addPortfolioTag**(`id`, `tag`, `options?`): `Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)[]\>\> Adds a single tag to Portfolio object @@ -134,7 +134,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)[]\>\> #### Defined in @@ -144,7 +144,7 @@ ___ ### createPortfolio -▸ **createPortfolio**(`portfolio`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +▸ **createPortfolio**(`portfolio`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> Adds a portfolio. @@ -167,7 +167,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> #### Defined in @@ -177,7 +177,7 @@ ___ ### destroyPortfolio -▸ **destroyPortfolio**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md), `any`\>\> +▸ **destroyPortfolio**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md)\>\> Deletes the portfolio specified by the ID. @@ -200,7 +200,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md)\>\> #### Defined in @@ -210,7 +210,7 @@ ___ ### fetchPortfolioItemsWithPortfolio -▸ **fetchPortfolioItemsWithPortfolio**(`portfolioId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItemsCollection`](../interfaces/PortfolioItemsCollection.md), `any`\>\> +▸ **fetchPortfolioItemsWithPortfolio**(`portfolioId`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItemsCollection`](../interfaces/PortfolioItemsCollection.md)\>\> Gets all portfilio items in the portfolio specified by the given ID. @@ -237,7 +237,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`PortfolioItemsCollection`](../interfaces/PortfolioItemsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PortfolioItemsCollection`](../interfaces/PortfolioItemsCollection.md)\>\> #### Defined in @@ -247,7 +247,7 @@ ___ ### listPortfolioTags -▸ **listPortfolioTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listPortfolioTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -274,7 +274,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -284,7 +284,7 @@ ___ ### listPortfolios -▸ **listPortfolios**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`PortfoliosCollection`](../interfaces/PortfoliosCollection.md), `any`\>\> +▸ **listPortfolios**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`PortfoliosCollection`](../interfaces/PortfoliosCollection.md)\>\> Gets a list of portfolios. @@ -310,7 +310,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`PortfoliosCollection`](../interfaces/PortfoliosCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PortfoliosCollection`](../interfaces/PortfoliosCollection.md)\>\> #### Defined in @@ -320,7 +320,7 @@ ___ ### postCopyPortfolio -▸ **postCopyPortfolio**(`portfolioId`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +▸ **postCopyPortfolio**(`portfolioId`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> Make a copy of the Portfolio. @@ -343,7 +343,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> #### Defined in @@ -353,7 +353,7 @@ ___ ### removePortfolioTags -▸ **removePortfolioTags**(`id`, `tag`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **removePortfolioTags**(`id`, `tag`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Remove Tags from Portfolio @@ -377,7 +377,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -387,7 +387,7 @@ ___ ### shareInfo -▸ **shareInfo**(`portfolioId`, `options?`): `Promise`<`AxiosResponse`<[`ShareInfo`](../interfaces/ShareInfo.md)[], `any`\>\> +▸ **shareInfo**(`portfolioId`, `options?`): `Promise`<`AxiosResponse`<[`ShareInfo`](../interfaces/ShareInfo.md)[]\>\> Fetch share information about a portfolio @@ -410,7 +410,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`ShareInfo`](../interfaces/ShareInfo.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ShareInfo`](../interfaces/ShareInfo.md)[]\>\> #### Defined in @@ -420,7 +420,7 @@ ___ ### sharePortfolio -▸ **sharePortfolio**(`portfolioId`, `sharePolicy`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **sharePortfolio**(`portfolioId`, `sharePolicy`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Share a Portfolio with one or more groups with specific permissions @@ -444,7 +444,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -454,7 +454,7 @@ ___ ### showPortfolio -▸ **showPortfolio**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +▸ **showPortfolio**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> Gets the portfolio specified by the portfolio ID. @@ -477,7 +477,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> #### Defined in @@ -487,7 +487,7 @@ ___ ### showPortfolioIcon -▸ **showPortfolioIcon**(`portfolioId`, `cacheId?`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> +▸ **showPortfolioIcon**(`portfolioId`, `cacheId?`, `options?`): `Promise`<`AxiosResponse`<`any`\>\> Fetch the specified portfolio\'s icon image. @@ -511,7 +511,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<`any`, `any`\>\> +`Promise`<`AxiosResponse`<`any`\>\> #### Defined in @@ -521,7 +521,7 @@ ___ ### unDeletePortfolio -▸ **unDeletePortfolio**(`id`, `restoreKey`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +▸ **unDeletePortfolio**(`id`, `restoreKey`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> Undeletes the portfolio specified by the portfolio ID. @@ -545,7 +545,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> #### Defined in @@ -555,7 +555,7 @@ ___ ### unsharePortfolio -▸ **unsharePortfolio**(`portfolioId`, `unsharePolicy`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **unsharePortfolio**(`portfolioId`, `unsharePolicy`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Unshare a Portfolio with one or more groups with specific permissions @@ -579,7 +579,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -589,7 +589,7 @@ ___ ### updatePortfolio -▸ **updatePortfolio**(`id`, `portfolio`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +▸ **updatePortfolio**(`id`, `portfolio`, `options?`): `Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> Returns the edited portfolio. @@ -613,7 +613,7 @@ PortfolioApi #### Returns -`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Portfolio`](../interfaces/Portfolio.md)\>\> #### Defined in diff --git a/packages/catalog/doc/classes/PortfolioItemApi.md b/packages/catalog/doc/classes/PortfolioItemApi.md index b45905c75..56140d510 100644 --- a/packages/catalog/doc/classes/PortfolioItemApi.md +++ b/packages/catalog/doc/classes/PortfolioItemApi.md @@ -108,7 +108,7 @@ BaseAPI.configuration ### addPortfolioItemTag -▸ **addPortfolioItemTag**(`id`, `tag`, `options?`): `Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)[], `any`\>\> +▸ **addPortfolioItemTag**(`id`, `tag`, `options?`): `Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)[]\>\> Adds a single tag to a Portfolio Item object @@ -132,7 +132,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)[]\>\> #### Defined in @@ -142,7 +142,7 @@ ___ ### createPortfolioItem -▸ **createPortfolioItem**(`createPortfolioItem`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +▸ **createPortfolioItem**(`createPortfolioItem`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> Adds a name and description for a portfolio item and returns the newly created portfolio item. @@ -165,7 +165,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> #### Defined in @@ -175,7 +175,7 @@ ___ ### destroyPortfolioItem -▸ **destroyPortfolioItem**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md), `any`\>\> +▸ **destroyPortfolioItem**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md)\>\> Deletes the portfolio item based on portfolio item ID passed @@ -198,7 +198,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RestoreKey`](../interfaces/RestoreKey.md)\>\> #### Defined in @@ -208,7 +208,7 @@ ___ ### getPortfolioItemNextName -▸ **getPortfolioItemNextName**(`portfolioItemId`, `destinationPortfolioId?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItemNextName`](../interfaces/PortfolioItemNextName.md), `any`\>\> +▸ **getPortfolioItemNextName**(`portfolioItemId`, `destinationPortfolioId?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItemNextName`](../interfaces/PortfolioItemNextName.md)\>\> Get the next name for a the Portfolio Item prior to a copy operation @@ -232,7 +232,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`PortfolioItemNextName`](../interfaces/PortfolioItemNextName.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PortfolioItemNextName`](../interfaces/PortfolioItemNextName.md)\>\> #### Defined in @@ -242,7 +242,7 @@ ___ ### listPortfolioItemTags -▸ **listPortfolioItemTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listPortfolioItemTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -269,7 +269,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -279,7 +279,7 @@ ___ ### listPortfolioItems -▸ **listPortfolioItems**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItemsCollection`](../interfaces/PortfolioItemsCollection.md), `any`\>\> +▸ **listPortfolioItems**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItemsCollection`](../interfaces/PortfolioItemsCollection.md)\>\> Gets a list of portfolio items. @@ -305,7 +305,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`PortfolioItemsCollection`](../interfaces/PortfolioItemsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PortfolioItemsCollection`](../interfaces/PortfolioItemsCollection.md)\>\> #### Defined in @@ -315,7 +315,7 @@ ___ ### listServicePlans -▸ **listServicePlans**(`portfolioItemId`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[], `any`\>\> +▸ **listServicePlans**(`portfolioItemId`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[]\>\> Gets all service plans for a portfolio item. @@ -338,7 +338,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[]\>\> #### Defined in @@ -348,7 +348,7 @@ ___ ### postCopyPortfolioItem -▸ **postCopyPortfolioItem**(`portfolioItemId`, `copyPortfolioItem?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +▸ **postCopyPortfolioItem**(`portfolioItemId`, `copyPortfolioItem?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> Make a copy of the Portfolio Item. @@ -372,7 +372,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> #### Defined in @@ -382,7 +382,7 @@ ___ ### removePortfolioItemTags -▸ **removePortfolioItemTags**(`id`, `tag`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **removePortfolioItemTags**(`id`, `tag`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Remove Tags from Portfolio Item @@ -406,7 +406,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -416,7 +416,7 @@ ___ ### showPortfolioItem -▸ **showPortfolioItem**(`id`, `showDiscarded?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +▸ **showPortfolioItem**(`id`, `showDiscarded?`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> Gets a specific portfolio item based on the portfolio item ID passed @@ -440,7 +440,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> #### Defined in @@ -450,7 +450,7 @@ ___ ### showPortfolioItemIcon -▸ **showPortfolioItemIcon**(`portfolioItemId`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> +▸ **showPortfolioItemIcon**(`portfolioItemId`, `options?`): `Promise`<`AxiosResponse`<`any`\>\> Fetch the specified portfolio item\'s icon image. @@ -473,7 +473,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<`any`, `any`\>\> +`Promise`<`AxiosResponse`<`any`\>\> #### Defined in @@ -483,7 +483,7 @@ ___ ### unDeletePortfolioItem -▸ **unDeletePortfolioItem**(`portfolioItemId`, `restoreKey`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +▸ **unDeletePortfolioItem**(`portfolioItemId`, `restoreKey`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> If a record has been discarded, this operation will undelete it so it can be requested normally. @@ -507,7 +507,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> #### Defined in @@ -517,7 +517,7 @@ ___ ### updatePortfolioItem -▸ **updatePortfolioItem**(`id`, `portfolioItem`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +▸ **updatePortfolioItem**(`id`, `portfolioItem`, `options?`): `Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> Edits portfolio item specified by the given ID. @@ -541,7 +541,7 @@ PortfolioItemApi #### Returns -`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PortfolioItem`](../interfaces/PortfolioItem.md)\>\> #### Defined in diff --git a/packages/catalog/doc/classes/ServicePlansApi.md b/packages/catalog/doc/classes/ServicePlansApi.md index af579a8ff..6a45f10b9 100644 --- a/packages/catalog/doc/classes/ServicePlansApi.md +++ b/packages/catalog/doc/classes/ServicePlansApi.md @@ -101,7 +101,7 @@ BaseAPI.configuration ### createServicePlan -▸ **createServicePlan**(`importServicePlan?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[], `any`\>\> +▸ **createServicePlan**(`importServicePlan?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[]\>\> Returns the new Service Plan @@ -124,7 +124,7 @@ ServicePlansApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[]\>\> #### Defined in @@ -134,7 +134,7 @@ ___ ### patchServicePlanModified -▸ **patchServicePlanModified**(`id`, `patchModifiedServicePlan?`, `options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\> +▸ **patchServicePlanModified**(`id`, `patchModifiedServicePlan?`, `options?`): `Promise`<`AxiosResponse`<`object`\>\> **`Summary`** @@ -156,7 +156,7 @@ ServicePlansApi #### Returns -`Promise`<`AxiosResponse`<`object`, `any`\>\> +`Promise`<`AxiosResponse`<`object`\>\> #### Defined in @@ -166,7 +166,7 @@ ___ ### resetServicePlanModified -▸ **resetServicePlanModified**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[], `any`\>\> +▸ **resetServicePlanModified**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[]\>\> Resets the Service Plan\'s Modified schema and returns the new one if it has been reset @@ -189,7 +189,7 @@ ServicePlansApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)[]\>\> #### Defined in @@ -199,7 +199,7 @@ ___ ### showServicePlan -▸ **showServicePlan**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md), `any`\>\> +▸ **showServicePlan**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)\>\> Returns the specified Service Plan @@ -222,7 +222,7 @@ ServicePlansApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)\>\> #### Defined in @@ -232,7 +232,7 @@ ___ ### showServicePlanBase -▸ **showServicePlanBase**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md), `any`\>\> +▸ **showServicePlanBase**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)\>\> Returns the specified Service Plan\'s base schema @@ -255,7 +255,7 @@ ServicePlansApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)\>\> #### Defined in @@ -265,7 +265,7 @@ ___ ### showServicePlanModified -▸ **showServicePlanModified**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md), `any`\>\> +▸ **showServicePlanModified**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)\>\> Returns the specified Service Plan\'s modified schema @@ -288,7 +288,7 @@ ServicePlansApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)\>\> #### Defined in diff --git a/packages/catalog/doc/classes/SettingsApi.md b/packages/catalog/doc/classes/SettingsApi.md index 4296033aa..e3ae4fcb0 100644 --- a/packages/catalog/doc/classes/SettingsApi.md +++ b/packages/catalog/doc/classes/SettingsApi.md @@ -100,7 +100,7 @@ BaseAPI.configuration ### createSetting -▸ **createSetting**(`setting`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **createSetting**(`setting`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Create Tenant Setting @@ -123,7 +123,7 @@ SettingsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -133,7 +133,7 @@ ___ ### destroySetting -▸ **destroySetting**(`name`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **destroySetting**(`name`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete a Tenant Setting @@ -156,7 +156,7 @@ SettingsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -166,7 +166,7 @@ ___ ### listSettings -▸ **listSettings**(`options?`): `Promise`<`AxiosResponse`<[`TenantSettings`](../interfaces/TenantSettings.md), `any`\>\> +▸ **listSettings**(`options?`): `Promise`<`AxiosResponse`<[`TenantSettings`](../interfaces/TenantSettings.md)\>\> List Tenant Settings @@ -188,7 +188,7 @@ SettingsApi #### Returns -`Promise`<`AxiosResponse`<[`TenantSettings`](../interfaces/TenantSettings.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TenantSettings`](../interfaces/TenantSettings.md)\>\> #### Defined in @@ -198,7 +198,7 @@ ___ ### showSetting -▸ **showSetting**(`name`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **showSetting**(`name`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Get a specific Tenant Setting @@ -221,7 +221,7 @@ SettingsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -231,7 +231,7 @@ ___ ### updateSetting -▸ **updateSetting**(`name`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **updateSetting**(`name`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Update a Tenant Setting @@ -254,7 +254,7 @@ SettingsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/catalog/doc/classes/TagsApi.md b/packages/catalog/doc/classes/TagsApi.md index 4fd5c30e1..aa620ed28 100644 --- a/packages/catalog/doc/classes/TagsApi.md +++ b/packages/catalog/doc/classes/TagsApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### listTags -▸ **listTags**(`options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listTags**(`options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> List Tags @@ -118,7 +118,7 @@ TagsApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in diff --git a/packages/catalog/doc/classes/TenantApi.md b/packages/catalog/doc/classes/TenantApi.md index bc7397c28..3fc7d1383 100644 --- a/packages/catalog/doc/classes/TenantApi.md +++ b/packages/catalog/doc/classes/TenantApi.md @@ -98,7 +98,7 @@ BaseAPI.configuration ### listTenants -▸ **listTenants**(`options?`): `Promise`<`AxiosResponse`<[`TenantsCollection`](../interfaces/TenantsCollection.md), `any`\>\> +▸ **listTenants**(`options?`): `Promise`<`AxiosResponse`<[`TenantsCollection`](../interfaces/TenantsCollection.md)\>\> Get a list of tenants. @@ -120,7 +120,7 @@ TenantApi #### Returns -`Promise`<`AxiosResponse`<[`TenantsCollection`](../interfaces/TenantsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TenantsCollection`](../interfaces/TenantsCollection.md)\>\> #### Defined in @@ -130,7 +130,7 @@ ___ ### showTenant -▸ **showTenant**(`tenantId`, `options?`): `Promise`<`AxiosResponse`<[`Tenant`](../interfaces/Tenant.md), `any`\>\> +▸ **showTenant**(`tenantId`, `options?`): `Promise`<`AxiosResponse`<[`Tenant`](../interfaces/Tenant.md)\>\> Gets the tenant specified by the tenant id. @@ -153,7 +153,7 @@ TenantApi #### Returns -`Promise`<`AxiosResponse`<[`Tenant`](../interfaces/Tenant.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Tenant`](../interfaces/Tenant.md)\>\> #### Defined in @@ -163,7 +163,7 @@ ___ ### tenantSeed -▸ **tenantSeed**(`tenantId`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **tenantSeed**(`tenantId`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Run a task to seed the Tenant Groups required for an org admin to onboard additional users. @@ -186,7 +186,7 @@ TenantApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/config-manager/doc/classes/DefaultApi.md b/packages/config-manager/doc/classes/DefaultApi.md index bb750a824..cec4196bc 100644 --- a/packages/config-manager/doc/classes/DefaultApi.md +++ b/packages/config-manager/doc/classes/DefaultApi.md @@ -99,7 +99,7 @@ BaseAPI.configuration ### createProfile -▸ **createProfile**(`inlineObject`, `options?`): `Promise`<`AxiosResponse`<[`Profile`](../interfaces/Profile.md), `any`\>\> +▸ **createProfile**(`inlineObject`, `options?`): `Promise`<`AxiosResponse`<[`Profile`](../interfaces/Profile.md)\>\> Create and optionally activate a new profile. @@ -122,7 +122,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Profile`](../interfaces/Profile.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Profile`](../interfaces/Profile.md)\>\> #### Defined in @@ -132,7 +132,7 @@ ___ ### getPlaybook -▸ **getPlaybook**(`profileId`, `options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\> +▸ **getPlaybook**(`profileId`, `options?`): `Promise`<`AxiosResponse`<`object`\>\> Constructs and returns a Ansible playbook suitable to configure a host for the requested profile. @@ -155,7 +155,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`object`, `any`\>\> +`Promise`<`AxiosResponse`<`object`\>\> #### Defined in @@ -165,7 +165,7 @@ ___ ### getProfile -▸ **getProfile**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Profile`](../interfaces/Profile.md), `any`\>\> +▸ **getProfile**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Profile`](../interfaces/Profile.md)\>\> Retrieve a specific profile identified by the \'id\' path parameter for the identified account. If the special value \"current\" is used for the \'id\' path parameter, the most recent profile is retrieved instead. @@ -188,7 +188,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Profile`](../interfaces/Profile.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Profile`](../interfaces/Profile.md)\>\> #### Defined in @@ -198,7 +198,7 @@ ___ ### getProfiles -▸ **getProfiles**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +▸ **getProfiles**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> Retrieve a paginated array of profiles for the identified account. The URL query parameters \'limit\' and \'offset\' can be used to paginate the results. The default value of \'limit\' is 50. The default value of \'offset\' is 0. @@ -222,7 +222,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> #### Defined in diff --git a/packages/entitlements/doc/classes/ServicesApi.md b/packages/entitlements/doc/classes/ServicesApi.md index dfa2f2a3a..72602cff5 100644 --- a/packages/entitlements/doc/classes/ServicesApi.md +++ b/packages/entitlements/doc/classes/ServicesApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### servicesGet -▸ **servicesGet**(`options?`): `Promise`<`AxiosResponse`<{ `[key: string]`: [`ServiceDetails`](../interfaces/ServiceDetails.md); }, `any`\>\> +▸ **servicesGet**(`options?`): `Promise`<`AxiosResponse`<{ `[key: string]`: [`ServiceDetails`](../interfaces/ServiceDetails.md); }\>\> **`Summary`** @@ -116,7 +116,7 @@ ServicesApi #### Returns -`Promise`<`AxiosResponse`<{ `[key: string]`: [`ServiceDetails`](../interfaces/ServiceDetails.md); }, `any`\>\> +`Promise`<`AxiosResponse`<{ `[key: string]`: [`ServiceDetails`](../interfaces/ServiceDetails.md); }\>\> #### Defined in diff --git a/packages/host-inventory/api.ts b/packages/host-inventory/api.ts index b13fc72c3..782372058 100644 --- a/packages/host-inventory/api.ts +++ b/packages/host-inventory/api.ts @@ -1571,6 +1571,12 @@ export interface SystemProfile { * @memberof SystemProfile */ cores_per_socket?: number; + /** + * Number of CPU threads per CPU core. Typical values: 1, 2, 4 + * @type {number} + * @memberof SystemProfile + */ + threads_per_core?: number; /** * * @type {number} @@ -2432,6 +2438,12 @@ export interface SystemProfileSystemd { * @memberof SystemProfileSystemd */ failed: number; + /** + * List of all failed jobs. + * @type {Array} + * @memberof SystemProfileSystemd + */ + failed_services?: Array; } /** @@ -3392,6 +3404,50 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; + + return { + url: globalImportUrl.format(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Delete a list of hosts from the groups they are in.

Required permissions: inventory:groups:write + * @summary Delete a list of hosts from the groups they are in + * @param {Array} hostIdList A comma-separated list of host IDs. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiGroupDeleteHostsFromDifferentGroups: async (hostIdList: Array, options: any = {}): Promise => { + // verify required parameter 'hostIdList' is not null or undefined + if (hostIdList === null || hostIdList === undefined) { + throw new RequiredError('hostIdList','Required parameter hostIdList was null or undefined when calling apiGroupDeleteHostsFromDifferentGroups.'); + } + const localVarPath = `/groups/hosts/{host_id_list}` + .replace(`{${"host_id_list"}}`, encodeURIComponent(String(hostIdList))); + const localVarUrlObj = globalImportUrl.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? await configuration.apiKey("x-rh-identity") + : await configuration.apiKey; + localVarHeaderParameter["x-rh-identity"] = localVarApiKeyValue; + } + + + localVarUrlObj.query = {...localVarUrlObj.query, ...localVarQueryParameter, ...options.query}; // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 delete localVarUrlObj.search; @@ -3409,12 +3465,12 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio * @param {string} [name] Filter by group name * @param {number} [perPage] A number of items to return per page. * @param {number} [page] A page number of the items to return. - * @param {'name' | 'host_count'} [orderBy] Ordering field name + * @param {'name' | 'host_count' | 'updated'} [orderBy] Ordering field name * @param {'ASC' | 'DESC'} [orderHow] Direction of the ordering; defaults to ASC for name, and to DESC for host_count * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiGroupGetGroupList: async (name?: string, perPage?: number, page?: number, orderBy?: 'name' | 'host_count', orderHow?: 'ASC' | 'DESC', options: any = {}): Promise => { + apiGroupGetGroupList: async (name?: string, perPage?: number, page?: number, orderBy?: 'name' | 'host_count' | 'updated', orderHow?: 'ASC' | 'DESC', options: any = {}): Promise => { const localVarPath = `/groups`; const localVarUrlObj = globalImportUrl.parse(localVarPath, true); let baseOptions; @@ -3472,12 +3528,12 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio * @param {Array} groupIdList A comma-separated list of group IDs. * @param {number} [perPage] A number of items to return per page. * @param {number} [page] A page number of the items to return. - * @param {'name' | 'host_count'} [orderBy] Ordering field name + * @param {'name' | 'host_count' | 'updated'} [orderBy] Ordering field name * @param {'ASC' | 'DESC'} [orderHow] Direction of the ordering; defaults to ASC for name, and to DESC for host_count * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiGroupGetGroupsById: async (groupIdList: Array, perPage?: number, page?: number, orderBy?: 'name' | 'host_count', orderHow?: 'ASC' | 'DESC', options: any = {}): Promise => { + apiGroupGetGroupsById: async (groupIdList: Array, perPage?: number, page?: number, orderBy?: 'name' | 'host_count' | 'updated', orderHow?: 'ASC' | 'DESC', options: any = {}): Promise => { // verify required parameter 'groupIdList' is not null or undefined if (groupIdList === null || groupIdList === undefined) { throw new RequiredError('groupIdList','Required parameter groupIdList was null or undefined when calling apiGroupGetGroupsById.'); @@ -3773,18 +3829,32 @@ export const GroupsApiFp = function(configuration?: Configuration) { return axios.request(axiosRequestArgs); }; }, + /** + * Delete a list of hosts from the groups they are in.

Required permissions: inventory:groups:write + * @summary Delete a list of hosts from the groups they are in + * @param {Array} hostIdList A comma-separated list of host IDs. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async apiGroupDeleteHostsFromDifferentGroups(hostIdList: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await GroupsApiAxiosParamCreator(configuration).apiGroupDeleteHostsFromDifferentGroups(hostIdList, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; + return axios.request(axiosRequestArgs); + }; + }, /** * Read the entire list of all groups available to the account.

Required permissions: inventory:groups:read * @summary Read the entire list of groups * @param {string} [name] Filter by group name * @param {number} [perPage] A number of items to return per page. * @param {number} [page] A page number of the items to return. - * @param {'name' | 'host_count'} [orderBy] Ordering field name + * @param {'name' | 'host_count' | 'updated'} [orderBy] Ordering field name * @param {'ASC' | 'DESC'} [orderHow] Direction of the ordering; defaults to ASC for name, and to DESC for host_count * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiGroupGetGroupList(name?: string, perPage?: number, page?: number, orderBy?: 'name' | 'host_count', orderHow?: 'ASC' | 'DESC', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async apiGroupGetGroupList(name?: string, perPage?: number, page?: number, orderBy?: 'name' | 'host_count' | 'updated', orderHow?: 'ASC' | 'DESC', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await GroupsApiAxiosParamCreator(configuration).apiGroupGetGroupList(name, perPage, page, orderBy, orderHow, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -3797,12 +3867,12 @@ export const GroupsApiFp = function(configuration?: Configuration) { * @param {Array} groupIdList A comma-separated list of group IDs. * @param {number} [perPage] A number of items to return per page. * @param {number} [page] A page number of the items to return. - * @param {'name' | 'host_count'} [orderBy] Ordering field name + * @param {'name' | 'host_count' | 'updated'} [orderBy] Ordering field name * @param {'ASC' | 'DESC'} [orderHow] Direction of the ordering; defaults to ASC for name, and to DESC for host_count * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async apiGroupGetGroupsById(groupIdList: Array, perPage?: number, page?: number, orderBy?: 'name' | 'host_count', orderHow?: 'ASC' | 'DESC', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + async apiGroupGetGroupsById(groupIdList: Array, perPage?: number, page?: number, orderBy?: 'name' | 'host_count' | 'updated', orderHow?: 'ASC' | 'DESC', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await GroupsApiAxiosParamCreator(configuration).apiGroupGetGroupsById(groupIdList, perPage, page, orderBy, orderHow, options); return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; @@ -3921,18 +3991,28 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat apiGroupDeleteGroups(groupIdList: Array, options?: any): AxiosPromise { return GroupsApiFp(configuration).apiGroupDeleteGroups(groupIdList, options).then((request) => request(axios, basePath)); }, + /** + * Delete a list of hosts from the groups they are in.

Required permissions: inventory:groups:write + * @summary Delete a list of hosts from the groups they are in + * @param {Array} hostIdList A comma-separated list of host IDs. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiGroupDeleteHostsFromDifferentGroups(hostIdList: Array, options?: any): AxiosPromise { + return GroupsApiFp(configuration).apiGroupDeleteHostsFromDifferentGroups(hostIdList, options).then((request) => request(axios, basePath)); + }, /** * Read the entire list of all groups available to the account.

Required permissions: inventory:groups:read * @summary Read the entire list of groups * @param {string} [name] Filter by group name * @param {number} [perPage] A number of items to return per page. * @param {number} [page] A page number of the items to return. - * @param {'name' | 'host_count'} [orderBy] Ordering field name + * @param {'name' | 'host_count' | 'updated'} [orderBy] Ordering field name * @param {'ASC' | 'DESC'} [orderHow] Direction of the ordering; defaults to ASC for name, and to DESC for host_count * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiGroupGetGroupList(name?: string, perPage?: number, page?: number, orderBy?: 'name' | 'host_count', orderHow?: 'ASC' | 'DESC', options?: any): AxiosPromise { + apiGroupGetGroupList(name?: string, perPage?: number, page?: number, orderBy?: 'name' | 'host_count' | 'updated', orderHow?: 'ASC' | 'DESC', options?: any): AxiosPromise { return GroupsApiFp(configuration).apiGroupGetGroupList(name, perPage, page, orderBy, orderHow, options).then((request) => request(axios, basePath)); }, /** @@ -3941,12 +4021,12 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat * @param {Array} groupIdList A comma-separated list of group IDs. * @param {number} [perPage] A number of items to return per page. * @param {number} [page] A page number of the items to return. - * @param {'name' | 'host_count'} [orderBy] Ordering field name + * @param {'name' | 'host_count' | 'updated'} [orderBy] Ordering field name * @param {'ASC' | 'DESC'} [orderHow] Direction of the ordering; defaults to ASC for name, and to DESC for host_count * @param {*} [options] Override http request option. * @throws {RequiredError} */ - apiGroupGetGroupsById(groupIdList: Array, perPage?: number, page?: number, orderBy?: 'name' | 'host_count', orderHow?: 'ASC' | 'DESC', options?: any): AxiosPromise { + apiGroupGetGroupsById(groupIdList: Array, perPage?: number, page?: number, orderBy?: 'name' | 'host_count' | 'updated', orderHow?: 'ASC' | 'DESC', options?: any): AxiosPromise { return GroupsApiFp(configuration).apiGroupGetGroupsById(groupIdList, perPage, page, orderBy, orderHow, options).then((request) => request(axios, basePath)); }, /** @@ -4060,19 +4140,31 @@ export class GroupsApi extends BaseAPI { return GroupsApiFp(this.configuration).apiGroupDeleteGroups(groupIdList, options).then((request) => request(this.axios, this.basePath)); } + /** + * Delete a list of hosts from the groups they are in.

Required permissions: inventory:groups:write + * @summary Delete a list of hosts from the groups they are in + * @param {Array} hostIdList A comma-separated list of host IDs. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof GroupsApi + */ + public apiGroupDeleteHostsFromDifferentGroups(hostIdList: Array, options?: any) { + return GroupsApiFp(this.configuration).apiGroupDeleteHostsFromDifferentGroups(hostIdList, options).then((request) => request(this.axios, this.basePath)); + } + /** * Read the entire list of all groups available to the account.

Required permissions: inventory:groups:read * @summary Read the entire list of groups * @param {string} [name] Filter by group name * @param {number} [perPage] A number of items to return per page. * @param {number} [page] A page number of the items to return. - * @param {'name' | 'host_count'} [orderBy] Ordering field name + * @param {'name' | 'host_count' | 'updated'} [orderBy] Ordering field name * @param {'ASC' | 'DESC'} [orderHow] Direction of the ordering; defaults to ASC for name, and to DESC for host_count * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ - public apiGroupGetGroupList(name?: string, perPage?: number, page?: number, orderBy?: 'name' | 'host_count', orderHow?: 'ASC' | 'DESC', options?: any) { + public apiGroupGetGroupList(name?: string, perPage?: number, page?: number, orderBy?: 'name' | 'host_count' | 'updated', orderHow?: 'ASC' | 'DESC', options?: any) { return GroupsApiFp(this.configuration).apiGroupGetGroupList(name, perPage, page, orderBy, orderHow, options).then((request) => request(this.axios, this.basePath)); } @@ -4082,13 +4174,13 @@ export class GroupsApi extends BaseAPI { * @param {Array} groupIdList A comma-separated list of group IDs. * @param {number} [perPage] A number of items to return per page. * @param {number} [page] A page number of the items to return. - * @param {'name' | 'host_count'} [orderBy] Ordering field name + * @param {'name' | 'host_count' | 'updated'} [orderBy] Ordering field name * @param {'ASC' | 'DESC'} [orderHow] Direction of the ordering; defaults to ASC for name, and to DESC for host_count * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof GroupsApi */ - public apiGroupGetGroupsById(groupIdList: Array, perPage?: number, page?: number, orderBy?: 'name' | 'host_count', orderHow?: 'ASC' | 'DESC', options?: any) { + public apiGroupGetGroupsById(groupIdList: Array, perPage?: number, page?: number, orderBy?: 'name' | 'host_count' | 'updated', orderHow?: 'ASC' | 'DESC', options?: any) { return GroupsApiFp(this.configuration).apiGroupGetGroupsById(groupIdList, perPage, page, orderBy, orderHow, options).then((request) => request(this.axios, this.basePath)); } diff --git a/packages/host-inventory/doc/classes/AccountsStalenessApi.md b/packages/host-inventory/doc/classes/AccountsStalenessApi.md index 1554cb7fd..a27a2debb 100644 --- a/packages/host-inventory/doc/classes/AccountsStalenessApi.md +++ b/packages/host-inventory/doc/classes/AccountsStalenessApi.md @@ -100,7 +100,7 @@ BaseAPI.configuration ### apiStalenessCreateStaleness -▸ **apiStalenessCreateStaleness**(`stalenessIn`, `options?`): `Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> +▸ **apiStalenessCreateStaleness**(`stalenessIn`, `options?`): `Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md)\>\> Create account staleness record. Required permissions: inventory:TODO:write @@ -123,17 +123,17 @@ AccountsStalenessApi #### Returns -`Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md)\>\> #### Defined in -[api.ts:3065](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3065) +[api.ts:3077](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3077) ___ ### apiStalenessDeleteStaleness -▸ **apiStalenessDeleteStaleness**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiStalenessDeleteStaleness**(`options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete an account staleness

Required permissions: inventory:staleness:write @@ -155,17 +155,17 @@ AccountsStalenessApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:3076](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3076) +[api.ts:3088](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3088) ___ ### apiStalenessGetDefaultStaleness -▸ **apiStalenessGetDefaultStaleness**(`options?`): `Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> +▸ **apiStalenessGetDefaultStaleness**(`options?`): `Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md)\>\> Read the entire list of all accounts staleness available. Required permissions: inventory:TODO:read @@ -187,17 +187,17 @@ AccountsStalenessApi #### Returns -`Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md)\>\> #### Defined in -[api.ts:3087](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3087) +[api.ts:3099](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3099) ___ ### apiStalenessGetStaleness -▸ **apiStalenessGetStaleness**(`options?`): `Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> +▸ **apiStalenessGetStaleness**(`options?`): `Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md)\>\> Read the entire list of all accounts staleness available. Required permissions: inventory:TODO:read @@ -219,17 +219,17 @@ AccountsStalenessApi #### Returns -`Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md)\>\> #### Defined in -[api.ts:3098](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3098) +[api.ts:3110](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3110) ___ ### apiStalenessUpdateStaleness -▸ **apiStalenessUpdateStaleness**(`stalenessIn`, `options?`): `Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> +▸ **apiStalenessUpdateStaleness**(`stalenessIn`, `options?`): `Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md)\>\> Update account staleness record. Required permissions: inventory:staleness:write @@ -252,8 +252,8 @@ AccountsStalenessApi #### Returns -`Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`StalenessOutput`](../interfaces/StalenessOutput.md)\>\> #### Defined in -[api.ts:3110](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3110) +[api.ts:3122](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3122) diff --git a/packages/host-inventory/doc/classes/GroupsApi.md b/packages/host-inventory/doc/classes/GroupsApi.md index f446463d6..2534b9f38 100644 --- a/packages/host-inventory/doc/classes/GroupsApi.md +++ b/packages/host-inventory/doc/classes/GroupsApi.md @@ -31,6 +31,7 @@ GroupsApi - object-oriented interface - [apiAssignmentRuleGetAssignmentRulesList](GroupsApi.md#apiassignmentrulegetassignmentruleslist) - [apiGroupCreateGroup](GroupsApi.md#apigroupcreategroup) - [apiGroupDeleteGroups](GroupsApi.md#apigroupdeletegroups) +- [apiGroupDeleteHostsFromDifferentGroups](GroupsApi.md#apigroupdeletehostsfromdifferentgroups) - [apiGroupGetGroupList](GroupsApi.md#apigroupgetgrouplist) - [apiGroupGetGroupsById](GroupsApi.md#apigroupgetgroupsbyid) - [apiGroupPatchGroupById](GroupsApi.md#apigrouppatchgroupbyid) @@ -105,7 +106,7 @@ BaseAPI.configuration ### apiAssignmentRuleCreateAssignmentRule -▸ **apiAssignmentRuleCreateAssignmentRule**(`assignmentRuleIn`, `options?`): `Promise`<`AxiosResponse`<[`AssignmentRuleOut`](../interfaces/AssignmentRuleOut.md), `any`\>\> +▸ **apiAssignmentRuleCreateAssignmentRule**(`assignmentRuleIn`, `options?`): `Promise`<`AxiosResponse`<[`AssignmentRuleOut`](../interfaces/AssignmentRuleOut.md)\>\> Create Assignment Rule object using post request

Required permissions: inventory:groups:write @@ -128,17 +129,17 @@ GroupsApi #### Returns -`Promise`<`AxiosResponse`<[`AssignmentRuleOut`](../interfaces/AssignmentRuleOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AssignmentRuleOut`](../interfaces/AssignmentRuleOut.md)\>\> #### Defined in -[api.ts:4003](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4003) +[api.ts:4083](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4083) ___ ### apiAssignmentRuleGetAssignmentRulesById -▸ **apiAssignmentRuleGetAssignmentRulesById**(`assignmentRuleIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md), `any`\>\> +▸ **apiAssignmentRuleGetAssignmentRulesById**(`assignmentRuleIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md)\>\> Find one or more assignment rules by their IDs.

Required permissions: inventory:groups:read @@ -165,17 +166,17 @@ GroupsApi #### Returns -`Promise`<`AxiosResponse`<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md)\>\> #### Defined in -[api.ts:4019](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4019) +[api.ts:4099](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4099) ___ ### apiAssignmentRuleGetAssignmentRulesList -▸ **apiAssignmentRuleGetAssignmentRulesList**(`name?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md), `any`\>\> +▸ **apiAssignmentRuleGetAssignmentRulesList**(`name?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md)\>\> Read the entire list of all assignment-rules available to the account. [Not Implemented] Required permissions: inventory:groups:read @@ -202,17 +203,17 @@ GroupsApi #### Returns -`Promise`<`AxiosResponse`<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md)\>\> #### Defined in -[api.ts:4035](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4035) +[api.ts:4115](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4115) ___ ### apiGroupCreateGroup -▸ **apiGroupCreateGroup**(`groupIn`, `options?`): `Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> +▸ **apiGroupCreateGroup**(`groupIn`, `options?`): `Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md)\>\> Creates a new group containing the hosts associated with the host IDs provided.

Required permissions: inventory:groups:write @@ -235,17 +236,17 @@ GroupsApi #### Returns -`Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md)\>\> #### Defined in -[api.ts:4047](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4047) +[api.ts:4127](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4127) ___ ### apiGroupDeleteGroups -▸ **apiGroupDeleteGroups**(`groupIdList`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiGroupDeleteGroups**(`groupIdList`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete a list of groups.

Required permissions: inventory:groups:write @@ -268,17 +269,50 @@ GroupsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:4059](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4059) +[api.ts:4139](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4139) + +___ + +### apiGroupDeleteHostsFromDifferentGroups + +▸ **apiGroupDeleteHostsFromDifferentGroups**(`hostIdList`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> + +Delete a list of hosts from the groups they are in.

Required permissions: inventory:groups:write + +**`Summary`** + +Delete a list of hosts from the groups they are in + +**`Throws`** + +**`Memberof`** + +GroupsApi + +#### Parameters + +| Name | Type | Description | +| :------ | :------ | :------ | +| `hostIdList` | `string`[] | A comma-separated list of host IDs. | +| `options?` | `any` | Override http request option. | + +#### Returns + +`Promise`<`AxiosResponse`<`void`\>\> + +#### Defined in + +[api.ts:4151](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4151) ___ ### apiGroupGetGroupList -▸ **apiGroupGetGroupList**(`name?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`GroupQueryOutput`](../interfaces/GroupQueryOutput.md), `any`\>\> +▸ **apiGroupGetGroupList**(`name?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`GroupQueryOutput`](../interfaces/GroupQueryOutput.md)\>\> Read the entire list of all groups available to the account.

Required permissions: inventory:groups:read @@ -299,23 +333,23 @@ GroupsApi | `name?` | `string` | Filter by group name | | `perPage?` | `number` | A number of items to return per page. | | `page?` | `number` | A page number of the items to return. | -| `orderBy?` | ``"name"`` \| ``"host_count"`` | Ordering field name | +| `orderBy?` | ``"name"`` \| ``"host_count"`` \| ``"updated"`` | Ordering field name | | `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering; defaults to ASC for name, and to DESC for host_count | | `options?` | `any` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`GroupQueryOutput`](../interfaces/GroupQueryOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupQueryOutput`](../interfaces/GroupQueryOutput.md)\>\> #### Defined in -[api.ts:4075](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4075) +[api.ts:4167](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4167) ___ ### apiGroupGetGroupsById -▸ **apiGroupGetGroupsById**(`groupIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`GroupQueryOutput`](../interfaces/GroupQueryOutput.md), `any`\>\> +▸ **apiGroupGetGroupsById**(`groupIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`GroupQueryOutput`](../interfaces/GroupQueryOutput.md)\>\> Find one or more groups by their IDs.

Required permissions: inventory:groups:read @@ -336,23 +370,23 @@ GroupsApi | `groupIdList` | `string`[] | A comma-separated list of group IDs. | | `perPage?` | `number` | A number of items to return per page. | | `page?` | `number` | A page number of the items to return. | -| `orderBy?` | ``"name"`` \| ``"host_count"`` | Ordering field name | +| `orderBy?` | ``"name"`` \| ``"host_count"`` \| ``"updated"`` | Ordering field name | | `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering; defaults to ASC for name, and to DESC for host_count | | `options?` | `any` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`GroupQueryOutput`](../interfaces/GroupQueryOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupQueryOutput`](../interfaces/GroupQueryOutput.md)\>\> #### Defined in -[api.ts:4091](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4091) +[api.ts:4183](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4183) ___ ### apiGroupPatchGroupById -▸ **apiGroupPatchGroupById**(`groupId`, `groupIn`, `options?`): `Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> +▸ **apiGroupPatchGroupById**(`groupId`, `groupIn`, `options?`): `Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md)\>\> Merge group information.

Required permissions: inventory:groups:write @@ -376,17 +410,17 @@ GroupsApi #### Returns -`Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md)\>\> #### Defined in -[api.ts:4104](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4104) +[api.ts:4196](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4196) ___ ### apiHostGroupAddHostListToGroup -▸ **apiHostGroupAddHostListToGroup**(`groupId`, `requestBody`, `options?`): `Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> +▸ **apiHostGroupAddHostListToGroup**(`groupId`, `requestBody`, `options?`): `Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md)\>\> Adds the host list in the request body to the provided group.

Required permissions: inventory:groups:write @@ -410,17 +444,17 @@ GroupsApi #### Returns -`Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md)\>\> #### Defined in -[api.ts:4117](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4117) +[api.ts:4209](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4209) ___ ### apiHostGroupDeleteHostsFromGroup -▸ **apiHostGroupDeleteHostsFromGroup**(`groupId`, `hostIdList`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiHostGroupDeleteHostsFromGroup**(`groupId`, `hostIdList`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete one or more hosts from a group.

Required permissions: inventory:groups:write @@ -444,8 +478,8 @@ GroupsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:4130](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4130) +[api.ts:4222](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4222) diff --git a/packages/host-inventory/doc/classes/HostsApi.md b/packages/host-inventory/doc/classes/HostsApi.md index 7e2645c2a..de9f84502 100644 --- a/packages/host-inventory/doc/classes/HostsApi.md +++ b/packages/host-inventory/doc/classes/HostsApi.md @@ -107,7 +107,7 @@ BaseAPI.configuration ### apiHostDeleteAllHosts -▸ **apiHostDeleteAllHosts**(`confirmDeleteAll?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiHostDeleteAllHosts**(`confirmDeleteAll?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete all hosts on the account. The request must include \"confirm_delete_all=true\".

Required permissions: inventory:hosts:write @@ -130,17 +130,17 @@ HostsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:5446](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5446) +[api.ts:5538](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5538) ___ ### apiHostDeleteHostById -▸ **apiHostDeleteHostById**(`hostIdList`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiHostDeleteHostById**(`hostIdList`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete hosts by IDs

Required permissions: inventory:hosts:write @@ -164,17 +164,17 @@ HostsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:5459](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5459) +[api.ts:5551](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5551) ___ ### apiHostDeleteHostsByFilter -▸ **apiHostDeleteHostsByFilter**(`displayName?`, `fqdn?`, `hostnameOrId?`, `insightsId?`, `providerId?`, `providerType?`, `updatedStart?`, `updatedEnd?`, `groupName?`, `registeredWith?`, `staleness?`, `tags?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiHostDeleteHostsByFilter**(`displayName?`, `fqdn?`, `hostnameOrId?`, `insightsId?`, `providerId?`, `providerType?`, `updatedStart?`, `updatedEnd?`, `groupName?`, `registeredWith?`, `staleness?`, `tags?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete the entire list of hosts filtered by the given parameters.

Required permissions: inventory:hosts:write @@ -209,17 +209,17 @@ HostsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:5483](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5483) +[api.ts:5575](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5575) ___ ### apiHostGetHostById -▸ **apiHostGetHostById**(`hostIdList`, `branchId?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `fields?`, `options?`): `Promise`<`AxiosResponse`<[`HostQueryOutput`](../interfaces/HostQueryOutput.md), `any`\>\> +▸ **apiHostGetHostById**(`hostIdList`, `branchId?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `fields?`, `options?`): `Promise`<`AxiosResponse`<[`HostQueryOutput`](../interfaces/HostQueryOutput.md)\>\> Find one or more hosts by their ID.

Required permissions: inventory:hosts:read @@ -241,24 +241,24 @@ HostsApi | `branchId?` | `string` | Filter by branch_id | | `perPage?` | `number` | A number of items to return per page. | | `page?` | `number` | A page number of the items to return. | -| `orderBy?` | ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"`` | Ordering field name | +| `orderBy?` | ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"`` | Ordering field name | | `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering; defaults to ASC for display_name, and to DESC for updated and operating_system | | `fields?` | `Object` | Fetches only mentioned system_profile fields | | `options?` | `any` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`HostQueryOutput`](../interfaces/HostQueryOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HostQueryOutput`](../interfaces/HostQueryOutput.md)\>\> #### Defined in -[api.ts:5501](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5501) +[api.ts:5593](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5593) ___ ### apiHostGetHostList -▸ **apiHostGetHostList**(`displayName?`, `fqdn?`, `hostnameOrId?`, `insightsId?`, `providerId?`, `providerType?`, `updatedStart?`, `updatedEnd?`, `groupName?`, `branchId?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `staleness?`, `tags?`, `registeredWith?`, `filter?`, `fields?`, `options?`): `Promise`<`AxiosResponse`<[`HostQueryOutput`](../interfaces/HostQueryOutput.md), `any`\>\> +▸ **apiHostGetHostList**(`displayName?`, `fqdn?`, `hostnameOrId?`, `insightsId?`, `providerId?`, `providerType?`, `updatedStart?`, `updatedEnd?`, `groupName?`, `branchId?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `staleness?`, `tags?`, `registeredWith?`, `filter?`, `fields?`, `options?`): `Promise`<`AxiosResponse`<[`HostQueryOutput`](../interfaces/HostQueryOutput.md)\>\> Read the entire list of all hosts available to the account.

Required permissions: inventory:hosts:read @@ -288,7 +288,7 @@ HostsApi | `branchId?` | `string` | Filter by branch_id | | `perPage?` | `number` | A number of items to return per page. | | `page?` | `number` | A page number of the items to return. | -| `orderBy?` | ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"`` | Ordering field name | +| `orderBy?` | ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"`` | Ordering field name | | `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering; defaults to ASC for display_name, and to DESC for updated and operating_system | | `staleness?` | (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[] | Culling states of the hosts. Default: fresh,stale,unknown | | `tags?` | `string`[] | filters out hosts not tagged by the given tags | @@ -299,17 +299,17 @@ HostsApi #### Returns -`Promise`<`AxiosResponse`<[`HostQueryOutput`](../interfaces/HostQueryOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HostQueryOutput`](../interfaces/HostQueryOutput.md)\>\> #### Defined in -[api.ts:5531](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5531) +[api.ts:5623](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5623) ___ ### apiHostGetHostSystemProfileById -▸ **apiHostGetHostSystemProfileById**(`hostIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `branchId?`, `fields?`, `options?`): `Promise`<`AxiosResponse`<[`SystemProfileByHostOut`](../interfaces/SystemProfileByHostOut.md), `any`\>\> +▸ **apiHostGetHostSystemProfileById**(`hostIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `branchId?`, `fields?`, `options?`): `Promise`<`AxiosResponse`<[`SystemProfileByHostOut`](../interfaces/SystemProfileByHostOut.md)\>\> Find one or more hosts by their ID and return the id and system profile

Required permissions: inventory:hosts:read @@ -330,7 +330,7 @@ HostsApi | `hostIdList` | `string`[] | A comma-separated list of host IDs. | | `perPage?` | `number` | A number of items to return per page. | | `page?` | `number` | A page number of the items to return. | -| `orderBy?` | ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"`` | Ordering field name | +| `orderBy?` | ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"`` | Ordering field name | | `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering; defaults to ASC for display_name, and to DESC for updated and operating_system | | `branchId?` | `string` | Filter by branch_id | | `fields?` | `Object` | Fetches only mentioned system_profile fields | @@ -338,17 +338,17 @@ HostsApi #### Returns -`Promise`<`AxiosResponse`<[`SystemProfileByHostOut`](../interfaces/SystemProfileByHostOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemProfileByHostOut`](../interfaces/SystemProfileByHostOut.md)\>\> #### Defined in -[api.ts:5549](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5549) +[api.ts:5641](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5641) ___ ### apiHostGetHostTagCount -▸ **apiHostGetHostTagCount**(`hostIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`TagCountOut`](../interfaces/TagCountOut.md), `any`\>\> +▸ **apiHostGetHostTagCount**(`hostIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`<`AxiosResponse`<[`TagCountOut`](../interfaces/TagCountOut.md)\>\> Get the number of tags on a host or hosts

Required permissions: inventory:hosts:read @@ -369,23 +369,23 @@ HostsApi | `hostIdList` | `string`[] | A comma-separated list of host IDs. | | `perPage?` | `number` | A number of items to return per page. | | `page?` | `number` | A page number of the items to return. | -| `orderBy?` | ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"`` | Ordering field name | +| `orderBy?` | ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"`` | Ordering field name | | `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering; defaults to ASC for display_name, and to DESC for updated and operating_system | | `options?` | `any` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`TagCountOut`](../interfaces/TagCountOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagCountOut`](../interfaces/TagCountOut.md)\>\> #### Defined in -[api.ts:5565](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5565) +[api.ts:5657](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5657) ___ ### apiHostGetHostTags -▸ **apiHostGetHostTags**(`hostIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `search?`, `options?`): `Promise`<`AxiosResponse`<[`TagsOut`](../interfaces/TagsOut.md), `any`\>\> +▸ **apiHostGetHostTags**(`hostIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `search?`, `options?`): `Promise`<`AxiosResponse`<[`TagsOut`](../interfaces/TagsOut.md)\>\> Get the tags on a host

Required permissions: inventory:hosts:read @@ -406,24 +406,24 @@ HostsApi | `hostIdList` | `string`[] | A comma-separated list of host IDs. | | `perPage?` | `number` | A number of items to return per page. | | `page?` | `number` | A page number of the items to return. | -| `orderBy?` | ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"`` | Ordering field name | +| `orderBy?` | ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"`` | Ordering field name | | `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering; defaults to ASC for display_name, and to DESC for updated and operating_system | | `search?` | `string` | Used for searching tags and sap_sids that match the given search string. For searching tags, a tag\'s namespace, key, and/or value is used for matching. | | `options?` | `any` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`TagsOut`](../interfaces/TagsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsOut`](../interfaces/TagsOut.md)\>\> #### Defined in -[api.ts:5582](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5582) +[api.ts:5674](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5674) ___ ### apiHostHostCheckin -▸ **apiHostHostCheckin**(`createCheckIn`, `options?`): `Promise`<`AxiosResponse`<[`HostOut`](../interfaces/HostOut.md), `any`\>\> +▸ **apiHostHostCheckin**(`createCheckIn`, `options?`): `Promise`<`AxiosResponse`<[`HostOut`](../interfaces/HostOut.md)\>\> Finds a host and updates its staleness timestamps. It uses the supplied canonical facts to determine which host to update. By default, the staleness timestamp is set to 1 hour from when the request is received; however, this can be overridden by supplying the interval.

Required permissions: inventory:hosts:write @@ -446,17 +446,17 @@ HostsApi #### Returns -`Promise`<`AxiosResponse`<[`HostOut`](../interfaces/HostOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HostOut`](../interfaces/HostOut.md)\>\> #### Defined in -[api.ts:5594](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5594) +[api.ts:5686](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5686) ___ ### apiHostMergeFacts -▸ **apiHostMergeFacts**(`hostIdList`, `namespace`, `body`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiHostMergeFacts**(`hostIdList`, `namespace`, `body`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Merge one or multiple hosts facts under a namespace.

Required permissions: inventory:hosts:write @@ -482,17 +482,17 @@ HostsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:5609](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5609) +[api.ts:5701](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5701) ___ ### apiHostPatchHostById -▸ **apiHostPatchHostById**(`hostIdList`, `patchHostIn`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiHostPatchHostById**(`hostIdList`, `patchHostIn`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Update hosts

Required permissions: inventory:hosts:write @@ -517,17 +517,17 @@ HostsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:5623](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5623) +[api.ts:5715](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5715) ___ ### apiHostReplaceFacts -▸ **apiHostReplaceFacts**(`hostIdList`, `namespace`, `body`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiHostReplaceFacts**(`hostIdList`, `namespace`, `body`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Replace facts under a namespace

Required permissions: inventory:hosts:write @@ -553,8 +553,8 @@ HostsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:5638](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5638) +[api.ts:5730](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5730) diff --git a/packages/host-inventory/doc/classes/ResourceTypesApi.md b/packages/host-inventory/doc/classes/ResourceTypesApi.md index 304dcc801..13972a4a3 100644 --- a/packages/host-inventory/doc/classes/ResourceTypesApi.md +++ b/packages/host-inventory/doc/classes/ResourceTypesApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### apiResourceTypeGetResourceTypeGroupsList -▸ **apiResourceTypeGetResourceTypeGroupsList**(`name?`, `perPage?`, `page?`, `options?`): `Promise`<`AxiosResponse`<[`ResourceTypesGroupsQueryOutput`](../interfaces/ResourceTypesGroupsQueryOutput.md), `any`\>\> +▸ **apiResourceTypeGetResourceTypeGroupsList**(`name?`, `perPage?`, `page?`, `options?`): `Promise`<`AxiosResponse`<[`ResourceTypesGroupsQueryOutput`](../interfaces/ResourceTypesGroupsQueryOutput.md)\>\> Returns the list of groups in the current account.

Required permissions: rbac:*:* @@ -122,17 +122,17 @@ ResourceTypesApi #### Returns -`Promise`<`AxiosResponse`<[`ResourceTypesGroupsQueryOutput`](../interfaces/ResourceTypesGroupsQueryOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ResourceTypesGroupsQueryOutput`](../interfaces/ResourceTypesGroupsQueryOutput.md)\>\> #### Defined in -[api.ts:5844](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5844) +[api.ts:5936](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5936) ___ ### apiResourceTypeGetResourceTypeList -▸ **apiResourceTypeGetResourceTypeList**(`perPage?`, `page?`, `options?`): `Promise`<`AxiosResponse`<[`ResourceTypesQueryOutput`](../interfaces/ResourceTypesQueryOutput.md), `any`\>\> +▸ **apiResourceTypeGetResourceTypeList**(`perPage?`, `page?`, `options?`): `Promise`<`AxiosResponse`<[`ResourceTypesQueryOutput`](../interfaces/ResourceTypesQueryOutput.md)\>\> Returns the list of available RBAC resource types.

Required permissions: rbac:*:* @@ -156,8 +156,8 @@ ResourceTypesApi #### Returns -`Promise`<`AxiosResponse`<[`ResourceTypesQueryOutput`](../interfaces/ResourceTypesQueryOutput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ResourceTypesQueryOutput`](../interfaces/ResourceTypesQueryOutput.md)\>\> #### Defined in -[api.ts:5857](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5857) +[api.ts:5949](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5949) diff --git a/packages/host-inventory/doc/classes/SystemProfileApi.md b/packages/host-inventory/doc/classes/SystemProfileApi.md index 35e3415fb..3a2865f5a 100644 --- a/packages/host-inventory/doc/classes/SystemProfileApi.md +++ b/packages/host-inventory/doc/classes/SystemProfileApi.md @@ -99,7 +99,7 @@ BaseAPI.configuration ### apiSystemProfileGetOperatingSystem -▸ **apiSystemProfileGetOperatingSystem**(`tags?`, `perPage?`, `page?`, `staleness?`, `registeredWith?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<[`SystemProfileOperatingSystemOut`](../interfaces/SystemProfileOperatingSystemOut.md), `any`\>\> +▸ **apiSystemProfileGetOperatingSystem**(`tags?`, `perPage?`, `page?`, `staleness?`, `registeredWith?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<[`SystemProfileOperatingSystemOut`](../interfaces/SystemProfileOperatingSystemOut.md)\>\> Required permissions: inventory:hosts:read @@ -127,17 +127,17 @@ SystemProfileApi #### Returns -`Promise`<`AxiosResponse`<[`SystemProfileOperatingSystemOut`](../interfaces/SystemProfileOperatingSystemOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemProfileOperatingSystemOut`](../interfaces/SystemProfileOperatingSystemOut.md)\>\> #### Defined in -[api.ts:6316](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6316) +[api.ts:6408](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6408) ___ ### apiSystemProfileGetSapSids -▸ **apiSystemProfileGetSapSids**(`search?`, `tags?`, `perPage?`, `page?`, `staleness?`, `registeredWith?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md), `any`\>\> +▸ **apiSystemProfileGetSapSids**(`search?`, `tags?`, `perPage?`, `page?`, `staleness?`, `registeredWith?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md)\>\> Required permissions: inventory:hosts:read @@ -166,17 +166,17 @@ SystemProfileApi #### Returns -`Promise`<`AxiosResponse`<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md)\>\> #### Defined in -[api.ts:6334](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6334) +[api.ts:6426](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6426) ___ ### apiSystemProfileGetSapSystem -▸ **apiSystemProfileGetSapSystem**(`tags?`, `perPage?`, `page?`, `staleness?`, `registeredWith?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md), `any`\>\> +▸ **apiSystemProfileGetSapSystem**(`tags?`, `perPage?`, `page?`, `staleness?`, `registeredWith?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md)\>\> Required permissions: inventory:hosts:read @@ -204,17 +204,17 @@ SystemProfileApi #### Returns -`Promise`<`AxiosResponse`<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md)\>\> #### Defined in -[api.ts:6351](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6351) +[api.ts:6443](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6443) ___ ### apiSystemProfileValidateSchema -▸ **apiSystemProfileValidateSchema**(`repoBranch`, `repoFork?`, `days?`, `maxMessages?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **apiSystemProfileValidateSchema**(`repoBranch`, `repoFork?`, `days?`, `maxMessages?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Validates System Profile data from recent Kafka messages against a given spec, and compares it with the current one. Only HBI Admins can access this endpoint. @@ -240,8 +240,8 @@ SystemProfileApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in -[api.ts:6366](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6366) +[api.ts:6458](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6458) diff --git a/packages/host-inventory/doc/classes/TagsApi.md b/packages/host-inventory/doc/classes/TagsApi.md index dbf49661e..2bfead1a3 100644 --- a/packages/host-inventory/doc/classes/TagsApi.md +++ b/packages/host-inventory/doc/classes/TagsApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### apiTagGetTags -▸ **apiTagGetTags**(`tags?`, `orderBy?`, `orderHow?`, `perPage?`, `page?`, `staleness?`, `search?`, `displayName?`, `fqdn?`, `hostnameOrId?`, `insightsId?`, `providerId?`, `providerType?`, `updatedStart?`, `updatedEnd?`, `groupName?`, `registeredWith?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<[`ActiveTags`](../interfaces/ActiveTags.md), `any`\>\> +▸ **apiTagGetTags**(`tags?`, `orderBy?`, `orderHow?`, `perPage?`, `page?`, `staleness?`, `search?`, `displayName?`, `fqdn?`, `hostnameOrId?`, `insightsId?`, `providerId?`, `providerType?`, `updatedStart?`, `updatedEnd?`, `groupName?`, `registeredWith?`, `filter?`, `options?`): `Promise`<`AxiosResponse`<[`ActiveTags`](../interfaces/ActiveTags.md)\>\> Required permissions: inventory:hosts:read @@ -136,8 +136,8 @@ TagsApi #### Returns -`Promise`<`AxiosResponse`<[`ActiveTags`](../interfaces/ActiveTags.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ActiveTags`](../interfaces/ActiveTags.md)\>\> #### Defined in -[api.ts:6622](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6622) +[api.ts:6714](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6714) diff --git a/packages/host-inventory/doc/classes/UnleashApi.md b/packages/host-inventory/doc/classes/UnleashApi.md index 09968d278..6705e575e 100644 --- a/packages/host-inventory/doc/classes/UnleashApi.md +++ b/packages/host-inventory/doc/classes/UnleashApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### apiUnleashGetInventoryGroupsToggle -▸ **apiUnleashGetInventoryGroupsToggle**(`options?`): `Promise`<`AxiosResponse`<[`UnleashToggleOut`](../interfaces/UnleashToggleOut.md), `any`\>\> +▸ **apiUnleashGetInventoryGroupsToggle**(`options?`): `Promise`<`AxiosResponse`<[`UnleashToggleOut`](../interfaces/UnleashToggleOut.md)\>\> Returns the value of the hbi.api.inventory-groups toggle, if able to be retrieved. @@ -118,8 +118,8 @@ UnleashApi #### Returns -`Promise`<`AxiosResponse`<[`UnleashToggleOut`](../interfaces/UnleashToggleOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`UnleashToggleOut`](../interfaces/UnleashToggleOut.md)\>\> #### Defined in -[api.ts:6730](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6730) +[api.ts:6822](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6822) diff --git a/packages/host-inventory/doc/enums/SystemProfileGreenbootStatusEnum.md b/packages/host-inventory/doc/enums/SystemProfileGreenbootStatusEnum.md index 7a7d0a91b..2e2e3b3b0 100644 --- a/packages/host-inventory/doc/enums/SystemProfileGreenbootStatusEnum.md +++ b/packages/host-inventory/doc/enums/SystemProfileGreenbootStatusEnum.md @@ -19,7 +19,7 @@ #### Defined in -[api.ts:1928](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1928) +[api.ts:1934](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1934) ___ @@ -29,4 +29,4 @@ ___ #### Defined in -[api.ts:1927](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1927) +[api.ts:1933](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1933) diff --git a/packages/host-inventory/doc/enums/SystemProfileHostTypeEnum.md b/packages/host-inventory/doc/enums/SystemProfileHostTypeEnum.md index 7338e2932..cc8c024fb 100644 --- a/packages/host-inventory/doc/enums/SystemProfileHostTypeEnum.md +++ b/packages/host-inventory/doc/enums/SystemProfileHostTypeEnum.md @@ -18,4 +18,4 @@ #### Defined in -[api.ts:1920](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1920) +[api.ts:1926](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1926) diff --git a/packages/host-inventory/doc/enums/SystemProfileOperatingSystemNameEnum.md b/packages/host-inventory/doc/enums/SystemProfileOperatingSystemNameEnum.md index 98307e655..5eabb29c0 100644 --- a/packages/host-inventory/doc/enums/SystemProfileOperatingSystemNameEnum.md +++ b/packages/host-inventory/doc/enums/SystemProfileOperatingSystemNameEnum.md @@ -20,7 +20,7 @@ #### Defined in -[api.ts:2196](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2196) +[api.ts:2202](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2202) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[api.ts:2197](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2197) +[api.ts:2203](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2203) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[api.ts:2195](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2195) +[api.ts:2201](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2201) diff --git a/packages/host-inventory/doc/enums/SystemProfileSelinuxCurrentModeEnum.md b/packages/host-inventory/doc/enums/SystemProfileSelinuxCurrentModeEnum.md index 8fa6adf2f..2de92e267 100644 --- a/packages/host-inventory/doc/enums/SystemProfileSelinuxCurrentModeEnum.md +++ b/packages/host-inventory/doc/enums/SystemProfileSelinuxCurrentModeEnum.md @@ -20,7 +20,7 @@ #### Defined in -[api.ts:1913](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1913) +[api.ts:1919](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1919) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[api.ts:1911](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1911) +[api.ts:1917](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1917) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[api.ts:1912](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1912) +[api.ts:1918](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1918) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeRoleEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemPurposeRoleEnum.md index 2c8106b4c..cfd828ac3 100644 --- a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeRoleEnum.md +++ b/packages/host-inventory/doc/enums/SystemProfileSystemPurposeRoleEnum.md @@ -20,7 +20,7 @@ #### Defined in -[api.ts:2399](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2399) +[api.ts:2405](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2405) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[api.ts:2397](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2397) +[api.ts:2403](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2403) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[api.ts:2398](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2398) +[api.ts:2404](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2404) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeSlaEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemPurposeSlaEnum.md index 74b64b017..1d76da1e1 100644 --- a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeSlaEnum.md +++ b/packages/host-inventory/doc/enums/SystemProfileSystemPurposeSlaEnum.md @@ -20,7 +20,7 @@ #### Defined in -[api.ts:2406](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2406) +[api.ts:2412](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2412) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[api.ts:2408](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2408) +[api.ts:2414](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2414) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[api.ts:2407](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2407) +[api.ts:2413](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2413) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeUsageEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemPurposeUsageEnum.md index 4f37f5ff7..06faebdb2 100644 --- a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeUsageEnum.md +++ b/packages/host-inventory/doc/enums/SystemProfileSystemPurposeUsageEnum.md @@ -20,7 +20,7 @@ #### Defined in -[api.ts:2389](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2389) +[api.ts:2395](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2395) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[api.ts:2390](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2390) +[api.ts:2396](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2396) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[api.ts:2388](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2388) +[api.ts:2394](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2394) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemUpdateMethodEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemUpdateMethodEnum.md index f208b199c..a000b49f1 100644 --- a/packages/host-inventory/doc/enums/SystemProfileSystemUpdateMethodEnum.md +++ b/packages/host-inventory/doc/enums/SystemProfileSystemUpdateMethodEnum.md @@ -20,7 +20,7 @@ #### Defined in -[api.ts:1935](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1935) +[api.ts:1941](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1941) ___ @@ -30,7 +30,7 @@ ___ #### Defined in -[api.ts:1936](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1936) +[api.ts:1942](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1942) ___ @@ -40,4 +40,4 @@ ___ #### Defined in -[api.ts:1937](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1937) +[api.ts:1943](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1943) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemdStateEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemdStateEnum.md index 3655bcfff..5a392332e 100644 --- a/packages/host-inventory/doc/enums/SystemProfileSystemdStateEnum.md +++ b/packages/host-inventory/doc/enums/SystemProfileSystemdStateEnum.md @@ -23,7 +23,7 @@ #### Defined in -[api.ts:2445](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2445) +[api.ts:2457](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2457) ___ @@ -33,7 +33,7 @@ ___ #### Defined in -[api.ts:2442](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2442) +[api.ts:2454](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2454) ___ @@ -43,7 +43,7 @@ ___ #### Defined in -[api.ts:2446](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2446) +[api.ts:2458](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2458) ___ @@ -53,7 +53,7 @@ ___ #### Defined in -[api.ts:2444](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2444) +[api.ts:2456](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2456) ___ @@ -63,7 +63,7 @@ ___ #### Defined in -[api.ts:2443](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2443) +[api.ts:2455](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2455) ___ @@ -73,4 +73,4 @@ ___ #### Defined in -[api.ts:2447](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2447) +[api.ts:2459](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2459) diff --git a/packages/host-inventory/doc/interfaces/SystemProfile.md b/packages/host-inventory/doc/interfaces/SystemProfile.md index f0d16469a..2e64430e4 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfile.md +++ b/packages/host-inventory/doc/interfaces/SystemProfile.md @@ -74,6 +74,7 @@ SystemProfile - [system\_purpose](SystemProfile.md#system_purpose) - [system\_update\_method](SystemProfile.md#system_update_method) - [systemd](SystemProfile.md#systemd) +- [threads\_per\_core](SystemProfile.md#threads_per_core) - [tuned\_profile](SystemProfile.md#tuned_profile) - [yum\_repos](SystemProfile.md#yum_repos) @@ -89,7 +90,7 @@ SystemProfile #### Defined in -[api.ts:1891](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1891) +[api.ts:1897](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1897) ___ @@ -103,7 +104,7 @@ SystemProfile #### Defined in -[api.ts:1663](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1663) +[api.ts:1669](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1669) ___ @@ -119,7 +120,7 @@ SystemProfile #### Defined in -[api.ts:1669](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1669) +[api.ts:1675](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1675) ___ @@ -133,7 +134,7 @@ SystemProfile #### Defined in -[api.ts:1621](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1621) +[api.ts:1627](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1627) ___ @@ -147,7 +148,7 @@ SystemProfile #### Defined in -[api.ts:1609](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1609) +[api.ts:1615](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1615) ___ @@ -161,7 +162,7 @@ SystemProfile #### Defined in -[api.ts:1615](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1615) +[api.ts:1621](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1621) ___ @@ -175,7 +176,7 @@ SystemProfile #### Defined in -[api.ts:1765](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1765) +[api.ts:1771](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1771) ___ @@ -189,7 +190,7 @@ SystemProfile #### Defined in -[api.ts:1717](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1717) +[api.ts:1723](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1723) ___ @@ -217,7 +218,7 @@ SystemProfile #### Defined in -[api.ts:1627](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1627) +[api.ts:1633](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1633) ___ @@ -247,7 +248,7 @@ SystemProfile #### Defined in -[api.ts:1603](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1603) +[api.ts:1609](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1609) ___ @@ -261,7 +262,7 @@ SystemProfile #### Defined in -[api.ts:1741](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1741) +[api.ts:1747](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1747) ___ @@ -275,7 +276,7 @@ SystemProfile #### Defined in -[api.ts:1795](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1795) +[api.ts:1801](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1801) ___ @@ -289,7 +290,7 @@ SystemProfile #### Defined in -[api.ts:1783](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1783) +[api.ts:1789](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1789) ___ @@ -305,7 +306,7 @@ SystemProfile #### Defined in -[api.ts:1867](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1867) +[api.ts:1873](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1873) ___ @@ -321,7 +322,7 @@ SystemProfile #### Defined in -[api.ts:1861](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1861) +[api.ts:1867](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1867) ___ @@ -337,7 +338,7 @@ SystemProfile #### Defined in -[api.ts:1855](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1855) +[api.ts:1861](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1861) ___ @@ -351,7 +352,7 @@ SystemProfile #### Defined in -[api.ts:1585](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1585) +[api.ts:1591](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1591) ___ @@ -365,7 +366,7 @@ SystemProfile #### Defined in -[api.ts:1591](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1591) +[api.ts:1597](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1597) ___ @@ -381,7 +382,7 @@ SystemProfile #### Defined in -[api.ts:1753](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1753) +[api.ts:1759](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1759) ___ @@ -395,7 +396,7 @@ SystemProfile #### Defined in -[api.ts:1759](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1759) +[api.ts:1765](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1765) ___ @@ -409,7 +410,7 @@ SystemProfile #### Defined in -[api.ts:1771](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1771) +[api.ts:1777](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1777) ___ @@ -423,7 +424,7 @@ SystemProfile #### Defined in -[api.ts:1777](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1777) +[api.ts:1783](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1783) ___ @@ -437,7 +438,7 @@ SystemProfile #### Defined in -[api.ts:1747](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1747) +[api.ts:1753](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1753) ___ @@ -451,7 +452,7 @@ SystemProfile #### Defined in -[api.ts:1789](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1789) +[api.ts:1795](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1795) ___ @@ -467,7 +468,7 @@ SystemProfile #### Defined in -[api.ts:1849](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1849) +[api.ts:1855](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1855) ___ @@ -481,7 +482,7 @@ SystemProfile #### Defined in -[api.ts:1705](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1705) +[api.ts:1711](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1711) ___ @@ -495,7 +496,7 @@ SystemProfile #### Defined in -[api.ts:1675](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1675) +[api.ts:1681](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1681) ___ @@ -509,7 +510,7 @@ SystemProfile #### Defined in -[api.ts:1681](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1681) +[api.ts:1687](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1687) ___ @@ -523,7 +524,7 @@ SystemProfile #### Defined in -[api.ts:1897](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1897) +[api.ts:1903](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1903) ___ @@ -537,7 +538,7 @@ SystemProfile #### Defined in -[api.ts:1597](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1597) +[api.ts:1603](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1603) ___ @@ -579,7 +580,7 @@ SystemProfile #### Defined in -[api.ts:1639](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1639) +[api.ts:1645](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1645) ___ @@ -595,7 +596,7 @@ SystemProfile #### Defined in -[api.ts:1651](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1651) +[api.ts:1657](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1657) ___ @@ -609,7 +610,7 @@ SystemProfile #### Defined in -[api.ts:1645](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1645) +[api.ts:1651](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1651) ___ @@ -639,7 +640,7 @@ SystemProfile #### Defined in -[api.ts:1729](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1729) +[api.ts:1735](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1735) ___ @@ -653,7 +654,7 @@ SystemProfile #### Defined in -[api.ts:1723](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1723) +[api.ts:1729](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1729) ___ @@ -669,7 +670,7 @@ SystemProfile #### Defined in -[api.ts:1657](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1657) +[api.ts:1663](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1663) ___ @@ -715,7 +716,7 @@ SystemProfile #### Defined in -[api.ts:1879](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1879) +[api.ts:1885](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1885) ___ @@ -731,7 +732,7 @@ SystemProfile #### Defined in -[api.ts:1873](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1873) +[api.ts:1879](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1879) ___ @@ -745,7 +746,7 @@ SystemProfile #### Defined in -[api.ts:1687](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1687) +[api.ts:1693](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1693) ___ @@ -759,7 +760,7 @@ SystemProfile #### Defined in -[api.ts:1801](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1801) +[api.ts:1807](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1807) ___ @@ -775,7 +776,7 @@ SystemProfile #### Defined in -[api.ts:1819](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1819) +[api.ts:1825](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1825) ___ @@ -789,7 +790,7 @@ SystemProfile #### Defined in -[api.ts:1813](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1813) +[api.ts:1819](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1819) ___ @@ -805,7 +806,7 @@ SystemProfile #### Defined in -[api.ts:1807](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1807) +[api.ts:1813](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1813) ___ @@ -821,7 +822,7 @@ SystemProfile #### Defined in -[api.ts:1825](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1825) +[api.ts:1831](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1831) ___ @@ -835,7 +836,7 @@ SystemProfile #### Defined in -[api.ts:1711](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1711) +[api.ts:1717](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1717) ___ @@ -851,7 +852,7 @@ SystemProfile #### Defined in -[api.ts:1843](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1843) +[api.ts:1849](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1849) ___ @@ -867,7 +868,7 @@ SystemProfile #### Defined in -[api.ts:1837](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1837) +[api.ts:1843](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1843) ___ @@ -881,7 +882,7 @@ SystemProfile #### Defined in -[api.ts:1699](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1699) +[api.ts:1705](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1705) ___ @@ -895,7 +896,7 @@ SystemProfile #### Defined in -[api.ts:1693](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1693) +[api.ts:1699](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1699) ___ @@ -909,7 +910,7 @@ SystemProfile #### Defined in -[api.ts:1579](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1579) +[api.ts:1585](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1585) ___ @@ -923,7 +924,7 @@ SystemProfile #### Defined in -[api.ts:1885](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1885) +[api.ts:1891](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1891) ___ @@ -939,7 +940,7 @@ SystemProfile #### Defined in -[api.ts:1903](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1903) +[api.ts:1909](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1909) ___ @@ -953,7 +954,23 @@ SystemProfile #### Defined in -[api.ts:1633](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1633) +[api.ts:1639](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1639) + +___ + +### threads\_per\_core + +• `Optional` **threads\_per\_core**: `number` + +Number of CPU threads per CPU core. Typical values: 1, 2, 4 + +**`Memberof`** + +SystemProfile + +#### Defined in + +[api.ts:1579](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1579) ___ @@ -969,7 +986,7 @@ SystemProfile #### Defined in -[api.ts:1831](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1831) +[api.ts:1837](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1837) ___ @@ -983,4 +1000,4 @@ SystemProfile #### Defined in -[api.ts:1735](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1735) +[api.ts:1741](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1741) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileAnsible.md b/packages/host-inventory/doc/interfaces/SystemProfileAnsible.md index 494c95e2e..6700d80ac 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileAnsible.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileAnsible.md @@ -33,7 +33,7 @@ SystemProfileAnsible #### Defined in -[api.ts:1963](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1963) +[api.ts:1969](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1969) ___ @@ -49,7 +49,7 @@ SystemProfileAnsible #### Defined in -[api.ts:1951](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1951) +[api.ts:1957](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1957) ___ @@ -65,7 +65,7 @@ SystemProfileAnsible #### Defined in -[api.ts:1957](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1957) +[api.ts:1963](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1963) ___ @@ -81,4 +81,4 @@ SystemProfileAnsible #### Defined in -[api.ts:1969](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1969) +[api.ts:1975](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1975) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileByHostOut.md b/packages/host-inventory/doc/interfaces/SystemProfileByHostOut.md index 6c3f20d6b..06de9f8a5 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileByHostOut.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileByHostOut.md @@ -34,7 +34,7 @@ SystemProfileByHostOut #### Defined in -[api.ts:1982](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1982) +[api.ts:1988](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1988) ___ @@ -50,7 +50,7 @@ SystemProfileByHostOut #### Defined in -[api.ts:1988](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1988) +[api.ts:1994](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1994) ___ @@ -66,7 +66,7 @@ SystemProfileByHostOut #### Defined in -[api.ts:1994](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1994) +[api.ts:2000](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2000) ___ @@ -82,7 +82,7 @@ SystemProfileByHostOut #### Defined in -[api.ts:2006](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2006) +[api.ts:2012](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2012) ___ @@ -98,4 +98,4 @@ SystemProfileByHostOut #### Defined in -[api.ts:2000](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2000) +[api.ts:2006](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2006) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileByHostOutAllOf.md b/packages/host-inventory/doc/interfaces/SystemProfileByHostOutAllOf.md index 6ed4e668c..f734f3b6a 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileByHostOutAllOf.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileByHostOutAllOf.md @@ -28,4 +28,4 @@ SystemProfileByHostOutAllOf #### Defined in -[api.ts:2019](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2019) +[api.ts:2025](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2025) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileDiskDevice.md b/packages/host-inventory/doc/interfaces/SystemProfileDiskDevice.md index 6ec8cc069..0e86c8977 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileDiskDevice.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileDiskDevice.md @@ -32,7 +32,7 @@ SystemProfileDiskDevice #### Defined in -[api.ts:2032](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2032) +[api.ts:2038](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2038) ___ @@ -48,7 +48,7 @@ SystemProfileDiskDevice #### Defined in -[api.ts:2038](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2038) +[api.ts:2044](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2044) ___ @@ -64,7 +64,7 @@ SystemProfileDiskDevice #### Defined in -[api.ts:2050](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2050) +[api.ts:2056](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2056) ___ @@ -84,7 +84,7 @@ SystemProfileDiskDevice #### Defined in -[api.ts:2044](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2044) +[api.ts:2050](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2050) ___ @@ -100,4 +100,4 @@ SystemProfileDiskDevice #### Defined in -[api.ts:2056](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2056) +[api.ts:2062](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2062) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileDnfModule.md b/packages/host-inventory/doc/interfaces/SystemProfileDnfModule.md index 1cad76cf8..7b2723e70 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileDnfModule.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileDnfModule.md @@ -29,7 +29,7 @@ SystemProfileDnfModule #### Defined in -[api.ts:2069](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2069) +[api.ts:2075](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2075) ___ @@ -43,4 +43,4 @@ SystemProfileDnfModule #### Defined in -[api.ts:2075](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2075) +[api.ts:2081](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2081) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileInstalledProduct.md b/packages/host-inventory/doc/interfaces/SystemProfileInstalledProduct.md index 9f97503fb..c2d61388b 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileInstalledProduct.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileInstalledProduct.md @@ -32,7 +32,7 @@ SystemProfileInstalledProduct #### Defined in -[api.ts:2094](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2094) +[api.ts:2100](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2100) ___ @@ -46,7 +46,7 @@ SystemProfileInstalledProduct #### Defined in -[api.ts:2088](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2088) +[api.ts:2094](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2094) ___ @@ -62,4 +62,4 @@ SystemProfileInstalledProduct #### Defined in -[api.ts:2100](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2100) +[api.ts:2106](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2106) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileMssql.md b/packages/host-inventory/doc/interfaces/SystemProfileMssql.md index f6cfb8c26..7e9a79245 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileMssql.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileMssql.md @@ -30,4 +30,4 @@ SystemProfileMssql #### Defined in -[api.ts:2113](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2113) +[api.ts:2119](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2119) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileNetworkInterface.md b/packages/host-inventory/doc/interfaces/SystemProfileNetworkInterface.md index ff993efe9..e07a9e5d9 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileNetworkInterface.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileNetworkInterface.md @@ -34,7 +34,7 @@ SystemProfileNetworkInterface #### Defined in -[api.ts:2126](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2126) +[api.ts:2132](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2132) ___ @@ -48,7 +48,7 @@ SystemProfileNetworkInterface #### Defined in -[api.ts:2132](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2132) +[api.ts:2138](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2138) ___ @@ -64,7 +64,7 @@ SystemProfileNetworkInterface #### Defined in -[api.ts:2144](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2144) +[api.ts:2150](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2150) ___ @@ -80,7 +80,7 @@ SystemProfileNetworkInterface #### Defined in -[api.ts:2138](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2138) +[api.ts:2144](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2144) ___ @@ -96,7 +96,7 @@ SystemProfileNetworkInterface #### Defined in -[api.ts:2150](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2150) +[api.ts:2156](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2156) ___ @@ -112,7 +112,7 @@ SystemProfileNetworkInterface #### Defined in -[api.ts:2156](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2156) +[api.ts:2162](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2162) ___ @@ -128,4 +128,4 @@ SystemProfileNetworkInterface #### Defined in -[api.ts:2162](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2162) +[api.ts:2168](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2168) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystem.md b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystem.md index d07d25c76..5e5064912 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystem.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystem.md @@ -32,7 +32,7 @@ SystemProfileOperatingSystem #### Defined in -[api.ts:2175](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2175) +[api.ts:2181](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2181) ___ @@ -48,7 +48,7 @@ SystemProfileOperatingSystem #### Defined in -[api.ts:2181](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2181) +[api.ts:2187](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2187) ___ @@ -64,4 +64,4 @@ SystemProfileOperatingSystem #### Defined in -[api.ts:2187](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2187) +[api.ts:2193](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2193) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOut.md b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOut.md index fe2272ded..53dbacb0c 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOut.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOut.md @@ -30,7 +30,7 @@ SystemProfileOperatingSystemOut #### Defined in -[api.ts:2217](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2217) +[api.ts:2223](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2223) ___ @@ -46,7 +46,7 @@ SystemProfileOperatingSystemOut #### Defined in -[api.ts:2223](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2223) +[api.ts:2229](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2229) ___ @@ -62,4 +62,4 @@ SystemProfileOperatingSystemOut #### Defined in -[api.ts:2211](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2211) +[api.ts:2217](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2217) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutResults.md b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutResults.md index b3c8bd1af..c039da600 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutResults.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutResults.md @@ -27,7 +27,7 @@ SystemProfileOperatingSystemOutResults #### Defined in -[api.ts:2242](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2242) +[api.ts:2248](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2248) ___ @@ -41,4 +41,4 @@ SystemProfileOperatingSystemOutResults #### Defined in -[api.ts:2236](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2236) +[api.ts:2242](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2242) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutValue.md b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutValue.md index aa50f6e6f..7b862613e 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutValue.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutValue.md @@ -28,7 +28,7 @@ SystemProfileOperatingSystemOutValue #### Defined in -[api.ts:2261](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2261) +[api.ts:2267](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2267) ___ @@ -42,7 +42,7 @@ SystemProfileOperatingSystemOutValue #### Defined in -[api.ts:2267](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2267) +[api.ts:2273](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2273) ___ @@ -56,4 +56,4 @@ SystemProfileOperatingSystemOutValue #### Defined in -[api.ts:2255](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2255) +[api.ts:2261](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2261) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileRhsm.md b/packages/host-inventory/doc/interfaces/SystemProfileRhsm.md index da3657bfa..6459c1df6 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileRhsm.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileRhsm.md @@ -30,4 +30,4 @@ SystemProfileRhsm #### Defined in -[api.ts:2280](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2280) +[api.ts:2286](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2286) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSap.md b/packages/host-inventory/doc/interfaces/SystemProfileSap.md index ca82df1dd..1eb60b4ae 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileSap.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileSap.md @@ -33,7 +33,7 @@ SystemProfileSap #### Defined in -[api.ts:2305](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2305) +[api.ts:2311](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2311) ___ @@ -49,7 +49,7 @@ SystemProfileSap #### Defined in -[api.ts:2293](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2293) +[api.ts:2299](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2299) ___ @@ -63,7 +63,7 @@ SystemProfileSap #### Defined in -[api.ts:2299](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2299) +[api.ts:2305](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2305) ___ @@ -79,4 +79,4 @@ SystemProfileSap #### Defined in -[api.ts:2311](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2311) +[api.ts:2317](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2317) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOut.md b/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOut.md index 7c8559f60..61127aee6 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOut.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOut.md @@ -30,7 +30,7 @@ SystemProfileSapSystemOut #### Defined in -[api.ts:2330](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2330) +[api.ts:2336](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2336) ___ @@ -46,7 +46,7 @@ SystemProfileSapSystemOut #### Defined in -[api.ts:2336](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2336) +[api.ts:2342](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2342) ___ @@ -62,4 +62,4 @@ SystemProfileSapSystemOut #### Defined in -[api.ts:2324](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2324) +[api.ts:2330](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2330) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOutResults.md b/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOutResults.md index 5e3a96fab..df80dbb64 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOutResults.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOutResults.md @@ -27,7 +27,7 @@ SystemProfileSapSystemOutResults #### Defined in -[api.ts:2355](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2355) +[api.ts:2361](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2361) ___ @@ -41,4 +41,4 @@ SystemProfileSapSystemOutResults #### Defined in -[api.ts:2349](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2349) +[api.ts:2355](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2355) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSystemPurpose.md b/packages/host-inventory/doc/interfaces/SystemProfileSystemPurpose.md index c1fc1bd27..35f00dcaf 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileSystemPurpose.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileSystemPurpose.md @@ -32,7 +32,7 @@ SystemProfileSystemPurpose #### Defined in -[api.ts:2374](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2374) +[api.ts:2380](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2380) ___ @@ -48,7 +48,7 @@ SystemProfileSystemPurpose #### Defined in -[api.ts:2380](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2380) +[api.ts:2386](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2386) ___ @@ -64,4 +64,4 @@ SystemProfileSystemPurpose #### Defined in -[api.ts:2368](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2368) +[api.ts:2374](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2374) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSystemd.md b/packages/host-inventory/doc/interfaces/SystemProfileSystemd.md index 6c5f59509..8c80b644c 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileSystemd.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileSystemd.md @@ -15,6 +15,7 @@ SystemProfileSystemd ### Properties - [failed](SystemProfileSystemd.md#failed) +- [failed\_services](SystemProfileSystemd.md#failed_services) - [jobs\_queued](SystemProfileSystemd.md#jobs_queued) - [state](SystemProfileSystemd.md#state) @@ -32,7 +33,23 @@ SystemProfileSystemd #### Defined in -[api.ts:2434](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2434) +[api.ts:2440](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2440) + +___ + +### failed\_services + +• `Optional` **failed\_services**: `string`[] + +List of all failed jobs. + +**`Memberof`** + +SystemProfileSystemd + +#### Defined in + +[api.ts:2446](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2446) ___ @@ -48,7 +65,7 @@ SystemProfileSystemd #### Defined in -[api.ts:2428](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2428) +[api.ts:2434](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2434) ___ @@ -64,4 +81,4 @@ SystemProfileSystemd #### Defined in -[api.ts:2422](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2422) +[api.ts:2428](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2428) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileYumRepo.md b/packages/host-inventory/doc/interfaces/SystemProfileYumRepo.md index d534ad8c6..042a823f2 100644 --- a/packages/host-inventory/doc/interfaces/SystemProfileYumRepo.md +++ b/packages/host-inventory/doc/interfaces/SystemProfileYumRepo.md @@ -33,7 +33,7 @@ SystemProfileYumRepo #### Defined in -[api.ts:2485](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2485) +[api.ts:2497](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2497) ___ @@ -47,7 +47,7 @@ SystemProfileYumRepo #### Defined in -[api.ts:2479](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2479) +[api.ts:2491](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2491) ___ @@ -61,7 +61,7 @@ SystemProfileYumRepo #### Defined in -[api.ts:2473](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2473) +[api.ts:2485](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2485) ___ @@ -75,7 +75,7 @@ SystemProfileYumRepo #### Defined in -[api.ts:2461](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2461) +[api.ts:2473](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2473) ___ @@ -91,7 +91,7 @@ SystemProfileYumRepo #### Defined in -[api.ts:2491](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2491) +[api.ts:2503](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2503) ___ @@ -105,4 +105,4 @@ SystemProfileYumRepo #### Defined in -[api.ts:2467](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2467) +[api.ts:2479](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2479) diff --git a/packages/host-inventory/doc/interfaces/TagCountOut.md b/packages/host-inventory/doc/interfaces/TagCountOut.md index 78de9fa55..bc7651856 100644 --- a/packages/host-inventory/doc/interfaces/TagCountOut.md +++ b/packages/host-inventory/doc/interfaces/TagCountOut.md @@ -32,7 +32,7 @@ TagCountOut #### Defined in -[api.ts:2504](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2504) +[api.ts:2516](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2516) ___ @@ -48,7 +48,7 @@ TagCountOut #### Defined in -[api.ts:2510](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2510) +[api.ts:2522](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2522) ___ @@ -64,7 +64,7 @@ TagCountOut #### Defined in -[api.ts:2516](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2516) +[api.ts:2528](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2528) ___ @@ -84,7 +84,7 @@ TagCountOut #### Defined in -[api.ts:2528](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2528) +[api.ts:2540](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2540) ___ @@ -100,4 +100,4 @@ TagCountOut #### Defined in -[api.ts:2522](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2522) +[api.ts:2534](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2534) diff --git a/packages/host-inventory/doc/interfaces/TagCountOutAllOf.md b/packages/host-inventory/doc/interfaces/TagCountOutAllOf.md index 3bc30ab0e..0d8f12699 100644 --- a/packages/host-inventory/doc/interfaces/TagCountOutAllOf.md +++ b/packages/host-inventory/doc/interfaces/TagCountOutAllOf.md @@ -32,4 +32,4 @@ TagCountOutAllOf #### Defined in -[api.ts:2541](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2541) +[api.ts:2553](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2553) diff --git a/packages/host-inventory/doc/interfaces/TagsOut.md b/packages/host-inventory/doc/interfaces/TagsOut.md index 95ca62660..01dd723d4 100644 --- a/packages/host-inventory/doc/interfaces/TagsOut.md +++ b/packages/host-inventory/doc/interfaces/TagsOut.md @@ -32,7 +32,7 @@ TagsOut #### Defined in -[api.ts:2554](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2554) +[api.ts:2566](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2566) ___ @@ -48,7 +48,7 @@ TagsOut #### Defined in -[api.ts:2560](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2560) +[api.ts:2572](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2572) ___ @@ -64,7 +64,7 @@ TagsOut #### Defined in -[api.ts:2566](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2566) +[api.ts:2578](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2578) ___ @@ -84,7 +84,7 @@ TagsOut #### Defined in -[api.ts:2578](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2578) +[api.ts:2590](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2590) ___ @@ -100,4 +100,4 @@ TagsOut #### Defined in -[api.ts:2572](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2572) +[api.ts:2584](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2584) diff --git a/packages/host-inventory/doc/interfaces/TagsOutAllOf.md b/packages/host-inventory/doc/interfaces/TagsOutAllOf.md index 22b167591..295e22599 100644 --- a/packages/host-inventory/doc/interfaces/TagsOutAllOf.md +++ b/packages/host-inventory/doc/interfaces/TagsOutAllOf.md @@ -32,4 +32,4 @@ TagsOutAllOf #### Defined in -[api.ts:2591](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2591) +[api.ts:2603](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2603) diff --git a/packages/host-inventory/doc/interfaces/UnleashToggleOut.md b/packages/host-inventory/doc/interfaces/UnleashToggleOut.md index 98a8399eb..4105a0ea9 100644 --- a/packages/host-inventory/doc/interfaces/UnleashToggleOut.md +++ b/packages/host-inventory/doc/interfaces/UnleashToggleOut.md @@ -29,7 +29,7 @@ UnleashToggleOut #### Defined in -[api.ts:2604](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2604) +[api.ts:2616](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2616) ___ @@ -45,4 +45,4 @@ UnleashToggleOut #### Defined in -[api.ts:2610](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2610) +[api.ts:2622](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2622) diff --git a/packages/host-inventory/doc/interfaces/YumRepo.md b/packages/host-inventory/doc/interfaces/YumRepo.md index 987771765..8a3140fad 100644 --- a/packages/host-inventory/doc/interfaces/YumRepo.md +++ b/packages/host-inventory/doc/interfaces/YumRepo.md @@ -33,7 +33,7 @@ YumRepo #### Defined in -[api.ts:2647](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2647) +[api.ts:2659](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2659) ___ @@ -47,7 +47,7 @@ YumRepo #### Defined in -[api.ts:2641](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2641) +[api.ts:2653](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2653) ___ @@ -61,7 +61,7 @@ YumRepo #### Defined in -[api.ts:2635](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2635) +[api.ts:2647](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2647) ___ @@ -75,7 +75,7 @@ YumRepo #### Defined in -[api.ts:2623](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2623) +[api.ts:2635](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2635) ___ @@ -91,7 +91,7 @@ YumRepo #### Defined in -[api.ts:2653](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2653) +[api.ts:2665](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2665) ___ @@ -105,4 +105,4 @@ YumRepo #### Defined in -[api.ts:2629](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2629) +[api.ts:2641](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2641) diff --git a/packages/host-inventory/doc/modules.md b/packages/host-inventory/doc/modules.md index 94d7af27c..8cc8baeaa 100644 --- a/packages/host-inventory/doc/modules.md +++ b/packages/host-inventory/doc/modules.md @@ -172,7 +172,7 @@ AccountsStalenessApi - axios parameter creator #### Defined in -[api.ts:2660](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2660) +[api.ts:2672](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2672) ___ @@ -206,7 +206,7 @@ AccountsStalenessApi - factory interface #### Defined in -[api.ts:2998](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2998) +[api.ts:3010](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3010) ___ @@ -238,7 +238,7 @@ AccountsStalenessApi - functional programming interface #### Defined in -[api.ts:2922](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2922) +[api.ts:2934](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L2934) ___ @@ -267,15 +267,16 @@ GroupsApi - axios parameter creator | `apiAssignmentRuleGetAssignmentRulesList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"group_id"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiGroupCreateGroup` | (`groupIn`: [`GroupIn`](interfaces/GroupIn.md), `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiGroupDeleteGroups` | (`groupIdList`: `string`[], `options?`: `any`) => `Promise`<`RequestArgs`\> | -| `apiGroupGetGroupList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<`RequestArgs`\> | -| `apiGroupGetGroupsById` | (`groupIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<`RequestArgs`\> | +| `apiGroupDeleteHostsFromDifferentGroups` | (`hostIdList`: `string`[], `options?`: `any`) => `Promise`<`RequestArgs`\> | +| `apiGroupGetGroupList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"`` \| ``"updated"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<`RequestArgs`\> | +| `apiGroupGetGroupsById` | (`groupIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"`` \| ``"updated"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiGroupPatchGroupById` | (`groupId`: `string`, `groupIn`: [`GroupIn`](interfaces/GroupIn.md), `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiHostGroupAddHostListToGroup` | (`groupId`: `string`, `requestBody`: `string`[], `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiHostGroupDeleteHostsFromGroup` | (`groupId`: `string`, `hostIdList`: `string`[], `options?`: `any`) => `Promise`<`RequestArgs`\> | #### Defined in -[api.ts:3121](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3121) +[api.ts:3133](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3133) ___ @@ -306,15 +307,16 @@ GroupsApi - factory interface | `apiAssignmentRuleGetAssignmentRulesList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"group_id"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `AxiosPromise`<[`AssignmentRuleQueryOutput`](interfaces/AssignmentRuleQueryOutput.md)\> | | `apiGroupCreateGroup` | (`groupIn`: [`GroupIn`](interfaces/GroupIn.md), `options?`: `any`) => `AxiosPromise`<[`GroupOutWithHostCount`](interfaces/GroupOutWithHostCount.md)\> | | `apiGroupDeleteGroups` | (`groupIdList`: `string`[], `options?`: `any`) => `AxiosPromise`<`void`\> | -| `apiGroupGetGroupList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `AxiosPromise`<[`GroupQueryOutput`](interfaces/GroupQueryOutput.md)\> | -| `apiGroupGetGroupsById` | (`groupIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `AxiosPromise`<[`GroupQueryOutput`](interfaces/GroupQueryOutput.md)\> | +| `apiGroupDeleteHostsFromDifferentGroups` | (`hostIdList`: `string`[], `options?`: `any`) => `AxiosPromise`<`void`\> | +| `apiGroupGetGroupList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"`` \| ``"updated"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `AxiosPromise`<[`GroupQueryOutput`](interfaces/GroupQueryOutput.md)\> | +| `apiGroupGetGroupsById` | (`groupIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"`` \| ``"updated"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `AxiosPromise`<[`GroupQueryOutput`](interfaces/GroupQueryOutput.md)\> | | `apiGroupPatchGroupById` | (`groupId`: `string`, `groupIn`: [`GroupIn`](interfaces/GroupIn.md), `options?`: `any`) => `AxiosPromise`<[`GroupOutWithHostCount`](interfaces/GroupOutWithHostCount.md)\> | | `apiHostGroupAddHostListToGroup` | (`groupId`: `string`, `requestBody`: `string`[], `options?`: `any`) => `AxiosPromise`<[`GroupOutWithHostCount`](interfaces/GroupOutWithHostCount.md)\> | | `apiHostGroupDeleteHostsFromGroup` | (`groupId`: `string`, `hostIdList`: `string`[], `options?`: `any`) => `AxiosPromise`<`void`\> | #### Defined in -[api.ts:3864](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3864) +[api.ts:3934](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3934) ___ @@ -343,15 +345,16 @@ GroupsApi - functional programming interface | `apiAssignmentRuleGetAssignmentRulesList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"group_id"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`AssignmentRuleQueryOutput`](interfaces/AssignmentRuleQueryOutput.md)\>\> | | `apiGroupCreateGroup` | (`groupIn`: [`GroupIn`](interfaces/GroupIn.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GroupOutWithHostCount`](interfaces/GroupOutWithHostCount.md)\>\> | | `apiGroupDeleteGroups` | (`groupIdList`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `apiGroupGetGroupList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GroupQueryOutput`](interfaces/GroupQueryOutput.md)\>\> | -| `apiGroupGetGroupsById` | (`groupIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GroupQueryOutput`](interfaces/GroupQueryOutput.md)\>\> | +| `apiGroupDeleteHostsFromDifferentGroups` | (`hostIdList`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | +| `apiGroupGetGroupList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"`` \| ``"updated"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GroupQueryOutput`](interfaces/GroupQueryOutput.md)\>\> | +| `apiGroupGetGroupsById` | (`groupIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"host_count"`` \| ``"updated"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GroupQueryOutput`](interfaces/GroupQueryOutput.md)\>\> | | `apiGroupPatchGroupById` | (`groupId`: `string`, `groupIn`: [`GroupIn`](interfaces/GroupIn.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GroupOutWithHostCount`](interfaces/GroupOutWithHostCount.md)\>\> | | `apiHostGroupAddHostListToGroup` | (`groupId`: `string`, `requestBody`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`GroupOutWithHostCount`](interfaces/GroupOutWithHostCount.md)\>\> | | `apiHostGroupDeleteHostsFromGroup` | (`groupId`: `string`, `hostIdList`: `string`[], `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | #### Defined in -[api.ts:3696](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3696) +[api.ts:3752](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L3752) ___ @@ -378,11 +381,11 @@ HostsApi - axios parameter creator | `apiHostDeleteAllHosts` | (`confirmDeleteAll?`: `boolean`, `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiHostDeleteHostById` | (`hostIdList`: `string`[], `branchId?`: `string`, `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiHostDeleteHostsByFilter` | (`displayName?`: `string`, `fqdn?`: `string`, `hostnameOrId?`: `string`, `insightsId?`: `string`, `providerId?`: `string`, `providerType?`: ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"``, `updatedStart?`: `string`, `updatedEnd?`: `string`, `groupName?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `staleness?`: (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[], `tags?`: `string`[], `filter?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<`RequestArgs`\> | -| `apiHostGetHostById` | (`hostIdList`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<`RequestArgs`\> | -| `apiHostGetHostList` | (`displayName?`: `string`, `fqdn?`: `string`, `hostnameOrId?`: `string`, `insightsId?`: `string`, `providerId?`: `string`, `providerType?`: ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"``, `updatedStart?`: `string`, `updatedEnd?`: `string`, `groupName?`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `staleness?`: (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[], `tags?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: { `[key: string]`: `object`; }, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<`RequestArgs`\> | -| `apiHostGetHostSystemProfileById` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `branchId?`: `string`, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<`RequestArgs`\> | -| `apiHostGetHostTagCount` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<`RequestArgs`\> | -| `apiHostGetHostTags` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `search?`: `string`, `options?`: `any`) => `Promise`<`RequestArgs`\> | +| `apiHostGetHostById` | (`hostIdList`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<`RequestArgs`\> | +| `apiHostGetHostList` | (`displayName?`: `string`, `fqdn?`: `string`, `hostnameOrId?`: `string`, `insightsId?`: `string`, `providerId?`: `string`, `providerType?`: ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"``, `updatedStart?`: `string`, `updatedEnd?`: `string`, `groupName?`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `staleness?`: (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[], `tags?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: { `[key: string]`: `object`; }, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<`RequestArgs`\> | +| `apiHostGetHostSystemProfileById` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `branchId?`: `string`, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<`RequestArgs`\> | +| `apiHostGetHostTagCount` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<`RequestArgs`\> | +| `apiHostGetHostTags` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `search?`: `string`, `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiHostHostCheckin` | (`createCheckIn`: [`CreateCheckIn`](interfaces/CreateCheckIn.md), `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiHostMergeFacts` | (`hostIdList`: `string`[], `namespace`: `string`, `body`: `object`, `branchId?`: `string`, `options?`: `any`) => `Promise`<`RequestArgs`\> | | `apiHostPatchHostById` | (`hostIdList`: `string`[], `patchHostIn`: [`PatchHostIn`](interfaces/PatchHostIn.md), `branchId?`: `string`, `options?`: `any`) => `Promise`<`RequestArgs`\> | @@ -390,7 +393,7 @@ HostsApi - axios parameter creator #### Defined in -[api.ts:4141](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4141) +[api.ts:4233](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L4233) ___ @@ -419,11 +422,11 @@ HostsApi - factory interface | `apiHostDeleteAllHosts` | (`confirmDeleteAll?`: `boolean`, `options?`: `any`) => `AxiosPromise`<`void`\> | | `apiHostDeleteHostById` | (`hostIdList`: `string`[], `branchId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | | `apiHostDeleteHostsByFilter` | (`displayName?`: `string`, `fqdn?`: `string`, `hostnameOrId?`: `string`, `insightsId?`: `string`, `providerId?`: `string`, `providerType?`: ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"``, `updatedStart?`: `string`, `updatedEnd?`: `string`, `groupName?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `staleness?`: (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[], `tags?`: `string`[], `filter?`: { `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`<`void`\> | -| `apiHostGetHostById` | (`hostIdList`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`<[`HostQueryOutput`](interfaces/HostQueryOutput.md)\> | -| `apiHostGetHostList` | (`displayName?`: `string`, `fqdn?`: `string`, `hostnameOrId?`: `string`, `insightsId?`: `string`, `providerId?`: `string`, `providerType?`: ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"``, `updatedStart?`: `string`, `updatedEnd?`: `string`, `groupName?`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `staleness?`: (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[], `tags?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: { `[key: string]`: `object`; }, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`<[`HostQueryOutput`](interfaces/HostQueryOutput.md)\> | -| `apiHostGetHostSystemProfileById` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `branchId?`: `string`, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`<[`SystemProfileByHostOut`](interfaces/SystemProfileByHostOut.md)\> | -| `apiHostGetHostTagCount` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `AxiosPromise`<[`TagCountOut`](interfaces/TagCountOut.md)\> | -| `apiHostGetHostTags` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `search?`: `string`, `options?`: `any`) => `AxiosPromise`<[`TagsOut`](interfaces/TagsOut.md)\> | +| `apiHostGetHostById` | (`hostIdList`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`<[`HostQueryOutput`](interfaces/HostQueryOutput.md)\> | +| `apiHostGetHostList` | (`displayName?`: `string`, `fqdn?`: `string`, `hostnameOrId?`: `string`, `insightsId?`: `string`, `providerId?`: `string`, `providerType?`: ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"``, `updatedStart?`: `string`, `updatedEnd?`: `string`, `groupName?`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `staleness?`: (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[], `tags?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: { `[key: string]`: `object`; }, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`<[`HostQueryOutput`](interfaces/HostQueryOutput.md)\> | +| `apiHostGetHostSystemProfileById` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `branchId?`: `string`, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`<[`SystemProfileByHostOut`](interfaces/SystemProfileByHostOut.md)\> | +| `apiHostGetHostTagCount` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `AxiosPromise`<[`TagCountOut`](interfaces/TagCountOut.md)\> | +| `apiHostGetHostTags` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `search?`: `string`, `options?`: `any`) => `AxiosPromise`<[`TagsOut`](interfaces/TagsOut.md)\> | | `apiHostHostCheckin` | (`createCheckIn`: [`CreateCheckIn`](interfaces/CreateCheckIn.md), `options?`: `any`) => `AxiosPromise`<[`HostOut`](interfaces/HostOut.md)\> | | `apiHostMergeFacts` | (`hostIdList`: `string`[], `namespace`: `string`, `body`: `object`, `branchId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | | `apiHostPatchHostById` | (`hostIdList`: `string`[], `patchHostIn`: [`PatchHostIn`](interfaces/PatchHostIn.md), `branchId?`: `string`, `options?`: `any`) => `AxiosPromise`<`void`\> | @@ -431,7 +434,7 @@ HostsApi - factory interface #### Defined in -[api.ts:5246](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5246) +[api.ts:5338](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5338) ___ @@ -458,11 +461,11 @@ HostsApi - functional programming interface | `apiHostDeleteAllHosts` | (`confirmDeleteAll?`: `boolean`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | | `apiHostDeleteHostById` | (`hostIdList`: `string`[], `branchId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | | `apiHostDeleteHostsByFilter` | (`displayName?`: `string`, `fqdn?`: `string`, `hostnameOrId?`: `string`, `insightsId?`: `string`, `providerId?`: `string`, `providerType?`: ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"``, `updatedStart?`: `string`, `updatedEnd?`: `string`, `groupName?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `staleness?`: (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[], `tags?`: `string`[], `filter?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `apiHostGetHostById` | (`hostIdList`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`HostQueryOutput`](interfaces/HostQueryOutput.md)\>\> | -| `apiHostGetHostList` | (`displayName?`: `string`, `fqdn?`: `string`, `hostnameOrId?`: `string`, `insightsId?`: `string`, `providerId?`: `string`, `providerType?`: ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"``, `updatedStart?`: `string`, `updatedEnd?`: `string`, `groupName?`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `staleness?`: (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[], `tags?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: { `[key: string]`: `object`; }, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`HostQueryOutput`](interfaces/HostQueryOutput.md)\>\> | -| `apiHostGetHostSystemProfileById` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `branchId?`: `string`, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SystemProfileByHostOut`](interfaces/SystemProfileByHostOut.md)\>\> | -| `apiHostGetHostTagCount` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TagCountOut`](interfaces/TagCountOut.md)\>\> | -| `apiHostGetHostTags` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"display_name"`` \| ``"group_name"`` \| ``"updated"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `search?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TagsOut`](interfaces/TagsOut.md)\>\> | +| `apiHostGetHostById` | (`hostIdList`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`HostQueryOutput`](interfaces/HostQueryOutput.md)\>\> | +| `apiHostGetHostList` | (`displayName?`: `string`, `fqdn?`: `string`, `hostnameOrId?`: `string`, `insightsId?`: `string`, `providerId?`: `string`, `providerType?`: ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"``, `updatedStart?`: `string`, `updatedEnd?`: `string`, `groupName?`: `string`[], `branchId?`: `string`, `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `staleness?`: (``"unknown"`` \| ``"fresh"`` \| ``"stale"`` \| ``"stale_warning"``)[], `tags?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: { `[key: string]`: `object`; }, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`HostQueryOutput`](interfaces/HostQueryOutput.md)\>\> | +| `apiHostGetHostSystemProfileById` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `branchId?`: `string`, `fields?`: { `[key: string]`: `object`; }, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`SystemProfileByHostOut`](interfaces/SystemProfileByHostOut.md)\>\> | +| `apiHostGetHostTagCount` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TagCountOut`](interfaces/TagCountOut.md)\>\> | +| `apiHostGetHostTags` | (`hostIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"updated"`` \| ``"display_name"`` \| ``"group_name"`` \| ``"operating_system"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `search?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`TagsOut`](interfaces/TagsOut.md)\>\> | | `apiHostHostCheckin` | (`createCheckIn`: [`CreateCheckIn`](interfaces/CreateCheckIn.md), `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`HostOut`](interfaces/HostOut.md)\>\> | | `apiHostMergeFacts` | (`hostIdList`: `string`[], `namespace`: `string`, `body`: `object`, `branchId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | | `apiHostPatchHostById` | (`hostIdList`: `string`[], `patchHostIn`: [`PatchHostIn`](interfaces/PatchHostIn.md), `branchId?`: `string`, `options?`: `any`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | @@ -470,7 +473,7 @@ HostsApi - functional programming interface #### Defined in -[api.ts:5009](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5009) +[api.ts:5101](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5101) ___ @@ -499,7 +502,7 @@ ResourceTypesApi - axios parameter creator #### Defined in -[api.ts:5649](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5649) +[api.ts:5741](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5741) ___ @@ -530,7 +533,7 @@ ResourceTypesApi - factory interface #### Defined in -[api.ts:5799](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5799) +[api.ts:5891](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5891) ___ @@ -559,7 +562,7 @@ ResourceTypesApi - functional programming interface #### Defined in -[api.ts:5759](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5759) +[api.ts:5851](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5851) ___ @@ -590,7 +593,7 @@ SystemProfileApi - axios parameter creator #### Defined in -[api.ts:5868](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5868) +[api.ts:5960](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L5960) ___ @@ -623,7 +626,7 @@ SystemProfileApi - factory interface #### Defined in -[api.ts:6232](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6232) +[api.ts:6324](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6324) ___ @@ -654,7 +657,7 @@ SystemProfileApi - functional programming interface #### Defined in -[api.ts:6148](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6148) +[api.ts:6240](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6240) ___ @@ -682,7 +685,7 @@ TagsApi - axios parameter creator #### Defined in -[api.ts:6377](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6377) +[api.ts:6469](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6469) ___ @@ -712,7 +715,7 @@ TagsApi - factory interface #### Defined in -[api.ts:6558](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6558) +[api.ts:6650](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6650) ___ @@ -740,7 +743,7 @@ TagsApi - functional programming interface #### Defined in -[api.ts:6518](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6518) +[api.ts:6610](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6610) ___ @@ -768,7 +771,7 @@ UnleashApi - axios parameter creator #### Defined in -[api.ts:6633](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6633) +[api.ts:6725](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6725) ___ @@ -798,7 +801,7 @@ UnleashApi - factory interface #### Defined in -[api.ts:6702](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6702) +[api.ts:6794](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6794) ___ @@ -826,4 +829,4 @@ UnleashApi - functional programming interface #### Defined in -[api.ts:6680](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6680) +[api.ts:6772](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L6772) diff --git a/packages/insights/doc/classes/AccountApi.md b/packages/insights/doc/classes/AccountApi.md index e98765a70..07701ee87 100644 --- a/packages/insights/doc/classes/AccountApi.md +++ b/packages/insights/doc/classes/AccountApi.md @@ -98,7 +98,7 @@ BaseAPI.configuration ### accountHostsRetrieve -▸ **accountHostsRetrieve**(`orgId`, `options?`): `Promise`<`AxiosResponse`<[`OrgId`](../interfaces/OrgId.md), `any`\>\> +▸ **accountHostsRetrieve**(`orgId`, `options?`): `Promise`<`AxiosResponse`<[`OrgId`](../interfaces/OrgId.md)\>\> List details about the number of hosts in this account by org_id. As well as the total number of hosts, we report on the number of hosts in various states of staleness: * fresh: hosts that have updated in the last 26 hours * stale: hosts not updated in the last 26 hours - we display the results for these hosts but a warning is shown to say they are not updating * warn: hosts not updated in the last week - these are not shown in any queries This may have other aggregate data added in the future. @@ -117,7 +117,7 @@ AccountApi #### Returns -`Promise`<`AxiosResponse`<[`OrgId`](../interfaces/OrgId.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrgId`](../interfaces/OrgId.md)\>\> #### Defined in @@ -127,7 +127,7 @@ ___ ### accountList -▸ **accountList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedOrgIdList`](../interfaces/PaginatedOrgIdList.md), `any`\>\> +▸ **accountList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedOrgIdList`](../interfaces/PaginatedOrgIdList.md)\>\> List all accounts by org_id we know about (through the host table). No other information about the accounts is provided in this view. @@ -147,7 +147,7 @@ AccountApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedOrgIdList`](../interfaces/PaginatedOrgIdList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedOrgIdList`](../interfaces/PaginatedOrgIdList.md)\>\> #### Defined in @@ -157,7 +157,7 @@ ___ ### accountRetrieve -▸ **accountRetrieve**(`orgId`, `options?`): `Promise`<`AxiosResponse`<[`OrgId`](../interfaces/OrgId.md), `any`\>\> +▸ **accountRetrieve**(`orgId`, `options?`): `Promise`<`AxiosResponse`<[`OrgId`](../interfaces/OrgId.md)\>\> List information relating to other accounts. This allows us to collect data that requires the user to specify an org_id number, such as number of systems currently registered to that org. param: org_id: Org ID number of a Red Hat customer. @@ -176,7 +176,7 @@ AccountApi #### Returns -`Promise`<`AxiosResponse`<[`OrgId`](../interfaces/OrgId.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrgId`](../interfaces/OrgId.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/AccountSettingApi.md b/packages/insights/doc/classes/AccountSettingApi.md index 805f46eb3..c54504a1d 100644 --- a/packages/insights/doc/classes/AccountSettingApi.md +++ b/packages/insights/doc/classes/AccountSettingApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### accountSettingCreate -▸ **accountSettingCreate**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **accountSettingCreate**(`options?`): `Promise`<`AxiosResponse`<`void`\>\> Update this account\'s settings, and return the updated settings. A new object will be created, even if the default settings are supplied. @@ -115,7 +115,7 @@ AccountSettingApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -125,7 +125,7 @@ ___ ### accountSettingRetrieve -▸ **accountSettingRetrieve**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **accountSettingRetrieve**(`options?`): `Promise`<`AxiosResponse`<`void`\>\> Show this account\'s settings, or the defaults. This will not create a new account settings object if none exists. @@ -143,7 +143,7 @@ AccountSettingApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/insights/doc/classes/AckApi.md b/packages/insights/doc/classes/AckApi.md index cb04ee53d..cb2420e66 100644 --- a/packages/insights/doc/classes/AckApi.md +++ b/packages/insights/doc/classes/AckApi.md @@ -101,7 +101,7 @@ BaseAPI.configuration ### ackAllList -▸ **ackAllList**(`options?`): `Promise`<`AxiosResponse`<[`AllAck`](../interfaces/AllAck.md)[], `any`\>\> +▸ **ackAllList**(`options?`): `Promise`<`AxiosResponse`<[`AllAck`](../interfaces/AllAck.md)[]\>\> List acks from all accounts, with org_id. Has no pagination. @@ -119,7 +119,7 @@ AckApi #### Returns -`Promise`<`AxiosResponse`<[`AllAck`](../interfaces/AllAck.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`AllAck`](../interfaces/AllAck.md)[]\>\> #### Defined in @@ -129,7 +129,7 @@ ___ ### ackCreate -▸ **ackCreate**(`ackInput`, `options?`): `Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md), `any`\>\> +▸ **ackCreate**(`ackInput`, `options?`): `Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md)\>\> Add an acknowledgement for a rule, by rule ID. If there\'s already an acknowledgement of this rule by this accounts org_id, then return that. Otherwise, a new ack is created. @@ -148,7 +148,7 @@ AckApi #### Returns -`Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md)\>\> #### Defined in @@ -158,7 +158,7 @@ ___ ### ackDestroy -▸ **ackDestroy**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> +▸ **ackDestroy**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<`string`\>\> Delete an acknowledgement for a rule, by its rule ID. If the ack existed, it is deleted and a 204 is returned. Otherwise, a 404 is returned. @@ -177,7 +177,7 @@ AckApi #### Returns -`Promise`<`AxiosResponse`<`string`, `any`\>\> +`Promise`<`AxiosResponse`<`string`\>\> #### Defined in @@ -187,7 +187,7 @@ ___ ### ackList -▸ **ackList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedAckList`](../interfaces/PaginatedAckList.md), `any`\>\> +▸ **ackList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedAckList`](../interfaces/PaginatedAckList.md)\>\> List acks from this account by org_id where the rule is active Will return an empty list if this account has no acks. @@ -207,7 +207,7 @@ AckApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedAckList`](../interfaces/PaginatedAckList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedAckList`](../interfaces/PaginatedAckList.md)\>\> #### Defined in @@ -217,7 +217,7 @@ ___ ### ackRetrieve -▸ **ackRetrieve**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md), `any`\>\> +▸ **ackRetrieve**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md)\>\> Acks acknowledge (and therefore hide) a rule from view in an account. This view handles listing, retrieving, creating and deleting acks. Acks are created and deleted by Insights rule ID, not by their own ack ID. param: rule_id: Rule ID defined by Insights ruleset @@ -236,7 +236,7 @@ AckApi #### Returns -`Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md)\>\> #### Defined in @@ -246,7 +246,7 @@ ___ ### ackUpdate -▸ **ackUpdate**(`ruleId`, `ackJustification?`, `options?`): `Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md), `any`\>\> +▸ **ackUpdate**(`ruleId`, `ackJustification?`, `options?`): `Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md)\>\> Update an acknowledgement for a rule, by rule ID. A new justification can be supplied. The username is taken from the authenticated request. The updated ack is returned. @@ -266,7 +266,7 @@ AckApi #### Returns -`Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Ack`](../interfaces/Ack.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/AckcountApi.md b/packages/insights/doc/classes/AckcountApi.md index 56e7bb8ab..c35de99cb 100644 --- a/packages/insights/doc/classes/AckcountApi.md +++ b/packages/insights/doc/classes/AckcountApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### ackcountList -▸ **ackcountList**(`options?`): `Promise`<`AxiosResponse`<[`AckCount`](../interfaces/AckCount.md)[], `any`\>\> +▸ **ackcountList**(`options?`): `Promise`<`AxiosResponse`<[`AckCount`](../interfaces/AckCount.md)[]\>\> Get the ack counts for all active rules Return a list of rule_ids and their ack counts @@ -115,7 +115,7 @@ AckcountApi #### Returns -`Promise`<`AxiosResponse`<[`AckCount`](../interfaces/AckCount.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`AckCount`](../interfaces/AckCount.md)[]\>\> #### Defined in @@ -125,7 +125,7 @@ ___ ### ackcountRetrieve -▸ **ackcountRetrieve**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`AckCount`](../interfaces/AckCount.md), `any`\>\> +▸ **ackcountRetrieve**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`AckCount`](../interfaces/AckCount.md)\>\> Get the ack count for the given rule_id Returns the rule_id and its ack count @@ -144,7 +144,7 @@ AckcountApi #### Returns -`Promise`<`AxiosResponse`<[`AckCount`](../interfaces/AckCount.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AckCount`](../interfaces/AckCount.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/AutosubexclusionApi.md b/packages/insights/doc/classes/AutosubexclusionApi.md index f8dc97c11..44a567807 100644 --- a/packages/insights/doc/classes/AutosubexclusionApi.md +++ b/packages/insights/doc/classes/AutosubexclusionApi.md @@ -99,7 +99,7 @@ BaseAPI.configuration ### autosubexclusionCreate -▸ **autosubexclusionCreate**(`subscriptionExcludedAccount`, `options?`): `Promise`<`AxiosResponse`<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md), `any`\>\> +▸ **autosubexclusionCreate**(`subscriptionExcludedAccount`, `options?`): `Promise`<`AxiosResponse`<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md)\>\> Create a new subscription exclusion for an account. This creates a new subscription exclusion for an account. This should contain an org_id and account. Only org_id is required. Account is optional. @@ -118,7 +118,7 @@ AutosubexclusionApi #### Returns -`Promise`<`AxiosResponse`<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md)\>\> #### Defined in @@ -128,7 +128,7 @@ ___ ### autosubexclusionDestroy -▸ **autosubexclusionDestroy**(`orgId`, `options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> +▸ **autosubexclusionDestroy**(`orgId`, `options?`): `Promise`<`AxiosResponse`<`string`\>\> Destroy an existing subscription exclusion in the system. This will DELETE an existing subscription exclusion in the system. Existing subscription exclusions are identified and deleted by the \"org_id\" field. @@ -147,7 +147,7 @@ AutosubexclusionApi #### Returns -`Promise`<`AxiosResponse`<`string`, `any`\>\> +`Promise`<`AxiosResponse`<`string`\>\> #### Defined in @@ -157,7 +157,7 @@ ___ ### autosubexclusionList -▸ **autosubexclusionList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedSubscriptionExcludedAccountList`](../interfaces/PaginatedSubscriptionExcludedAccountList.md), `any`\>\> +▸ **autosubexclusionList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedSubscriptionExcludedAccountList`](../interfaces/PaginatedSubscriptionExcludedAccountList.md)\>\> Returns all subscription exclusions for accounts This returns a list of all subscription exclusions. This contains exclusions and their account and org_id. These are all accounts that are excluded from the autosub subscription path for weekly report subscriptions. @@ -177,7 +177,7 @@ AutosubexclusionApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedSubscriptionExcludedAccountList`](../interfaces/PaginatedSubscriptionExcludedAccountList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedSubscriptionExcludedAccountList`](../interfaces/PaginatedSubscriptionExcludedAccountList.md)\>\> #### Defined in @@ -187,7 +187,7 @@ ___ ### autosubexclusionRetrieve -▸ **autosubexclusionRetrieve**(`orgId`, `options?`): `Promise`<`AxiosResponse`<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md), `any`\>\> +▸ **autosubexclusionRetrieve**(`orgId`, `options?`): `Promise`<`AxiosResponse`<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md)\>\> Returns an individual subscription exclusion based on org_id. This returns an individual subscription exclusion based on the org_id. @@ -206,7 +206,7 @@ AutosubexclusionApi #### Returns -`Promise`<`AxiosResponse`<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubscriptionExcludedAccount`](../interfaces/SubscriptionExcludedAccount.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/ExportApi.md b/packages/insights/doc/classes/ExportApi.md index 4a9fd5955..43be658ae 100644 --- a/packages/insights/doc/classes/ExportApi.md +++ b/packages/insights/doc/classes/ExportApi.md @@ -99,7 +99,7 @@ BaseAPI.configuration ### exportHitsList -▸ **exportHitsList**(`category?`, `displayName?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `format?`, `groups?`, `hasPlaybook?`, `impact?`, `incident?`, `likelihood?`, `reboot?`, `resRisk?`, `tags?`, `text?`, `totalRisk?`, `uuid?`, `options?`): `Promise`<`AxiosResponse`<[`ExportHits`](../interfaces/ExportHits.md)[], `any`\>\> +▸ **exportHitsList**(`category?`, `displayName?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `format?`, `groups?`, `hasPlaybook?`, `impact?`, `incident?`, `likelihood?`, `reboot?`, `resRisk?`, `tags?`, `text?`, `totalRisk?`, `uuid?`, `options?`): `Promise`<`AxiosResponse`<[`ExportHits`](../interfaces/ExportHits.md)[]\>\> Get each host and all rules currently affecting it. We also only present active, non-acked (on an account AND host level) rules. Inventory data may be requested if Advisor has not seen all the hosts. The accepted content type supplied in the request headers is used to determine the supplied content type. @@ -133,7 +133,7 @@ ExportApi #### Returns -`Promise`<`AxiosResponse`<[`ExportHits`](../interfaces/ExportHits.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ExportHits`](../interfaces/ExportHits.md)[]\>\> #### Defined in @@ -143,7 +143,7 @@ ___ ### exportReportsList -▸ **exportReportsList**(`options?`): `Promise`<`AxiosResponse`<[`ReportExport`](../interfaces/ReportExport.md)[], `any`\>\> +▸ **exportReportsList**(`options?`): `Promise`<`AxiosResponse`<[`ReportExport`](../interfaces/ReportExport.md)[]\>\> List the report details of each rule affecting each system. System and Rule are referred to by ID only, to be correlated with the Rule and System export data. It\'s like the hits output but much less repetitive. @@ -161,7 +161,7 @@ ExportApi #### Returns -`Promise`<`AxiosResponse`<[`ReportExport`](../interfaces/ReportExport.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ReportExport`](../interfaces/ReportExport.md)[]\>\> #### Defined in @@ -171,7 +171,7 @@ ___ ### exportRulesList -▸ **exportRulesList**(`options?`): `Promise`<`AxiosResponse`<[`RuleExport`](../interfaces/RuleExport.md)[], `any`\>\> +▸ **exportRulesList**(`options?`): `Promise`<`AxiosResponse`<[`RuleExport`](../interfaces/RuleExport.md)[]\>\> List the report details of each rule affecting each system. System and Rule are referred to by ID only, to be correlated with the Rule and System export data. It\'s like the hits output but much less repetitive. @@ -189,7 +189,7 @@ ExportApi #### Returns -`Promise`<`AxiosResponse`<[`RuleExport`](../interfaces/RuleExport.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`RuleExport`](../interfaces/RuleExport.md)[]\>\> #### Defined in @@ -199,7 +199,7 @@ ___ ### exportSystemsList -▸ **exportSystemsList**(`displayName?`, `format?`, `groups?`, `ruleId?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`System`](../interfaces/System.md)[], `any`\>\> +▸ **exportSystemsList**(`displayName?`, `format?`, `groups?`, `ruleId?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`System`](../interfaces/System.md)[]\>\> List of systems with details and hit counts. Systems can be sorted and filtered by display name and rule id. @@ -222,7 +222,7 @@ ExportApi #### Returns -`Promise`<`AxiosResponse`<[`System`](../interfaces/System.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`System`](../interfaces/System.md)[]\>\> #### Defined in diff --git a/packages/insights/doc/classes/HostackApi.md b/packages/insights/doc/classes/HostackApi.md index cae8e1623..ee01ef9d2 100644 --- a/packages/insights/doc/classes/HostackApi.md +++ b/packages/insights/doc/classes/HostackApi.md @@ -100,7 +100,7 @@ BaseAPI.configuration ### hostackCreate -▸ **hostackCreate**(`hostAckInput`, `options?`): `Promise`<`AxiosResponse`<[`HostAck`](../interfaces/HostAck.md), `any`\>\> +▸ **hostackCreate**(`hostAckInput`, `options?`): `Promise`<`AxiosResponse`<[`HostAck`](../interfaces/HostAck.md)\>\> Add an acknowledgement for a rule, by rule ID, system, and account. Return the new hostack. If there\'s already an acknowledgement of this rule by this account for a system, then return that. This does not take an \'id\' number. @@ -119,7 +119,7 @@ HostackApi #### Returns -`Promise`<`AxiosResponse`<[`HostAck`](../interfaces/HostAck.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HostAck`](../interfaces/HostAck.md)\>\> #### Defined in @@ -129,7 +129,7 @@ ___ ### hostackDestroy -▸ **hostackDestroy**(`id`, `options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> +▸ **hostackDestroy**(`id`, `options?`): `Promise`<`AxiosResponse`<`string`\>\> Delete an acknowledgement for a rule, for a system, for an account, by its ID. Takes the hostack ID (given in the hostack list) as an identifier. @@ -148,7 +148,7 @@ HostackApi #### Returns -`Promise`<`AxiosResponse`<`string`, `any`\>\> +`Promise`<`AxiosResponse`<`string`\>\> #### Defined in @@ -158,7 +158,7 @@ ___ ### hostackList -▸ **hostackList**(`filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `ruleId?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedHostAckList`](../interfaces/PaginatedHostAckList.md), `any`\>\> +▸ **hostackList**(`filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `ruleId?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedHostAckList`](../interfaces/PaginatedHostAckList.md)\>\> List host acks from this account for a system where the rule is active. Hostacks are retrieved, edited and deleted by the \'id\' field. @@ -183,7 +183,7 @@ HostackApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedHostAckList`](../interfaces/PaginatedHostAckList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedHostAckList`](../interfaces/PaginatedHostAckList.md)\>\> #### Defined in @@ -193,7 +193,7 @@ ___ ### hostackRetrieve -▸ **hostackRetrieve**(`id`, `options?`): `Promise`<`AxiosResponse`<[`HostAck`](../interfaces/HostAck.md), `any`\>\> +▸ **hostackRetrieve**(`id`, `options?`): `Promise`<`AxiosResponse`<[`HostAck`](../interfaces/HostAck.md)\>\> HostAcks acknowledge (and therefore hide) a rule from view in an account for a specific system. This view handles listing, retrieving, creating and deleting hostacks. @@ -212,7 +212,7 @@ HostackApi #### Returns -`Promise`<`AxiosResponse`<[`HostAck`](../interfaces/HostAck.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HostAck`](../interfaces/HostAck.md)\>\> #### Defined in @@ -222,7 +222,7 @@ ___ ### hostackUpdate -▸ **hostackUpdate**(`id`, `hostAckJustification?`, `options?`): `Promise`<`AxiosResponse`<[`HostAckJustification`](../interfaces/HostAckJustification.md), `any`\>\> +▸ **hostackUpdate**(`id`, `hostAckJustification?`, `options?`): `Promise`<`AxiosResponse`<[`HostAckJustification`](../interfaces/HostAckJustification.md)\>\> Update the justification for this host acknowledgement. The justification is taken from the request body. The created_by field is taken from the username in the x-rh-identity field, and the updated_at field is set to the current time. @@ -242,7 +242,7 @@ HostackApi #### Returns -`Promise`<`AxiosResponse`<[`HostAckJustification`](../interfaces/HostAckJustification.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HostAckJustification`](../interfaces/HostAckJustification.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/KcsApi.md b/packages/insights/doc/classes/KcsApi.md index 2ebae1a19..8a7c4f7db 100644 --- a/packages/insights/doc/classes/KcsApi.md +++ b/packages/insights/doc/classes/KcsApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### kcsList -▸ **kcsList**(`nodeIds?`, `options?`): `Promise`<`AxiosResponse`<[`Kcs`](../interfaces/Kcs.md)[], `any`\>\> +▸ **kcsList**(`nodeIds?`, `options?`): `Promise`<`AxiosResponse`<[`Kcs`](../interfaces/Kcs.md)[]\>\> Looks for all active rules with KCS solutions Returns a list of dicts of the C.R.C rule URL and its KCS solution number @@ -116,7 +116,7 @@ KcsApi #### Returns -`Promise`<`AxiosResponse`<[`Kcs`](../interfaces/Kcs.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`Kcs`](../interfaces/Kcs.md)[]\>\> #### Defined in @@ -126,7 +126,7 @@ ___ ### kcsRetrieve -▸ **kcsRetrieve**(`nodeId`, `options?`): `Promise`<`AxiosResponse`<`string`[], `any`\>\> +▸ **kcsRetrieve**(`nodeId`, `options?`): `Promise`<`AxiosResponse`<`string`[]\>\> Gets active rule(s) for a particular KCS solution (node_id) Returns a list of C.R.C rule url(s) for that KCS solution @@ -145,7 +145,7 @@ KcsApi #### Returns -`Promise`<`AxiosResponse`<`string`[], `any`\>\> +`Promise`<`AxiosResponse`<`string`[]\>\> #### Defined in diff --git a/packages/insights/doc/classes/PathwayApi.md b/packages/insights/doc/classes/PathwayApi.md index 90ed56a45..27573d51e 100644 --- a/packages/insights/doc/classes/PathwayApi.md +++ b/packages/insights/doc/classes/PathwayApi.md @@ -103,7 +103,7 @@ BaseAPI.configuration ### pathwayCreate -▸ **pathwayCreate**(`pathwayInput`, `options?`): `Promise`<`AxiosResponse`<[`PathwayInput`](../interfaces/PathwayInput.md), `any`\>\> +▸ **pathwayCreate**(`pathwayInput`, `options?`): `Promise`<`AxiosResponse`<[`PathwayInput`](../interfaces/PathwayInput.md)\>\> Create a new Pathway in the system. This creates a new Pathway in the system. Required fields are \"name,\" \"description,\" \"component,\" \"resolution_risk,\" and \"publish_date.\" \"name\" is a slug field and used to identify and retrieve Pathways for detailed analysis. The slug for a Pathway is auto-generated by converting the \"name\" to lowercase and replacing all spaces with dashes. \"resolution_risk\" should be the \"name\" of the ResolutionRisk to associate with this Pathway, not the risk value. @@ -122,7 +122,7 @@ PathwayApi #### Returns -`Promise`<`AxiosResponse`<[`PathwayInput`](../interfaces/PathwayInput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PathwayInput`](../interfaces/PathwayInput.md)\>\> #### Defined in @@ -132,7 +132,7 @@ ___ ### pathwayDestroy -▸ **pathwayDestroy**(`slug`, `options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> +▸ **pathwayDestroy**(`slug`, `options?`): `Promise`<`AxiosResponse`<`string`\>\> Destroy an existing Pathway in the system. This will DELETE an existing Pathway in the system. Existing pathways are identified and deleted by the \"slug\" field. @@ -151,7 +151,7 @@ PathwayApi #### Returns -`Promise`<`AxiosResponse`<`string`, `any`\>\> +`Promise`<`AxiosResponse`<`string`\>\> #### Defined in @@ -161,7 +161,7 @@ ___ ### pathwayList -▸ **pathwayList**(`category?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `tags?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedPathwayList`](../interfaces/PaginatedPathwayList.md), `any`\>\> +▸ **pathwayList**(`category?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `tags?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedPathwayList`](../interfaces/PaginatedPathwayList.md)\>\> Returns all Pathways This returns a list of all Pathways. Will display the same information as is provided in the retrieve view, but has all Pathways listed. @@ -187,7 +187,7 @@ PathwayApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedPathwayList`](../interfaces/PaginatedPathwayList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedPathwayList`](../interfaces/PaginatedPathwayList.md)\>\> #### Defined in @@ -197,7 +197,7 @@ ___ ### pathwayReportsRetrieve -▸ **pathwayReportsRetrieve**(`slug`, `category?`, `groups?`, `hostId?`, `ruleId?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`RuleSystemsExport`](../interfaces/RuleSystemsExport.md), `any`\>\> +▸ **pathwayReportsRetrieve**(`slug`, `category?`, `groups?`, `hostId?`, `ruleId?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`RuleSystemsExport`](../interfaces/RuleSystemsExport.md)\>\> Get the list of systems for each rule in this pathway. Each rule is listed once, with the systems currently reporting an incidence of that rule in a list. @@ -221,7 +221,7 @@ PathwayApi #### Returns -`Promise`<`AxiosResponse`<[`RuleSystemsExport`](../interfaces/RuleSystemsExport.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RuleSystemsExport`](../interfaces/RuleSystemsExport.md)\>\> #### Defined in @@ -231,7 +231,7 @@ ___ ### pathwayRetrieve -▸ **pathwayRetrieve**(`slug`, `category?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `tags?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`Pathway`](../interfaces/Pathway.md), `any`\>\> +▸ **pathwayRetrieve**(`slug`, `category?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `tags?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`Pathway`](../interfaces/Pathway.md)\>\> Returns an individual Pathway based on slug. This returns an individual pathway based on slug. Will display the same information as is provided in the list view. @@ -256,7 +256,7 @@ PathwayApi #### Returns -`Promise`<`AxiosResponse`<[`Pathway`](../interfaces/Pathway.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Pathway`](../interfaces/Pathway.md)\>\> #### Defined in @@ -266,7 +266,7 @@ ___ ### pathwayRulesList -▸ **pathwayRulesList**(`slug`, `category?`, `limit?`, `offset?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRuleList`](../interfaces/PaginatedRuleList.md), `any`\>\> +▸ **pathwayRulesList**(`slug`, `category?`, `limit?`, `offset?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRuleList`](../interfaces/PaginatedRuleList.md)\>\> Get all rules in a Pathway This view will retrieve/list in paginated format, all rules for a specific Pathway. This does not take into account acks or host asks. The Specific Pathway is requested by its slug @@ -289,7 +289,7 @@ PathwayApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedRuleList`](../interfaces/PaginatedRuleList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedRuleList`](../interfaces/PaginatedRuleList.md)\>\> #### Defined in @@ -299,7 +299,7 @@ ___ ### pathwaySystemsList -▸ **pathwaySystemsList**(`slug`, `category?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `tags?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md), `any`\>\> +▸ **pathwaySystemsList**(`slug`, `category?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `tags?`, `text?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md)\>\> Get all impacted systems for an account, for a specific Pathway This view will retrieve/list in paginated format, all impacted systems for an account, for a specific Pathway. The specific Pathway is requested by its slug. @@ -326,7 +326,7 @@ PathwayApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md)\>\> #### Defined in @@ -336,7 +336,7 @@ ___ ### pathwayUpdate -▸ **pathwayUpdate**(`slug`, `pathwayInput`, `options?`): `Promise`<`AxiosResponse`<[`PathwayInput`](../interfaces/PathwayInput.md), `any`\>\> +▸ **pathwayUpdate**(`slug`, `pathwayInput`, `options?`): `Promise`<`AxiosResponse`<[`PathwayInput`](../interfaces/PathwayInput.md)\>\> Update an existing Pathway in the system. This updates an existing Pathway already defined in the system. All fields that are required to define a Pathway initially may be updated here as well. Pathways are idenfitied and updated by the \"slug\" field. @@ -356,7 +356,7 @@ PathwayApi #### Returns -`Promise`<`AxiosResponse`<[`PathwayInput`](../interfaces/PathwayInput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PathwayInput`](../interfaces/PathwayInput.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/RatingApi.md b/packages/insights/doc/classes/RatingApi.md index 76fa8f66b..b8df24604 100644 --- a/packages/insights/doc/classes/RatingApi.md +++ b/packages/insights/doc/classes/RatingApi.md @@ -100,7 +100,7 @@ BaseAPI.configuration ### ratingAllRatingsList -▸ **ratingAllRatingsList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedAllRuleRatingsList`](../interfaces/PaginatedAllRuleRatingsList.md), `any`\>\> +▸ **ratingAllRatingsList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedAllRuleRatingsList`](../interfaces/PaginatedAllRuleRatingsList.md)\>\> Show all ratings. Available only to internal users. @@ -120,7 +120,7 @@ RatingApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedAllRuleRatingsList`](../interfaces/PaginatedAllRuleRatingsList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedAllRuleRatingsList`](../interfaces/PaginatedAllRuleRatingsList.md)\>\> #### Defined in @@ -130,7 +130,7 @@ ___ ### ratingCreate -▸ **ratingCreate**(`ruleRating`, `options?`): `Promise`<`AxiosResponse`<[`RuleRating`](../interfaces/RuleRating.md), `any`\>\> +▸ **ratingCreate**(`ruleRating`, `options?`): `Promise`<`AxiosResponse`<[`RuleRating`](../interfaces/RuleRating.md)\>\> Add or update a rating for a rule, by rule ID. Return the new rating. Any previous rating for this rule by this user is amended to the current value. This does not attempt to delete a rating by this user of this rule if the rating is zero. @@ -149,7 +149,7 @@ RatingApi #### Returns -`Promise`<`AxiosResponse`<[`RuleRating`](../interfaces/RuleRating.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RuleRating`](../interfaces/RuleRating.md)\>\> #### Defined in @@ -159,7 +159,7 @@ ___ ### ratingList -▸ **ratingList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRuleRatingList`](../interfaces/PaginatedRuleRatingList.md), `any`\>\> +▸ **ratingList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRuleRatingList`](../interfaces/PaginatedRuleRatingList.md)\>\> List all rules rated by the current user Only the current user\'s ratings are listed here. @@ -179,7 +179,7 @@ RatingApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedRuleRatingList`](../interfaces/PaginatedRuleRatingList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedRuleRatingList`](../interfaces/PaginatedRuleRatingList.md)\>\> #### Defined in @@ -189,7 +189,7 @@ ___ ### ratingRetrieve -▸ **ratingRetrieve**(`rule`, `options?`): `Promise`<`AxiosResponse`<[`RuleRating`](../interfaces/RuleRating.md), `any`\>\> +▸ **ratingRetrieve**(`rule`, `options?`): `Promise`<`AxiosResponse`<[`RuleRating`](../interfaces/RuleRating.md)\>\> Retrieve the ratings for a single rule, by Insights Rule ID @@ -212,7 +212,7 @@ RatingApi #### Returns -`Promise`<`AxiosResponse`<[`RuleRating`](../interfaces/RuleRating.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RuleRating`](../interfaces/RuleRating.md)\>\> #### Defined in @@ -222,7 +222,7 @@ ___ ### ratingStatsList -▸ **ratingStatsList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRuleRatingStatsList`](../interfaces/PaginatedRuleRatingStatsList.md), `any`\>\> +▸ **ratingStatsList**(`limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRuleRatingStatsList`](../interfaces/PaginatedRuleRatingStatsList.md)\>\> Summarise the ratings for a rule. This summarises the statistics for each rule. Available only to internal users. @@ -242,7 +242,7 @@ RatingApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedRuleRatingStatsList`](../interfaces/PaginatedRuleRatingStatsList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedRuleRatingStatsList`](../interfaces/PaginatedRuleRatingStatsList.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/RuleApi.md b/packages/insights/doc/classes/RuleApi.md index 45d5114c9..c51535af8 100644 --- a/packages/insights/doc/classes/RuleApi.md +++ b/packages/insights/doc/classes/RuleApi.md @@ -103,7 +103,7 @@ BaseAPI.configuration ### ruleAckHostsCreate -▸ **ruleAckHostsCreate**(`ruleId`, `multiHostAck`, `options?`): `Promise`<`AxiosResponse`<[`MultiAckResponse`](../interfaces/MultiAckResponse.md), `any`\>\> +▸ **ruleAckHostsCreate**(`ruleId`, `multiHostAck`, `options?`): `Promise`<`AxiosResponse`<[`MultiAckResponse`](../interfaces/MultiAckResponse.md)\>\> Add acknowledgements for one or more hosts to this rule. Host acknowledgements will be added to this rule in this account for the system UUIDs supplied. The justification supplied will be given for all host acks created. Any existing host acknowledgements for a host on this rule will be updated. The count of created hosts acknowledgements, and the list of systems now impacted by this rule, will be returned. Account-wide acks are unaffected. @@ -123,7 +123,7 @@ RuleApi #### Returns -`Promise`<`AxiosResponse`<[`MultiAckResponse`](../interfaces/MultiAckResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`MultiAckResponse`](../interfaces/MultiAckResponse.md)\>\> #### Defined in @@ -133,7 +133,7 @@ ___ ### ruleJustificationsList -▸ **ruleJustificationsList**(`ruleId`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedJustificationCountList`](../interfaces/PaginatedJustificationCountList.md), `any`\>\> +▸ **ruleJustificationsList**(`ruleId`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedJustificationCountList`](../interfaces/PaginatedJustificationCountList.md)\>\> List all justifications given for disabling this rule. This is an **internal-only** view that allows us to provide feedback on why rules are disabled by our customers. It lists the justifications given in both account-wide acks and host-specific acks of a rule. @@ -154,7 +154,7 @@ RuleApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedJustificationCountList`](../interfaces/PaginatedJustificationCountList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedJustificationCountList`](../interfaces/PaginatedJustificationCountList.md)\>\> #### Defined in @@ -164,7 +164,7 @@ ___ ### ruleList -▸ **ruleList**(`category?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `hasPlaybook?`, `hasTag?`, `impact?`, `impacting?`, `incident?`, `likelihood?`, `limit?`, `offset?`, `pathway?`, `reboot?`, `reportsShown?`, `resRisk?`, `ruleStatus?`, `sort?`, `tags?`, `text?`, `topic?`, `totalRisk?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRuleForAccountList`](../interfaces/PaginatedRuleForAccountList.md), `any`\>\> +▸ **ruleList**(`category?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `hasPlaybook?`, `hasTag?`, `impact?`, `impacting?`, `incident?`, `likelihood?`, `limit?`, `offset?`, `pathway?`, `reboot?`, `reportsShown?`, `resRisk?`, `ruleStatus?`, `sort?`, `tags?`, `text?`, `topic?`, `totalRisk?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRuleForAccountList`](../interfaces/PaginatedRuleForAccountList.md)\>\> List all active rules for this account. If \'acked\' is False or not given, then only rules that are not acked will be shown. If acked is set and \'true\' as a string or evaluates to a true value, then all rules including those that are acked will be shown. @@ -204,7 +204,7 @@ RuleApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedRuleForAccountList`](../interfaces/PaginatedRuleForAccountList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedRuleForAccountList`](../interfaces/PaginatedRuleForAccountList.md)\>\> #### Defined in @@ -214,7 +214,7 @@ ___ ### ruleRetrieve -▸ **ruleRetrieve**(`ruleId`, `groups?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`RuleForAccount`](../interfaces/RuleForAccount.md), `any`\>\> +▸ **ruleRetrieve**(`ruleId`, `groups?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`RuleForAccount`](../interfaces/RuleForAccount.md)\>\> Retrieve a single rule and its associated details. This includes the account-relevant details such as number of impacted systems and host acknowledgements. @@ -235,7 +235,7 @@ RuleApi #### Returns -`Promise`<`AxiosResponse`<[`RuleForAccount`](../interfaces/RuleForAccount.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RuleForAccount`](../interfaces/RuleForAccount.md)\>\> #### Defined in @@ -245,7 +245,7 @@ ___ ### ruleStatsRetrieve -▸ **ruleStatsRetrieve**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`RuleUsageStats`](../interfaces/RuleUsageStats.md), `any`\>\> +▸ **ruleStatsRetrieve**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`RuleUsageStats`](../interfaces/RuleUsageStats.md)\>\> Display usage and impact statistics for this rule. For internal use only. This allows rule developers to see the number of systems and accounts impacted by a rule. @@ -264,7 +264,7 @@ RuleApi #### Returns -`Promise`<`AxiosResponse`<[`RuleUsageStats`](../interfaces/RuleUsageStats.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RuleUsageStats`](../interfaces/RuleUsageStats.md)\>\> #### Defined in @@ -274,7 +274,7 @@ ___ ### ruleSystemsDetailList -▸ **ruleSystemsDetailList**(`ruleId`, `groups?`, `limit?`, `name?`, `offset?`, `rhelVersion?`, `sort?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedSystemsDetailList`](../interfaces/PaginatedSystemsDetailList.md), `any`\>\> +▸ **ruleSystemsDetailList**(`ruleId`, `groups?`, `limit?`, `name?`, `offset?`, `rhelVersion?`, `sort?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedSystemsDetailList`](../interfaces/PaginatedSystemsDetailList.md)\>\> List systems affected by this rule with additional information about each system All systems owned by the user\'s account, with a current upload reporting the given rule, are listed in a paginated format. Additional information includes hit counts and upload/stale timestamps. @@ -300,7 +300,7 @@ RuleApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedSystemsDetailList`](../interfaces/PaginatedSystemsDetailList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedSystemsDetailList`](../interfaces/PaginatedSystemsDetailList.md)\>\> #### Defined in @@ -310,7 +310,7 @@ ___ ### ruleSystemsRetrieve -▸ **ruleSystemsRetrieve**(`ruleId`, `format?`, `groups?`, `name?`, `rhelVersion?`, `sort?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`SystemsForRule`](../interfaces/SystemsForRule.md), `any`\>\> +▸ **ruleSystemsRetrieve**(`ruleId`, `format?`, `groups?`, `name?`, `rhelVersion?`, `sort?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`SystemsForRule`](../interfaces/SystemsForRule.md)\>\> List all systems affected by this rule. All systems owned by the user\'s account, with a current upload reporting the given rule, are listed. Systems are simply listed by Insights Inventory UUID. @@ -335,7 +335,7 @@ RuleApi #### Returns -`Promise`<`AxiosResponse`<[`SystemsForRule`](../interfaces/SystemsForRule.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemsForRule`](../interfaces/SystemsForRule.md)\>\> #### Defined in @@ -345,7 +345,7 @@ ___ ### ruleUnackHostsCreate -▸ **ruleUnackHostsCreate**(`ruleId`, `multiHostUnAck`, `options?`): `Promise`<`AxiosResponse`<[`MultiAckResponse`](../interfaces/MultiAckResponse.md), `any`\>\> +▸ **ruleUnackHostsCreate**(`ruleId`, `multiHostUnAck`, `options?`): `Promise`<`AxiosResponse`<[`MultiAckResponse`](../interfaces/MultiAckResponse.md)\>\> Delete acknowledgements for one or more hosts to this rule. Any host acknowledgements for this rule in this account for the given system are deleted. Hosts that do not have an acknowledgement for this rule in this account are ignored. The count of deleted host acknowledgements, and the list of hosts now impacted by this rule, will be returned. Account-wide acks are unaffected. @@ -365,7 +365,7 @@ RuleApi #### Returns -`Promise`<`AxiosResponse`<[`MultiAckResponse`](../interfaces/MultiAckResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`MultiAckResponse`](../interfaces/MultiAckResponse.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/RulecategoryApi.md b/packages/insights/doc/classes/RulecategoryApi.md index 1b7d06ba4..364fc1257 100644 --- a/packages/insights/doc/classes/RulecategoryApi.md +++ b/packages/insights/doc/classes/RulecategoryApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### rulecategoryList -▸ **rulecategoryList**(`options?`): `Promise`<`AxiosResponse`<[`RuleCategory`](../interfaces/RuleCategory.md)[], `any`\>\> +▸ **rulecategoryList**(`options?`): `Promise`<`AxiosResponse`<[`RuleCategory`](../interfaces/RuleCategory.md)[]\>\> Rules are divided into categories, the usual being Availability, Stability, Security and Performance. Categories are listed in decreasing order of importance. @@ -115,7 +115,7 @@ RulecategoryApi #### Returns -`Promise`<`AxiosResponse`<[`RuleCategory`](../interfaces/RuleCategory.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`RuleCategory`](../interfaces/RuleCategory.md)[]\>\> #### Defined in @@ -125,7 +125,7 @@ ___ ### rulecategoryRetrieve -▸ **rulecategoryRetrieve**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RuleCategory`](../interfaces/RuleCategory.md), `any`\>\> +▸ **rulecategoryRetrieve**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RuleCategory`](../interfaces/RuleCategory.md)\>\> Rules are divided into categories, the usual being Availability, Stability, Security and Performance. Categories are listed in decreasing order of importance. @@ -144,7 +144,7 @@ RulecategoryApi #### Returns -`Promise`<`AxiosResponse`<[`RuleCategory`](../interfaces/RuleCategory.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RuleCategory`](../interfaces/RuleCategory.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/SettingsApi.md b/packages/insights/doc/classes/SettingsApi.md index 279487b62..2c5bbdb9e 100644 --- a/packages/insights/doc/classes/SettingsApi.md +++ b/packages/insights/doc/classes/SettingsApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### settingsList -▸ **settingsList**(`options?`): `Promise`<`AxiosResponse`<[`SettingsDDF`](../interfaces/SettingsDDF.md)[], `any`\>\> +▸ **settingsList**(`options?`): `Promise`<`AxiosResponse`<[`SettingsDDF`](../interfaces/SettingsDDF.md)[]\>\> Describe the settings we have in a Data-Driven Forms way. This simply compiles the \'show_satellite_hosts\' account-wide setting into a format compatible with Data-Driven Forms. @@ -114,7 +114,7 @@ SettingsApi #### Returns -`Promise`<`AxiosResponse`<[`SettingsDDF`](../interfaces/SettingsDDF.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`SettingsDDF`](../interfaces/SettingsDDF.md)[]\>\> #### Defined in diff --git a/packages/insights/doc/classes/StatsApi.md b/packages/insights/doc/classes/StatsApi.md index 4965eaafe..4919f2f98 100644 --- a/packages/insights/doc/classes/StatsApi.md +++ b/packages/insights/doc/classes/StatsApi.md @@ -100,7 +100,7 @@ BaseAPI.configuration ### statsList -▸ **statsList**(`options?`): `Promise`<`AxiosResponse`<`string`[][], `any`\>\> +▸ **statsList**(`options?`): `Promise`<`AxiosResponse`<`string`[][]\>\> Provide a simple list of URLs contained here. A list of statistics views. @@ -118,7 +118,7 @@ StatsApi #### Returns -`Promise`<`AxiosResponse`<`string`[][], `any`\>\> +`Promise`<`AxiosResponse`<`string`[][]\>\> #### Defined in @@ -128,7 +128,7 @@ ___ ### statsOverviewRetrieve -▸ **statsOverviewRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md), `any`\>\> +▸ **statsOverviewRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md)\>\> Show overview statistics for this user This gives the number of pathways, and incident, critical and important recommendations, affecting systems that the user can see. @@ -150,7 +150,7 @@ StatsApi #### Returns -`Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md)\>\> #### Defined in @@ -160,7 +160,7 @@ ___ ### statsReportsRetrieve -▸ **statsReportsRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md), `any`\>\> +▸ **statsReportsRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md)\>\> Show statistics of reports impacting across categories and risks. Only current reports are considered. @@ -182,7 +182,7 @@ StatsApi #### Returns -`Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md)\>\> #### Defined in @@ -192,7 +192,7 @@ ___ ### statsRulesRetrieve -▸ **statsRulesRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md), `any`\>\> +▸ **statsRulesRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md)\>\> Show statistics of rule usage across categories and risks. Only current reports are considered. @@ -214,7 +214,7 @@ StatsApi #### Returns -`Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md)\>\> #### Defined in @@ -224,7 +224,7 @@ ___ ### statsSystemsRetrieve -▸ **statsSystemsRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md), `any`\>\> +▸ **statsSystemsRetrieve**(`tags?`, `groups?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsContains?`, `options?`): `Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md)\>\> Show statistics of systems being impacted across categories and risks. Only current reports are considered. @@ -246,7 +246,7 @@ StatsApi #### Returns -`Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Stats`](../interfaces/Stats.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/StatusApi.md b/packages/insights/doc/classes/StatusApi.md index 20a7a10c0..418035e83 100644 --- a/packages/insights/doc/classes/StatusApi.md +++ b/packages/insights/doc/classes/StatusApi.md @@ -98,7 +98,7 @@ BaseAPI.configuration ### statusLiveRetrieve -▸ **statusLiveRetrieve**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **statusLiveRetrieve**(`options?`): `Promise`<`AxiosResponse`<`void`\>\> Is the Advisor API live and serving requests? This returns a dictionary with properties defining the status of the components Advisor relies on. At the moment this is the same as the Readiness check (see `/ready/`). In the future it may include other checks if we need to, but the properties of `/ready/` will always be included. @@ -116,7 +116,7 @@ StatusApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -126,7 +126,7 @@ ___ ### statusReadyRetrieve -▸ **statusReadyRetrieve**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **statusReadyRetrieve**(`options?`): `Promise`<`AxiosResponse`<`void`\>\> Is the Advisor API ready to serve requests? This returns a dictionary with properties defining the status of the components Advisor relies on. * \'django\' should always be True. If Django isn\'t ready, you can\'t get this information :-) * \'database\' is True when a database access returns successfully with valid information. * \'rbac\' is True when we can make a request to the RBAC API and get a valid response. * \'advisor\' is True if all of the above are True. @@ -144,7 +144,7 @@ StatusApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -154,7 +154,7 @@ ___ ### statusRetrieve -▸ **statusRetrieve**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **statusRetrieve**(`options?`): `Promise`<`AxiosResponse`<`void`\>\> Provide a simple list of URLs contained here. A list of statistics views. @@ -172,7 +172,7 @@ StatusApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/insights/doc/classes/SystemApi.md b/packages/insights/doc/classes/SystemApi.md index 14200929e..6bf19647d 100644 --- a/packages/insights/doc/classes/SystemApi.md +++ b/packages/insights/doc/classes/SystemApi.md @@ -99,7 +99,7 @@ BaseAPI.configuration ### systemList -▸ **systemList**(`displayName?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `hits?`, `incident?`, `limit?`, `offset?`, `pathway?`, `rhelVersion?`, `sort?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md), `any`\>\> +▸ **systemList**(`displayName?`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `hits?`, `incident?`, `limit?`, `offset?`, `pathway?`, `rhelVersion?`, `sort?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md)\>\> Returns systems with their hit count and last upload time. Results can be sorted and systems can be filtered by display name and hits @@ -129,7 +129,7 @@ SystemApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedSystemList`](../interfaces/PaginatedSystemList.md)\>\> #### Defined in @@ -139,7 +139,7 @@ ___ ### systemRenderedReportsList -▸ **systemRenderedReportsList**(`uuid`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `limit?`, `offset?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRenderedReportList`](../interfaces/PaginatedRenderedReportList.md), `any`\>\> +▸ **systemRenderedReportsList**(`uuid`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `limit?`, `offset?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedRenderedReportList`](../interfaces/PaginatedRenderedReportList.md)\>\> Returns the list of reports for an Inventory Host ID, with the rule templates filled in thanks to node.js and DoT and Markdown. If the host ID is not found, return an empty list. @@ -163,7 +163,7 @@ SystemApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedRenderedReportList`](../interfaces/PaginatedRenderedReportList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedRenderedReportList`](../interfaces/PaginatedRenderedReportList.md)\>\> #### Defined in @@ -173,7 +173,7 @@ ___ ### systemReportsList -▸ **systemReportsList**(`uuid`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedReportList`](../interfaces/PaginatedReportList.md), `any`\>\> +▸ **systemReportsList**(`uuid`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `limit?`, `offset?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`PaginatedReportList`](../interfaces/PaginatedReportList.md)\>\> Returns the list of latest reports for an Inventory Host ID. Returns reports that: * are in the user\'s account * have an active, not-deleted rule * where the rule has not been acked by this account If the host ID is not found, return an empty list. @@ -198,7 +198,7 @@ SystemApi #### Returns -`Promise`<`AxiosResponse`<[`PaginatedReportList`](../interfaces/PaginatedReportList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PaginatedReportList`](../interfaces/PaginatedReportList.md)\>\> #### Defined in @@ -208,7 +208,7 @@ ___ ### systemRetrieve -▸ **systemRetrieve**(`uuid`, `options?`): `Promise`<`AxiosResponse`<[`System`](../interfaces/System.md), `any`\>\> +▸ **systemRetrieve**(`uuid`, `options?`): `Promise`<`AxiosResponse`<[`System`](../interfaces/System.md)\>\> Retrieve the reports for a single system by Insights Inventory UUID @@ -231,7 +231,7 @@ SystemApi #### Returns -`Promise`<`AxiosResponse`<[`System`](../interfaces/System.md), `any`\>\> +`Promise`<`AxiosResponse`<[`System`](../interfaces/System.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/SystemtypeApi.md b/packages/insights/doc/classes/SystemtypeApi.md index 5b960102d..f07b8e835 100644 --- a/packages/insights/doc/classes/SystemtypeApi.md +++ b/packages/insights/doc/classes/SystemtypeApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### systemtypeList -▸ **systemtypeList**(`options?`): `Promise`<`AxiosResponse`<[`SystemType`](../interfaces/SystemType.md)[], `any`\>\> +▸ **systemtypeList**(`options?`): `Promise`<`AxiosResponse`<[`SystemType`](../interfaces/SystemType.md)[]\>\> List all system types by role and product code @@ -119,7 +119,7 @@ SystemtypeApi #### Returns -`Promise`<`AxiosResponse`<[`SystemType`](../interfaces/SystemType.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`SystemType`](../interfaces/SystemType.md)[]\>\> #### Defined in @@ -129,7 +129,7 @@ ___ ### systemtypeRetrieve -▸ **systemtypeRetrieve**(`id`, `options?`): `Promise`<`AxiosResponse`<[`SystemType`](../interfaces/SystemType.md), `any`\>\> +▸ **systemtypeRetrieve**(`id`, `options?`): `Promise`<`AxiosResponse`<[`SystemType`](../interfaces/SystemType.md)\>\> Retrieve details of a single system type @@ -152,7 +152,7 @@ SystemtypeApi #### Returns -`Promise`<`AxiosResponse`<[`SystemType`](../interfaces/SystemType.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemType`](../interfaces/SystemType.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/TopicApi.md b/packages/insights/doc/classes/TopicApi.md index f2cd24cc3..e1f6f4a7f 100644 --- a/packages/insights/doc/classes/TopicApi.md +++ b/packages/insights/doc/classes/TopicApi.md @@ -103,7 +103,7 @@ BaseAPI.configuration ### topicCreate -▸ **topicCreate**(`topicEdit`, `options?`): `Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> +▸ **topicCreate**(`topicEdit`, `options?`): `Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md)\>\> Create a new rule topic, along with its association to a rule tag @@ -126,7 +126,7 @@ TopicApi #### Returns -`Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md)\>\> #### Defined in @@ -136,7 +136,7 @@ ___ ### topicDestroy -▸ **topicDestroy**(`slug`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **topicDestroy**(`slug`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete a rule topic. Rules associated with the tag of this topic will be unaffected @@ -159,7 +159,7 @@ TopicApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -169,7 +169,7 @@ ___ ### topicList -▸ **topicList**(`filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `showDisabled?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`Topic`](../interfaces/Topic.md)[], `any`\>\> +▸ **topicList**(`filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `showDisabled?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`Topic`](../interfaces/Topic.md)[]\>\> List the rule topics and their impacted systems counts. Normally this only shows enabled topics, but if the \'show_disabled\' parameter is set to True then this will show disabled topics as well. @@ -192,7 +192,7 @@ TopicApi #### Returns -`Promise`<`AxiosResponse`<[`Topic`](../interfaces/Topic.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`Topic`](../interfaces/Topic.md)[]\>\> #### Defined in @@ -202,7 +202,7 @@ ___ ### topicPartialUpdate -▸ **topicPartialUpdate**(`slug`, `patchedTopicEdit?`, `options?`): `Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> +▸ **topicPartialUpdate**(`slug`, `patchedTopicEdit?`, `options?`): `Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md)\>\> Update an existing rule topic. Only the fields being changed need to be supplied @@ -226,7 +226,7 @@ TopicApi #### Returns -`Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md)\>\> #### Defined in @@ -236,7 +236,7 @@ ___ ### topicRetrieve -▸ **topicRetrieve**(`slug`, `options?`): `Promise`<`AxiosResponse`<[`Topic`](../interfaces/Topic.md), `any`\>\> +▸ **topicRetrieve**(`slug`, `options?`): `Promise`<`AxiosResponse`<[`Topic`](../interfaces/Topic.md)\>\> Retrieve a single topic by slug. This also lists the topic\'s impacted systems count. @@ -255,7 +255,7 @@ TopicApi #### Returns -`Promise`<`AxiosResponse`<[`Topic`](../interfaces/Topic.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Topic`](../interfaces/Topic.md)\>\> #### Defined in @@ -265,7 +265,7 @@ ___ ### topicRulesWithTagList -▸ **topicRulesWithTagList**(`slug`, `options?`): `Promise`<`AxiosResponse`<[`Rule`](../interfaces/Rule.md)[], `any`\>\> +▸ **topicRulesWithTagList**(`slug`, `options?`): `Promise`<`AxiosResponse`<[`Rule`](../interfaces/Rule.md)[]\>\> Lists the available rules that have this tag. This shows the rule information for rules with this tag. @@ -284,7 +284,7 @@ TopicApi #### Returns -`Promise`<`AxiosResponse`<[`Rule`](../interfaces/Rule.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`Rule`](../interfaces/Rule.md)[]\>\> #### Defined in @@ -294,7 +294,7 @@ ___ ### topicSystemsRetrieve -▸ **topicSystemsRetrieve**(`slug`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `sort?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`SystemsForRule`](../interfaces/SystemsForRule.md), `any`\>\> +▸ **topicSystemsRetrieve**(`slug`, `filterSystemProfileSapSidsContains?`, `filterSystemProfileSapSystem?`, `groups?`, `sort?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`SystemsForRule`](../interfaces/SystemsForRule.md)\>\> List all systems affected by this rule topic. Systems are just listed by their UUID. @@ -318,7 +318,7 @@ TopicApi #### Returns -`Promise`<`AxiosResponse`<[`SystemsForRule`](../interfaces/SystemsForRule.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemsForRule`](../interfaces/SystemsForRule.md)\>\> #### Defined in @@ -328,7 +328,7 @@ ___ ### topicUpdate -▸ **topicUpdate**(`slug`, `topicEdit`, `options?`): `Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> +▸ **topicUpdate**(`slug`, `topicEdit`, `options?`): `Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md)\>\> Update an existing rule topic. All fields need to be supplied @@ -352,7 +352,7 @@ TopicApi #### Returns -`Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TopicEdit`](../interfaces/TopicEdit.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/UsageApi.md b/packages/insights/doc/classes/UsageApi.md index 62077162a..7d76b3d2d 100644 --- a/packages/insights/doc/classes/UsageApi.md +++ b/packages/insights/doc/classes/UsageApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### usageList -▸ **usageList**(`account?`, `end?`, `orgId?`, `start?`, `options?`): `Promise`<`AxiosResponse`<[`Usage`](../interfaces/Usage.md), `any`\>\> +▸ **usageList**(`account?`, `end?`, `orgId?`, `start?`, `options?`): `Promise`<`AxiosResponse`<[`Usage`](../interfaces/Usage.md)\>\> List the unique rule hits for this account over the given time range This uses a HashLogLog structure to record number of hits, and this is therefore an approximation. @@ -118,7 +118,7 @@ UsageApi #### Returns -`Promise`<`AxiosResponse`<[`Usage`](../interfaces/Usage.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Usage`](../interfaces/Usage.md)\>\> #### Defined in diff --git a/packages/insights/doc/classes/UserPreferencesApi.md b/packages/insights/doc/classes/UserPreferencesApi.md index 1644c1231..5dc4435ac 100644 --- a/packages/insights/doc/classes/UserPreferencesApi.md +++ b/packages/insights/doc/classes/UserPreferencesApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### userPreferencesCreate -▸ **userPreferencesCreate**(`preferencesInput`, `options?`): `Promise`<`AxiosResponse`<[`PreferencesInput`](../interfaces/PreferencesInput.md), `any`\>\> +▸ **userPreferencesCreate**(`preferencesInput`, `options?`): `Promise`<`AxiosResponse`<[`PreferencesInput`](../interfaces/PreferencesInput.md)\>\> Accept the settings as input, and adjust the actual models accordingly. The current account settings will be updated, or one will be created, with the @@ -116,7 +116,7 @@ UserPreferencesApi #### Returns -`Promise`<`AxiosResponse`<[`PreferencesInput`](../interfaces/PreferencesInput.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PreferencesInput`](../interfaces/PreferencesInput.md)\>\> #### Defined in @@ -126,7 +126,7 @@ ___ ### userPreferencesList -▸ **userPreferencesList**(`options?`): `Promise`<`AxiosResponse`<[`SettingsDDF`](../interfaces/SettingsDDF.md)[], `any`\>\> +▸ **userPreferencesList**(`options?`): `Promise`<`AxiosResponse`<[`SettingsDDF`](../interfaces/SettingsDDF.md)[]\>\> Describe the settings we have in a Data-Driven Forms way. This simply compiles the \'show_satellite_hosts\' account-wide setting and the weekly report \'is_subscribed\' user-specific setting into one handy view, with the description metadata necessary to use Data-Driven Forms to display it. @@ -144,7 +144,7 @@ UserPreferencesApi #### Returns -`Promise`<`AxiosResponse`<[`SettingsDDF`](../interfaces/SettingsDDF.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`SettingsDDF`](../interfaces/SettingsDDF.md)[]\>\> #### Defined in diff --git a/packages/insights/doc/classes/WeeklyreportautosubscribeApi.md b/packages/insights/doc/classes/WeeklyreportautosubscribeApi.md index dc3d54c47..6ad48b798 100644 --- a/packages/insights/doc/classes/WeeklyreportautosubscribeApi.md +++ b/packages/insights/doc/classes/WeeklyreportautosubscribeApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### weeklyreportautosubscribeCreate -▸ **weeklyreportautosubscribeCreate**(`autoSubscribeInput`, `options?`): `Promise`<`AxiosResponse`<[`AutoSubscribe`](../interfaces/AutoSubscribe.md), `any`\>\> +▸ **weeklyreportautosubscribeCreate**(`autoSubscribeInput`, `options?`): `Promise`<`AxiosResponse`<[`AutoSubscribe`](../interfaces/AutoSubscribe.md)\>\> Set the auto-subscription status of the current user to the supplied `is_auto_subscribed` value. If \'is_auto_subscribed\' is true, an auto-subscription is added if it doesn\'t already exist. If it is false, the auto-subscription is removed if it exists. Check if ENABLE_AUTOSUB enviroment variable is set to allow the method. @@ -116,7 +116,7 @@ WeeklyreportautosubscribeApi #### Returns -`Promise`<`AxiosResponse`<[`AutoSubscribe`](../interfaces/AutoSubscribe.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AutoSubscribe`](../interfaces/AutoSubscribe.md)\>\> #### Defined in @@ -126,7 +126,7 @@ ___ ### weeklyreportautosubscribeList -▸ **weeklyreportautosubscribeList**(`options?`): `Promise`<`AxiosResponse`<[`AutoSubscribe`](../interfaces/AutoSubscribe.md)[], `any`\>\> +▸ **weeklyreportautosubscribeList**(`options?`): `Promise`<`AxiosResponse`<[`AutoSubscribe`](../interfaces/AutoSubscribe.md)[]\>\> Show the user\'s current subscription status. This shows the presence of a weekly report subscription by the user in this account. @@ -144,7 +144,7 @@ WeeklyreportautosubscribeApi #### Returns -`Promise`<`AxiosResponse`<[`AutoSubscribe`](../interfaces/AutoSubscribe.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`AutoSubscribe`](../interfaces/AutoSubscribe.md)[]\>\> #### Defined in diff --git a/packages/insights/doc/classes/WeeklyreportsubscriptionApi.md b/packages/insights/doc/classes/WeeklyreportsubscriptionApi.md index 049907ec0..6325b9b93 100644 --- a/packages/insights/doc/classes/WeeklyreportsubscriptionApi.md +++ b/packages/insights/doc/classes/WeeklyreportsubscriptionApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### weeklyreportsubscriptionCreate -▸ **weeklyreportsubscriptionCreate**(`weeklyReportSubscription`, `options?`): `Promise`<`AxiosResponse`<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md), `any`\>\> +▸ **weeklyreportsubscriptionCreate**(`weeklyReportSubscription`, `options?`): `Promise`<`AxiosResponse`<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md)\>\> Set the subscription status of the current user to the supplied `is_subscribed` value. If \'is_subscribed\' is true, a subscription is added if it doesn\'t already exist. If it is false, the subscription is removed if it exists. @@ -116,7 +116,7 @@ WeeklyreportsubscriptionApi #### Returns -`Promise`<`AxiosResponse`<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md), `any`\>\> +`Promise`<`AxiosResponse`<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md)\>\> #### Defined in @@ -126,7 +126,7 @@ ___ ### weeklyreportsubscriptionList -▸ **weeklyreportsubscriptionList**(`options?`): `Promise`<`AxiosResponse`<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md)[], `any`\>\> +▸ **weeklyreportsubscriptionList**(`options?`): `Promise`<`AxiosResponse`<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md)[]\>\> Show the user\'s current subscription status. This shows the presence of a weekly report subscription by the user in this account. @@ -144,7 +144,7 @@ WeeklyreportsubscriptionApi #### Returns -`Promise`<`AxiosResponse`<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`WeeklyReportSubscription`](../interfaces/WeeklyReportSubscription.md)[]\>\> #### Defined in diff --git a/packages/integrations/doc/classes/BaseAPI.md b/packages/integrations/doc/classes/BaseAPI.md index 91c9d716d..19220b290 100644 --- a/packages/integrations/doc/classes/BaseAPI.md +++ b/packages/integrations/doc/classes/BaseAPI.md @@ -96,7 +96,7 @@ ___ ### sendRequest -▸ **sendRequest**<`T`\>(`request`, `axios?`, `basePath?`): `Promise`<`AxiosResponse`<`T`, `any`\>\> +▸ **sendRequest**<`T`\>(`request`, `axios?`, `basePath?`): `Promise`<`AxiosResponse`<`T`\>\> Send axios request @@ -116,7 +116,7 @@ Send axios request #### Returns -`Promise`<`AxiosResponse`<`T`, `any`\>\> +`Promise`<`AxiosResponse`<`T`\>\> promisable axios response. diff --git a/packages/integrations/doc/interfaces/RequestArgs.md b/packages/integrations/doc/interfaces/RequestArgs.md index a22fc52d2..8f0832906 100644 --- a/packages/integrations/doc/interfaces/RequestArgs.md +++ b/packages/integrations/doc/interfaces/RequestArgs.md @@ -31,7 +31,7 @@ ___ ### options -• **options**: `AxiosRequestConfig`<`any`\> +• **options**: `AxiosRequestConfig` #### Defined in diff --git a/packages/integrations/doc/modules.md b/packages/integrations/doc/modules.md index 95dea2a32..b06e74c2f 100644 --- a/packages/integrations/doc/modules.md +++ b/packages/integrations/doc/modules.md @@ -302,7 +302,7 @@ ___ | Name | Type | | :------ | :------ | | `T` | `unknown` | -| `R` | `AxiosResponse`<`T`, `any`\> | +| `R` | `AxiosResponse`<`T`\> | ##### Parameters @@ -337,7 +337,7 @@ Create a new endpoint | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`EndpointResourceV1CreateEndpointParams`] \| [[`Endpoint`](interfaces/Endpoint.md), `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`EndpointResourceV1CreateEndpointParams`] \| [[`Endpoint`](interfaces/Endpoint.md), `AxiosRequestConfig`] | with all available params. | #### Returns @@ -365,7 +365,7 @@ Delete an endpoint | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`EndpointResourceV1DeleteEndpointParams`] \| [`string`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`EndpointResourceV1DeleteEndpointParams`] \| [`string`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -393,7 +393,7 @@ Disable an endpoint | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `AxiosRequestConfig`<`any`\>] \| [`EndpointResourceV1DisableEndpointParams`] | with all available params. | +| `...config` | [`string`, `AxiosRequestConfig`] \| [`EndpointResourceV1DisableEndpointParams`] | with all available params. | #### Returns @@ -421,7 +421,7 @@ Enable an endpoint | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `AxiosRequestConfig`<`any`\>] \| [`EndpointResourceV1EnableEndpointParams`] | with all available params. | +| `...config` | [`string`, `AxiosRequestConfig`] \| [`EndpointResourceV1EnableEndpointParams`] | with all available params. | #### Returns @@ -449,7 +449,7 @@ Retrieve event notification details | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`EndpointResourceV1GetDetailedEndpointHistoryParams`] \| [`string`, `string`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`EndpointResourceV1GetDetailedEndpointHistoryParams`] \| [`string`, `string`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -471,7 +471,7 @@ ___ | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`EndpointResourceV1GetEndpointHistoryParams`] \| [`string`, `number`, `number`, `boolean`, `number`, `string`, `string`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`EndpointResourceV1GetEndpointHistoryParams`] \| [`string`, `number`, `number`, `boolean`, `number`, `string`, `string`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -499,7 +499,7 @@ Retrieve an endpoint | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `AxiosRequestConfig`<`any`\>] \| [`EndpointResourceV1GetEndpointParams`] | with all available params. | +| `...config` | [`string`, `AxiosRequestConfig`] \| [`EndpointResourceV1GetEndpointParams`] | with all available params. | #### Returns @@ -527,7 +527,7 @@ List endpoints | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`EndpointResourceV1GetEndpointsParams`] \| [`number`, `number`, `boolean`, `string`, `number`, `string`, `string`, `string`[], `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`EndpointResourceV1GetEndpointsParams`] \| [`number`, `number`, `boolean`, `string`, `number`, `string`, `string`, `string`[], `AxiosRequestConfig`] | with all available params. | #### Returns @@ -555,7 +555,7 @@ Add a drawer endpoint | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`EndpointResourceV1GetOrCreateDrawerSubscriptionEndpointParams`] \| [[`RequestSystemSubscriptionProperties`](interfaces/RequestSystemSubscriptionProperties.md), `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`EndpointResourceV1GetOrCreateDrawerSubscriptionEndpointParams`] \| [[`RequestSystemSubscriptionProperties`](interfaces/RequestSystemSubscriptionProperties.md), `AxiosRequestConfig`] | with all available params. | #### Returns @@ -583,7 +583,7 @@ Create an email subscription endpoint | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [[`RequestSystemSubscriptionProperties`](interfaces/RequestSystemSubscriptionProperties.md), `AxiosRequestConfig`<`any`\>] \| [`EndpointResourceV1GetOrCreateEmailSubscriptionEndpointParams`] | with all available params. | +| `...config` | [[`RequestSystemSubscriptionProperties`](interfaces/RequestSystemSubscriptionProperties.md), `AxiosRequestConfig`] \| [`EndpointResourceV1GetOrCreateEmailSubscriptionEndpointParams`] | with all available params. | #### Returns @@ -611,7 +611,7 @@ Generate a test notification | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`EndpointResourceV1TestEndpointParams`] \| [`string`, [`EndpointTestRequest`](interfaces/EndpointTestRequest.md), `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`EndpointResourceV1TestEndpointParams`] \| [`string`, [`EndpointTestRequest`](interfaces/EndpointTestRequest.md), `AxiosRequestConfig`] | with all available params. | #### Returns @@ -639,7 +639,7 @@ Update an endpoint | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`EndpointResourceV1UpdateEndpointParams`] \| [`string`, [`Endpoint`](interfaces/Endpoint.md), `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`EndpointResourceV1UpdateEndpointParams`] \| [`string`, [`Endpoint`](interfaces/Endpoint.md), `AxiosRequestConfig`] | with all available params. | #### Returns diff --git a/packages/notifications/doc/classes/BaseAPI.md b/packages/notifications/doc/classes/BaseAPI.md index 70bc44841..5a5da79f6 100644 --- a/packages/notifications/doc/classes/BaseAPI.md +++ b/packages/notifications/doc/classes/BaseAPI.md @@ -96,7 +96,7 @@ ___ ### sendRequest -▸ **sendRequest**<`T`\>(`request`, `axios?`, `basePath?`): `Promise`<`AxiosResponse`<`T`, `any`\>\> +▸ **sendRequest**<`T`\>(`request`, `axios?`, `basePath?`): `Promise`<`AxiosResponse`<`T`\>\> Send axios request @@ -116,7 +116,7 @@ Send axios request #### Returns -`Promise`<`AxiosResponse`<`T`, `any`\>\> +`Promise`<`AxiosResponse`<`T`\>\> promisable axios response. diff --git a/packages/notifications/doc/interfaces/RequestArgs.md b/packages/notifications/doc/interfaces/RequestArgs.md index 67267fc84..61393bf6f 100644 --- a/packages/notifications/doc/interfaces/RequestArgs.md +++ b/packages/notifications/doc/interfaces/RequestArgs.md @@ -31,7 +31,7 @@ ___ ### options -• **options**: `AxiosRequestConfig`<`any`\> +• **options**: `AxiosRequestConfig` #### Defined in diff --git a/packages/notifications/doc/modules.md b/packages/notifications/doc/modules.md index 387bd6528..35296e3cc 100644 --- a/packages/notifications/doc/modules.md +++ b/packages/notifications/doc/modules.md @@ -312,7 +312,7 @@ ___ | Name | Type | | :------ | :------ | | `T` | `unknown` | -| `R` | `AxiosResponse`<`T`, `any`\> | +| `R` | `AxiosResponse`<`T`\> | ##### Parameters @@ -347,7 +347,7 @@ Retrieve drawer notifications entries. | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`DrawerResourceV1GetDrawerEntriesParams`] \| [`Set`<`string`\>, `Set`<`string`\>, `string`, `Set`<`string`\>, `number`, `number`, `number`, `boolean`, `string`, `string`, `string`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`DrawerResourceV1GetDrawerEntriesParams`] \| [`Set`<`string`\>, `Set`<`string`\>, `string`, `Set`<`string`\>, `number`, `number`, `number`, `boolean`, `string`, `string`, `string`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -375,7 +375,7 @@ Update drawer notifications status. | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`DrawerResourceV1UpdateNotificationReadStatusParams`] \| [[`UpdateNotificationDrawerStatus`](interfaces/UpdateNotificationDrawerStatus.md), `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`DrawerResourceV1UpdateNotificationReadStatusParams`] \| [[`UpdateNotificationDrawerStatus`](interfaces/UpdateNotificationDrawerStatus.md), `AxiosRequestConfig`] | with all available params. | #### Returns @@ -403,7 +403,7 @@ Retrieve the event log entries | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`EventResourceV1GetEventsParams`] \| [`Set`<`string`\>, `Set`<`string`\>, `string`, `Set`<`string`\>, `string`, `boolean`, `boolean`, `boolean`, `Set`<`boolean`\>, `number`, `number`, `number`, `string`, `string`, `string`, `Set`<[`EventLogEntryActionStatus`](enums/EventLogEntryActionStatus.md)\>, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`EventResourceV1GetEventsParams`] \| [`Set`<`string`\>, `Set`<`string`\>, `string`, `Set`<`string`\>, `string`, `boolean`, `boolean`, `boolean`, `Set`<`boolean`\>, `number`, `number`, `number`, `string`, `string`, `string`, `Set`<[`EventLogEntryActionStatus`](enums/EventLogEntryActionStatus.md)\>, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -429,7 +429,7 @@ Add a behavior group to the given event type. | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1AppendBehaviorGroupToEventTypeParams`] \| [`string`, `string`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1AppendBehaviorGroupToEventTypeParams`] \| [`string`, `string`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -457,7 +457,7 @@ Create a behavior group | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1CreateBehaviorGroupParams`] \| [[`CreateBehaviorGroupRequest`](interfaces/CreateBehaviorGroupRequest.md), `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1CreateBehaviorGroupParams`] \| [[`CreateBehaviorGroupRequest`](interfaces/CreateBehaviorGroupRequest.md), `AxiosRequestConfig`] | with all available params. | #### Returns @@ -485,7 +485,7 @@ Add a behavior group to an event type | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `string`, `AxiosRequestConfig`<`any`\>] \| [`NotificationResourceV1DeleteBehaviorGroupFromEventTypeParams`] | with all available params. | +| `...config` | [`string`, `string`, `AxiosRequestConfig`] \| [`NotificationResourceV1DeleteBehaviorGroupFromEventTypeParams`] | with all available params. | #### Returns @@ -513,7 +513,7 @@ Delete a behavior group | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1DeleteBehaviorGroupParams`] \| [`string`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1DeleteBehaviorGroupParams`] \| [`string`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -541,7 +541,7 @@ List behavior groups in a bundle | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `AxiosRequestConfig`<`any`\>] \| [`NotificationResourceV1FindBehaviorGroupsByBundleIdParams`] | with all available params. | +| `...config` | [`string`, `AxiosRequestConfig`] \| [`NotificationResourceV1FindBehaviorGroupsByBundleIdParams`] | with all available params. | #### Returns @@ -569,7 +569,7 @@ Retrieve an application by bundle and application names | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `string`, `AxiosRequestConfig`<`any`\>] \| [`NotificationResourceV1GetApplicationByNameAndBundleNameParams`] | with all available params. | +| `...config` | [`string`, `string`, `AxiosRequestConfig`] \| [`NotificationResourceV1GetApplicationByNameAndBundleNameParams`] | with all available params. | #### Returns @@ -597,7 +597,7 @@ List configured applications | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `AxiosRequestConfig`<`any`\>] \| [`NotificationResourceV1GetApplicationsFacetsParams`] | with all available params. | +| `...config` | [`string`, `AxiosRequestConfig`] \| [`NotificationResourceV1GetApplicationsFacetsParams`] | with all available params. | #### Returns @@ -625,7 +625,7 @@ List the behavior groups affected by the removal of an endpoint | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `AxiosRequestConfig`<`any`\>] \| [`NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParams`] | with all available params. | +| `...config` | [`string`, `AxiosRequestConfig`] \| [`NotificationResourceV1GetBehaviorGroupsAffectedByRemovalOfEndpointParams`] | with all available params. | #### Returns @@ -653,7 +653,7 @@ Retrieve a bundle by name | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `AxiosRequestConfig`<`any`\>] \| [`NotificationResourceV1GetBundleByNameParams`] | with all available params. | +| `...config` | [`string`, `AxiosRequestConfig`] \| [`NotificationResourceV1GetBundleByNameParams`] | with all available params. | #### Returns @@ -681,7 +681,7 @@ List configured bundles | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1GetBundleFacetsParams`] \| [`boolean`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1GetBundleFacetsParams`] \| [`boolean`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -709,7 +709,7 @@ List the event types affected by the removal of a behavior group | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `AxiosRequestConfig`<`any`\>] \| [`NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParams`] | with all available params. | +| `...config` | [`string`, `AxiosRequestConfig`] \| [`NotificationResourceV1GetEventTypesAffectedByRemovalOfBehaviorGroupParams`] | with all available params. | #### Returns @@ -737,7 +737,7 @@ Retrieve an event type by bundle, application and event type names | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams`] \| [`string`, `string`, `string`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1GetEventTypesByNameAndBundleAndApplicationNameParams`] \| [`string`, `string`, `string`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -765,7 +765,7 @@ List all event types | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1GetEventTypesParams`] \| [`Set`<`string`\>, `string`, `string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1GetEventTypesParams`] \| [`Set`<`string`\>, `string`, `string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -793,7 +793,7 @@ List the behavior groups linked to an event type | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1GetLinkedBehaviorGroupsParams`] \| [`string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1GetLinkedBehaviorGroupsParams`] \| [`string`, `number`, `number`, `number`, `string`, `string`, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -821,7 +821,7 @@ Update the list of behavior group actions | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1UpdateBehaviorGroupActionsParams`] \| [`string`, `string`[], `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1UpdateBehaviorGroupActionsParams`] \| [`string`, `string`[], `AxiosRequestConfig`] | with all available params. | #### Returns @@ -849,7 +849,7 @@ Update a behavior group | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1UpdateBehaviorGroupParams`] \| [`string`, [`UpdateBehaviorGroupRequest`](interfaces/UpdateBehaviorGroupRequest.md), `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1UpdateBehaviorGroupParams`] \| [`string`, [`UpdateBehaviorGroupRequest`](interfaces/UpdateBehaviorGroupRequest.md), `AxiosRequestConfig`] | with all available params. | #### Returns @@ -877,7 +877,7 @@ Update the list of behavior groups for an event type | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`NotificationResourceV1UpdateEventTypeBehaviorsParams`] \| [`string`, `Set`<`string`\>, `AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`NotificationResourceV1UpdateEventTypeBehaviorsParams`] \| [`string`, `Set`<`string`\>, `AxiosRequestConfig`] | with all available params. | #### Returns @@ -905,7 +905,7 @@ Retrieve the daily digest time | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`OrgConfigResourceV1GetDailyDigestTimePreferenceParams`] \| [`AxiosRequestConfig`<`any`\>] | with all available params. | +| `...config` | [`OrgConfigResourceV1GetDailyDigestTimePreferenceParams`] \| [`AxiosRequestConfig`] | with all available params. | #### Returns @@ -933,7 +933,7 @@ Set the daily digest time | Name | Type | Description | | :------ | :------ | :------ | -| `...config` | [`string`, `AxiosRequestConfig`<`any`\>] \| [`OrgConfigResourceV1SaveDailyDigestTimePreferenceParams`] | with all available params. | +| `...config` | [`string`, `AxiosRequestConfig`] \| [`OrgConfigResourceV1SaveDailyDigestTimePreferenceParams`] | with all available params. | #### Returns diff --git a/packages/patch/doc/classes/DefaultApi.md b/packages/patch/doc/classes/DefaultApi.md index 5851968fb..2f249fe42 100644 --- a/packages/patch/doc/classes/DefaultApi.md +++ b/packages/patch/doc/classes/DefaultApi.md @@ -123,7 +123,7 @@ BaseAPI.configuration ### baselineDelete -▸ **baselineDelete**(`baselineId`, `options?`): `Promise`<`AxiosResponse`<[`ControllersDeleteBaselineResponse`](../interfaces/ControllersDeleteBaselineResponse.md), `any`\>\> +▸ **baselineDelete**(`baselineId`, `options?`): `Promise`<`AxiosResponse`<[`ControllersDeleteBaselineResponse`](../interfaces/ControllersDeleteBaselineResponse.md)\>\> Delete a baseline @@ -146,7 +146,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersDeleteBaselineResponse`](../interfaces/ControllersDeleteBaselineResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersDeleteBaselineResponse`](../interfaces/ControllersDeleteBaselineResponse.md)\>\> #### Defined in @@ -156,7 +156,7 @@ ___ ### createBaseline -▸ **createBaseline**(`body`, `options?`): `Promise`<`AxiosResponse`<[`ControllersCreateBaselineResponse`](../interfaces/ControllersCreateBaselineResponse.md), `any`\>\> +▸ **createBaseline**(`body`, `options?`): `Promise`<`AxiosResponse`<[`ControllersCreateBaselineResponse`](../interfaces/ControllersCreateBaselineResponse.md)\>\> Create a baseline for my set of systems @@ -179,7 +179,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersCreateBaselineResponse`](../interfaces/ControllersCreateBaselineResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersCreateBaselineResponse`](../interfaces/ControllersCreateBaselineResponse.md)\>\> #### Defined in @@ -189,7 +189,7 @@ ___ ### deletesystem -▸ **deletesystem**(`inventoryId`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deletesystem**(`inventoryId`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Delete system by inventory id @@ -212,7 +212,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -222,7 +222,7 @@ ___ ### detailAdvisory -▸ **detailAdvisory**(`advisoryId`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisoryDetailResponseV1`](../interfaces/ControllersAdvisoryDetailResponseV1.md), `any`\>\> +▸ **detailAdvisory**(`advisoryId`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisoryDetailResponseV1`](../interfaces/ControllersAdvisoryDetailResponseV1.md)\>\> Show me details an advisory by given advisory name @@ -245,7 +245,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersAdvisoryDetailResponseV1`](../interfaces/ControllersAdvisoryDetailResponseV1.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersAdvisoryDetailResponseV1`](../interfaces/ControllersAdvisoryDetailResponseV1.md)\>\> #### Defined in @@ -255,7 +255,7 @@ ___ ### detailBaseline -▸ **detailBaseline**(`baselineId`, `options?`): `Promise`<`AxiosResponse`<[`ControllersBaselineDetailResponse`](../interfaces/ControllersBaselineDetailResponse.md), `any`\>\> +▸ **detailBaseline**(`baselineId`, `options?`): `Promise`<`AxiosResponse`<[`ControllersBaselineDetailResponse`](../interfaces/ControllersBaselineDetailResponse.md)\>\> Show baseline detail by given baseline ID @@ -278,7 +278,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersBaselineDetailResponse`](../interfaces/ControllersBaselineDetailResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersBaselineDetailResponse`](../interfaces/ControllersBaselineDetailResponse.md)\>\> #### Defined in @@ -288,7 +288,7 @@ ___ ### detailSystem -▸ **detailSystem**(`inventoryId`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemDetailResponse`](../interfaces/ControllersSystemDetailResponse.md), `any`\>\> +▸ **detailSystem**(`inventoryId`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemDetailResponse`](../interfaces/ControllersSystemDetailResponse.md)\>\> Show me details about a system by given inventory id @@ -311,7 +311,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersSystemDetailResponse`](../interfaces/ControllersSystemDetailResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersSystemDetailResponse`](../interfaces/ControllersSystemDetailResponse.md)\>\> #### Defined in @@ -321,7 +321,7 @@ ___ ### exportAdvisories -▸ **exportAdvisories**(`search?`, `filterId?`, `filterDescription?`, `filterPublicDate?`, `filterSynopsis?`, `filterAdvisoryType?`, `filterAdvisoryTypeName?`, `filterSeverity?`, `filterApplicableSystems?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisoryInlineItem`](../interfaces/ControllersAdvisoryInlineItem.md)[], `any`\>\> +▸ **exportAdvisories**(`search?`, `filterId?`, `filterDescription?`, `filterPublicDate?`, `filterSynopsis?`, `filterAdvisoryType?`, `filterAdvisoryTypeName?`, `filterSeverity?`, `filterApplicableSystems?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisoryInlineItem`](../interfaces/ControllersAdvisoryInlineItem.md)[]\>\> Export applicable advisories for all my systems @@ -352,7 +352,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersAdvisoryInlineItem`](../interfaces/ControllersAdvisoryInlineItem.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersAdvisoryInlineItem`](../interfaces/ControllersAdvisoryInlineItem.md)[]\>\> #### Defined in @@ -362,7 +362,7 @@ ___ ### exportAdvisorySystems -▸ **exportAdvisorySystems**(`advisoryId`, `search?`, `filterId?`, `filterDisplayName?`, `filterLastEvaluation?`, `filterLastUpload?`, `filterRhsaCount?`, `filterRhbaCount?`, `filterRheaCount?`, `filterOtherCount?`, `filterStale?`, `filterPackagesInstalled?`, `filterPackagesUpdatable?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `filterOsname?`, `filterOsminor?`, `filterOsmajor?`, `filterOs?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemInlineItem`](../interfaces/ControllersSystemInlineItem.md)[], `any`\>\> +▸ **exportAdvisorySystems**(`advisoryId`, `search?`, `filterId?`, `filterDisplayName?`, `filterLastEvaluation?`, `filterLastUpload?`, `filterRhsaCount?`, `filterRhbaCount?`, `filterRheaCount?`, `filterOtherCount?`, `filterStale?`, `filterPackagesInstalled?`, `filterPackagesUpdatable?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `filterOsname?`, `filterOsminor?`, `filterOsmajor?`, `filterOs?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemInlineItem`](../interfaces/ControllersSystemInlineItem.md)[]\>\> Export systems for my account @@ -408,7 +408,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersSystemInlineItem`](../interfaces/ControllersSystemInlineItem.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersSystemInlineItem`](../interfaces/ControllersSystemInlineItem.md)[]\>\> #### Defined in @@ -418,7 +418,7 @@ ___ ### exportPackageSystems -▸ **exportPackageSystems**(`packageName`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageSystemItem`](../interfaces/ControllersPackageSystemItem.md)[], `any`\>\> +▸ **exportPackageSystems**(`packageName`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageSystemItem`](../interfaces/ControllersPackageSystemItem.md)[]\>\> Show me all my systems which have a package installed @@ -448,7 +448,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersPackageSystemItem`](../interfaces/ControllersPackageSystemItem.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersPackageSystemItem`](../interfaces/ControllersPackageSystemItem.md)[]\>\> #### Defined in @@ -458,7 +458,7 @@ ___ ### exportPackages -▸ **exportPackages**(`sort?`, `search?`, `filterName?`, `filterSystemsInstalled?`, `filterSystemsUpdatable?`, `filterSummary?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageItem`](../interfaces/ControllersPackageItem.md)[], `any`\>\> +▸ **exportPackages**(`sort?`, `search?`, `filterName?`, `filterSystemsInstalled?`, `filterSystemsUpdatable?`, `filterSummary?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageItem`](../interfaces/ControllersPackageItem.md)[]\>\> Show me all installed packages across my systems @@ -486,7 +486,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersPackageItem`](../interfaces/ControllersPackageItem.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersPackageItem`](../interfaces/ControllersPackageItem.md)[]\>\> #### Defined in @@ -496,7 +496,7 @@ ___ ### exportSystemAdvisories -▸ **exportSystemAdvisories**(`inventoryId`, `search?`, `filterId?`, `filterDescription?`, `filterPublicDate?`, `filterSynopsis?`, `filterAdvisoryType?`, `filterAdvisoryTypeName?`, `filterSeverity?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemAdvisoriesDBLookup`](../interfaces/ControllersSystemAdvisoriesDBLookup.md)[], `any`\>\> +▸ **exportSystemAdvisories**(`inventoryId`, `search?`, `filterId?`, `filterDescription?`, `filterPublicDate?`, `filterSynopsis?`, `filterAdvisoryType?`, `filterAdvisoryTypeName?`, `filterSeverity?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemAdvisoriesDBLookup`](../interfaces/ControllersSystemAdvisoriesDBLookup.md)[]\>\> Export applicable advisories for all my systems @@ -527,7 +527,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersSystemAdvisoriesDBLookup`](../interfaces/ControllersSystemAdvisoriesDBLookup.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersSystemAdvisoriesDBLookup`](../interfaces/ControllersSystemAdvisoriesDBLookup.md)[]\>\> #### Defined in @@ -537,7 +537,7 @@ ___ ### exportSystemPackages -▸ **exportSystemPackages**(`inventoryId`, `search?`, `filterName?`, `filterDescription?`, `filterEvra?`, `filterSummary?`, `filterUpdatable?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemPackageInline`](../interfaces/ControllersSystemPackageInline.md)[], `any`\>\> +▸ **exportSystemPackages**(`inventoryId`, `search?`, `filterName?`, `filterDescription?`, `filterEvra?`, `filterSummary?`, `filterUpdatable?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemPackageInline`](../interfaces/ControllersSystemPackageInline.md)[]\>\> Show me details about a system packages by given inventory id @@ -566,7 +566,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersSystemPackageInline`](../interfaces/ControllersSystemPackageInline.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersSystemPackageInline`](../interfaces/ControllersSystemPackageInline.md)[]\>\> #### Defined in @@ -576,7 +576,7 @@ ___ ### exportSystems -▸ **exportSystems**(`search?`, `filterId?`, `filterDisplayName?`, `filterLastEvaluation?`, `filterLastUpload?`, `filterRhsaCount?`, `filterRhbaCount?`, `filterRheaCount?`, `filterOtherCount?`, `filterStale?`, `filterPackagesInstalled?`, `filterPackagesUpdatable?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `filterOsname?`, `filterOsminor?`, `filterOsmajor?`, `filterBaselineName?`, `filterOs?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemInlineItem`](../interfaces/ControllersSystemInlineItem.md)[], `any`\>\> +▸ **exportSystems**(`search?`, `filterId?`, `filterDisplayName?`, `filterLastEvaluation?`, `filterLastUpload?`, `filterRhsaCount?`, `filterRhbaCount?`, `filterRheaCount?`, `filterOtherCount?`, `filterStale?`, `filterPackagesInstalled?`, `filterPackagesUpdatable?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `filterOsname?`, `filterOsminor?`, `filterOsmajor?`, `filterBaselineName?`, `filterOs?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemInlineItem`](../interfaces/ControllersSystemInlineItem.md)[]\>\> Export systems for my account @@ -622,7 +622,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersSystemInlineItem`](../interfaces/ControllersSystemInlineItem.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersSystemInlineItem`](../interfaces/ControllersSystemInlineItem.md)[]\>\> #### Defined in @@ -632,7 +632,7 @@ ___ ### latestPackage -▸ **latestPackage**(`packageName`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageDetailResponse`](../interfaces/ControllersPackageDetailResponse.md), `any`\>\> +▸ **latestPackage**(`packageName`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageDetailResponse`](../interfaces/ControllersPackageDetailResponse.md)\>\> Show me metadata of selected package @@ -655,7 +655,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersPackageDetailResponse`](../interfaces/ControllersPackageDetailResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersPackageDetailResponse`](../interfaces/ControllersPackageDetailResponse.md)\>\> #### Defined in @@ -665,7 +665,7 @@ ___ ### listAdvisories -▸ **listAdvisories**(`limit?`, `offset?`, `sort?`, `search?`, `filterId?`, `filterDescription?`, `filterPublicDate?`, `filterSynopsis?`, `filterAdvisoryType?`, `filterAdvisoryTypeName?`, `filterSeverity?`, `filterApplicableSystems?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisoriesResponse`](../interfaces/ControllersAdvisoriesResponse.md), `any`\>\> +▸ **listAdvisories**(`limit?`, `offset?`, `sort?`, `search?`, `filterId?`, `filterDescription?`, `filterPublicDate?`, `filterSynopsis?`, `filterAdvisoryType?`, `filterAdvisoryTypeName?`, `filterSeverity?`, `filterApplicableSystems?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisoriesResponse`](../interfaces/ControllersAdvisoriesResponse.md)\>\> Show me all applicable advisories for all my systems @@ -706,7 +706,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersAdvisoriesResponse`](../interfaces/ControllersAdvisoriesResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersAdvisoriesResponse`](../interfaces/ControllersAdvisoriesResponse.md)\>\> #### Defined in @@ -716,7 +716,7 @@ ___ ### listAdvisorySystems -▸ **listAdvisorySystems**(`advisoryId`, `limit?`, `offset?`, `sort?`, `search?`, `filterId?`, `filterInsightsId?`, `filterDisplayName?`, `filterLastEvaluation?`, `filterLastUpload?`, `filterRhsaCount?`, `filterRhbaCount?`, `filterRheaCount?`, `filterOtherCount?`, `filterStale?`, `filterStaleTimestamp?`, `filterStaleWarningTimestamp?`, `filterCulledTimestamp?`, `filterCreated?`, `filterOsname?`, `filterOsminor?`, `filterOsmajor?`, `filterOs?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisorySystemsResponse`](../interfaces/ControllersAdvisorySystemsResponse.md), `any`\>\> +▸ **listAdvisorySystems**(`advisoryId`, `limit?`, `offset?`, `sort?`, `search?`, `filterId?`, `filterInsightsId?`, `filterDisplayName?`, `filterLastEvaluation?`, `filterLastUpload?`, `filterRhsaCount?`, `filterRhbaCount?`, `filterRheaCount?`, `filterOtherCount?`, `filterStale?`, `filterStaleTimestamp?`, `filterStaleWarningTimestamp?`, `filterCulledTimestamp?`, `filterCreated?`, `filterOsname?`, `filterOsminor?`, `filterOsmajor?`, `filterOs?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisorySystemsResponse`](../interfaces/ControllersAdvisorySystemsResponse.md)\>\> Show me systems on which the given advisory is applicable @@ -768,7 +768,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersAdvisorySystemsResponse`](../interfaces/ControllersAdvisorySystemsResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersAdvisorySystemsResponse`](../interfaces/ControllersAdvisorySystemsResponse.md)\>\> #### Defined in @@ -778,7 +778,7 @@ ___ ### listBaseline -▸ **listBaseline**(`limit?`, `offset?`, `sort?`, `search?`, `filterId?`, `filterName?`, `filterSystems?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersBaselinesResponse`](../interfaces/ControllersBaselinesResponse.md), `any`\>\> +▸ **listBaseline**(`limit?`, `offset?`, `sort?`, `search?`, `filterId?`, `filterName?`, `filterSystems?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersBaselinesResponse`](../interfaces/ControllersBaselinesResponse.md)\>\> Show me all baselines for all my systems @@ -808,7 +808,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersBaselinesResponse`](../interfaces/ControllersBaselinesResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersBaselinesResponse`](../interfaces/ControllersBaselinesResponse.md)\>\> #### Defined in @@ -818,7 +818,7 @@ ___ ### listBaselineSystems -▸ **listBaselineSystems**(`baselineId`, `limit?`, `offset?`, `sort?`, `search?`, `filterDisplayName?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersBaselineSystemsResponse`](../interfaces/ControllersBaselineSystemsResponse.md), `any`\>\> +▸ **listBaselineSystems**(`baselineId`, `limit?`, `offset?`, `sort?`, `search?`, `filterDisplayName?`, `tags?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersBaselineSystemsResponse`](../interfaces/ControllersBaselineSystemsResponse.md)\>\> Show me all systems applicable to a baseline @@ -847,7 +847,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersBaselineSystemsResponse`](../interfaces/ControllersBaselineSystemsResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersBaselineSystemsResponse`](../interfaces/ControllersBaselineSystemsResponse.md)\>\> #### Defined in @@ -857,7 +857,7 @@ ___ ### listPackages -▸ **listPackages**(`limit?`, `offset?`, `sort?`, `search?`, `filterName?`, `filterSystemsInstalled?`, `filterSystemsUpdatable?`, `filterSummary?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackagesResponse`](../interfaces/ControllersPackagesResponse.md), `any`\>\> +▸ **listPackages**(`limit?`, `offset?`, `sort?`, `search?`, `filterName?`, `filterSystemsInstalled?`, `filterSystemsUpdatable?`, `filterSummary?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackagesResponse`](../interfaces/ControllersPackagesResponse.md)\>\> Show me all installed packages across my systems @@ -894,7 +894,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersPackagesResponse`](../interfaces/ControllersPackagesResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersPackagesResponse`](../interfaces/ControllersPackagesResponse.md)\>\> #### Defined in @@ -904,7 +904,7 @@ ___ ### listSystemAdvisories -▸ **listSystemAdvisories**(`inventoryId`, `limit?`, `offset?`, `sort?`, `search?`, `filterId?`, `filterDescription?`, `filterPublicDate?`, `filterSynopsis?`, `filterAdvisoryType?`, `filterAdvisoryTypeName?`, `filterSeverity?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemAdvisoriesResponse`](../interfaces/ControllersSystemAdvisoriesResponse.md), `any`\>\> +▸ **listSystemAdvisories**(`inventoryId`, `limit?`, `offset?`, `sort?`, `search?`, `filterId?`, `filterDescription?`, `filterPublicDate?`, `filterSynopsis?`, `filterAdvisoryType?`, `filterAdvisoryTypeName?`, `filterSeverity?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemAdvisoriesResponse`](../interfaces/ControllersSystemAdvisoriesResponse.md)\>\> Show me advisories for a system by given inventory id @@ -938,7 +938,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersSystemAdvisoriesResponse`](../interfaces/ControllersSystemAdvisoriesResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersSystemAdvisoriesResponse`](../interfaces/ControllersSystemAdvisoriesResponse.md)\>\> #### Defined in @@ -948,7 +948,7 @@ ___ ### listSystems -▸ **listSystems**(`limit?`, `offset?`, `sort?`, `search?`, `filterInsightsId?`, `filterId?`, `filterDisplayName?`, `filterLastEvaluation?`, `filterLastUpload?`, `filterRhsaCount?`, `filterRhbaCount?`, `filterRheaCount?`, `filterOtherCount?`, `filterStale?`, `filterPackagesInstalled?`, `filterPackagesUpdatable?`, `filterStaleTimestamp?`, `filterStaleWarningTimestamp?`, `filterCulledTimestamp?`, `filterCreated?`, `filterOsname?`, `filterOsminor?`, `filterOsmajor?`, `filterBaselineName?`, `filterOs?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemsResponse`](../interfaces/ControllersSystemsResponse.md), `any`\>\> +▸ **listSystems**(`limit?`, `offset?`, `sort?`, `search?`, `filterInsightsId?`, `filterId?`, `filterDisplayName?`, `filterLastEvaluation?`, `filterLastUpload?`, `filterRhsaCount?`, `filterRhbaCount?`, `filterRheaCount?`, `filterOtherCount?`, `filterStale?`, `filterPackagesInstalled?`, `filterPackagesUpdatable?`, `filterStaleTimestamp?`, `filterStaleWarningTimestamp?`, `filterCulledTimestamp?`, `filterCreated?`, `filterOsname?`, `filterOsminor?`, `filterOsmajor?`, `filterBaselineName?`, `filterOs?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemsResponse`](../interfaces/ControllersSystemsResponse.md)\>\> Show me all my systems @@ -1002,7 +1002,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersSystemsResponse`](../interfaces/ControllersSystemsResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersSystemsResponse`](../interfaces/ControllersSystemsResponse.md)\>\> #### Defined in @@ -1012,7 +1012,7 @@ ___ ### packageSystems -▸ **packageSystems**(`packageName`, `limit?`, `offset?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageSystemsResponse`](../interfaces/ControllersPackageSystemsResponse.md), `any`\>\> +▸ **packageSystems**(`packageName`, `limit?`, `offset?`, `tags?`, `filterSystemProfileSapSystem?`, `filterSystemProfileSapSidsIn?`, `filterSystemProfileAnsible?`, `filterSystemProfileAnsibleControllerVersion?`, `filterSystemProfileMssql?`, `filterSystemProfileMssqlVersion?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageSystemsResponse`](../interfaces/ControllersPackageSystemsResponse.md)\>\> Show me all my systems which have a package installed @@ -1044,7 +1044,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersPackageSystemsResponse`](../interfaces/ControllersPackageSystemsResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersPackageSystemsResponse`](../interfaces/ControllersPackageSystemsResponse.md)\>\> #### Defined in @@ -1054,7 +1054,7 @@ ___ ### packageVersions -▸ **packageVersions**(`packageName`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageVersionsResponse`](../interfaces/ControllersPackageVersionsResponse.md), `any`\>\> +▸ **packageVersions**(`packageName`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersPackageVersionsResponse`](../interfaces/ControllersPackageVersionsResponse.md)\>\> Show me all package versions installed on some system @@ -1079,7 +1079,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersPackageVersionsResponse`](../interfaces/ControllersPackageVersionsResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersPackageVersionsResponse`](../interfaces/ControllersPackageVersionsResponse.md)\>\> #### Defined in @@ -1089,7 +1089,7 @@ ___ ### removeBaselineSystems -▸ **removeBaselineSystems**(`body`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **removeBaselineSystems**(`body`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Remove systems from baseline @@ -1112,7 +1112,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -1122,7 +1122,7 @@ ___ ### systemPackages -▸ **systemPackages**(`inventoryId`, `limit?`, `offset?`, `search?`, `filterName?`, `filterDescription?`, `filterEvra?`, `filterSummary?`, `filterUpdatable?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemPackageResponse`](../interfaces/ControllersSystemPackageResponse.md), `any`\>\> +▸ **systemPackages**(`inventoryId`, `limit?`, `offset?`, `search?`, `filterName?`, `filterDescription?`, `filterEvra?`, `filterSummary?`, `filterUpdatable?`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemPackageResponse`](../interfaces/ControllersSystemPackageResponse.md)\>\> Show me details about a system packages by given inventory id @@ -1153,7 +1153,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersSystemPackageResponse`](../interfaces/ControllersSystemPackageResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersSystemPackageResponse`](../interfaces/ControllersSystemPackageResponse.md)\>\> #### Defined in @@ -1163,7 +1163,7 @@ ___ ### updateBaseline -▸ **updateBaseline**(`baselineId`, `body`, `options?`): `Promise`<`AxiosResponse`<[`ControllersUpdateBaselineResponse`](../interfaces/ControllersUpdateBaselineResponse.md), `any`\>\> +▸ **updateBaseline**(`baselineId`, `body`, `options?`): `Promise`<`AxiosResponse`<[`ControllersUpdateBaselineResponse`](../interfaces/ControllersUpdateBaselineResponse.md)\>\> Update a baseline for my set of systems @@ -1187,7 +1187,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersUpdateBaselineResponse`](../interfaces/ControllersUpdateBaselineResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersUpdateBaselineResponse`](../interfaces/ControllersUpdateBaselineResponse.md)\>\> #### Defined in @@ -1197,7 +1197,7 @@ ___ ### viewAdvisoriesSystems -▸ **viewAdvisoriesSystems**(`body`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisoriesSystemsResponse`](../interfaces/ControllersAdvisoriesSystemsResponse.md), `any`\>\> +▸ **viewAdvisoriesSystems**(`body`, `options?`): `Promise`<`AxiosResponse`<[`ControllersAdvisoriesSystemsResponse`](../interfaces/ControllersAdvisoriesSystemsResponse.md)\>\> View advisory-system pairs for selected systems and advisories @@ -1220,7 +1220,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersAdvisoriesSystemsResponse`](../interfaces/ControllersAdvisoriesSystemsResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersAdvisoriesSystemsResponse`](../interfaces/ControllersAdvisoriesSystemsResponse.md)\>\> #### Defined in @@ -1230,7 +1230,7 @@ ___ ### viewSystemsAdvisories -▸ **viewSystemsAdvisories**(`body`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemsAdvisoriesResponse`](../interfaces/ControllersSystemsAdvisoriesResponse.md), `any`\>\> +▸ **viewSystemsAdvisories**(`body`, `options?`): `Promise`<`AxiosResponse`<[`ControllersSystemsAdvisoriesResponse`](../interfaces/ControllersSystemsAdvisoriesResponse.md)\>\> View system-advisory pairs for selected systems and advisories @@ -1253,7 +1253,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ControllersSystemsAdvisoriesResponse`](../interfaces/ControllersSystemsAdvisoriesResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ControllersSystemsAdvisoriesResponse`](../interfaces/ControllersSystemsAdvisoriesResponse.md)\>\> #### Defined in diff --git a/packages/policies/doc/classes/BasePathFillerServiceApi.md b/packages/policies/doc/classes/BasePathFillerServiceApi.md index 4af8b5c11..9950b1836 100644 --- a/packages/policies/doc/classes/BasePathFillerServiceApi.md +++ b/packages/policies/doc/classes/BasePathFillerServiceApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### get -▸ **get**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **get**(`options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -112,11 +112,11 @@ BasePathFillerServiceApi | Name | Type | Description | | :------ | :------ | :------ | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/policies/doc/classes/FactServiceApi.md b/packages/policies/doc/classes/FactServiceApi.md index a7f17c380..85efd6650 100644 --- a/packages/policies/doc/classes/FactServiceApi.md +++ b/packages/policies/doc/classes/FactServiceApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### getFacts -▸ **getFacts**(`options?`): `Promise`<`AxiosResponse`<[`Fact`](../interfaces/Fact.md)[], `any`\>\> +▸ **getFacts**(`options?`): `Promise`<`AxiosResponse`<[`Fact`](../interfaces/Fact.md)[]\>\> **`Summary`** @@ -112,11 +112,11 @@ FactServiceApi | Name | Type | Description | | :------ | :------ | :------ | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`Fact`](../interfaces/Fact.md)[], `any`\>\> +`Promise`<`AxiosResponse`<[`Fact`](../interfaces/Fact.md)[]\>\> #### Defined in diff --git a/packages/policies/doc/classes/PolicyCrudServiceApi.md b/packages/policies/doc/classes/PolicyCrudServiceApi.md index 9d4005fbb..fa980a06c 100644 --- a/packages/policies/doc/classes/PolicyCrudServiceApi.md +++ b/packages/policies/doc/classes/PolicyCrudServiceApi.md @@ -107,7 +107,7 @@ BaseAPI.configuration ### deletePoliciesById -▸ **deletePoliciesById**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deletePoliciesById**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -124,11 +124,11 @@ PolicyCrudServiceApi | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | UUID of the policy | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -138,7 +138,7 @@ ___ ### deletePoliciesIds -▸ **deletePoliciesIds**(`requestBody?`, `options?`): `Promise`<`AxiosResponse`<`string`[], `any`\>\> +▸ **deletePoliciesIds**(`requestBody?`, `options?`): `Promise`<`AxiosResponse`<`string`[]\>\> **`Summary`** @@ -155,11 +155,11 @@ PolicyCrudServiceApi | Name | Type | Description | | :------ | :------ | :------ | | `requestBody?` | `string`[] | | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<`string`[], `any`\>\> +`Promise`<`AxiosResponse`<`string`[]\>\> #### Defined in @@ -169,7 +169,7 @@ ___ ### getPolicies -▸ **getPolicies**(`filteropDescription?`, `filteropName?`, `filterDescription?`, `filterIsEnabled?`, `filterName?`, `limit?`, `offset?`, `sortColumn?`, `sortDirection?`, `options?`): `Promise`<`AxiosResponse`<[`PagedResponseOfPolicy`](../interfaces/PagedResponseOfPolicy.md), `any`\>\> +▸ **getPolicies**(`filteropDescription?`, `filteropName?`, `filterDescription?`, `filterIsEnabled?`, `filterName?`, `limit?`, `offset?`, `sortColumn?`, `sortDirection?`, `options?`): `Promise`<`AxiosResponse`<[`PagedResponseOfPolicy`](../interfaces/PagedResponseOfPolicy.md)\>\> **`Summary`** @@ -194,11 +194,11 @@ PolicyCrudServiceApi | `offset?` | `number` | Page number, starts 0, if not specified uses 0. | | `sortColumn?` | ``"name"`` \| ``"description"`` \| ``"is_enabled"`` \| ``"mtime"`` \| ``"last_triggered"`` | Column to sort the results by | | `sortDirection?` | ``"desc"`` \| ``"asc"`` | Sort direction used | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`PagedResponseOfPolicy`](../interfaces/PagedResponseOfPolicy.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PagedResponseOfPolicy`](../interfaces/PagedResponseOfPolicy.md)\>\> #### Defined in @@ -208,7 +208,7 @@ ___ ### getPoliciesById -▸ **getPoliciesById**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Policy`](../interfaces/Policy.md), `any`\>\> +▸ **getPoliciesById**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Policy`](../interfaces/Policy.md)\>\> **`Summary`** @@ -225,11 +225,11 @@ PolicyCrudServiceApi | Name | Type | Description | | :------ | :------ | :------ | | `id` | `string` | UUID of the policy | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`Policy`](../interfaces/Policy.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Policy`](../interfaces/Policy.md)\>\> #### Defined in @@ -239,7 +239,7 @@ ___ ### getPoliciesByIdHistoryTrigger -▸ **getPoliciesByIdHistoryTrigger**(`id`, `filteropId?`, `filteropName?`, `filterId?`, `filterName?`, `limit?`, `offset?`, `sortColumn?`, `sortDirection?`, `options?`): `Promise`<`AxiosResponse`<[`PagedResponseOfHistoryItem`](../interfaces/PagedResponseOfHistoryItem.md), `any`\>\> +▸ **getPoliciesByIdHistoryTrigger**(`id`, `filteropId?`, `filteropName?`, `filterId?`, `filterName?`, `limit?`, `offset?`, `sortColumn?`, `sortDirection?`, `options?`): `Promise`<`AxiosResponse`<[`PagedResponseOfHistoryItem`](../interfaces/PagedResponseOfHistoryItem.md)\>\> **`Summary`** @@ -264,11 +264,11 @@ PolicyCrudServiceApi | `offset?` | `number` | Page number, starts 0, if not specified uses 0. | | `sortColumn?` | ``"hostName"`` \| ``"ctime"`` | Column to sort the results by | | `sortDirection?` | ``"desc"`` \| ``"asc"`` | Sort direction used | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`PagedResponseOfHistoryItem`](../interfaces/PagedResponseOfHistoryItem.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PagedResponseOfHistoryItem`](../interfaces/PagedResponseOfHistoryItem.md)\>\> #### Defined in @@ -278,7 +278,7 @@ ___ ### getPoliciesIds -▸ **getPoliciesIds**(`filteropDescription?`, `filteropName?`, `filterDescription?`, `filterIsEnabled?`, `filterName?`, `options?`): `Promise`<`AxiosResponse`<`string`[], `any`\>\> +▸ **getPoliciesIds**(`filteropDescription?`, `filteropName?`, `filterDescription?`, `filterIsEnabled?`, `filterName?`, `options?`): `Promise`<`AxiosResponse`<`string`[]\>\> **`Summary`** @@ -299,11 +299,11 @@ PolicyCrudServiceApi | `filterDescription?` | `string` | Filtering policies by the description depending on the Filter operator used. | | `filterIsEnabled?` | ``"false"`` \| ``"true"`` | Filtering policies by the is_enabled field.Defaults to true if no operand is given. | | `filterName?` | `string` | Filtering policies by the name depending on the Filter operator used. | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<`string`[], `any`\>\> +`Promise`<`AxiosResponse`<`string`[]\>\> #### Defined in @@ -313,7 +313,7 @@ ___ ### postPolicies -▸ **postPolicies**(`alsoStore?`, `policy?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **postPolicies**(`alsoStore?`, `policy?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -331,11 +331,11 @@ PolicyCrudServiceApi | :------ | :------ | :------ | | `alsoStore?` | `boolean` | If passed and set to true, the passed policy is also persisted (if it is valid) | | `policy?` | [`Policy`](../interfaces/Policy.md) | | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -345,7 +345,7 @@ ___ ### postPoliciesByIdEnabled -▸ **postPoliciesByIdEnabled**(`id`, `enabled?`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **postPoliciesByIdEnabled**(`id`, `enabled?`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -363,11 +363,11 @@ PolicyCrudServiceApi | :------ | :------ | :------ | | `id` | `string` | ID of the Policy | | `enabled?` | `boolean` | Should the policy be enabled (true) or disabled (false, default) | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -377,7 +377,7 @@ ___ ### postPoliciesIdsEnabled -▸ **postPoliciesIdsEnabled**(`enabled?`, `requestBody?`, `options?`): `Promise`<`AxiosResponse`<`string`[], `any`\>\> +▸ **postPoliciesIdsEnabled**(`enabled?`, `requestBody?`, `options?`): `Promise`<`AxiosResponse`<`string`[]\>\> **`Summary`** @@ -395,11 +395,11 @@ PolicyCrudServiceApi | :------ | :------ | :------ | | `enabled?` | `boolean` | | | `requestBody?` | `string`[] | | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<`string`[], `any`\>\> +`Promise`<`AxiosResponse`<`string`[]\>\> #### Defined in @@ -409,7 +409,7 @@ ___ ### postPoliciesValidate -▸ **postPoliciesValidate**(`policy?`, `options?`): `Promise`<`AxiosResponse`<[`Msg`](../interfaces/Msg.md), `any`\>\> +▸ **postPoliciesValidate**(`policy?`, `options?`): `Promise`<`AxiosResponse`<[`Msg`](../interfaces/Msg.md)\>\> **`Summary`** @@ -426,11 +426,11 @@ PolicyCrudServiceApi | Name | Type | Description | | :------ | :------ | :------ | | `policy?` | [`Policy`](../interfaces/Policy.md) | | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`Msg`](../interfaces/Msg.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Msg`](../interfaces/Msg.md)\>\> #### Defined in @@ -440,7 +440,7 @@ ___ ### postPoliciesValidateName -▸ **postPoliciesValidateName**(`body`, `id?`, `options?`): `Promise`<`AxiosResponse`<[`Msg`](../interfaces/Msg.md), `any`\>\> +▸ **postPoliciesValidateName**(`body`, `id?`, `options?`): `Promise`<`AxiosResponse`<[`Msg`](../interfaces/Msg.md)\>\> **`Summary`** @@ -458,11 +458,11 @@ PolicyCrudServiceApi | :------ | :------ | :------ | | `body` | `string` | | | `id?` | `string` | UUID of the policy | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`Msg`](../interfaces/Msg.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Msg`](../interfaces/Msg.md)\>\> #### Defined in @@ -472,7 +472,7 @@ ___ ### putPoliciesByPolicyId -▸ **putPoliciesByPolicyId**(`policyId`, `dry?`, `policy?`, `options?`): `Promise`<`AxiosResponse`<[`Policy`](../interfaces/Policy.md), `any`\>\> +▸ **putPoliciesByPolicyId**(`policyId`, `dry?`, `policy?`, `options?`): `Promise`<`AxiosResponse`<[`Policy`](../interfaces/Policy.md)\>\> **`Summary`** @@ -491,11 +491,11 @@ PolicyCrudServiceApi | `policyId` | `string` | | | `dry?` | `boolean` | | | `policy?` | [`Policy`](../interfaces/Policy.md) | | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`Policy`](../interfaces/Policy.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Policy`](../interfaces/Policy.md)\>\> #### Defined in diff --git a/packages/policies/doc/modules.md b/packages/policies/doc/modules.md index f1e69a2d7..1196668e2 100644 --- a/packages/policies/doc/modules.md +++ b/packages/policies/doc/modules.md @@ -61,7 +61,7 @@ BasePathFillerServiceApi - axios parameter creator | Name | Type | | :------ | :------ | -| `get` | (`options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | +| `get` | (`options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | #### Defined in @@ -119,7 +119,7 @@ BasePathFillerServiceApi - functional programming interface | Name | Type | | :------ | :------ | -| `get` | (`options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | +| `get` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | #### Defined in @@ -147,7 +147,7 @@ FactServiceApi - axios parameter creator | Name | Type | | :------ | :------ | -| `getFacts` | (`options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | +| `getFacts` | (`options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | #### Defined in @@ -205,7 +205,7 @@ FactServiceApi - functional programming interface | Name | Type | | :------ | :------ | -| `getFacts` | (`options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Fact`](interfaces/Fact.md)[]\>\> | +| `getFacts` | (`options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Fact`](interfaces/Fact.md)[]\>\> | #### Defined in @@ -233,18 +233,18 @@ PolicyCrudServiceApi - axios parameter creator | Name | Type | | :------ | :------ | -| `deletePoliciesById` | (`id`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `deletePoliciesIds` | (`requestBody?`: `string`[], `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `getPolicies` | (`filteropDescription?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filterDescription?`: `string`, `filterIsEnabled?`: ``"false"`` \| ``"true"``, `filterName?`: `string`, `limit?`: `number`, `offset?`: `number`, `sortColumn?`: ``"name"`` \| ``"description"`` \| ``"is_enabled"`` \| ``"mtime"`` \| ``"last_triggered"``, `sortDirection?`: ``"desc"`` \| ``"asc"``, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `getPoliciesById` | (`id`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `getPoliciesByIdHistoryTrigger` | (`id`: `string`, `filteropId?`: ``"equal"`` \| ``"like"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"not_equal"``, `filterId?`: `string`, `filterName?`: `string`, `limit?`: `number`, `offset?`: `number`, `sortColumn?`: ``"hostName"`` \| ``"ctime"``, `sortDirection?`: ``"desc"`` \| ``"asc"``, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `getPoliciesIds` | (`filteropDescription?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filterDescription?`: `string`, `filterIsEnabled?`: ``"false"`` \| ``"true"``, `filterName?`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `postPolicies` | (`alsoStore?`: `boolean`, `policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `postPoliciesByIdEnabled` | (`id`: `string`, `enabled?`: `boolean`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `postPoliciesIdsEnabled` | (`enabled?`: `boolean`, `requestBody?`: `string`[], `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `postPoliciesValidate` | (`policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `postPoliciesValidateName` | (`body`: `string`, `id?`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `putPoliciesByPolicyId` | (`policyId`: `string`, `dry?`: `boolean`, `policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | +| `deletePoliciesById` | (`id`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `deletePoliciesIds` | (`requestBody?`: `string`[], `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `getPolicies` | (`filteropDescription?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filterDescription?`: `string`, `filterIsEnabled?`: ``"false"`` \| ``"true"``, `filterName?`: `string`, `limit?`: `number`, `offset?`: `number`, `sortColumn?`: ``"name"`` \| ``"description"`` \| ``"is_enabled"`` \| ``"mtime"`` \| ``"last_triggered"``, `sortDirection?`: ``"desc"`` \| ``"asc"``, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `getPoliciesById` | (`id`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `getPoliciesByIdHistoryTrigger` | (`id`: `string`, `filteropId?`: ``"equal"`` \| ``"like"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"not_equal"``, `filterId?`: `string`, `filterName?`: `string`, `limit?`: `number`, `offset?`: `number`, `sortColumn?`: ``"hostName"`` \| ``"ctime"``, `sortDirection?`: ``"desc"`` \| ``"asc"``, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `getPoliciesIds` | (`filteropDescription?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filterDescription?`: `string`, `filterIsEnabled?`: ``"false"`` \| ``"true"``, `filterName?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `postPolicies` | (`alsoStore?`: `boolean`, `policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `postPoliciesByIdEnabled` | (`id`: `string`, `enabled?`: `boolean`, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `postPoliciesIdsEnabled` | (`enabled?`: `boolean`, `requestBody?`: `string`[], `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `postPoliciesValidate` | (`policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `postPoliciesValidateName` | (`body`: `string`, `id?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `putPoliciesByPolicyId` | (`policyId`: `string`, `dry?`: `boolean`, `policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | #### Defined in @@ -313,18 +313,18 @@ PolicyCrudServiceApi - functional programming interface | Name | Type | | :------ | :------ | -| `deletePoliciesById` | (`id`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `deletePoliciesIds` | (`requestBody?`: `string`[], `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`[]\>\> | -| `getPolicies` | (`filteropDescription?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filterDescription?`: `string`, `filterIsEnabled?`: ``"false"`` \| ``"true"``, `filterName?`: `string`, `limit?`: `number`, `offset?`: `number`, `sortColumn?`: ``"name"`` \| ``"description"`` \| ``"is_enabled"`` \| ``"mtime"`` \| ``"last_triggered"``, `sortDirection?`: ``"desc"`` \| ``"asc"``, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PagedResponseOfPolicy`](interfaces/PagedResponseOfPolicy.md)\>\> | -| `getPoliciesById` | (`id`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Policy`](interfaces/Policy.md)\>\> | -| `getPoliciesByIdHistoryTrigger` | (`id`: `string`, `filteropId?`: ``"equal"`` \| ``"like"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"not_equal"``, `filterId?`: `string`, `filterName?`: `string`, `limit?`: `number`, `offset?`: `number`, `sortColumn?`: ``"hostName"`` \| ``"ctime"``, `sortDirection?`: ``"desc"`` \| ``"asc"``, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PagedResponseOfHistoryItem`](interfaces/PagedResponseOfHistoryItem.md)\>\> | -| `getPoliciesIds` | (`filteropDescription?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filterDescription?`: `string`, `filterIsEnabled?`: ``"false"`` \| ``"true"``, `filterName?`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`[]\>\> | -| `postPolicies` | (`alsoStore?`: `boolean`, `policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `postPoliciesByIdEnabled` | (`id`: `string`, `enabled?`: `boolean`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | -| `postPoliciesIdsEnabled` | (`enabled?`: `boolean`, `requestBody?`: `string`[], `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`[]\>\> | -| `postPoliciesValidate` | (`policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Msg`](interfaces/Msg.md)\>\> | -| `postPoliciesValidateName` | (`body`: `string`, `id?`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Msg`](interfaces/Msg.md)\>\> | -| `putPoliciesByPolicyId` | (`policyId`: `string`, `dry?`: `boolean`, `policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Policy`](interfaces/Policy.md)\>\> | +| `deletePoliciesById` | (`id`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | +| `deletePoliciesIds` | (`requestBody?`: `string`[], `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`[]\>\> | +| `getPolicies` | (`filteropDescription?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filterDescription?`: `string`, `filterIsEnabled?`: ``"false"`` \| ``"true"``, `filterName?`: `string`, `limit?`: `number`, `offset?`: `number`, `sortColumn?`: ``"name"`` \| ``"description"`` \| ``"is_enabled"`` \| ``"mtime"`` \| ``"last_triggered"``, `sortDirection?`: ``"desc"`` \| ``"asc"``, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PagedResponseOfPolicy`](interfaces/PagedResponseOfPolicy.md)\>\> | +| `getPoliciesById` | (`id`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Policy`](interfaces/Policy.md)\>\> | +| `getPoliciesByIdHistoryTrigger` | (`id`: `string`, `filteropId?`: ``"equal"`` \| ``"like"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"not_equal"``, `filterId?`: `string`, `filterName?`: `string`, `limit?`: `number`, `offset?`: `number`, `sortColumn?`: ``"hostName"`` \| ``"ctime"``, `sortDirection?`: ``"desc"`` \| ``"asc"``, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`PagedResponseOfHistoryItem`](interfaces/PagedResponseOfHistoryItem.md)\>\> | +| `getPoliciesIds` | (`filteropDescription?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filteropName?`: ``"equal"`` \| ``"like"`` \| ``"ilike"`` \| ``"not_equal"``, `filterDescription?`: `string`, `filterIsEnabled?`: ``"false"`` \| ``"true"``, `filterName?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`[]\>\> | +| `postPolicies` | (`alsoStore?`: `boolean`, `policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | +| `postPoliciesByIdEnabled` | (`id`: `string`, `enabled?`: `boolean`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`void`\>\> | +| `postPoliciesIdsEnabled` | (`enabled?`: `boolean`, `requestBody?`: `string`[], `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<`string`[]\>\> | +| `postPoliciesValidate` | (`policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Msg`](interfaces/Msg.md)\>\> | +| `postPoliciesValidateName` | (`body`: `string`, `id?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Msg`](interfaces/Msg.md)\>\> | +| `putPoliciesByPolicyId` | (`policyId`: `string`, `dry?`: `boolean`, `policy?`: [`Policy`](interfaces/Policy.md), `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`Policy`](interfaces/Policy.md)\>\> | #### Defined in diff --git a/packages/quickstarts/doc/classes/HelptopicApi.md b/packages/quickstarts/doc/classes/HelptopicApi.md index dc92e7d85..f015dc3c2 100644 --- a/packages/quickstarts/doc/classes/HelptopicApi.md +++ b/packages/quickstarts/doc/classes/HelptopicApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### helptopicsGet -▸ **helptopicsGet**(`bundle?`, `application?`, `name?`, `options?`): `Promise`<`AxiosResponse`<[`HelptopicsGet200Response`](../interfaces/HelptopicsGet200Response.md), `any`\>\> +▸ **helptopicsGet**(`bundle?`, `application?`, `name?`, `options?`): `Promise`<`AxiosResponse`<[`HelptopicsGet200Response`](../interfaces/HelptopicsGet200Response.md)\>\> **`Summary`** @@ -116,11 +116,11 @@ HelptopicApi | `bundle?` | `string` | If set, content is associated with a specific CRC bundle | | `application?` | `string` | If set, content is associated with a specific CRC application | | `name?` | `string` | Search content by name | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`HelptopicsGet200Response`](../interfaces/HelptopicsGet200Response.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HelptopicsGet200Response`](../interfaces/HelptopicsGet200Response.md)\>\> #### Defined in @@ -130,7 +130,7 @@ ___ ### helptopicsNameGet -▸ **helptopicsNameGet**(`name`, `options?`): `Promise`<`AxiosResponse`<[`HelptopicsNameGet200Response`](../interfaces/HelptopicsNameGet200Response.md), `any`\>\> +▸ **helptopicsNameGet**(`name`, `options?`): `Promise`<`AxiosResponse`<[`HelptopicsNameGet200Response`](../interfaces/HelptopicsNameGet200Response.md)\>\> **`Summary`** @@ -147,11 +147,11 @@ HelptopicApi | Name | Type | Description | | :------ | :------ | :------ | | `name` | `string` | identifier | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`HelptopicsNameGet200Response`](../interfaces/HelptopicsNameGet200Response.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HelptopicsNameGet200Response`](../interfaces/HelptopicsNameGet200Response.md)\>\> #### Defined in diff --git a/packages/quickstarts/doc/classes/QuickstartApi.md b/packages/quickstarts/doc/classes/QuickstartApi.md index 84f3eaef9..38b18f535 100644 --- a/packages/quickstarts/doc/classes/QuickstartApi.md +++ b/packages/quickstarts/doc/classes/QuickstartApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### quickstartsGet -▸ **quickstartsGet**(`bundle?`, `application?`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`QuickstartsGet200Response`](../interfaces/QuickstartsGet200Response.md), `any`\>\> +▸ **quickstartsGet**(`bundle?`, `application?`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`QuickstartsGet200Response`](../interfaces/QuickstartsGet200Response.md)\>\> **`Summary`** @@ -117,11 +117,11 @@ QuickstartApi | `application?` | `string` | If set, content is associated with a specific CRC application | | `limit?` | `number` | Pagination limit | | `offset?` | `number` | Pagination offset | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`QuickstartsGet200Response`](../interfaces/QuickstartsGet200Response.md), `any`\>\> +`Promise`<`AxiosResponse`<[`QuickstartsGet200Response`](../interfaces/QuickstartsGet200Response.md)\>\> #### Defined in @@ -131,7 +131,7 @@ ___ ### quickstartsIdGet -▸ **quickstartsIdGet**(`id`, `options?`): `Promise`<`AxiosResponse`<[`V1Quickstart`](../interfaces/V1Quickstart.md), `any`\>\> +▸ **quickstartsIdGet**(`id`, `options?`): `Promise`<`AxiosResponse`<[`V1Quickstart`](../interfaces/V1Quickstart.md)\>\> **`Summary`** @@ -148,11 +148,11 @@ QuickstartApi | Name | Type | Description | | :------ | :------ | :------ | | `id` | `number` | identifier | -| `options?` | `AxiosRequestConfig`<`any`\> | Override http request option. | +| `options?` | `AxiosRequestConfig` | Override http request option. | #### Returns -`Promise`<`AxiosResponse`<[`V1Quickstart`](../interfaces/V1Quickstart.md), `any`\>\> +`Promise`<`AxiosResponse`<[`V1Quickstart`](../interfaces/V1Quickstart.md)\>\> #### Defined in diff --git a/packages/quickstarts/doc/modules.md b/packages/quickstarts/doc/modules.md index 1f2e73384..88c832018 100644 --- a/packages/quickstarts/doc/modules.md +++ b/packages/quickstarts/doc/modules.md @@ -54,8 +54,8 @@ HelptopicApi - axios parameter creator | Name | Type | | :------ | :------ | -| `helptopicsGet` | (`bundle?`: `string`, `application?`: `string`, `name?`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `helptopicsNameGet` | (`name`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | +| `helptopicsGet` | (`bundle?`: `string`, `application?`: `string`, `name?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `helptopicsNameGet` | (`name`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | #### Defined in @@ -114,8 +114,8 @@ HelptopicApi - functional programming interface | Name | Type | | :------ | :------ | -| `helptopicsGet` | (`bundle?`: `string`, `application?`: `string`, `name?`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`HelptopicsGet200Response`](interfaces/HelptopicsGet200Response.md)\>\> | -| `helptopicsNameGet` | (`name`: `string`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`HelptopicsNameGet200Response`](interfaces/HelptopicsNameGet200Response.md)\>\> | +| `helptopicsGet` | (`bundle?`: `string`, `application?`: `string`, `name?`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`HelptopicsGet200Response`](interfaces/HelptopicsGet200Response.md)\>\> | +| `helptopicsNameGet` | (`name`: `string`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`HelptopicsNameGet200Response`](interfaces/HelptopicsNameGet200Response.md)\>\> | #### Defined in @@ -143,8 +143,8 @@ QuickstartApi - axios parameter creator | Name | Type | | :------ | :------ | -| `quickstartsGet` | (`bundle?`: `string`, `application?`: `string`, `limit?`: `number`, `offset?`: `number`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | -| `quickstartsIdGet` | (`id`: `number`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<`RequestArgs`\> | +| `quickstartsGet` | (`bundle?`: `string`, `application?`: `string`, `limit?`: `number`, `offset?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | +| `quickstartsIdGet` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<`RequestArgs`\> | #### Defined in @@ -203,8 +203,8 @@ QuickstartApi - functional programming interface | Name | Type | | :------ | :------ | -| `quickstartsGet` | (`bundle?`: `string`, `application?`: `string`, `limit?`: `number`, `offset?`: `number`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`QuickstartsGet200Response`](interfaces/QuickstartsGet200Response.md)\>\> | -| `quickstartsIdGet` | (`id`: `number`, `options?`: `AxiosRequestConfig`<`any`\>) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`V1Quickstart`](interfaces/V1Quickstart.md)\>\> | +| `quickstartsGet` | (`bundle?`: `string`, `application?`: `string`, `limit?`: `number`, `offset?`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`QuickstartsGet200Response`](interfaces/QuickstartsGet200Response.md)\>\> | +| `quickstartsIdGet` | (`id`: `number`, `options?`: `AxiosRequestConfig`) => `Promise`<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`<[`V1Quickstart`](interfaces/V1Quickstart.md)\>\> | #### Defined in diff --git a/packages/rbac/api.ts b/packages/rbac/api.ts index 6fb8cb5b5..7ec58eeff 100644 --- a/packages/rbac/api.ts +++ b/packages/rbac/api.ts @@ -1782,10 +1782,10 @@ export interface ResourceDefinitionFilter { operation: ResourceDefinitionFilterOperationEnum; /** * - * @type {string} + * @type {string | Array} * @memberof ResourceDefinitionFilter */ - value: string; + value: string | Array; } /** diff --git a/packages/rbac/doc/classes/AccessApi.md b/packages/rbac/doc/classes/AccessApi.md index b806229b1..a70661663 100644 --- a/packages/rbac/doc/classes/AccessApi.md +++ b/packages/rbac/doc/classes/AccessApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### getPrincipalAccess -▸ **getPrincipalAccess**(`application`, `username?`, `orderBy?`, `status?`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`AccessPagination`](../interfaces/AccessPagination.md), `any`\>\> +▸ **getPrincipalAccess**(`application`, `username?`, `orderBy?`, `status?`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`AccessPagination`](../interfaces/AccessPagination.md)\>\> Access responses are sorted in ascending order by an ID internal to the database @@ -124,7 +124,7 @@ AccessApi #### Returns -`Promise`<`AxiosResponse`<[`AccessPagination`](../interfaces/AccessPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AccessPagination`](../interfaces/AccessPagination.md)\>\> #### Defined in diff --git a/packages/rbac/doc/classes/CrossAccountRequestApi.md b/packages/rbac/doc/classes/CrossAccountRequestApi.md index 78fb670a7..a7ac98065 100644 --- a/packages/rbac/doc/classes/CrossAccountRequestApi.md +++ b/packages/rbac/doc/classes/CrossAccountRequestApi.md @@ -100,7 +100,7 @@ BaseAPI.configuration ### createCrossAccountRequests -▸ **createCrossAccountRequests**(`crossAccountRequestIn`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestOut`](../interfaces/CrossAccountRequestOut.md), `any`\>\> +▸ **createCrossAccountRequests**(`crossAccountRequestIn`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestOut`](../interfaces/CrossAccountRequestOut.md)\>\> **`Summary`** @@ -121,7 +121,7 @@ CrossAccountRequestApi #### Returns -`Promise`<`AxiosResponse`<[`CrossAccountRequestOut`](../interfaces/CrossAccountRequestOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`CrossAccountRequestOut`](../interfaces/CrossAccountRequestOut.md)\>\> #### Defined in @@ -131,7 +131,7 @@ ___ ### getCrossAccountRequest -▸ **getCrossAccountRequest**(`uuid`, `queryBy?`, `account?`, `approvedOnly?`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail), `any`\>\> +▸ **getCrossAccountRequest**(`uuid`, `queryBy?`, `account?`, `approvedOnly?`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail)\>\> **`Summary`** @@ -155,7 +155,7 @@ CrossAccountRequestApi #### Returns -`Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail), `any`\>\> +`Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail)\>\> #### Defined in @@ -165,7 +165,7 @@ ___ ### listCrossAccountRequests -▸ **listCrossAccountRequests**(`limit?`, `offset?`, `queryBy?`, `account?`, `orgId?`, `approvedOnly?`, `status?`, `orderBy?`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestPagination`](../interfaces/CrossAccountRequestPagination.md), `any`\>\> +▸ **listCrossAccountRequests**(`limit?`, `offset?`, `queryBy?`, `account?`, `orgId?`, `approvedOnly?`, `status?`, `orderBy?`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestPagination`](../interfaces/CrossAccountRequestPagination.md)\>\> By default, responses are sorted in ascending order by created_at @@ -195,7 +195,7 @@ CrossAccountRequestApi #### Returns -`Promise`<`AxiosResponse`<[`CrossAccountRequestPagination`](../interfaces/CrossAccountRequestPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`CrossAccountRequestPagination`](../interfaces/CrossAccountRequestPagination.md)\>\> #### Defined in @@ -205,7 +205,7 @@ ___ ### patchCrossAccountRequest -▸ **patchCrossAccountRequest**(`uuid`, `crossAccountRequestPatch`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail), `any`\>\> +▸ **patchCrossAccountRequest**(`uuid`, `crossAccountRequestPatch`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail)\>\> Patch the start_date/end_date/roles of an existing request. Could be used by TAM requestor to cancel request or target account admin to approve/deny request. @@ -229,7 +229,7 @@ CrossAccountRequestApi #### Returns -`Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail), `any`\>\> +`Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail)\>\> #### Defined in @@ -239,7 +239,7 @@ ___ ### putCrossAccountRequest -▸ **putCrossAccountRequest**(`uuid`, `crossAccountRequestUpdateIn`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail), `any`\>\> +▸ **putCrossAccountRequest**(`uuid`, `crossAccountRequestUpdateIn`, `options?`): `Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail)\>\> For TAM requestor to update the start_date/end_date/roles of an existing cross account request. @@ -263,7 +263,7 @@ CrossAccountRequestApi #### Returns -`Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail), `any`\>\> +`Promise`<`AxiosResponse`<[`CrossAccountRequestDetail`](../modules.md#crossaccountrequestdetail)\>\> #### Defined in diff --git a/packages/rbac/doc/classes/GroupApi.md b/packages/rbac/doc/classes/GroupApi.md index 9e3758ff8..9f5df0efe 100644 --- a/packages/rbac/doc/classes/GroupApi.md +++ b/packages/rbac/doc/classes/GroupApi.md @@ -106,7 +106,7 @@ BaseAPI.configuration ### addPrincipalToGroup -▸ **addPrincipalToGroup**(`uuid`, `groupPrincipalIn`, `options?`): `Promise`<`AxiosResponse`<[`GroupWithPrincipalsAndRoles`](../interfaces/GroupWithPrincipalsAndRoles.md), `any`\>\> +▸ **addPrincipalToGroup**(`uuid`, `groupPrincipalIn`, `options?`): `Promise`<`AxiosResponse`<[`GroupWithPrincipalsAndRoles`](../interfaces/GroupWithPrincipalsAndRoles.md)\>\> **`Summary`** @@ -128,7 +128,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<[`GroupWithPrincipalsAndRoles`](../interfaces/GroupWithPrincipalsAndRoles.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupWithPrincipalsAndRoles`](../interfaces/GroupWithPrincipalsAndRoles.md)\>\> #### Defined in @@ -138,7 +138,7 @@ ___ ### addRoleToGroup -▸ **addRoleToGroup**(`uuid`, `groupRoleIn`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +▸ **addRoleToGroup**(`uuid`, `groupRoleIn`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> **`Summary`** @@ -160,7 +160,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> #### Defined in @@ -170,7 +170,7 @@ ___ ### createGroup -▸ **createGroup**(`group`, `options?`): `Promise`<`AxiosResponse`<[`GroupOut`](../interfaces/GroupOut.md), `any`\>\> +▸ **createGroup**(`group`, `options?`): `Promise`<`AxiosResponse`<[`GroupOut`](../interfaces/GroupOut.md)\>\> **`Summary`** @@ -191,7 +191,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<[`GroupOut`](../interfaces/GroupOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupOut`](../interfaces/GroupOut.md)\>\> #### Defined in @@ -201,7 +201,7 @@ ___ ### deleteGroup -▸ **deleteGroup**(`uuid`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteGroup**(`uuid`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -222,7 +222,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -232,7 +232,7 @@ ___ ### deletePrincipalFromGroup -▸ **deletePrincipalFromGroup**(`uuid`, `usernames`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deletePrincipalFromGroup**(`uuid`, `usernames`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -254,7 +254,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -264,7 +264,7 @@ ___ ### deleteRoleFromGroup -▸ **deleteRoleFromGroup**(`uuid`, `roles`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteRoleFromGroup**(`uuid`, `roles`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -286,7 +286,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -296,7 +296,7 @@ ___ ### getGroup -▸ **getGroup**(`uuid`, `options?`): `Promise`<`AxiosResponse`<[`GroupWithPrincipalsAndRoles`](../interfaces/GroupWithPrincipalsAndRoles.md), `any`\>\> +▸ **getGroup**(`uuid`, `options?`): `Promise`<`AxiosResponse`<[`GroupWithPrincipalsAndRoles`](../interfaces/GroupWithPrincipalsAndRoles.md)\>\> **`Summary`** @@ -317,7 +317,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<[`GroupWithPrincipalsAndRoles`](../interfaces/GroupWithPrincipalsAndRoles.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupWithPrincipalsAndRoles`](../interfaces/GroupWithPrincipalsAndRoles.md)\>\> #### Defined in @@ -327,7 +327,7 @@ ___ ### getPrincipalsFromGroup -▸ **getPrincipalsFromGroup**(`uuid`, `adminOnly?`, `principalUsername?`, `limit?`, `offset?`, `orderBy?`, `usernameOnly?`, `principalType?`, `options?`): `Promise`<`AxiosResponse`<[`PrincipalPagination`](../interfaces/PrincipalPagination.md), `any`\>\> +▸ **getPrincipalsFromGroup**(`uuid`, `adminOnly?`, `principalUsername?`, `limit?`, `offset?`, `orderBy?`, `usernameOnly?`, `principalType?`, `options?`): `Promise`<`AxiosResponse`<[`PrincipalPagination`](../interfaces/PrincipalPagination.md)\>\> By default, responses are sorted in ascending order by username @@ -357,7 +357,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<[`PrincipalPagination`](../interfaces/PrincipalPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PrincipalPagination`](../interfaces/PrincipalPagination.md)\>\> #### Defined in @@ -367,7 +367,7 @@ ___ ### listGroups -▸ **listGroups**(`limit?`, `offset?`, `name?`, `nameMatch?`, `scope?`, `username?`, `excludeUsername?`, `uuid?`, `roleNames?`, `roleDiscriminator?`, `orderBy?`, `platformDefault?`, `adminDefault?`, `system?`, `options?`): `Promise`<`AxiosResponse`<[`GroupPagination`](../interfaces/GroupPagination.md), `any`\>\> +▸ **listGroups**(`limit?`, `offset?`, `name?`, `nameMatch?`, `scope?`, `username?`, `excludeUsername?`, `uuid?`, `roleNames?`, `roleDiscriminator?`, `orderBy?`, `platformDefault?`, `adminDefault?`, `system?`, `options?`): `Promise`<`AxiosResponse`<[`GroupPagination`](../interfaces/GroupPagination.md)\>\> By default, responses are sorted in ascending order by group name @@ -403,7 +403,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<[`GroupPagination`](../interfaces/GroupPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupPagination`](../interfaces/GroupPagination.md)\>\> #### Defined in @@ -413,7 +413,7 @@ ___ ### listRolesForGroup -▸ **listRolesForGroup**(`uuid`, `exclude?`, `roleName?`, `roleDisplayName?`, `roleDescription?`, `roleSystem?`, `roleExternalTenant?`, `limit?`, `offset?`, `orderBy?`, `options?`): `Promise`<`AxiosResponse`<[`GroupRolesPagination`](../interfaces/GroupRolesPagination.md), `any`\>\> +▸ **listRolesForGroup**(`uuid`, `exclude?`, `roleName?`, `roleDisplayName?`, `roleDescription?`, `roleSystem?`, `roleExternalTenant?`, `limit?`, `offset?`, `orderBy?`, `options?`): `Promise`<`AxiosResponse`<[`GroupRolesPagination`](../interfaces/GroupRolesPagination.md)\>\> By default, responses are sorted in ascending order by role name @@ -445,7 +445,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<[`GroupRolesPagination`](../interfaces/GroupRolesPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupRolesPagination`](../interfaces/GroupRolesPagination.md)\>\> #### Defined in @@ -455,7 +455,7 @@ ___ ### updateGroup -▸ **updateGroup**(`uuid`, `group`, `options?`): `Promise`<`AxiosResponse`<[`GroupOut`](../interfaces/GroupOut.md), `any`\>\> +▸ **updateGroup**(`uuid`, `group`, `options?`): `Promise`<`AxiosResponse`<[`GroupOut`](../interfaces/GroupOut.md)\>\> **`Summary`** @@ -477,7 +477,7 @@ GroupApi #### Returns -`Promise`<`AxiosResponse`<[`GroupOut`](../interfaces/GroupOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GroupOut`](../interfaces/GroupOut.md)\>\> #### Defined in diff --git a/packages/rbac/doc/classes/PermissionApi.md b/packages/rbac/doc/classes/PermissionApi.md index 685713c60..e109968af 100644 --- a/packages/rbac/doc/classes/PermissionApi.md +++ b/packages/rbac/doc/classes/PermissionApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### listPermissionOptions -▸ **listPermissionOptions**(`field`, `limit?`, `offset?`, `application?`, `resourceType?`, `verb?`, `excludeGlobals?`, `allowedOnly?`, `options?`): `Promise`<`AxiosResponse`<[`PermissionOptionsPagination`](../interfaces/PermissionOptionsPagination.md), `any`\>\> +▸ **listPermissionOptions**(`field`, `limit?`, `offset?`, `application?`, `resourceType?`, `verb?`, `excludeGlobals?`, `allowedOnly?`, `options?`): `Promise`<`AxiosResponse`<[`PermissionOptionsPagination`](../interfaces/PermissionOptionsPagination.md)\>\> By default, options of application is returned. And could be resource_type or verb on demand. @@ -127,7 +127,7 @@ PermissionApi #### Returns -`Promise`<`AxiosResponse`<[`PermissionOptionsPagination`](../interfaces/PermissionOptionsPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PermissionOptionsPagination`](../interfaces/PermissionOptionsPagination.md)\>\> #### Defined in @@ -137,7 +137,7 @@ ___ ### listPermissions -▸ **listPermissions**(`limit?`, `offset?`, `orderBy?`, `application?`, `resourceType?`, `verb?`, `permission?`, `excludeGlobals?`, `excludeRoles?`, `allowedOnly?`, `options?`): `Promise`<`AxiosResponse`<[`PermissionPagination`](../interfaces/PermissionPagination.md), `any`\>\> +▸ **listPermissions**(`limit?`, `offset?`, `orderBy?`, `application?`, `resourceType?`, `verb?`, `permission?`, `excludeGlobals?`, `excludeRoles?`, `allowedOnly?`, `options?`): `Promise`<`AxiosResponse`<[`PermissionPagination`](../interfaces/PermissionPagination.md)\>\> By default, responses are sorted in ascending order by permission application. @@ -169,7 +169,7 @@ PermissionApi #### Returns -`Promise`<`AxiosResponse`<[`PermissionPagination`](../interfaces/PermissionPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PermissionPagination`](../interfaces/PermissionPagination.md)\>\> #### Defined in diff --git a/packages/rbac/doc/classes/PolicyApi.md b/packages/rbac/doc/classes/PolicyApi.md index a160904cb..13be922a3 100644 --- a/packages/rbac/doc/classes/PolicyApi.md +++ b/packages/rbac/doc/classes/PolicyApi.md @@ -100,7 +100,7 @@ BaseAPI.configuration ### createPolicies -▸ **createPolicies**(`policyIn`, `options?`): `Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md), `any`\>\> +▸ **createPolicies**(`policyIn`, `options?`): `Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md)\>\> **`Summary`** @@ -121,7 +121,7 @@ PolicyApi #### Returns -`Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md)\>\> #### Defined in @@ -131,7 +131,7 @@ ___ ### deletePolicy -▸ **deletePolicy**(`uuid`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deletePolicy**(`uuid`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -152,7 +152,7 @@ PolicyApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -162,7 +162,7 @@ ___ ### getPolicy -▸ **getPolicy**(`uuid`, `options?`): `Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md), `any`\>\> +▸ **getPolicy**(`uuid`, `options?`): `Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md)\>\> **`Summary`** @@ -183,7 +183,7 @@ PolicyApi #### Returns -`Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md)\>\> #### Defined in @@ -193,7 +193,7 @@ ___ ### listPolicies -▸ **listPolicies**(`limit?`, `offset?`, `name?`, `scope?`, `groupName?`, `groupUuid?`, `orderBy?`, `options?`): `Promise`<`AxiosResponse`<[`PolicyPagination`](../interfaces/PolicyPagination.md), `any`\>\> +▸ **listPolicies**(`limit?`, `offset?`, `name?`, `scope?`, `groupName?`, `groupUuid?`, `orderBy?`, `options?`): `Promise`<`AxiosResponse`<[`PolicyPagination`](../interfaces/PolicyPagination.md)\>\> By default, responses are sorted in ascending order by policy name @@ -222,7 +222,7 @@ PolicyApi #### Returns -`Promise`<`AxiosResponse`<[`PolicyPagination`](../interfaces/PolicyPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PolicyPagination`](../interfaces/PolicyPagination.md)\>\> #### Defined in @@ -232,7 +232,7 @@ ___ ### updatePolicy -▸ **updatePolicy**(`uuid`, `policyIn`, `options?`): `Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md), `any`\>\> +▸ **updatePolicy**(`uuid`, `policyIn`, `options?`): `Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md)\>\> **`Summary`** @@ -254,7 +254,7 @@ PolicyApi #### Returns -`Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PolicyExtended`](../interfaces/PolicyExtended.md)\>\> #### Defined in diff --git a/packages/rbac/doc/classes/PrincipalApi.md b/packages/rbac/doc/classes/PrincipalApi.md index 42bc9b123..d53773ab9 100644 --- a/packages/rbac/doc/classes/PrincipalApi.md +++ b/packages/rbac/doc/classes/PrincipalApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### listPrincipals -▸ **listPrincipals**(`limit?`, `offset?`, `matchCriteria?`, `usernames?`, `sortOrder?`, `email?`, `status?`, `adminOnly?`, `orderBy?`, `usernameOnly?`, `type?`, `options?`): `Promise`<`AxiosResponse`<[`PrincipalPagination`](../interfaces/PrincipalPagination.md), `any`\>\> +▸ **listPrincipals**(`limit?`, `offset?`, `matchCriteria?`, `usernames?`, `sortOrder?`, `email?`, `status?`, `adminOnly?`, `orderBy?`, `usernameOnly?`, `type?`, `options?`): `Promise`<`AxiosResponse`<[`PrincipalPagination`](../interfaces/PrincipalPagination.md)\>\> By default, responses are sorted in ascending order by username @@ -129,7 +129,7 @@ PrincipalApi #### Returns -`Promise`<`AxiosResponse`<[`PrincipalPagination`](../interfaces/PrincipalPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PrincipalPagination`](../interfaces/PrincipalPagination.md)\>\> #### Defined in diff --git a/packages/rbac/doc/classes/RoleApi.md b/packages/rbac/doc/classes/RoleApi.md index 7717476bb..569ff8605 100644 --- a/packages/rbac/doc/classes/RoleApi.md +++ b/packages/rbac/doc/classes/RoleApi.md @@ -102,7 +102,7 @@ BaseAPI.configuration ### createRole -▸ **createRole**(`roleIn`, `options?`): `Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md), `any`\>\> +▸ **createRole**(`roleIn`, `options?`): `Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md)\>\> **`Summary`** @@ -123,7 +123,7 @@ RoleApi #### Returns -`Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md)\>\> #### Defined in @@ -133,7 +133,7 @@ ___ ### deleteRole -▸ **deleteRole**(`uuid`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteRole**(`uuid`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -154,7 +154,7 @@ RoleApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -164,7 +164,7 @@ ___ ### getRole -▸ **getRole**(`uuid`, `scope?`, `options?`): `Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md), `any`\>\> +▸ **getRole**(`uuid`, `scope?`, `options?`): `Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md)\>\> **`Summary`** @@ -186,7 +186,7 @@ RoleApi #### Returns -`Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md)\>\> #### Defined in @@ -196,7 +196,7 @@ ___ ### getRoleAccess -▸ **getRoleAccess**(`uuid`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`AccessPagination`](../interfaces/AccessPagination.md), `any`\>\> +▸ **getRoleAccess**(`uuid`, `limit?`, `offset?`, `options?`): `Promise`<`AxiosResponse`<[`AccessPagination`](../interfaces/AccessPagination.md)\>\> **`Summary`** @@ -219,7 +219,7 @@ RoleApi #### Returns -`Promise`<`AxiosResponse`<[`AccessPagination`](../interfaces/AccessPagination.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AccessPagination`](../interfaces/AccessPagination.md)\>\> #### Defined in @@ -229,7 +229,7 @@ ___ ### listRoles -▸ **listRoles**(`limit?`, `offset?`, `name?`, `system?`, `displayName?`, `nameMatch?`, `scope?`, `orderBy?`, `addFields?`, `username?`, `application?`, `permission?`, `externalTenant?`, `options?`): `Promise`<`AxiosResponse`<[`RolePaginationDynamic`](../interfaces/RolePaginationDynamic.md), `any`\>\> +▸ **listRoles**(`limit?`, `offset?`, `name?`, `system?`, `displayName?`, `nameMatch?`, `scope?`, `orderBy?`, `addFields?`, `username?`, `application?`, `permission?`, `externalTenant?`, `options?`): `Promise`<`AxiosResponse`<[`RolePaginationDynamic`](../interfaces/RolePaginationDynamic.md)\>\> By default, responses are sorted in ascending order by role name @@ -264,7 +264,7 @@ RoleApi #### Returns -`Promise`<`AxiosResponse`<[`RolePaginationDynamic`](../interfaces/RolePaginationDynamic.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RolePaginationDynamic`](../interfaces/RolePaginationDynamic.md)\>\> #### Defined in @@ -274,7 +274,7 @@ ___ ### patchRole -▸ **patchRole**(`uuid`, `rolePatch?`, `options?`): `Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md), `any`\>\> +▸ **patchRole**(`uuid`, `rolePatch?`, `options?`): `Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md)\>\> **`Summary`** @@ -296,7 +296,7 @@ RoleApi #### Returns -`Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RoleWithAccess`](../interfaces/RoleWithAccess.md)\>\> #### Defined in @@ -306,7 +306,7 @@ ___ ### updateRole -▸ **updateRole**(`uuid`, `roleWithAccess`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **updateRole**(`uuid`, `roleWithAccess`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> **`Summary`** @@ -328,7 +328,7 @@ RoleApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/rbac/doc/classes/StatusApi.md b/packages/rbac/doc/classes/StatusApi.md index 790e355a1..781691555 100644 --- a/packages/rbac/doc/classes/StatusApi.md +++ b/packages/rbac/doc/classes/StatusApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### getStatus -▸ **getStatus**(`options?`): `Promise`<`AxiosResponse`<[`Status`](../interfaces/Status.md), `any`\>\> +▸ **getStatus**(`options?`): `Promise`<`AxiosResponse`<[`Status`](../interfaces/Status.md)\>\> **`Summary`** @@ -116,7 +116,7 @@ StatusApi #### Returns -`Promise`<`AxiosResponse`<[`Status`](../interfaces/Status.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Status`](../interfaces/Status.md)\>\> #### Defined in diff --git a/packages/rbac/doc/interfaces/ResourceDefinitionFilter.md b/packages/rbac/doc/interfaces/ResourceDefinitionFilter.md index cc4562658..eefe13dce 100644 --- a/packages/rbac/doc/interfaces/ResourceDefinitionFilter.md +++ b/packages/rbac/doc/interfaces/ResourceDefinitionFilter.md @@ -48,7 +48,7 @@ ___ ### value -• **value**: `string` +• **value**: `string` \| `string`[] **`Memberof`** diff --git a/packages/remediations/doc/classes/DiagnosisApi.md b/packages/remediations/doc/classes/DiagnosisApi.md index 3132b2399..b45a871b5 100644 --- a/packages/remediations/doc/classes/DiagnosisApi.md +++ b/packages/remediations/doc/classes/DiagnosisApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### getDiagnosis -▸ **getDiagnosis**(`system`, `remediation?`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<[`Diagnosis`](../interfaces/Diagnosis.md), `any`\>\> +▸ **getDiagnosis**(`system`, `remediation?`, `branchId?`, `options?`): `Promise`<`AxiosResponse`<[`Diagnosis`](../interfaces/Diagnosis.md)\>\> Provides host-specific diagnosis information @@ -121,7 +121,7 @@ DiagnosisApi #### Returns -`Promise`<`AxiosResponse`<[`Diagnosis`](../interfaces/Diagnosis.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Diagnosis`](../interfaces/Diagnosis.md)\>\> #### Defined in diff --git a/packages/remediations/doc/classes/GeneratorApi.md b/packages/remediations/doc/classes/GeneratorApi.md index ea57f05e6..1231cd820 100644 --- a/packages/remediations/doc/classes/GeneratorApi.md +++ b/packages/remediations/doc/classes/GeneratorApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### generate -▸ **generate**(`playbookDefinition`, `options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> +▸ **generate**(`playbookDefinition`, `options?`): `Promise`<`AxiosResponse`<`string`\>\> Generates an Ansible Playbook based on input parameters @@ -119,7 +119,7 @@ GeneratorApi #### Returns -`Promise`<`AxiosResponse`<`string`, `any`\>\> +`Promise`<`AxiosResponse`<`string`\>\> #### Defined in diff --git a/packages/remediations/doc/classes/RemediationsApi.md b/packages/remediations/doc/classes/RemediationsApi.md index c2b8c48fc..4bec8cc9c 100644 --- a/packages/remediations/doc/classes/RemediationsApi.md +++ b/packages/remediations/doc/classes/RemediationsApi.md @@ -115,7 +115,7 @@ BaseAPI.configuration ### cancelPlaybookRuns -▸ **cancelPlaybookRuns**(`id`, `playbookRunId`, `options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\> +▸ **cancelPlaybookRuns**(`id`, `playbookRunId`, `options?`): `Promise`<`AxiosResponse`<`object`\>\> Cancel execution of the remediation @@ -139,7 +139,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<`object`, `any`\>\> +`Promise`<`AxiosResponse`<`object`\>\> #### Defined in @@ -149,7 +149,7 @@ ___ ### checkExecutable -▸ **checkExecutable**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **checkExecutable**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Checks remediation for the existence of smart_managment flaged systems @@ -172,7 +172,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -182,7 +182,7 @@ ___ ### createRemediation -▸ **createRemediation**(`remediationInput`, `options?`): `Promise`<`AxiosResponse`<[`RemediationCreated`](../interfaces/RemediationCreated.md), `any`\>\> +▸ **createRemediation**(`remediationInput`, `options?`): `Promise`<`AxiosResponse`<[`RemediationCreated`](../interfaces/RemediationCreated.md)\>\> Creates a new Remediation based on given information, RBAC permission {remediations:remediation:write} @@ -205,7 +205,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`RemediationCreated`](../interfaces/RemediationCreated.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RemediationCreated`](../interfaces/RemediationCreated.md)\>\> #### Defined in @@ -215,7 +215,7 @@ ___ ### deleteRemediation -▸ **deleteRemediation**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteRemediation**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Removes the given Remediation, RBAC permission {remediations:remediation:write} @@ -238,7 +238,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -248,7 +248,7 @@ ___ ### deleteRemediationIssue -▸ **deleteRemediationIssue**(`id`, `issue`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteRemediationIssue**(`id`, `issue`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Removes the given Issue from the Remediation, RBAC permission {remediations:remediation:write} @@ -272,7 +272,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -282,7 +282,7 @@ ___ ### deleteRemediationIssueSystem -▸ **deleteRemediationIssueSystem**(`id`, `issue`, `system`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteRemediationIssueSystem**(`id`, `issue`, `system`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Removes the given System from the Issue Remediation, RBAC permission {remediations:remediation:write} @@ -307,7 +307,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -317,7 +317,7 @@ ___ ### deleteRemediations -▸ **deleteRemediations**(`remediationsList`, `options?`): `Promise`<`AxiosResponse`<[`MultipleDelete`](../interfaces/MultipleDelete.md), `any`\>\> +▸ **deleteRemediations**(`remediationsList`, `options?`): `Promise`<`AxiosResponse`<[`MultipleDelete`](../interfaces/MultipleDelete.md)\>\> Removes the given list of Remediations. Requests containing malformed remediation IDs are rejected. Duplicate or missing IDs are ignored. RBAC permission {remediations:remediation:write} @@ -340,7 +340,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`MultipleDelete`](../interfaces/MultipleDelete.md), `any`\>\> +`Promise`<`AxiosResponse`<[`MultipleDelete`](../interfaces/MultipleDelete.md)\>\> #### Defined in @@ -350,7 +350,7 @@ ___ ### downloadPlaybooks -▸ **downloadPlaybooks**(`selectedRemediations?`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> +▸ **downloadPlaybooks**(`selectedRemediations?`, `options?`): `Promise`<`AxiosResponse`<`any`\>\> Downloads a zip file containing selected Remediations, RBAC permission {remediations:remediation:read} @@ -373,7 +373,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<`any`, `any`\>\> +`Promise`<`AxiosResponse`<`any`\>\> #### Defined in @@ -383,7 +383,7 @@ ___ ### getPlaybookRunDetails -▸ **getPlaybookRunDetails**(`id`, `playbookRunId`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookRunExecutorDetails`](../interfaces/PlaybookRunExecutorDetails.md), `any`\>\> +▸ **getPlaybookRunDetails**(`id`, `playbookRunId`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookRunExecutorDetails`](../interfaces/PlaybookRunExecutorDetails.md)\>\> Get details on execution of the remediation @@ -407,7 +407,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`PlaybookRunExecutorDetails`](../interfaces/PlaybookRunExecutorDetails.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PlaybookRunExecutorDetails`](../interfaces/PlaybookRunExecutorDetails.md)\>\> #### Defined in @@ -417,7 +417,7 @@ ___ ### getPlaybookRunSystemDetails -▸ **getPlaybookRunSystemDetails**(`id`, `playbookRunId`, `system`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookRunSystemDetails`](../interfaces/PlaybookRunSystemDetails.md), `any`\>\> +▸ **getPlaybookRunSystemDetails**(`id`, `playbookRunId`, `system`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookRunSystemDetails`](../interfaces/PlaybookRunSystemDetails.md)\>\> Get details and updated log of system being executed on in specific playbook run @@ -442,7 +442,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`PlaybookRunSystemDetails`](../interfaces/PlaybookRunSystemDetails.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PlaybookRunSystemDetails`](../interfaces/PlaybookRunSystemDetails.md)\>\> #### Defined in @@ -452,7 +452,7 @@ ___ ### getPlaybookRunSystems -▸ **getPlaybookRunSystems**(`id`, `playbookRunId`, `executor?`, `limit?`, `offset?`, `ansibleHost?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookRunSystemList`](../interfaces/PlaybookRunSystemList.md), `any`\>\> +▸ **getPlaybookRunSystems**(`id`, `playbookRunId`, `executor?`, `limit?`, `offset?`, `ansibleHost?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookRunSystemList`](../interfaces/PlaybookRunSystemList.md)\>\> Get details on systems being executed on in specific playbook run @@ -481,7 +481,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`PlaybookRunSystemList`](../interfaces/PlaybookRunSystemList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PlaybookRunSystemList`](../interfaces/PlaybookRunSystemList.md)\>\> #### Defined in @@ -491,7 +491,7 @@ ___ ### getRemediation -▸ **getRemediation**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RemediationDetails`](../interfaces/RemediationDetails.md), `any`\>\> +▸ **getRemediation**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RemediationDetails`](../interfaces/RemediationDetails.md)\>\> Provides information about the given Remediation, RBAC permission {remediations:remediation:read} @@ -514,7 +514,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`RemediationDetails`](../interfaces/RemediationDetails.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RemediationDetails`](../interfaces/RemediationDetails.md)\>\> #### Defined in @@ -524,7 +524,7 @@ ___ ### getRemediationConnectionStatus -▸ **getRemediationConnectionStatus**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RemediationConnectionStatus`](../interfaces/RemediationConnectionStatus.md), `any`\>\> +▸ **getRemediationConnectionStatus**(`id`, `options?`): `Promise`<`AxiosResponse`<[`RemediationConnectionStatus`](../interfaces/RemediationConnectionStatus.md)\>\> Get satellite connection status for a given host, RBAC permission {remediations:remediation:execute} @@ -547,7 +547,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`RemediationConnectionStatus`](../interfaces/RemediationConnectionStatus.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RemediationConnectionStatus`](../interfaces/RemediationConnectionStatus.md)\>\> #### Defined in @@ -557,7 +557,7 @@ ___ ### getRemediationIssueSystems -▸ **getRemediationIssueSystems**(`id`, `issue`, `limit?`, `offset?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`RemediationIssueSystemList`](../interfaces/RemediationIssueSystemList.md), `any`\>\> +▸ **getRemediationIssueSystems**(`id`, `issue`, `limit?`, `offset?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`RemediationIssueSystemList`](../interfaces/RemediationIssueSystemList.md)\>\> Get a paginated list of systems from a given issue, RBAC permission {remediations:remediation:read} @@ -584,7 +584,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`RemediationIssueSystemList`](../interfaces/RemediationIssueSystemList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RemediationIssueSystemList`](../interfaces/RemediationIssueSystemList.md)\>\> #### Defined in @@ -594,7 +594,7 @@ ___ ### getRemediationPlaybook -▸ **getRemediationPlaybook**(`id`, `hosts?`, `satOrg?`, `localhost?`, `options?`): `Promise`<`AxiosResponse`<`string`, `any`\>\> +▸ **getRemediationPlaybook**(`id`, `hosts?`, `satOrg?`, `localhost?`, `options?`): `Promise`<`AxiosResponse`<`string`\>\> Provides Ansible Playbook, RBAC permission {remediations:remediation:read} @@ -620,7 +620,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<`string`, `any`\>\> +`Promise`<`AxiosResponse`<`string`\>\> #### Defined in @@ -630,7 +630,7 @@ ___ ### getRemediations -▸ **getRemediations**(`sort?`, `filter?`, `limit?`, `offset?`, `system?`, `hideArchived?`, `fieldsData?`, `options?`): `Promise`<`AxiosResponse`<[`RemediationList`](../interfaces/RemediationList.md), `any`\>\> +▸ **getRemediations**(`sort?`, `filter?`, `limit?`, `offset?`, `system?`, `hideArchived?`, `fieldsData?`, `options?`): `Promise`<`AxiosResponse`<[`RemediationList`](../interfaces/RemediationList.md)\>\> Provides information about Remediations, RBAC permission {remediations:remediation:read} @@ -659,7 +659,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`RemediationList`](../interfaces/RemediationList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`RemediationList`](../interfaces/RemediationList.md)\>\> #### Defined in @@ -669,7 +669,7 @@ ___ ### listPlaybookRuns -▸ **listPlaybookRuns**(`id`, `limit?`, `offset?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookRunsList`](../interfaces/PlaybookRunsList.md), `any`\>\> +▸ **listPlaybookRuns**(`id`, `limit?`, `offset?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookRunsList`](../interfaces/PlaybookRunsList.md)\>\> List of executions of this remediation @@ -695,7 +695,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`PlaybookRunsList`](../interfaces/PlaybookRunsList.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PlaybookRunsList`](../interfaces/PlaybookRunsList.md)\>\> #### Defined in @@ -705,7 +705,7 @@ ___ ### runRemediation -▸ **runRemediation**(`id`, `playbookRunsInput?`, `options?`): `Promise`<`AxiosResponse`<[`ExecuteRemediation`](../interfaces/ExecuteRemediation.md), `any`\>\> +▸ **runRemediation**(`id`, `playbookRunsInput?`, `options?`): `Promise`<`AxiosResponse`<[`ExecuteRemediation`](../interfaces/ExecuteRemediation.md)\>\> Execute remediation, RBAC permission {remediations:remediation:execute} @@ -729,7 +729,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<[`ExecuteRemediation`](../interfaces/ExecuteRemediation.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ExecuteRemediation`](../interfaces/ExecuteRemediation.md)\>\> #### Defined in @@ -739,7 +739,7 @@ ___ ### updateRemediation -▸ **updateRemediation**(`id`, `remediationInput`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **updateRemediation**(`id`, `remediationInput`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Updates the given Remediation, RBAC permission {remediations:remediation:write} @@ -763,7 +763,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -773,7 +773,7 @@ ___ ### updateRemediationIssue -▸ **updateRemediationIssue**(`id`, `issue`, `remediationIssueIn`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **updateRemediationIssue**(`id`, `issue`, `remediationIssueIn`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Updates the given Remediation Issue, RBAC permission {remediations:remediation:write} @@ -798,7 +798,7 @@ RemediationsApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/remediations/doc/classes/ResolutionsApi.md b/packages/remediations/doc/classes/ResolutionsApi.md index f0a9bacc5..6c07fb347 100644 --- a/packages/remediations/doc/classes/ResolutionsApi.md +++ b/packages/remediations/doc/classes/ResolutionsApi.md @@ -97,7 +97,7 @@ BaseAPI.configuration ### getResolutionsForIssue -▸ **getResolutionsForIssue**(`issue`, `options?`): `Promise`<`AxiosResponse`<[`Resolutions`](../interfaces/Resolutions.md), `any`\>\> +▸ **getResolutionsForIssue**(`issue`, `options?`): `Promise`<`AxiosResponse`<[`Resolutions`](../interfaces/Resolutions.md)\>\> Provides information about resolutions available for the given issue @@ -120,7 +120,7 @@ ResolutionsApi #### Returns -`Promise`<`AxiosResponse`<[`Resolutions`](../interfaces/Resolutions.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Resolutions`](../interfaces/Resolutions.md)\>\> #### Defined in @@ -130,7 +130,7 @@ ___ ### getResolutionsForIssues -▸ **getResolutionsForIssues**(`resolutionsBatchInput`, `options?`): `Promise`<`AxiosResponse`<{ `[key: string]`: [`Resolutions`](../interfaces/Resolutions.md) \| `boolean`; }, `any`\>\> +▸ **getResolutionsForIssues**(`resolutionsBatchInput`, `options?`): `Promise`<`AxiosResponse`<{ `[key: string]`: [`Resolutions`](../interfaces/Resolutions.md) \| `boolean`; }\>\> Provides information about resolutions available for the given issues @@ -153,7 +153,7 @@ ResolutionsApi #### Returns -`Promise`<`AxiosResponse`<{ `[key: string]`: [`Resolutions`](../interfaces/Resolutions.md) \| `boolean`; }, `any`\>\> +`Promise`<`AxiosResponse`<{ `[key: string]`: [`Resolutions`](../interfaces/Resolutions.md) \| `boolean`; }\>\> #### Defined in diff --git a/packages/remediations/doc/classes/VersionApi.md b/packages/remediations/doc/classes/VersionApi.md index 85f7ad160..94ef27c50 100644 --- a/packages/remediations/doc/classes/VersionApi.md +++ b/packages/remediations/doc/classes/VersionApi.md @@ -96,7 +96,7 @@ BaseAPI.configuration ### getVersion -▸ **getVersion**(`options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +▸ **getVersion**(`options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> Provides information about the version of the service @@ -118,7 +118,7 @@ VersionApi #### Returns -`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> #### Defined in diff --git a/packages/sources/doc/classes/DefaultApi.md b/packages/sources/doc/classes/DefaultApi.md index e233afe1b..0172da372 100644 --- a/packages/sources/doc/classes/DefaultApi.md +++ b/packages/sources/doc/classes/DefaultApi.md @@ -129,7 +129,7 @@ BaseAPI.configuration ### checkAvailabilitySource -▸ **checkAvailabilitySource**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **checkAvailabilitySource**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Checks Availability of a Source @@ -152,7 +152,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -162,7 +162,7 @@ ___ ### createApplication -▸ **createApplication**(`application`, `options?`): `Promise`<`AxiosResponse`<[`Application`](../interfaces/Application.md), `any`\>\> +▸ **createApplication**(`application`, `options?`): `Promise`<`AxiosResponse`<[`Application`](../interfaces/Application.md)\>\> Creates a Application object @@ -185,7 +185,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Application`](../interfaces/Application.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Application`](../interfaces/Application.md)\>\> #### Defined in @@ -195,7 +195,7 @@ ___ ### createAuthentication -▸ **createAuthentication**(`authentication`, `options?`): `Promise`<`AxiosResponse`<[`Authentication`](../interfaces/Authentication.md), `any`\>\> +▸ **createAuthentication**(`authentication`, `options?`): `Promise`<`AxiosResponse`<[`Authentication`](../interfaces/Authentication.md)\>\> Creates a Authentication object @@ -218,7 +218,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Authentication`](../interfaces/Authentication.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Authentication`](../interfaces/Authentication.md)\>\> #### Defined in @@ -228,7 +228,7 @@ ___ ### createEndpoint -▸ **createEndpoint**(`endpoint`, `options?`): `Promise`<`AxiosResponse`<[`Endpoint`](../interfaces/Endpoint.md), `any`\>\> +▸ **createEndpoint**(`endpoint`, `options?`): `Promise`<`AxiosResponse`<[`Endpoint`](../interfaces/Endpoint.md)\>\> Creates a Endpoint object @@ -251,7 +251,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Endpoint`](../interfaces/Endpoint.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Endpoint`](../interfaces/Endpoint.md)\>\> #### Defined in @@ -261,7 +261,7 @@ ___ ### createSource -▸ **createSource**(`source`, `options?`): `Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md), `any`\>\> +▸ **createSource**(`source`, `options?`): `Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md)\>\> Creates a Source object @@ -284,7 +284,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md)\>\> #### Defined in @@ -294,7 +294,7 @@ ___ ### deleteApplication -▸ **deleteApplication**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteApplication**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Deletes a Application object @@ -317,7 +317,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -327,7 +327,7 @@ ___ ### deleteAuthentication -▸ **deleteAuthentication**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteAuthentication**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Deletes a Authentication object @@ -350,7 +350,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -360,7 +360,7 @@ ___ ### deleteEndpoint -▸ **deleteEndpoint**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteEndpoint**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Deletes a Endpoint object @@ -383,7 +383,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -393,7 +393,7 @@ ___ ### deleteSource -▸ **deleteSource**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **deleteSource**(`id`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Deletes a Source object @@ -416,7 +416,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -426,7 +426,7 @@ ___ ### getDocumentation -▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\> +▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`\>\> **`Summary`** @@ -446,7 +446,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`object`, `any`\>\> +`Promise`<`AxiosResponse`<`object`\>\> #### Defined in @@ -456,7 +456,7 @@ ___ ### listApplicationTypeSources -▸ **listApplicationTypeSources**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md), `any`\>\> +▸ **listApplicationTypeSources**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md)\>\> Returns an array of Source objects @@ -483,7 +483,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md)\>\> #### Defined in @@ -493,7 +493,7 @@ ___ ### listApplicationTypes -▸ **listApplicationTypes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationTypesCollection`](../interfaces/ApplicationTypesCollection.md), `any`\>\> +▸ **listApplicationTypes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationTypesCollection`](../interfaces/ApplicationTypesCollection.md)\>\> Returns an array of ApplicationType objects @@ -519,7 +519,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ApplicationTypesCollection`](../interfaces/ApplicationTypesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ApplicationTypesCollection`](../interfaces/ApplicationTypesCollection.md)\>\> #### Defined in @@ -529,7 +529,7 @@ ___ ### listApplications -▸ **listApplications**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationsCollection`](../interfaces/ApplicationsCollection.md), `any`\>\> +▸ **listApplications**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationsCollection`](../interfaces/ApplicationsCollection.md)\>\> Returns an array of Application objects @@ -555,7 +555,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ApplicationsCollection`](../interfaces/ApplicationsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ApplicationsCollection`](../interfaces/ApplicationsCollection.md)\>\> #### Defined in @@ -565,7 +565,7 @@ ___ ### listAuthentications -▸ **listAuthentications**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md), `any`\>\> +▸ **listAuthentications**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md)\>\> Returns an array of Authentication objects @@ -591,7 +591,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md)\>\> #### Defined in @@ -601,7 +601,7 @@ ___ ### listEndpointAuthentications -▸ **listEndpointAuthentications**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md), `any`\>\> +▸ **listEndpointAuthentications**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md)\>\> Returns an array of Authentication objects @@ -628,7 +628,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md)\>\> #### Defined in @@ -638,7 +638,7 @@ ___ ### listEndpoints -▸ **listEndpoints**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`EndpointsCollection`](../interfaces/EndpointsCollection.md), `any`\>\> +▸ **listEndpoints**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`EndpointsCollection`](../interfaces/EndpointsCollection.md)\>\> Returns an array of Endpoint objects @@ -664,7 +664,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`EndpointsCollection`](../interfaces/EndpointsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`EndpointsCollection`](../interfaces/EndpointsCollection.md)\>\> #### Defined in @@ -674,7 +674,7 @@ ___ ### listSourceApplicationTypes -▸ **listSourceApplicationTypes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationTypesCollection`](../interfaces/ApplicationTypesCollection.md), `any`\>\> +▸ **listSourceApplicationTypes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationTypesCollection`](../interfaces/ApplicationTypesCollection.md)\>\> Returns an array of ApplicationType objects @@ -701,7 +701,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ApplicationTypesCollection`](../interfaces/ApplicationTypesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ApplicationTypesCollection`](../interfaces/ApplicationTypesCollection.md)\>\> #### Defined in @@ -711,7 +711,7 @@ ___ ### listSourceApplications -▸ **listSourceApplications**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationsCollection`](../interfaces/ApplicationsCollection.md), `any`\>\> +▸ **listSourceApplications**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationsCollection`](../interfaces/ApplicationsCollection.md)\>\> Returns an array of Application objects @@ -738,7 +738,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ApplicationsCollection`](../interfaces/ApplicationsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ApplicationsCollection`](../interfaces/ApplicationsCollection.md)\>\> #### Defined in @@ -748,7 +748,7 @@ ___ ### listSourceAuthentications -▸ **listSourceAuthentications**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md), `any`\>\> +▸ **listSourceAuthentications**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md)\>\> Returns an array of Authentication objects @@ -775,7 +775,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AuthenticationsCollection`](../interfaces/AuthenticationsCollection.md)\>\> #### Defined in @@ -785,7 +785,7 @@ ___ ### listSourceEndpoints -▸ **listSourceEndpoints**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`EndpointsCollection`](../interfaces/EndpointsCollection.md), `any`\>\> +▸ **listSourceEndpoints**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`EndpointsCollection`](../interfaces/EndpointsCollection.md)\>\> Returns an array of Endpoint objects @@ -812,7 +812,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`EndpointsCollection`](../interfaces/EndpointsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`EndpointsCollection`](../interfaces/EndpointsCollection.md)\>\> #### Defined in @@ -822,7 +822,7 @@ ___ ### listSourceTypeSources -▸ **listSourceTypeSources**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md), `any`\>\> +▸ **listSourceTypeSources**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md)\>\> Returns an array of Source objects @@ -849,7 +849,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md)\>\> #### Defined in @@ -859,7 +859,7 @@ ___ ### listSourceTypes -▸ **listSourceTypes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourceTypesCollection`](../interfaces/SourceTypesCollection.md), `any`\>\> +▸ **listSourceTypes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourceTypesCollection`](../interfaces/SourceTypesCollection.md)\>\> Returns an array of SourceType objects @@ -885,7 +885,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SourceTypesCollection`](../interfaces/SourceTypesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SourceTypesCollection`](../interfaces/SourceTypesCollection.md)\>\> #### Defined in @@ -895,7 +895,7 @@ ___ ### listSources -▸ **listSources**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md), `any`\>\> +▸ **listSources**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md)\>\> Returns an array of Source objects @@ -921,7 +921,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md)\>\> #### Defined in @@ -931,7 +931,7 @@ ___ ### postGraphQL -▸ **postGraphQL**(`graphQLRequest`, `options?`): `Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md), `any`\>\> +▸ **postGraphQL**(`graphQLRequest`, `options?`): `Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md)\>\> Performs a GraphQL Query @@ -954,7 +954,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md)\>\> #### Defined in @@ -964,7 +964,7 @@ ___ ### showApplication -▸ **showApplication**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Application`](../interfaces/Application.md), `any`\>\> +▸ **showApplication**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Application`](../interfaces/Application.md)\>\> Returns a Application object @@ -987,7 +987,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Application`](../interfaces/Application.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Application`](../interfaces/Application.md)\>\> #### Defined in @@ -997,7 +997,7 @@ ___ ### showApplicationType -▸ **showApplicationType**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationType`](../interfaces/ApplicationType.md), `any`\>\> +▸ **showApplicationType**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ApplicationType`](../interfaces/ApplicationType.md)\>\> Returns a ApplicationType object @@ -1020,7 +1020,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ApplicationType`](../interfaces/ApplicationType.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ApplicationType`](../interfaces/ApplicationType.md)\>\> #### Defined in @@ -1030,7 +1030,7 @@ ___ ### showAuthentication -▸ **showAuthentication**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Authentication`](../interfaces/Authentication.md), `any`\>\> +▸ **showAuthentication**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Authentication`](../interfaces/Authentication.md)\>\> Returns a Authentication object @@ -1053,7 +1053,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Authentication`](../interfaces/Authentication.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Authentication`](../interfaces/Authentication.md)\>\> #### Defined in @@ -1063,7 +1063,7 @@ ___ ### showEndpoint -▸ **showEndpoint**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Endpoint`](../interfaces/Endpoint.md), `any`\>\> +▸ **showEndpoint**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Endpoint`](../interfaces/Endpoint.md)\>\> Returns a Endpoint object @@ -1086,7 +1086,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Endpoint`](../interfaces/Endpoint.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Endpoint`](../interfaces/Endpoint.md)\>\> #### Defined in @@ -1096,7 +1096,7 @@ ___ ### showSource -▸ **showSource**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md), `any`\>\> +▸ **showSource**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md)\>\> Returns a Source object @@ -1119,7 +1119,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md)\>\> #### Defined in @@ -1129,7 +1129,7 @@ ___ ### showSourceType -▸ **showSourceType**(`id`, `options?`): `Promise`<`AxiosResponse`<[`SourceType`](../interfaces/SourceType.md), `any`\>\> +▸ **showSourceType**(`id`, `options?`): `Promise`<`AxiosResponse`<[`SourceType`](../interfaces/SourceType.md)\>\> Returns a SourceType object @@ -1152,7 +1152,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SourceType`](../interfaces/SourceType.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SourceType`](../interfaces/SourceType.md)\>\> #### Defined in @@ -1162,7 +1162,7 @@ ___ ### updateApplication -▸ **updateApplication**(`id`, `application`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **updateApplication**(`id`, `application`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Updates a Application object @@ -1186,7 +1186,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -1196,7 +1196,7 @@ ___ ### updateAuthentication -▸ **updateAuthentication**(`id`, `authentication`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **updateAuthentication**(`id`, `authentication`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Updates a Authentication object @@ -1220,7 +1220,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -1230,7 +1230,7 @@ ___ ### updateEndpoint -▸ **updateEndpoint**(`id`, `endpoint`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **updateEndpoint**(`id`, `endpoint`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Updates a Endpoint object @@ -1254,7 +1254,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -1264,7 +1264,7 @@ ___ ### updateSource -▸ **updateSource**(`id`, `source`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **updateSource**(`id`, `source`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Updates a Source object @@ -1288,7 +1288,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/topological-inventory/doc/classes/DefaultApi.md b/packages/topological-inventory/doc/classes/DefaultApi.md index fb3e3d186..771573c6a 100644 --- a/packages/topological-inventory/doc/classes/DefaultApi.md +++ b/packages/topological-inventory/doc/classes/DefaultApi.md @@ -272,7 +272,7 @@ BaseAPI.configuration ### appliedInventoriesForServiceOffering -▸ **appliedInventoriesForServiceOffering**(`id`, `appliedInventoriesParametersServicePlan`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +▸ **appliedInventoriesForServiceOffering**(`id`, `appliedInventoriesParametersServicePlan`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> Returns a Task id @@ -296,7 +296,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> #### Defined in @@ -306,7 +306,7 @@ ___ ### getDocumentation -▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`, `any`\>\> +▸ **getDocumentation**(`options?`): `Promise`<`AxiosResponse`<`object`\>\> **`Summary`** @@ -326,7 +326,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`object`, `any`\>\> +`Promise`<`AxiosResponse`<`object`\>\> #### Defined in @@ -336,7 +336,7 @@ ___ ### listClusterHosts -▸ **listClusterHosts**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md), `any`\>\> +▸ **listClusterHosts**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md)\>\> Returns an array of Host objects @@ -363,7 +363,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md)\>\> #### Defined in @@ -373,7 +373,7 @@ ___ ### listClusters -▸ **listClusters**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ClustersCollection`](../interfaces/ClustersCollection.md), `any`\>\> +▸ **listClusters**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ClustersCollection`](../interfaces/ClustersCollection.md)\>\> Returns an array of Cluster objects @@ -399,7 +399,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ClustersCollection`](../interfaces/ClustersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ClustersCollection`](../interfaces/ClustersCollection.md)\>\> #### Defined in @@ -409,7 +409,7 @@ ___ ### listContainerGroupContainers -▸ **listContainerGroupContainers**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md), `any`\>\> +▸ **listContainerGroupContainers**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md)\>\> Returns an array of Container objects @@ -436,7 +436,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md)\>\> #### Defined in @@ -446,7 +446,7 @@ ___ ### listContainerGroupTags -▸ **listContainerGroupTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listContainerGroupTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -473,7 +473,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -483,7 +483,7 @@ ___ ### listContainerGroups -▸ **listContainerGroups**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +▸ **listContainerGroups**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> Returns an array of ContainerGroup objects @@ -509,7 +509,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> #### Defined in @@ -519,7 +519,7 @@ ___ ### listContainerImageTags -▸ **listContainerImageTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listContainerImageTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -546,7 +546,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -556,7 +556,7 @@ ___ ### listContainerImages -▸ **listContainerImages**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md), `any`\>\> +▸ **listContainerImages**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md)\>\> Returns an array of ContainerImage objects @@ -582,7 +582,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md)\>\> #### Defined in @@ -592,7 +592,7 @@ ___ ### listContainerNodeContainerGroups -▸ **listContainerNodeContainerGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +▸ **listContainerNodeContainerGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> Returns an array of ContainerGroup objects @@ -619,7 +619,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> #### Defined in @@ -629,7 +629,7 @@ ___ ### listContainerNodeTags -▸ **listContainerNodeTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listContainerNodeTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -656,7 +656,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -666,7 +666,7 @@ ___ ### listContainerNodes -▸ **listContainerNodes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md), `any`\>\> +▸ **listContainerNodes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md)\>\> Returns an array of ContainerNode objects @@ -692,7 +692,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md)\>\> #### Defined in @@ -702,7 +702,7 @@ ___ ### listContainerProjectContainerGroups -▸ **listContainerProjectContainerGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +▸ **listContainerProjectContainerGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> Returns an array of ContainerGroup objects @@ -729,7 +729,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> #### Defined in @@ -739,7 +739,7 @@ ___ ### listContainerProjectContainerResourceQuota -▸ **listContainerProjectContainerResourceQuota**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerResourceQuotaCollection`](../interfaces/ContainerResourceQuotaCollection.md), `any`\>\> +▸ **listContainerProjectContainerResourceQuota**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerResourceQuotaCollection`](../interfaces/ContainerResourceQuotaCollection.md)\>\> Returns an array of ContainerResourceQuota objects @@ -766,7 +766,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerResourceQuotaCollection`](../interfaces/ContainerResourceQuotaCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerResourceQuotaCollection`](../interfaces/ContainerResourceQuotaCollection.md)\>\> #### Defined in @@ -776,7 +776,7 @@ ___ ### listContainerProjectContainerTemplates -▸ **listContainerProjectContainerTemplates**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md), `any`\>\> +▸ **listContainerProjectContainerTemplates**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md)\>\> Returns an array of ContainerTemplate objects @@ -803,7 +803,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md)\>\> #### Defined in @@ -813,7 +813,7 @@ ___ ### listContainerProjectTags -▸ **listContainerProjectTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listContainerProjectTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -840,7 +840,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -850,7 +850,7 @@ ___ ### listContainerProjects -▸ **listContainerProjects**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md), `any`\>\> +▸ **listContainerProjects**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md)\>\> Returns an array of ContainerProject objects @@ -876,7 +876,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md)\>\> #### Defined in @@ -886,7 +886,7 @@ ___ ### listContainerResourceQuota -▸ **listContainerResourceQuota**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerResourceQuotaCollection`](../interfaces/ContainerResourceQuotaCollection.md), `any`\>\> +▸ **listContainerResourceQuota**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerResourceQuotaCollection`](../interfaces/ContainerResourceQuotaCollection.md)\>\> Returns an array of ContainerResourceQuota objects @@ -912,7 +912,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerResourceQuotaCollection`](../interfaces/ContainerResourceQuotaCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerResourceQuotaCollection`](../interfaces/ContainerResourceQuotaCollection.md)\>\> #### Defined in @@ -922,7 +922,7 @@ ___ ### listContainerTemplateTags -▸ **listContainerTemplateTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listContainerTemplateTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -949,7 +949,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -959,7 +959,7 @@ ___ ### listContainerTemplates -▸ **listContainerTemplates**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md), `any`\>\> +▸ **listContainerTemplates**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md)\>\> Returns an array of ContainerTemplate objects @@ -985,7 +985,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md)\>\> #### Defined in @@ -995,7 +995,7 @@ ___ ### listContainers -▸ **listContainers**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md), `any`\>\> +▸ **listContainers**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md)\>\> Returns an array of Container objects @@ -1021,7 +1021,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md)\>\> #### Defined in @@ -1031,7 +1031,7 @@ ___ ### listDatastores -▸ **listDatastores**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`DatastoresCollection`](../interfaces/DatastoresCollection.md), `any`\>\> +▸ **listDatastores**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`DatastoresCollection`](../interfaces/DatastoresCollection.md)\>\> Returns an array of Datastore objects @@ -1057,7 +1057,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`DatastoresCollection`](../interfaces/DatastoresCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`DatastoresCollection`](../interfaces/DatastoresCollection.md)\>\> #### Defined in @@ -1067,7 +1067,7 @@ ___ ### listFlavors -▸ **listFlavors**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`FlavorsCollection`](../interfaces/FlavorsCollection.md), `any`\>\> +▸ **listFlavors**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`FlavorsCollection`](../interfaces/FlavorsCollection.md)\>\> Returns an array of Flavor objects @@ -1093,7 +1093,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`FlavorsCollection`](../interfaces/FlavorsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`FlavorsCollection`](../interfaces/FlavorsCollection.md)\>\> #### Defined in @@ -1103,7 +1103,7 @@ ___ ### listHosts -▸ **listHosts**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md), `any`\>\> +▸ **listHosts**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md)\>\> Returns an array of Host objects @@ -1129,7 +1129,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md)\>\> #### Defined in @@ -1139,7 +1139,7 @@ ___ ### listIpaddressTags -▸ **listIpaddressTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listIpaddressTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -1166,7 +1166,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -1176,7 +1176,7 @@ ___ ### listIpaddresses -▸ **listIpaddresses**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +▸ **listIpaddresses**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> Returns an array of Ipaddress objects @@ -1202,7 +1202,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> #### Defined in @@ -1212,7 +1212,7 @@ ___ ### listNetworkAdapterIpaddresses -▸ **listNetworkAdapterIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +▸ **listNetworkAdapterIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> Returns an array of Ipaddress objects @@ -1239,7 +1239,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> #### Defined in @@ -1249,7 +1249,7 @@ ___ ### listNetworkAdapterTags -▸ **listNetworkAdapterTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listNetworkAdapterTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -1276,7 +1276,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -1286,7 +1286,7 @@ ___ ### listNetworkAdapters -▸ **listNetworkAdapters**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +▸ **listNetworkAdapters**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> Returns an array of NetworkAdapter objects @@ -1312,7 +1312,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> #### Defined in @@ -1322,7 +1322,7 @@ ___ ### listNetworkSubnets -▸ **listNetworkSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +▸ **listNetworkSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> Returns an array of Subnet objects @@ -1349,7 +1349,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> #### Defined in @@ -1359,7 +1359,7 @@ ___ ### listNetworkTags -▸ **listNetworkTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listNetworkTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -1386,7 +1386,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -1396,7 +1396,7 @@ ___ ### listNetworks -▸ **listNetworks**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +▸ **listNetworks**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> Returns an array of Network objects @@ -1422,7 +1422,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> #### Defined in @@ -1432,7 +1432,7 @@ ___ ### listOrchestrationStackIpaddresses -▸ **listOrchestrationStackIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +▸ **listOrchestrationStackIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> Returns an array of Ipaddress objects @@ -1459,7 +1459,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> #### Defined in @@ -1469,7 +1469,7 @@ ___ ### listOrchestrationStackNetworkAdapters -▸ **listOrchestrationStackNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +▸ **listOrchestrationStackNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> Returns an array of NetworkAdapter objects @@ -1496,7 +1496,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> #### Defined in @@ -1506,7 +1506,7 @@ ___ ### listOrchestrationStackNetworks -▸ **listOrchestrationStackNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +▸ **listOrchestrationStackNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> Returns an array of Network objects @@ -1533,7 +1533,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> #### Defined in @@ -1543,7 +1543,7 @@ ___ ### listOrchestrationStackSecurityGroups -▸ **listOrchestrationStackSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +▸ **listOrchestrationStackSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> Returns an array of SecurityGroup objects @@ -1570,7 +1570,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> #### Defined in @@ -1580,7 +1580,7 @@ ___ ### listOrchestrationStackSubnets -▸ **listOrchestrationStackSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +▸ **listOrchestrationStackSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> Returns an array of Subnet objects @@ -1607,7 +1607,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> #### Defined in @@ -1617,7 +1617,7 @@ ___ ### listOrchestrationStackVms -▸ **listOrchestrationStackVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +▸ **listOrchestrationStackVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> Returns an array of Vm objects @@ -1644,7 +1644,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> #### Defined in @@ -1654,7 +1654,7 @@ ___ ### listOrchestrationStackVolumes -▸ **listOrchestrationStackVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +▸ **listOrchestrationStackVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> Returns an array of Volume objects @@ -1681,7 +1681,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> #### Defined in @@ -1691,7 +1691,7 @@ ___ ### listOrchestrationStacks -▸ **listOrchestrationStacks**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md), `any`\>\> +▸ **listOrchestrationStacks**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md)\>\> Returns an array of OrchestrationStack objects @@ -1717,7 +1717,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md)\>\> #### Defined in @@ -1727,7 +1727,7 @@ ___ ### listSecurityGroupTags -▸ **listSecurityGroupTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listSecurityGroupTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -1754,7 +1754,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -1764,7 +1764,7 @@ ___ ### listSecurityGroupVms -▸ **listSecurityGroupVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +▸ **listSecurityGroupVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> Returns an array of Vm objects @@ -1791,7 +1791,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> #### Defined in @@ -1801,7 +1801,7 @@ ___ ### listSecurityGroups -▸ **listSecurityGroups**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +▸ **listSecurityGroups**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> Returns an array of SecurityGroup objects @@ -1827,7 +1827,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> #### Defined in @@ -1837,7 +1837,7 @@ ___ ### listServiceInstanceNodes -▸ **listServiceInstanceNodes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md), `any`\>\> +▸ **listServiceInstanceNodes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md)\>\> Returns an array of ServiceInstanceNode objects @@ -1863,7 +1863,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md)\>\> #### Defined in @@ -1873,7 +1873,7 @@ ___ ### listServiceInstanceServiceInstanceNodes -▸ **listServiceInstanceServiceInstanceNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md), `any`\>\> +▸ **listServiceInstanceServiceInstanceNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md)\>\> Returns an array of ServiceInstanceNode objects @@ -1900,7 +1900,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md)\>\> #### Defined in @@ -1910,7 +1910,7 @@ ___ ### listServiceInstances -▸ **listServiceInstances**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +▸ **listServiceInstances**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> Returns an array of ServiceInstance objects @@ -1936,7 +1936,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> #### Defined in @@ -1946,7 +1946,7 @@ ___ ### listServiceInventories -▸ **listServiceInventories**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md), `any`\>\> +▸ **listServiceInventories**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md)\>\> Returns an array of ServiceInventory objects @@ -1972,7 +1972,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md)\>\> #### Defined in @@ -1982,7 +1982,7 @@ ___ ### listServiceInventoryTags -▸ **listServiceInventoryTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listServiceInventoryTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -2009,7 +2009,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -2019,7 +2019,7 @@ ___ ### listServiceOfferingIcons -▸ **listServiceOfferingIcons**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingIconsCollection`](../interfaces/ServiceOfferingIconsCollection.md), `any`\>\> +▸ **listServiceOfferingIcons**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingIconsCollection`](../interfaces/ServiceOfferingIconsCollection.md)\>\> Returns an array of ServiceOfferingIcon objects @@ -2045,7 +2045,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingIconsCollection`](../interfaces/ServiceOfferingIconsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingIconsCollection`](../interfaces/ServiceOfferingIconsCollection.md)\>\> #### Defined in @@ -2055,7 +2055,7 @@ ___ ### listServiceOfferingNodes -▸ **listServiceOfferingNodes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md), `any`\>\> +▸ **listServiceOfferingNodes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md)\>\> Returns an array of ServiceOfferingNode objects @@ -2081,7 +2081,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md)\>\> #### Defined in @@ -2091,7 +2091,7 @@ ___ ### listServiceOfferingServiceInstances -▸ **listServiceOfferingServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +▸ **listServiceOfferingServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> Returns an array of ServiceInstance objects @@ -2118,7 +2118,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> #### Defined in @@ -2128,7 +2128,7 @@ ___ ### listServiceOfferingServiceOfferingNodes -▸ **listServiceOfferingServiceOfferingNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md), `any`\>\> +▸ **listServiceOfferingServiceOfferingNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md)\>\> Returns an array of ServiceOfferingNode objects @@ -2155,7 +2155,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md)\>\> #### Defined in @@ -2165,7 +2165,7 @@ ___ ### listServiceOfferingServicePlans -▸ **listServiceOfferingServicePlans**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +▸ **listServiceOfferingServicePlans**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> Returns an array of ServicePlan objects @@ -2192,7 +2192,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> #### Defined in @@ -2202,7 +2202,7 @@ ___ ### listServiceOfferingTags -▸ **listServiceOfferingTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listServiceOfferingTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -2229,7 +2229,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -2239,7 +2239,7 @@ ___ ### listServiceOfferings -▸ **listServiceOfferings**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +▸ **listServiceOfferings**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> Returns an array of ServiceOffering objects @@ -2265,7 +2265,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> #### Defined in @@ -2275,7 +2275,7 @@ ___ ### listServicePlanServiceInstances -▸ **listServicePlanServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +▸ **listServicePlanServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> Returns an array of ServiceInstance objects @@ -2302,7 +2302,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> #### Defined in @@ -2312,7 +2312,7 @@ ___ ### listServicePlans -▸ **listServicePlans**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +▸ **listServicePlans**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> Returns an array of ServicePlan objects @@ -2338,7 +2338,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> #### Defined in @@ -2348,7 +2348,7 @@ ___ ### listSourceAvailabilities -▸ **listSourceAvailabilities**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`AvailabilitiesCollection`](../interfaces/AvailabilitiesCollection.md), `any`\>\> +▸ **listSourceAvailabilities**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`AvailabilitiesCollection`](../interfaces/AvailabilitiesCollection.md)\>\> Returns an array of Availability objects @@ -2375,7 +2375,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AvailabilitiesCollection`](../interfaces/AvailabilitiesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AvailabilitiesCollection`](../interfaces/AvailabilitiesCollection.md)\>\> #### Defined in @@ -2385,7 +2385,7 @@ ___ ### listSourceClusters -▸ **listSourceClusters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ClustersCollection`](../interfaces/ClustersCollection.md), `any`\>\> +▸ **listSourceClusters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ClustersCollection`](../interfaces/ClustersCollection.md)\>\> Returns an array of Cluster objects @@ -2412,7 +2412,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ClustersCollection`](../interfaces/ClustersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ClustersCollection`](../interfaces/ClustersCollection.md)\>\> #### Defined in @@ -2422,7 +2422,7 @@ ___ ### listSourceContainerGroups -▸ **listSourceContainerGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +▸ **listSourceContainerGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> Returns an array of ContainerGroup objects @@ -2449,7 +2449,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> #### Defined in @@ -2459,7 +2459,7 @@ ___ ### listSourceContainerImages -▸ **listSourceContainerImages**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md), `any`\>\> +▸ **listSourceContainerImages**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md)\>\> Returns an array of ContainerImage objects @@ -2486,7 +2486,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md)\>\> #### Defined in @@ -2496,7 +2496,7 @@ ___ ### listSourceContainerNodes -▸ **listSourceContainerNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md), `any`\>\> +▸ **listSourceContainerNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md)\>\> Returns an array of ContainerNode objects @@ -2523,7 +2523,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md)\>\> #### Defined in @@ -2533,7 +2533,7 @@ ___ ### listSourceContainerProjects -▸ **listSourceContainerProjects**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md), `any`\>\> +▸ **listSourceContainerProjects**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md)\>\> Returns an array of ContainerProject objects @@ -2560,7 +2560,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md)\>\> #### Defined in @@ -2570,7 +2570,7 @@ ___ ### listSourceContainerTemplates -▸ **listSourceContainerTemplates**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md), `any`\>\> +▸ **listSourceContainerTemplates**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md)\>\> Returns an array of ContainerTemplate objects @@ -2597,7 +2597,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md)\>\> #### Defined in @@ -2607,7 +2607,7 @@ ___ ### listSourceContainers -▸ **listSourceContainers**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md), `any`\>\> +▸ **listSourceContainers**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md)\>\> Returns an array of Container objects @@ -2634,7 +2634,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainersCollection`](../interfaces/ContainersCollection.md)\>\> #### Defined in @@ -2644,7 +2644,7 @@ ___ ### listSourceDatastores -▸ **listSourceDatastores**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`DatastoresCollection`](../interfaces/DatastoresCollection.md), `any`\>\> +▸ **listSourceDatastores**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`DatastoresCollection`](../interfaces/DatastoresCollection.md)\>\> Returns an array of Datastore objects @@ -2671,7 +2671,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`DatastoresCollection`](../interfaces/DatastoresCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`DatastoresCollection`](../interfaces/DatastoresCollection.md)\>\> #### Defined in @@ -2681,7 +2681,7 @@ ___ ### listSourceHosts -▸ **listSourceHosts**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md), `any`\>\> +▸ **listSourceHosts**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md)\>\> Returns an array of Host objects @@ -2708,7 +2708,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`HostsCollection`](../interfaces/HostsCollection.md)\>\> #### Defined in @@ -2718,7 +2718,7 @@ ___ ### listSourceIpaddresses -▸ **listSourceIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +▸ **listSourceIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> Returns an array of Ipaddress objects @@ -2745,7 +2745,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> #### Defined in @@ -2755,7 +2755,7 @@ ___ ### listSourceNetworkAdapters -▸ **listSourceNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +▸ **listSourceNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> Returns an array of NetworkAdapter objects @@ -2782,7 +2782,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> #### Defined in @@ -2792,7 +2792,7 @@ ___ ### listSourceNetworks -▸ **listSourceNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +▸ **listSourceNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> Returns an array of Network objects @@ -2819,7 +2819,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> #### Defined in @@ -2829,7 +2829,7 @@ ___ ### listSourceOrchestrationStacks -▸ **listSourceOrchestrationStacks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md), `any`\>\> +▸ **listSourceOrchestrationStacks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md)\>\> Returns an array of OrchestrationStack objects @@ -2856,7 +2856,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md)\>\> #### Defined in @@ -2866,7 +2866,7 @@ ___ ### listSourceRegionIpaddresses -▸ **listSourceRegionIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +▸ **listSourceRegionIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> Returns an array of Ipaddress objects @@ -2893,7 +2893,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> #### Defined in @@ -2903,7 +2903,7 @@ ___ ### listSourceRegionNetworkAdapters -▸ **listSourceRegionNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +▸ **listSourceRegionNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> Returns an array of NetworkAdapter objects @@ -2930,7 +2930,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> #### Defined in @@ -2940,7 +2940,7 @@ ___ ### listSourceRegionNetworks -▸ **listSourceRegionNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +▸ **listSourceRegionNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> Returns an array of Network objects @@ -2967,7 +2967,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> #### Defined in @@ -2977,7 +2977,7 @@ ___ ### listSourceRegionOrchestrationStacks -▸ **listSourceRegionOrchestrationStacks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md), `any`\>\> +▸ **listSourceRegionOrchestrationStacks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md)\>\> Returns an array of OrchestrationStack objects @@ -3004,7 +3004,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md)\>\> #### Defined in @@ -3014,7 +3014,7 @@ ___ ### listSourceRegionSecurityGroups -▸ **listSourceRegionSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +▸ **listSourceRegionSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> Returns an array of SecurityGroup objects @@ -3041,7 +3041,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> #### Defined in @@ -3051,7 +3051,7 @@ ___ ### listSourceRegionServiceInstances -▸ **listSourceRegionServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +▸ **listSourceRegionServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> Returns an array of ServiceInstance objects @@ -3078,7 +3078,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> #### Defined in @@ -3088,7 +3088,7 @@ ___ ### listSourceRegionServiceOfferings -▸ **listSourceRegionServiceOfferings**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +▸ **listSourceRegionServiceOfferings**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> Returns an array of ServiceOffering objects @@ -3115,7 +3115,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> #### Defined in @@ -3125,7 +3125,7 @@ ___ ### listSourceRegionServicePlans -▸ **listSourceRegionServicePlans**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +▸ **listSourceRegionServicePlans**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> Returns an array of ServicePlan objects @@ -3152,7 +3152,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> #### Defined in @@ -3162,7 +3162,7 @@ ___ ### listSourceRegionSubnets -▸ **listSourceRegionSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +▸ **listSourceRegionSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> Returns an array of Subnet objects @@ -3189,7 +3189,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> #### Defined in @@ -3199,7 +3199,7 @@ ___ ### listSourceRegionVms -▸ **listSourceRegionVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +▸ **listSourceRegionVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> Returns an array of Vm objects @@ -3226,7 +3226,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> #### Defined in @@ -3236,7 +3236,7 @@ ___ ### listSourceRegionVolumes -▸ **listSourceRegionVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +▸ **listSourceRegionVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> Returns an array of Volume objects @@ -3263,7 +3263,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> #### Defined in @@ -3273,7 +3273,7 @@ ___ ### listSourceRegions -▸ **listSourceRegions**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourceRegionsCollection`](../interfaces/SourceRegionsCollection.md), `any`\>\> +▸ **listSourceRegions**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourceRegionsCollection`](../interfaces/SourceRegionsCollection.md)\>\> Returns an array of SourceRegion objects @@ -3299,7 +3299,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SourceRegionsCollection`](../interfaces/SourceRegionsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SourceRegionsCollection`](../interfaces/SourceRegionsCollection.md)\>\> #### Defined in @@ -3309,7 +3309,7 @@ ___ ### listSourceSecurityGroups -▸ **listSourceSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +▸ **listSourceSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> Returns an array of SecurityGroup objects @@ -3336,7 +3336,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> #### Defined in @@ -3346,7 +3346,7 @@ ___ ### listSourceServiceInstanceNodes -▸ **listSourceServiceInstanceNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md), `any`\>\> +▸ **listSourceServiceInstanceNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md)\>\> Returns an array of ServiceInstanceNode objects @@ -3373,7 +3373,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstanceNodesCollection`](../interfaces/ServiceInstanceNodesCollection.md)\>\> #### Defined in @@ -3383,7 +3383,7 @@ ___ ### listSourceServiceInstances -▸ **listSourceServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +▸ **listSourceServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> Returns an array of ServiceInstance objects @@ -3410,7 +3410,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> #### Defined in @@ -3420,7 +3420,7 @@ ___ ### listSourceServiceInventories -▸ **listSourceServiceInventories**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md), `any`\>\> +▸ **listSourceServiceInventories**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md)\>\> Returns an array of ServiceInventory objects @@ -3447,7 +3447,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md)\>\> #### Defined in @@ -3457,7 +3457,7 @@ ___ ### listSourceServiceOfferingNodes -▸ **listSourceServiceOfferingNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md), `any`\>\> +▸ **listSourceServiceOfferingNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md)\>\> Returns an array of ServiceOfferingNode objects @@ -3484,7 +3484,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingNodesCollection`](../interfaces/ServiceOfferingNodesCollection.md)\>\> #### Defined in @@ -3494,7 +3494,7 @@ ___ ### listSourceServiceOfferings -▸ **listSourceServiceOfferings**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +▸ **listSourceServiceOfferings**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> Returns an array of ServiceOffering objects @@ -3521,7 +3521,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> #### Defined in @@ -3531,7 +3531,7 @@ ___ ### listSourceServicePlans -▸ **listSourceServicePlans**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +▸ **listSourceServicePlans**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> Returns an array of ServicePlan objects @@ -3558,7 +3558,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> #### Defined in @@ -3568,7 +3568,7 @@ ___ ### listSourceSourceRegions -▸ **listSourceSourceRegions**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourceRegionsCollection`](../interfaces/SourceRegionsCollection.md), `any`\>\> +▸ **listSourceSourceRegions**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourceRegionsCollection`](../interfaces/SourceRegionsCollection.md)\>\> Returns an array of SourceRegion objects @@ -3595,7 +3595,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SourceRegionsCollection`](../interfaces/SourceRegionsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SourceRegionsCollection`](../interfaces/SourceRegionsCollection.md)\>\> #### Defined in @@ -3605,7 +3605,7 @@ ___ ### listSourceSubnets -▸ **listSourceSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +▸ **listSourceSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> Returns an array of Subnet objects @@ -3632,7 +3632,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> #### Defined in @@ -3642,7 +3642,7 @@ ___ ### listSourceSubscriptions -▸ **listSourceSubscriptions**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubscriptionsCollection`](../interfaces/SubscriptionsCollection.md), `any`\>\> +▸ **listSourceSubscriptions**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubscriptionsCollection`](../interfaces/SubscriptionsCollection.md)\>\> Returns an array of Subscription objects @@ -3669,7 +3669,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SubscriptionsCollection`](../interfaces/SubscriptionsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubscriptionsCollection`](../interfaces/SubscriptionsCollection.md)\>\> #### Defined in @@ -3679,7 +3679,7 @@ ___ ### listSourceVms -▸ **listSourceVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +▸ **listSourceVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> Returns an array of Vm objects @@ -3706,7 +3706,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> #### Defined in @@ -3716,7 +3716,7 @@ ___ ### listSourceVolumeTypes -▸ **listSourceVolumeTypes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumeTypesCollection`](../interfaces/VolumeTypesCollection.md), `any`\>\> +▸ **listSourceVolumeTypes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumeTypesCollection`](../interfaces/VolumeTypesCollection.md)\>\> Returns an array of VolumeType objects @@ -3743,7 +3743,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumeTypesCollection`](../interfaces/VolumeTypesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumeTypesCollection`](../interfaces/VolumeTypesCollection.md)\>\> #### Defined in @@ -3753,7 +3753,7 @@ ___ ### listSourceVolumes -▸ **listSourceVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +▸ **listSourceVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> Returns an array of Volume objects @@ -3780,7 +3780,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> #### Defined in @@ -3790,7 +3790,7 @@ ___ ### listSources -▸ **listSources**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md), `any`\>\> +▸ **listSources**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md)\>\> Returns an array of Source objects @@ -3816,7 +3816,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SourcesCollection`](../interfaces/SourcesCollection.md)\>\> #### Defined in @@ -3826,7 +3826,7 @@ ___ ### listSubnetIpaddresses -▸ **listSubnetIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +▸ **listSubnetIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> Returns an array of Ipaddress objects @@ -3853,7 +3853,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> #### Defined in @@ -3863,7 +3863,7 @@ ___ ### listSubnetNetworkAdapters -▸ **listSubnetNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +▸ **listSubnetNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> Returns an array of NetworkAdapter objects @@ -3890,7 +3890,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> #### Defined in @@ -3900,7 +3900,7 @@ ___ ### listSubnetTags -▸ **listSubnetTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listSubnetTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -3927,7 +3927,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -3937,7 +3937,7 @@ ___ ### listSubnets -▸ **listSubnets**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +▸ **listSubnets**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> Returns an array of Subnet objects @@ -3963,7 +3963,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> #### Defined in @@ -3973,7 +3973,7 @@ ___ ### listSubscriptionIpaddresses -▸ **listSubscriptionIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +▸ **listSubscriptionIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> Returns an array of Ipaddress objects @@ -4000,7 +4000,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> #### Defined in @@ -4010,7 +4010,7 @@ ___ ### listSubscriptionNetworkAdapters -▸ **listSubscriptionNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +▸ **listSubscriptionNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> Returns an array of NetworkAdapter objects @@ -4037,7 +4037,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> #### Defined in @@ -4047,7 +4047,7 @@ ___ ### listSubscriptionNetworks -▸ **listSubscriptionNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +▸ **listSubscriptionNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> Returns an array of Network objects @@ -4074,7 +4074,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> #### Defined in @@ -4084,7 +4084,7 @@ ___ ### listSubscriptionOrchestrationStacks -▸ **listSubscriptionOrchestrationStacks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md), `any`\>\> +▸ **listSubscriptionOrchestrationStacks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md)\>\> Returns an array of OrchestrationStack objects @@ -4111,7 +4111,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrchestrationStacksCollection`](../interfaces/OrchestrationStacksCollection.md)\>\> #### Defined in @@ -4121,7 +4121,7 @@ ___ ### listSubscriptionSecurityGroups -▸ **listSubscriptionSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +▸ **listSubscriptionSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> Returns an array of SecurityGroup objects @@ -4148,7 +4148,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> #### Defined in @@ -4158,7 +4158,7 @@ ___ ### listSubscriptionServiceInstances -▸ **listSubscriptionServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +▸ **listSubscriptionServiceInstances**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> Returns an array of ServiceInstance objects @@ -4185,7 +4185,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstancesCollection`](../interfaces/ServiceInstancesCollection.md)\>\> #### Defined in @@ -4195,7 +4195,7 @@ ___ ### listSubscriptionServiceOfferings -▸ **listSubscriptionServiceOfferings**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +▸ **listSubscriptionServiceOfferings**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> Returns an array of ServiceOffering objects @@ -4222,7 +4222,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> #### Defined in @@ -4232,7 +4232,7 @@ ___ ### listSubscriptionServicePlans -▸ **listSubscriptionServicePlans**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +▸ **listSubscriptionServicePlans**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> Returns an array of ServicePlan objects @@ -4259,7 +4259,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlansCollection`](../interfaces/ServicePlansCollection.md)\>\> #### Defined in @@ -4269,7 +4269,7 @@ ___ ### listSubscriptionSubnets -▸ **listSubscriptionSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +▸ **listSubscriptionSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> Returns an array of Subnet objects @@ -4296,7 +4296,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> #### Defined in @@ -4306,7 +4306,7 @@ ___ ### listSubscriptionVms -▸ **listSubscriptionVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +▸ **listSubscriptionVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> Returns an array of Vm objects @@ -4333,7 +4333,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> #### Defined in @@ -4343,7 +4343,7 @@ ___ ### listSubscriptionVolumes -▸ **listSubscriptionVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +▸ **listSubscriptionVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> Returns an array of Volume objects @@ -4370,7 +4370,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> #### Defined in @@ -4380,7 +4380,7 @@ ___ ### listSubscriptions -▸ **listSubscriptions**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubscriptionsCollection`](../interfaces/SubscriptionsCollection.md), `any`\>\> +▸ **listSubscriptions**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubscriptionsCollection`](../interfaces/SubscriptionsCollection.md)\>\> Returns an array of Subscription objects @@ -4406,7 +4406,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SubscriptionsCollection`](../interfaces/SubscriptionsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubscriptionsCollection`](../interfaces/SubscriptionsCollection.md)\>\> #### Defined in @@ -4416,7 +4416,7 @@ ___ ### listTagContainerGroups -▸ **listTagContainerGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +▸ **listTagContainerGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> Returns an array of ContainerGroup objects @@ -4443,7 +4443,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerGroupsCollection`](../interfaces/ContainerGroupsCollection.md)\>\> #### Defined in @@ -4453,7 +4453,7 @@ ___ ### listTagContainerImages -▸ **listTagContainerImages**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md), `any`\>\> +▸ **listTagContainerImages**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md)\>\> Returns an array of ContainerImage objects @@ -4480,7 +4480,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerImagesCollection`](../interfaces/ContainerImagesCollection.md)\>\> #### Defined in @@ -4490,7 +4490,7 @@ ___ ### listTagContainerNodes -▸ **listTagContainerNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md), `any`\>\> +▸ **listTagContainerNodes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md)\>\> Returns an array of ContainerNode objects @@ -4517,7 +4517,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerNodesCollection`](../interfaces/ContainerNodesCollection.md)\>\> #### Defined in @@ -4527,7 +4527,7 @@ ___ ### listTagContainerProjects -▸ **listTagContainerProjects**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md), `any`\>\> +▸ **listTagContainerProjects**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md)\>\> Returns an array of ContainerProject objects @@ -4554,7 +4554,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerProjectsCollection`](../interfaces/ContainerProjectsCollection.md)\>\> #### Defined in @@ -4564,7 +4564,7 @@ ___ ### listTagContainerTemplates -▸ **listTagContainerTemplates**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md), `any`\>\> +▸ **listTagContainerTemplates**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md)\>\> Returns an array of ContainerTemplate objects @@ -4591,7 +4591,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerTemplatesCollection`](../interfaces/ContainerTemplatesCollection.md)\>\> #### Defined in @@ -4601,7 +4601,7 @@ ___ ### listTagIpaddresses -▸ **listTagIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +▸ **listTagIpaddresses**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> Returns an array of Ipaddress objects @@ -4628,7 +4628,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`IpaddressesCollection`](../interfaces/IpaddressesCollection.md)\>\> #### Defined in @@ -4638,7 +4638,7 @@ ___ ### listTagNetworkAdapters -▸ **listTagNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +▸ **listTagNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> Returns an array of NetworkAdapter objects @@ -4665,7 +4665,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> #### Defined in @@ -4675,7 +4675,7 @@ ___ ### listTagNetworks -▸ **listTagNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +▸ **listTagNetworks**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> Returns an array of Network objects @@ -4702,7 +4702,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworksCollection`](../interfaces/NetworksCollection.md)\>\> #### Defined in @@ -4712,7 +4712,7 @@ ___ ### listTagSecurityGroups -▸ **listTagSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +▸ **listTagSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> Returns an array of SecurityGroup objects @@ -4739,7 +4739,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> #### Defined in @@ -4749,7 +4749,7 @@ ___ ### listTagServiceInventories -▸ **listTagServiceInventories**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md), `any`\>\> +▸ **listTagServiceInventories**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md)\>\> Returns an array of ServiceInventory objects @@ -4776,7 +4776,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInventoriesCollection`](../interfaces/ServiceInventoriesCollection.md)\>\> #### Defined in @@ -4786,7 +4786,7 @@ ___ ### listTagServiceOfferings -▸ **listTagServiceOfferings**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +▸ **listTagServiceOfferings**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> Returns an array of ServiceOffering objects @@ -4813,7 +4813,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingsCollection`](../interfaces/ServiceOfferingsCollection.md)\>\> #### Defined in @@ -4823,7 +4823,7 @@ ___ ### listTagSubnets -▸ **listTagSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +▸ **listTagSubnets**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> Returns an array of Subnet objects @@ -4850,7 +4850,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SubnetsCollection`](../interfaces/SubnetsCollection.md)\>\> #### Defined in @@ -4860,7 +4860,7 @@ ___ ### listTagVms -▸ **listTagVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +▸ **listTagVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> Returns an array of Vm objects @@ -4887,7 +4887,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> #### Defined in @@ -4897,7 +4897,7 @@ ___ ### listTags -▸ **listTags**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listTags**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -4923,7 +4923,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -4933,7 +4933,7 @@ ___ ### listTasks -▸ **listTasks**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TasksCollection`](../interfaces/TasksCollection.md), `any`\>\> +▸ **listTasks**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TasksCollection`](../interfaces/TasksCollection.md)\>\> Returns an array of Task objects @@ -4959,7 +4959,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TasksCollection`](../interfaces/TasksCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TasksCollection`](../interfaces/TasksCollection.md)\>\> #### Defined in @@ -4969,7 +4969,7 @@ ___ ### listVmNetworkAdapters -▸ **listVmNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +▸ **listVmNetworkAdapters**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> Returns an array of NetworkAdapter objects @@ -4996,7 +4996,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworkAdaptersCollection`](../interfaces/NetworkAdaptersCollection.md)\>\> #### Defined in @@ -5006,7 +5006,7 @@ ___ ### listVmSecurityGroups -▸ **listVmSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +▸ **listVmSecurityGroups**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> Returns an array of SecurityGroup objects @@ -5033,7 +5033,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SecurityGroupsCollection`](../interfaces/SecurityGroupsCollection.md)\>\> #### Defined in @@ -5043,7 +5043,7 @@ ___ ### listVmTags -▸ **listVmTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +▸ **listVmTags**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> Returns an array of Tag objects @@ -5070,7 +5070,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`TagsCollection`](../interfaces/TagsCollection.md)\>\> #### Defined in @@ -5080,7 +5080,7 @@ ___ ### listVmVolumeAttachments -▸ **listVmVolumeAttachments**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumeAttachmentsCollection`](../interfaces/VolumeAttachmentsCollection.md), `any`\>\> +▸ **listVmVolumeAttachments**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumeAttachmentsCollection`](../interfaces/VolumeAttachmentsCollection.md)\>\> Returns an array of VolumeAttachment objects @@ -5107,7 +5107,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumeAttachmentsCollection`](../interfaces/VolumeAttachmentsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumeAttachmentsCollection`](../interfaces/VolumeAttachmentsCollection.md)\>\> #### Defined in @@ -5117,7 +5117,7 @@ ___ ### listVmVolumes -▸ **listVmVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +▸ **listVmVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> Returns an array of Volume objects @@ -5144,7 +5144,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> #### Defined in @@ -5154,7 +5154,7 @@ ___ ### listVms -▸ **listVms**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +▸ **listVms**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> Returns an array of Vm objects @@ -5180,7 +5180,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> #### Defined in @@ -5190,7 +5190,7 @@ ___ ### listVolumeAttachments -▸ **listVolumeAttachments**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumeAttachmentsCollection`](../interfaces/VolumeAttachmentsCollection.md), `any`\>\> +▸ **listVolumeAttachments**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumeAttachmentsCollection`](../interfaces/VolumeAttachmentsCollection.md)\>\> Returns an array of VolumeAttachment objects @@ -5216,7 +5216,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumeAttachmentsCollection`](../interfaces/VolumeAttachmentsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumeAttachmentsCollection`](../interfaces/VolumeAttachmentsCollection.md)\>\> #### Defined in @@ -5226,7 +5226,7 @@ ___ ### listVolumeTypeVolumes -▸ **listVolumeTypeVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +▸ **listVolumeTypeVolumes**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> Returns an array of Volume objects @@ -5253,7 +5253,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> #### Defined in @@ -5263,7 +5263,7 @@ ___ ### listVolumeTypes -▸ **listVolumeTypes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumeTypesCollection`](../interfaces/VolumeTypesCollection.md), `any`\>\> +▸ **listVolumeTypes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumeTypesCollection`](../interfaces/VolumeTypesCollection.md)\>\> Returns an array of VolumeType objects @@ -5289,7 +5289,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumeTypesCollection`](../interfaces/VolumeTypesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumeTypesCollection`](../interfaces/VolumeTypesCollection.md)\>\> #### Defined in @@ -5299,7 +5299,7 @@ ___ ### listVolumeVms -▸ **listVolumeVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +▸ **listVolumeVms**(`id`, `limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> Returns an array of Vm objects @@ -5326,7 +5326,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VmsCollection`](../interfaces/VmsCollection.md)\>\> #### Defined in @@ -5336,7 +5336,7 @@ ___ ### listVolumes -▸ **listVolumes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +▸ **listVolumes**(`limit?`, `offset?`, `filter?`, `sortBy?`, `options?`): `Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> Returns an array of Volume objects @@ -5362,7 +5362,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumesCollection`](../interfaces/VolumesCollection.md)\>\> #### Defined in @@ -5372,7 +5372,7 @@ ___ ### orderServiceOffering -▸ **orderServiceOffering**(`id`, `orderParametersServiceOffering`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +▸ **orderServiceOffering**(`id`, `orderParametersServiceOffering`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> Returns a Task id @@ -5396,7 +5396,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> #### Defined in @@ -5406,7 +5406,7 @@ ___ ### orderServicePlan -▸ **orderServicePlan**(`id`, `orderParametersServicePlan`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +▸ **orderServicePlan**(`id`, `orderParametersServicePlan`, `options?`): `Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> Returns a Task id @@ -5430,7 +5430,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md), `any`\>\> +`Promise`<`AxiosResponse`<[`InlineResponse200`](../interfaces/InlineResponse200.md)\>\> #### Defined in @@ -5440,7 +5440,7 @@ ___ ### postGraphQL -▸ **postGraphQL**(`graphQLRequest`, `options?`): `Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md), `any`\>\> +▸ **postGraphQL**(`graphQLRequest`, `options?`): `Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md)\>\> Performs a GraphQL Query @@ -5463,7 +5463,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md), `any`\>\> +`Promise`<`AxiosResponse`<[`GraphQLResponse`](../interfaces/GraphQLResponse.md)\>\> #### Defined in @@ -5473,7 +5473,7 @@ ___ ### showCluster -▸ **showCluster**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Cluster`](../interfaces/Cluster.md), `any`\>\> +▸ **showCluster**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Cluster`](../interfaces/Cluster.md)\>\> Returns a Cluster object @@ -5496,7 +5496,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Cluster`](../interfaces/Cluster.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Cluster`](../interfaces/Cluster.md)\>\> #### Defined in @@ -5506,7 +5506,7 @@ ___ ### showContainer -▸ **showContainer**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Container`](../interfaces/Container.md), `any`\>\> +▸ **showContainer**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Container`](../interfaces/Container.md)\>\> Returns a Container object @@ -5529,7 +5529,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Container`](../interfaces/Container.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Container`](../interfaces/Container.md)\>\> #### Defined in @@ -5539,7 +5539,7 @@ ___ ### showContainerGroup -▸ **showContainerGroup**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroup`](../interfaces/ContainerGroup.md), `any`\>\> +▸ **showContainerGroup**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerGroup`](../interfaces/ContainerGroup.md)\>\> Returns a ContainerGroup object @@ -5562,7 +5562,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerGroup`](../interfaces/ContainerGroup.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerGroup`](../interfaces/ContainerGroup.md)\>\> #### Defined in @@ -5572,7 +5572,7 @@ ___ ### showContainerImage -▸ **showContainerImage**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerImage`](../interfaces/ContainerImage.md), `any`\>\> +▸ **showContainerImage**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerImage`](../interfaces/ContainerImage.md)\>\> Returns a ContainerImage object @@ -5595,7 +5595,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerImage`](../interfaces/ContainerImage.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerImage`](../interfaces/ContainerImage.md)\>\> #### Defined in @@ -5605,7 +5605,7 @@ ___ ### showContainerNode -▸ **showContainerNode**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerNode`](../interfaces/ContainerNode.md), `any`\>\> +▸ **showContainerNode**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerNode`](../interfaces/ContainerNode.md)\>\> Returns a ContainerNode object @@ -5628,7 +5628,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerNode`](../interfaces/ContainerNode.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerNode`](../interfaces/ContainerNode.md)\>\> #### Defined in @@ -5638,7 +5638,7 @@ ___ ### showContainerProject -▸ **showContainerProject**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerProject`](../interfaces/ContainerProject.md), `any`\>\> +▸ **showContainerProject**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerProject`](../interfaces/ContainerProject.md)\>\> Returns a ContainerProject object @@ -5661,7 +5661,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerProject`](../interfaces/ContainerProject.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerProject`](../interfaces/ContainerProject.md)\>\> #### Defined in @@ -5671,7 +5671,7 @@ ___ ### showContainerResourceQuota -▸ **showContainerResourceQuota**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerResourceQuota`](../interfaces/ContainerResourceQuota.md), `any`\>\> +▸ **showContainerResourceQuota**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerResourceQuota`](../interfaces/ContainerResourceQuota.md)\>\> Returns a ContainerResourceQuota object @@ -5694,7 +5694,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerResourceQuota`](../interfaces/ContainerResourceQuota.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerResourceQuota`](../interfaces/ContainerResourceQuota.md)\>\> #### Defined in @@ -5704,7 +5704,7 @@ ___ ### showContainerTemplate -▸ **showContainerTemplate**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplate`](../interfaces/ContainerTemplate.md), `any`\>\> +▸ **showContainerTemplate**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ContainerTemplate`](../interfaces/ContainerTemplate.md)\>\> Returns a ContainerTemplate object @@ -5727,7 +5727,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ContainerTemplate`](../interfaces/ContainerTemplate.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ContainerTemplate`](../interfaces/ContainerTemplate.md)\>\> #### Defined in @@ -5737,7 +5737,7 @@ ___ ### showDatastore -▸ **showDatastore**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Datastore`](../interfaces/Datastore.md), `any`\>\> +▸ **showDatastore**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Datastore`](../interfaces/Datastore.md)\>\> Returns a Datastore object @@ -5760,7 +5760,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Datastore`](../interfaces/Datastore.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Datastore`](../interfaces/Datastore.md)\>\> #### Defined in @@ -5770,7 +5770,7 @@ ___ ### showFlavor -▸ **showFlavor**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Flavor`](../interfaces/Flavor.md), `any`\>\> +▸ **showFlavor**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Flavor`](../interfaces/Flavor.md)\>\> Returns a Flavor object @@ -5793,7 +5793,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Flavor`](../interfaces/Flavor.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Flavor`](../interfaces/Flavor.md)\>\> #### Defined in @@ -5803,7 +5803,7 @@ ___ ### showHost -▸ **showHost**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Host`](../interfaces/Host.md), `any`\>\> +▸ **showHost**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Host`](../interfaces/Host.md)\>\> Returns a Host object @@ -5826,7 +5826,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Host`](../interfaces/Host.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Host`](../interfaces/Host.md)\>\> #### Defined in @@ -5836,7 +5836,7 @@ ___ ### showIpaddress -▸ **showIpaddress**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Ipaddress`](../interfaces/Ipaddress.md), `any`\>\> +▸ **showIpaddress**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Ipaddress`](../interfaces/Ipaddress.md)\>\> Returns a Ipaddress object @@ -5859,7 +5859,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Ipaddress`](../interfaces/Ipaddress.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Ipaddress`](../interfaces/Ipaddress.md)\>\> #### Defined in @@ -5869,7 +5869,7 @@ ___ ### showNetwork -▸ **showNetwork**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Network`](../interfaces/Network.md), `any`\>\> +▸ **showNetwork**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Network`](../interfaces/Network.md)\>\> Returns a Network object @@ -5892,7 +5892,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Network`](../interfaces/Network.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Network`](../interfaces/Network.md)\>\> #### Defined in @@ -5902,7 +5902,7 @@ ___ ### showNetworkAdapter -▸ **showNetworkAdapter**(`id`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdapter`](../interfaces/NetworkAdapter.md), `any`\>\> +▸ **showNetworkAdapter**(`id`, `options?`): `Promise`<`AxiosResponse`<[`NetworkAdapter`](../interfaces/NetworkAdapter.md)\>\> Returns a NetworkAdapter object @@ -5925,7 +5925,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`NetworkAdapter`](../interfaces/NetworkAdapter.md), `any`\>\> +`Promise`<`AxiosResponse`<[`NetworkAdapter`](../interfaces/NetworkAdapter.md)\>\> #### Defined in @@ -5935,7 +5935,7 @@ ___ ### showOrchestrationStack -▸ **showOrchestrationStack**(`id`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStack`](../interfaces/OrchestrationStack.md), `any`\>\> +▸ **showOrchestrationStack**(`id`, `options?`): `Promise`<`AxiosResponse`<[`OrchestrationStack`](../interfaces/OrchestrationStack.md)\>\> Returns a OrchestrationStack object @@ -5958,7 +5958,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`OrchestrationStack`](../interfaces/OrchestrationStack.md), `any`\>\> +`Promise`<`AxiosResponse`<[`OrchestrationStack`](../interfaces/OrchestrationStack.md)\>\> #### Defined in @@ -5968,7 +5968,7 @@ ___ ### showSecurityGroup -▸ **showSecurityGroup**(`id`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroup`](../interfaces/SecurityGroup.md), `any`\>\> +▸ **showSecurityGroup**(`id`, `options?`): `Promise`<`AxiosResponse`<[`SecurityGroup`](../interfaces/SecurityGroup.md)\>\> Returns a SecurityGroup object @@ -5991,7 +5991,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SecurityGroup`](../interfaces/SecurityGroup.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SecurityGroup`](../interfaces/SecurityGroup.md)\>\> #### Defined in @@ -6001,7 +6001,7 @@ ___ ### showServiceInstance -▸ **showServiceInstance**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstance`](../interfaces/ServiceInstance.md), `any`\>\> +▸ **showServiceInstance**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstance`](../interfaces/ServiceInstance.md)\>\> Returns a ServiceInstance object @@ -6024,7 +6024,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstance`](../interfaces/ServiceInstance.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstance`](../interfaces/ServiceInstance.md)\>\> #### Defined in @@ -6034,7 +6034,7 @@ ___ ### showServiceInstanceNode -▸ **showServiceInstanceNode**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstanceNode`](../interfaces/ServiceInstanceNode.md), `any`\>\> +▸ **showServiceInstanceNode**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInstanceNode`](../interfaces/ServiceInstanceNode.md)\>\> Returns a ServiceInstanceNode object @@ -6057,7 +6057,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInstanceNode`](../interfaces/ServiceInstanceNode.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInstanceNode`](../interfaces/ServiceInstanceNode.md)\>\> #### Defined in @@ -6067,7 +6067,7 @@ ___ ### showServiceInventory -▸ **showServiceInventory**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInventory`](../interfaces/ServiceInventory.md), `any`\>\> +▸ **showServiceInventory**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceInventory`](../interfaces/ServiceInventory.md)\>\> Returns a ServiceInventory object @@ -6090,7 +6090,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceInventory`](../interfaces/ServiceInventory.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceInventory`](../interfaces/ServiceInventory.md)\>\> #### Defined in @@ -6100,7 +6100,7 @@ ___ ### showServiceOffering -▸ **showServiceOffering**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOffering`](../interfaces/ServiceOffering.md), `any`\>\> +▸ **showServiceOffering**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOffering`](../interfaces/ServiceOffering.md)\>\> Returns a ServiceOffering object @@ -6123,7 +6123,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOffering`](../interfaces/ServiceOffering.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOffering`](../interfaces/ServiceOffering.md)\>\> #### Defined in @@ -6133,7 +6133,7 @@ ___ ### showServiceOfferingIcon -▸ **showServiceOfferingIcon**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingIcon`](../interfaces/ServiceOfferingIcon.md), `any`\>\> +▸ **showServiceOfferingIcon**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingIcon`](../interfaces/ServiceOfferingIcon.md)\>\> Returns a ServiceOfferingIcon object @@ -6156,7 +6156,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingIcon`](../interfaces/ServiceOfferingIcon.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingIcon`](../interfaces/ServiceOfferingIcon.md)\>\> #### Defined in @@ -6166,7 +6166,7 @@ ___ ### showServiceOfferingIconIconData -▸ **showServiceOfferingIconIconData**(`id`, `options?`): `Promise`<`AxiosResponse`<`any`, `any`\>\> +▸ **showServiceOfferingIconIconData**(`id`, `options?`): `Promise`<`AxiosResponse`<`any`\>\> Returns a ServiceOfferingIcon IconData @@ -6189,7 +6189,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`any`, `any`\>\> +`Promise`<`AxiosResponse`<`any`\>\> #### Defined in @@ -6199,7 +6199,7 @@ ___ ### showServiceOfferingNode -▸ **showServiceOfferingNode**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingNode`](../interfaces/ServiceOfferingNode.md), `any`\>\> +▸ **showServiceOfferingNode**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServiceOfferingNode`](../interfaces/ServiceOfferingNode.md)\>\> Returns a ServiceOfferingNode object @@ -6222,7 +6222,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServiceOfferingNode`](../interfaces/ServiceOfferingNode.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServiceOfferingNode`](../interfaces/ServiceOfferingNode.md)\>\> #### Defined in @@ -6232,7 +6232,7 @@ ___ ### showServicePlan -▸ **showServicePlan**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md), `any`\>\> +▸ **showServicePlan**(`id`, `options?`): `Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)\>\> Returns a ServicePlan object @@ -6255,7 +6255,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ServicePlan`](../interfaces/ServicePlan.md)\>\> #### Defined in @@ -6265,7 +6265,7 @@ ___ ### showSource -▸ **showSource**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md), `any`\>\> +▸ **showSource**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md)\>\> Returns a Source object @@ -6288,7 +6288,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Source`](../interfaces/Source.md)\>\> #### Defined in @@ -6298,7 +6298,7 @@ ___ ### showSourceRegion -▸ **showSourceRegion**(`id`, `options?`): `Promise`<`AxiosResponse`<[`SourceRegion`](../interfaces/SourceRegion.md), `any`\>\> +▸ **showSourceRegion**(`id`, `options?`): `Promise`<`AxiosResponse`<[`SourceRegion`](../interfaces/SourceRegion.md)\>\> Returns a SourceRegion object @@ -6321,7 +6321,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SourceRegion`](../interfaces/SourceRegion.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SourceRegion`](../interfaces/SourceRegion.md)\>\> #### Defined in @@ -6331,7 +6331,7 @@ ___ ### showSubnet -▸ **showSubnet**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Subnet`](../interfaces/Subnet.md), `any`\>\> +▸ **showSubnet**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Subnet`](../interfaces/Subnet.md)\>\> Returns a Subnet object @@ -6354,7 +6354,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Subnet`](../interfaces/Subnet.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Subnet`](../interfaces/Subnet.md)\>\> #### Defined in @@ -6364,7 +6364,7 @@ ___ ### showSubscription -▸ **showSubscription**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Subscription`](../interfaces/Subscription.md), `any`\>\> +▸ **showSubscription**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Subscription`](../interfaces/Subscription.md)\>\> Returns a Subscription object @@ -6387,7 +6387,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Subscription`](../interfaces/Subscription.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Subscription`](../interfaces/Subscription.md)\>\> #### Defined in @@ -6397,7 +6397,7 @@ ___ ### showTag -▸ **showTag**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md), `any`\>\> +▸ **showTag**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)\>\> Returns a Tag object @@ -6420,7 +6420,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Tag`](../interfaces/Tag.md)\>\> #### Defined in @@ -6430,7 +6430,7 @@ ___ ### showTask -▸ **showTask**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Task`](../interfaces/Task.md), `any`\>\> +▸ **showTask**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Task`](../interfaces/Task.md)\>\> Returns a Task object @@ -6453,7 +6453,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Task`](../interfaces/Task.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Task`](../interfaces/Task.md)\>\> #### Defined in @@ -6463,7 +6463,7 @@ ___ ### showVm -▸ **showVm**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Vm`](../interfaces/Vm.md), `any`\>\> +▸ **showVm**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Vm`](../interfaces/Vm.md)\>\> Returns a Vm object @@ -6486,7 +6486,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Vm`](../interfaces/Vm.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Vm`](../interfaces/Vm.md)\>\> #### Defined in @@ -6496,7 +6496,7 @@ ___ ### showVolume -▸ **showVolume**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Volume`](../interfaces/Volume.md), `any`\>\> +▸ **showVolume**(`id`, `options?`): `Promise`<`AxiosResponse`<[`Volume`](../interfaces/Volume.md)\>\> Returns a Volume object @@ -6519,7 +6519,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Volume`](../interfaces/Volume.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Volume`](../interfaces/Volume.md)\>\> #### Defined in @@ -6529,7 +6529,7 @@ ___ ### showVolumeAttachment -▸ **showVolumeAttachment**(`id`, `options?`): `Promise`<`AxiosResponse`<[`VolumeAttachment`](../interfaces/VolumeAttachment.md), `any`\>\> +▸ **showVolumeAttachment**(`id`, `options?`): `Promise`<`AxiosResponse`<[`VolumeAttachment`](../interfaces/VolumeAttachment.md)\>\> Returns a VolumeAttachment object @@ -6552,7 +6552,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumeAttachment`](../interfaces/VolumeAttachment.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumeAttachment`](../interfaces/VolumeAttachment.md)\>\> #### Defined in @@ -6562,7 +6562,7 @@ ___ ### showVolumeType -▸ **showVolumeType**(`id`, `options?`): `Promise`<`AxiosResponse`<[`VolumeType`](../interfaces/VolumeType.md), `any`\>\> +▸ **showVolumeType**(`id`, `options?`): `Promise`<`AxiosResponse`<[`VolumeType`](../interfaces/VolumeType.md)\>\> Returns a VolumeType object @@ -6585,7 +6585,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VolumeType`](../interfaces/VolumeType.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VolumeType`](../interfaces/VolumeType.md)\>\> #### Defined in @@ -6595,7 +6595,7 @@ ___ ### updateTask -▸ **updateTask**(`id`, `task`, `options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **updateTask**(`id`, `task`, `options?`): `Promise`<`AxiosResponse`<`void`\>\> Updates a Task object @@ -6619,7 +6619,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in diff --git a/packages/vulnerabilities/api.ts b/packages/vulnerabilities/api.ts index 39dd3f483..1895bb9d6 100644 --- a/packages/vulnerabilities/api.ts +++ b/packages/vulnerabilities/api.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.19.1 + * The version of the OpenAPI document: 2.21.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -3191,7 +3191,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }, /** * Checks database availability and API response threshold time. - * @summary Health status of application + * @summary Determine the health of the application * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5090,7 +5090,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { }, /** * Checks database availability and API response threshold time. - * @summary Health status of application + * @summary Determine the health of the application * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5634,7 +5634,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa }, /** * Checks database availability and API response threshold time. - * @summary Health status of application + * @summary Determine the health of the application * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6097,7 +6097,7 @@ export class DefaultApi extends BaseAPI { /** * Checks database availability and API response threshold time. - * @summary Health status of application + * @summary Determine the health of the application * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi diff --git a/packages/vulnerabilities/apiSpec.json b/packages/vulnerabilities/apiSpec.json index 536088151..75bc63cbf 100644 --- a/packages/vulnerabilities/apiSpec.json +++ b/packages/vulnerabilities/apiSpec.json @@ -1 +1 @@ -{"components":{"parameters":{"account_id":{"description":"Account ID of user.","example":"123456","in":"path","name":"account_id","required":true,"schema":{"type":"string"}},"advanced_report":{"description":"Needs to be used when endpoint data is used for Report by CVEs feature, checks RBAC permission for advanced report.","example":false,"in":"query","name":"advanced_report","schema":{"type":"boolean"}},"advisory":{"description":"Filter by advisory name, works only with show_advisories=true","example":"RHSA-2019:1481","in":"query","name":"advisory","schema":{"type":"string"}},"advisory_available":{"description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","example":"true,false","in":"query","name":"advisory_available","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"affecting":{"description":"Comma seprated string with bools (array of bools). True value controls displaying CVEs with at least one system affected. False value toggles CVEs with no systems affected. Defaults to showing only CVEs with at least one system affected.","example":"true,false","in":"query","name":"affecting","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"affecting_host_type":{"description":"Controls, whenever CVE has 1 or more affecting systems. Value \"edge\" returns CVEs with one or more vulnerable immutable systems, value \"rpmdnf\" returns CVEs with one or more vulnerable conventional systems. Value \"none\" returns CVEs not affecting systems of any kind.","example":"edge,nil","in":"query","name":"affecting_host_type","schema":{"items":{"enum":["rpmdnf","edge","none"],"type":"string"},"maxItems":3,"type":"array"}},"ansible":{"description":"Boolean value which shows systems managed by Ansible Automation Platform.","example":false,"in":"query","name":"ansible","schema":{"type":"boolean"}},"business_risk_id":{"description":"Filter based on business risk IDs.","in":"query","name":"business_risk_id","schema":{"example":"1,3","type":"string"}},"cve_filter":{"description":"Full text filter for CVE and it's description text.","example":"CVE-2017","in":"query","name":"filter","schema":{"type":"string"}},"cve_id":{"description":"CVE id.","example":"CVE-2016-0800","in":"path","name":"cve_id","required":true,"schema":{"type":"string"}},"cve_sort":{"description":"Sorting used for response.","example":"-synopsis","in":"query","name":"sort","schema":{"type":"string"}},"cvss_from":{"description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"in":"query","name":"cvss_from","schema":{"type":"number"}},"cvss_to":{"description":"Filter based on cvss score, up to the value.","example":7.2,"in":"query","name":"cvss_to","schema":{"type":"number"}},"data_format":{"description":"Format of the output data, either JSON (default) or CSV.","in":"query","name":"data_format","schema":{"example":"json","type":"string"}},"excluded":{"description":"Comma seprated string with bools (array of bools). True boolean value displays systems which are excluded. False value displays systems excluded from vulnerability analysis. Defaults to showing only those systems which are not excluded.","example":"true,false","in":"query","name":"excluded","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"filter":{"description":"Full text filter for the display name of system.","example":"INV-ID-1234","in":"query","name":"filter","schema":{"type":"string"}},"first_reported_from":{"description":"Filter for CVEs/Systems where the vulnerability appeared after given date.","example":"2017-09-18T00:00:00+00:00","in":"query","name":"first_reported_from","required":false,"schema":{"description":"Datetime string","type":"string"}},"first_reported_to":{"description":"Filter for CVEs/Systems where the vulnerability appeared before given date.","example":"2017-09-18T00:00:00+00:00","in":"query","name":"first_reported_to","required":false,"schema":{"description":"Datetime string","type":"string"}},"group_ids":{"description":"IDs of the inventory groups.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","in":"query","name":"group_ids","schema":{"items":{"type":"string"},"type":"array"}},"group_names":{"description":"Names of the inventory groups.","example":"Production,Stage","in":"query","name":"group_names","schema":{"items":{"type":"string"},"type":"array"}},"host_type":{"description":"For filtering out the systems based on their type. Value \"rpmdnf\" for RPMDNF systems, \"edge\" for OSTree systems.","in":"query","name":"host_type","schema":{"items":{"enum":["rpmdnf","edge"],"type":"string"},"maxItems":2,"type":"array"}},"impact":{"description":"Filter based on impact IDs.","example":"5,7","in":"query","name":"impact","schema":{"type":"string"}},"inventory_id":{"description":"Inventory ID.","example":"INV-ID-0000-1234","in":"path","name":"inventory_id","required":true,"schema":{"format":"uuid","type":"string"}},"known_exploit":{"description":"String of booleans (array of booleans), where true shows CVEs with known exploits, false shows CVEs without known exploits.","example":"true,false","in":"query","name":"known_exploit","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"limit":{"description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","example":25,"in":"query","name":"limit","schema":{"maximum":9007199254740991,"minimum":1,"type":"integer"}},"mssql":{"description":"Boolean value which shows systems managed by MSSQL.","example":false,"in":"query","name":"mssql","schema":{"type":"boolean"}},"offset":{"description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","example":1,"in":"query","name":"offset","schema":{"maximum":9007199254740991,"minimum":0,"type":"integer"}},"page":{"description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","example":1,"in":"query","name":"page","schema":{"maximum":9007199254740991,"minimum":1,"type":"integer"}},"page_size":{"description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","example":25,"in":"query","name":"page_size","schema":{"maximum":9007199254740991,"minimum":1,"type":"integer"}},"public_from":{"description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","in":"query","name":"public_from","schema":{"type":"string"}},"public_to":{"description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","in":"query","name":"public_to","schema":{"type":"string"}},"remediation":{"description":"Filer based on available remediation type id.","in":"query","name":"remediation","schema":{"example":1,"type":"string"}},"report":{"description":"Needs to be used when endpoint data is used for report generation, checks RBAC permission for report and export feature.","example":false,"in":"query","name":"report","required":false,"schema":{"type":"boolean"}},"rhel_version":{"description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","in":"query","name":"rhel_version","required":false,"schema":{"description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1","type":"string"}},"rule":{"description":"Filters CVEs or systems by security rule, has two functionalities. If value is false, shows results without security rules, every other value is taken as rule error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","in":"query","name":"rule","schema":{"items":{"minLength":1,"type":"string"},"type":"array"}},"rule_key":{"description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","in":"query","name":"rule_key","schema":{"items":{"type":"string"},"type":"array"}},"rule_key_deprecated":{"deprecated":true,"description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","in":"query","name":"rule_key","schema":{"items":{"type":"string"},"type":"array"}},"rule_presence":{"description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","example":"true,false","in":"query","name":"rule_presence","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"rule_presence_deprecated":{"deprecated":true,"description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","example":"true,false","in":"query","name":"rule_presence","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"sap_sids":{"description":"List of SAP IDs to filter with","example":"ABC,CDE","in":"query","name":"sap_sids","schema":{"items":{"type":"string"},"type":"array"}},"sap_system":{"description":"Boolean value which shows systems managed by SAP.","example":false,"in":"query","name":"sap_system","schema":{"type":"boolean"}},"show_advisories":{"description":"If true shows advisories list","example":false,"in":"query","name":"show_advisories","schema":{"type":"boolean"}},"sort":{"description":"Sorting used for response.","example":"-inventory_id","in":"query","name":"sort","schema":{"type":"string"}},"stale":{"description":"If set to true, shows stale systems. If not set defaults to false.","in":"query","name":"stale","schema":{"type":"boolean"}},"status_id":{"description":"Filer based on CVE status ID.","in":"query","name":"status_id","schema":{"example":"1,4","type":"string"}},"tags":{"description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","example":"vulnerability/usage=server","in":"query","name":"tags","schema":{"items":{"pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$","type":"string"},"type":"array"}},"uuid":{"description":"Filter based on UUID of inventory.","example":"2ee58c62-809f-11ea-bc55-0242ac130003","in":"query","name":"uuid","schema":{"type":"string"}}},"schemas":{"AffectedSystemsIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"description":"Smallest dataset for frontend to work.","properties":{"display_name":{"description":"System's name.","example":"system.example.com","type":"string"},"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"mitigation_reason":{"description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true,"type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"rule_id":{"description":"ID of associated security rule.","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["inventory_id","rule_id","status_id","status_text","display_name","remediation"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"],"type":"object"},"AffectedSystemsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"advisories_list":{"description":"List of advisories for system","items":{"description":"Advisory id","example":"RHSA-2019:1481","type":"string"},"type":"array"},"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":true,"type":"boolean"},"culled_timestamp":{"description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"cve_status_id":{"description":"Internal ID of the CVE status.","example":4,"type":"integer"},"display_name":{"description":"System's name.","example":"system.example.com","nullable":true,"type":"string"},"first_reported":{"description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00","type":"string"},"insights_id":{"description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true,"type":"string"},"inventory_group":{"items":{"properties":{"id":{"description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000","type":"string"},"name":{"description":"Name of inventory group.","example":"group01","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"last_evaluation":{"description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"mitigation_reason":{"description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true,"type":"string"},"os":{"description":"Operating system.","example":"RHEL 8.4","type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"reporter":{"description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3],"type":"number"},"rule":{"description":"Details of associated security rule.","nullable":true,"properties":{"details":{"description":"Additional information specific to the system rule hit.","type":"object"},"resolution":{"description":"Details of recommended resolution.","properties":{"resolution":{"description":"Recommended resolution of the issue.","example":"Red Hat recommends that you update the dnsmasq package","nullable":true,"type":"string"}},"required":["resolution"],"type":"object"},"rule":{"properties":{"description":{"description":"Description of the associated security rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true,"type":"string"},"more_info":{"description":"Additional information about the issue.","example":"For more information about this specific flaw, see its ...","nullable":true,"type":"string"},"node_id":{"description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true,"type":"integer"},"reason":{"description":"Reason of why rule did hit.","example":"This system is vulnerable because it is running a vulnerable package.","nullable":true,"type":"string"},"rule_id":{"description":"ID of associated security rule.","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"}},"required":["description","more_info","node_id","reason","rule_id"],"type":"object"}},"required":["details","resolution","rule"],"type":"object"},"rules_evaluation":{"description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_timestamp":{"description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_warning_timestamp":{"description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_name":{"description":"Status of the vulnerability for the application's point of view.","example":"Resolved","type":"string"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"},"tags":{"items":{"properties":{"key":{"description":"Key of the single tag.","example":"CVE","type":"string"},"namespace":{"description":"Namespace of single tag.","example":"vulnerability","nullable":true,"type":"string"},"value":{"description":"Value of the single tag.","example":"CVE-2017-1","nullable":true,"type":"string"}},"required":["namespace","key","value"],"type":"object"},"type":"array"},"updated":{"description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"}},"required":["cve_status_id","culled_timestamp","display_name","first_reported","inventory_id","insights_id","last_evaluation","os","reporter","rule","rules_evaluation","stale_timestamp","stale_warning_timestamp","status_id","status_name","status_text","tags","updated","advisory_available","remediation","mitigation_reason","inventory_group"],"type":"object"},"id":{"description":"Host id.","example":"INV-ID-0000-1234","type":"string"},"type":{"description":"Type of the record.","example":"system","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"],"type":"object"},"AnnouncementOut":{"properties":{"last_updated":{"description":"Datetime string.","example":"2004-10-19 10:23:54+02","type":"string"},"message":{"description":"Announcement message.","example":"Hello from Vulnerability team :).","type":"string"}},"required":["message","last_updated"],"type":"object"},"BulkChangeOut":{"properties":{"meta":{"$ref":"#/components/schemas/MetaPermissions"},"updated":{"description":"List of updated objects/updated object IDs.","items":{"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","type":"string"},"type":"array"}},"required":["updated"],"type":"object"},"BusinessRiskListOut":{"properties":{"data":{"description":"List of available business risk/business_risk_id pairs.","items":{"properties":{"id":{"description":"Internal business_risk_id.","example":3,"type":"integer"},"name":{"description":"Represenation of internal business_risk_id.","example":"Low","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"meta":{"properties":{"total_items":{"description":"Total number of available business risk/business_risk_id pairs.","example":1,"type":"integer"}},"required":["total_items"],"type":"object"}},"required":["data","meta"],"type":"object"},"CveDetailOut":{"properties":{"data":{"properties":{"attributes":{"properties":{"advisories_list":{"description":"List of advisory names or detailed advisory information","items":{"oneOf":[{"example":"RHSA-2015:0809","type":"string"},{"properties":{"attributes":{"properties":{"advisory_type":{"example":3,"type":"integer"},"applicable_systems":{"example":2559,"type":"integer"},"description":{"example":"The bash packages provide Bash (Bourne-again shell), which is the default shell for Red Hat Enterprise Linux...","type":"string"},"public_date":{"example":"2020-09-01T15:22:07Z","type":"string"},"severity":{"example":2,"type":"integer"},"synopsis":{"example":"Moderate: bash security update","type":"string"}},"required":["applicable_systems"],"type":"object"},"id":{"example":"RHSA-2020:3592","type":"string"},"type":{"example":"advisory","type":"string"}},"required":["id","type"],"type":"object"}]},"nullable":true,"type":"array"},"affected_but_not_vulnerable":{"description":"Number of systems that are affected by given CVE but are not vulnerable.","example":0,"nullable":true,"type":"integer"},"business_risk":{"description":"Business risk of the vulnerability.","example":"Low","type":"string"},"business_risk_id":{"description":"Internal ID of the vulnerability business risk.","example":1,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true,"type":"string"},"celebrity_name":{"description":"\"Celebrity\" name of the CVE.","example":"Spectre/Meltdown","nullable":true,"type":"string"},"cvss2_metrics":{"description":"cvss2 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true,"type":"string"},"cvss2_score":{"description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true,"type":"string"},"cvss3_metrics":{"description":"cvss3 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true,"type":"string"},"cvss3_score":{"description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true,"type":"string"},"description":{"description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could...","type":"string"},"impact":{"description":"Red Hat security impact of the CVE.","example":"Important","type":"string"},"known_exploit":{"description":"Shows whether a CVE has known exploits or not","example":true,"type":"boolean"},"modified_date":{"description":"String representation of ISO-8601 formatted date of last modification of the CVE.","example":"2019-03-07T08:15:36+00:00","nullable":true,"type":"string"},"public_date":{"description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true,"type":"string"},"redhat_url":{"description":"Additional resource about the CVE, provided by Red Hat.","example":"https://access.redhat.com/security/cve/cve-2016-0800","nullable":true,"type":"string"},"rules":{"items":{"$ref":"#/components/schemas/InsightsRule"},"type":"array"},"secondary_url":{"description":"Additional resources about the CVE.","example":"https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-0800","nullable":true,"type":"string"},"status":{"description":"Status of the vulnerability.","example":"Not Reviewed","type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":1,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"},"synopsis":{"description":"Synopsis of the CVE.","example":"CVE-2016-0800","type":"string"},"systems_status_detail":{"description":"Counts of systems with given status type.","type":"object"},"systems_status_divergent":{"description":"How many systems-CVE pairs have different status than CVE-level.","example":20,"type":"integer"}},"required":["business_risk","business_risk_id","business_risk_text","celebrity_name","cvss2_metrics","cvss2_score","cvss3_metrics","cvss3_score","description","impact","modified_date","public_date","redhat_url","rules","secondary_url","status","status_id","status_text","synopsis","systems_status_detail","systems_status_divergent","advisories_list","known_exploit","affected_but_not_vulnerable"],"type":"object"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":{"description":"Type of the record.","example":"cve","type":"string"}},"required":["id","type","attributes"],"type":"object"},"meta":{"$ref":"#/components/schemas/MetaPermissions"}},"type":"object"},"CveOrList":{"example":"CVE-2016-0800","oneOf":[{"description":"CVE name.","example":"CVE-2016-0800","type":"string"},{"description":"List of CVEs for a bulk change.","items":{"example":"CVE-2016-0800","type":"string"},"type":"array"}]},"CveRiskIn":{"properties":{"business_risk_id":{"description":"Business risk ID to be set, obtained by GET method.","example":3,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"Not relevant","nullable":true,"type":"string"},"cve":{"$ref":"#/components/schemas/CveOrList"}},"required":["cve"],"type":"object"},"CveStatusIn":{"properties":{"cve":{"$ref":"#/components/schemas/CveOrList"},"status_id":{"description":"Status ID to be set, obtained by GET method.","example":3,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["cve"],"type":"object"},"CvesWithoutErrataIn":{"properties":{"enable":{"description":"Enable or disable CVEs without Errata feature.","example":true,"type":"boolean"}},"required":["enable"],"type":"object"},"CvesWithoutErrataOut":{"properties":{"meta":{"$ref":"#/components/schemas/MetaPermissions"},"updated":{"properties":{"cves_without_errata":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"org_id":{"type":"string"}},"type":"object"}},"required":["updated","meta"],"type":"object"},"DashbarOut":{"properties":{"critical_cves":{"type":"number"},"cves_with_rule":{"type":"number"},"exploitable_cves":{"type":"number"},"important_cves":{"type":"number"}},"type":"object"},"Dashboard":{"properties":{"cves_by_severity":{"description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"properties":{"count":{"description":"Number of CVEs with CVSS score lower than 4.","example":1902,"type":"integer"},"known_exploits":{"description":"Number of CVEs in given bracket with a known exploit.","example":6,"type":"number"},"percentage":{"description":"Percentage of CVEs with CVSS score lower than 4.","example":60,"type":"number"}},"required":["count","percentage"],"type":"object"},"4to7.9":{"properties":{"count":{"description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400,"type":"integer"},"known_exploits":{"description":"Number of CVEs in given bracket with a known exploit.","example":6,"type":"number"},"percentage":{"description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15,"type":"number"}},"required":["count","percentage"],"type":"object"},"8to10":{"properties":{"count":{"description":"Number of CVEs with CVSS score higher or equal to 8.","example":109,"type":"integer"},"known_exploits":{"description":"Number of CVEs in given bracket with a known exploit.","example":6,"type":"number"},"percentage":{"description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2,"type":"number"}},"required":["count","percentage"],"type":"object"},"na":{"properties":{"count":{"description":"Number of CVEs with N/A CVSS score.","example":109,"type":"integer"},"known_exploits":{"description":"Number of CVEs in given bracket with a known exploit.","example":6,"type":"number"},"percentage":{"description":"Percentage of CVEs with N/A CVSS score.","example":2,"type":"number"}},"required":["count","percentage"],"type":"object"}},"required":["0to3.9","4to7.9","8to10","na"],"type":"object"},"cves_total":{"description":"Number of unique CVEs discovered on the managed systems.","example":1902,"type":"integer"},"exploited_cves_count":{"description":"unique number of CVEs having known exploit affecting at least one system","example":5,"type":"integer"},"recent_cves":{"description":"Number of recently published CVEs identified on managed systems","properties":{"last30days":{"description":"Number of CVEs identified on managed systems published in last 30 days.","example":62,"type":"integer"},"last7days":{"description":"Number of CVEs identified on managed systems published in last 7 days.","example":14,"type":"integer"},"last90days":{"description":"Number of CVEs identified on managed systems published in last 90 days.","example":156,"type":"integer"}},"required":["last7days","last30days","last90days"],"type":"object"},"recent_rules":{"description":"List of recently (14 days) released security rules.","items":{"description":"Security rule.","properties":{"associated_cves":{"description":"List of CVEs associated with the security rule.","items":{"description":"CVE name.","example":"CVE-2016-0800","type":"string"},"type":"array"},"description":{"description":"Description of the issue related with the security rule.","example":"A heap-based buffer overflow was found in the way ...","type":"string"},"id":{"description":"ID of the security rule.","example":"CVE_2019_11135_cpu_taa|CVE_2019_11135_CPU_TAA_KERNEL","type":"string"},"name":{"description":"Name of the security rule.","example":"sudo privilege escalation","type":"string"},"node_id":{"description":"Node id of access.redhat.com/node/* article.","example":5737621,"nullable":true,"type":"number"},"public_date":{"description":"String representation of ISO-8601 formatted date of release of the security rule.","example":"2016-03-01T00:00:00+00:00","nullable":true,"type":"string"},"severity":{"description":"Number representation of the security rule severity.","example":3,"type":"number"},"systems_affected":{"description":"Number of systems triggering the security rule.","example":178,"type":"number"}},"type":"object"},"required":["associated_cves","description","name","node_id","severity","systems_affected"],"type":"array"},"rules_cves_total":{"description":"Total number of CVEs with associated security rules affecting given account.","example":12,"type":"integer"},"system_count":{"description":"Total systems registered to Vulnerability service (with applied filtering).","example":241,"type":"integer"}},"required":["cves_total","cves_by_severity","recent_cves","recent_rules","rules_cves_total","system_count","exploited_cves_count"],"type":"object"},"Errors":{"properties":{"errors":{"items":{"properties":{"detail":{"oneOf":[{"description":"Error detail.","example":"Record not found.","type":"string"},{"description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"description":"Error detail related to RBAC problem","type":"string"},"permissions":{"description":"Array with RBAC permissions of user","items":{"type":"string"},"type":"array"}},"type":"object"}]},"status":{"description":"String representation of HTTP status code.","example":404,"type":"string"}},"required":["detail","status"],"type":"object"},"minItems":1,"type":"array"}},"required":["errors"],"type":"object"},"ExecutiveReport":{"properties":{"cves_by_severity":{"description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"properties":{"count":{"description":"Number of CVEs with CVSS score lower than 4.","example":1902,"type":"integer"},"percentage":{"description":"Percentage of CVEs with CVSS score lower than 4.","example":60,"type":"number"}},"required":["count","percentage"],"type":"object"},"4to7.9":{"properties":{"count":{"description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400,"type":"integer"},"percentage":{"description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15,"type":"number"}},"required":["count","percentage"],"type":"object"},"8to10":{"properties":{"count":{"description":"Number of CVEs with CVSS score higher or equal to 8.","example":109,"type":"integer"},"percentage":{"description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2,"type":"number"}},"required":["count","percentage"],"type":"object"},"na":{"properties":{"count":{"description":"Number of CVEs with N/A CVSS score.","example":109,"type":"integer"},"percentage":{"description":"Percentage of CVEs with N/A CVSS score.","example":2,"type":"number"}},"required":["count","percentage"],"type":"object"}},"required":["0to3.9","4to7.9","8to10","na"],"type":"object"},"cves_total":{"description":"Number of unique CVEs discovered on the managed systems.","example":1902,"type":"integer"},"meta":{"$ref":"#/components/schemas/MetaPermissions"},"recent_cves":{"description":"Number of recently published CVEs identified on managed systems","properties":{"last30days":{"description":"Number of CVEs identified on managed systems published in last 30 days.","example":62,"type":"integer"},"last7days":{"description":"Number of CVEs identified on managed systems published in last 7 days.","example":14,"type":"integer"},"last90days":{"description":"Number of CVEs identified on managed systems published in last 90 days.","example":156,"type":"integer"}},"required":["last7days","last30days","last90days"],"type":"object"},"rules_by_severity":{"description":"Information about how much systems are affected by a security rule, broken down by rule severity.","properties":{"1":{"properties":{"rule_count":{"description":"How many unique rules with at least system affected are present.","example":12,"type":"integer"},"systems_affected":{"description":"How many unique systems are affected by at least one rules with given severity","example":443,"type":"integer"}},"required":["rule_count","systems_affected"],"type":"object"},"2":{"properties":{"rule_count":{"description":"How many unique rules with at least system affected are present.","example":12,"type":"integer"},"systems_affected":{"description":"How many unique systems are affected by at least one rules with given severity","example":443,"type":"integer"}},"required":["rule_count","systems_affected"],"type":"object"},"3":{"properties":{"rule_count":{"description":"How many unique rules with at least system affected are present.","example":12,"type":"integer"},"systems_affected":{"description":"How many unique systems are affected by at least one rules with given severity","example":443,"type":"integer"}},"required":["rule_count","systems_affected"],"type":"object"},"4":{"properties":{"rule_count":{"description":"How many unique rules with at least system affected are present.","example":12,"type":"integer"},"systems_affected":{"description":"How many unique systems are affected by at least one rules with given severity","example":443,"type":"integer"}},"required":["rule_count","systems_affected"],"type":"object"}},"required":["1","2","3","4"],"type":"object"},"rules_total":{"description":"Number of unique CVEs discovered on the managed systems.","example":1902,"type":"integer"},"system_count":{"description":"Total number of systems managed by vulnerability application.","example":25641,"type":"integer"},"top_cves":{"items":{"properties":{"cvss2_score":{"description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true,"type":"string"},"cvss3_score":{"description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true,"type":"string"},"description":{"description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could...","type":"string"},"known_exploit":{"description":"Shows whether a CVE has known exploits or not","example":true,"type":"boolean"},"rule_presence":{"description":"Indicator of security rule presence","example":true,"type":"boolean"},"security_rule":{"deprecated":true,"description":"Indicator of security rule presence","example":true,"type":"boolean"},"synopsis":{"description":"CVE synopsis","example":"CVE-2016-0800","type":"string"},"systems_affected":{"description":"Systems affected by the CVE.","example":1795,"type":"integer"}},"required":["synopsis","cvss2_score","cvss3_score","description","systems_affected","known_exploit"],"type":"object"},"type":"array"},"top_rules":{"items":{"properties":{"associated_cves":{"description":"All CVEs associated with the rule","items":{"example":"CVE-2019-1125","type":"string"},"type":"array"},"description":{"description":"Brief description of the issue.","example":"Privilege Escalation with running service (no fix available for this version)","type":"string"},"name":{"description":"Name of the security rule.","example":"httpd denial of service with running services","type":"string"},"rule_id":{"description":"ID of associated security rule.","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"},"severity":{"description":"Severity of the security rule.","example":3,"type":"integer"},"systems_affected":{"description":"Number of systems affected by the rule.","example":443,"type":"integer"}},"required":["associated_cves","description","name","rule_id","severity","systems_affected"],"type":"object"},"type":"array"}},"required":["system_count","cves_total","cves_by_severity","rules_by_severity","rules_total","recent_cves"],"type":"object"},"InsightsRule":{"properties":{"associated_cves":{"description":"List of CVEs associated with the rule.","items":{"example":"CVE-2016-0800","type":"string"},"type":"array"},"change_risk":{"description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true,"type":"integer"},"description":{"description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true,"type":"string"},"kbase_node_id":{"description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true,"type":"integer"},"playbook_count":{"description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true,"type":"integer"},"publish_date":{"description":"Date when the rule was published.","example":"2018-05-15T13:00:00Z","nullable":true,"type":"string"},"reboot_required":{"description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true,"type":"boolean"},"rule_id":{"description":"ID(s) of associated security rule(s).","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"},"rule_impact":{"description":"Shows rules impact number from 1 to 4","example":1,"nullable":true,"type":"integer"},"summary":{"description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true,"type":"string"},"systems_affected":{"description":"Number of systems affected by the rule.","example":72,"type":"integer"}},"required":["associated_cves","change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","rule_impact","publish_date"],"type":"object"},"InventoryIdOrList":{"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","oneOf":[{"description":"Inventory ID.","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","type":"string"},{"description":"List of inventory IDs for a bulk change.","items":{"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","type":"string"},"type":"array"}]},"Links":{"properties":{"first":{"description":"Link to first page.","example":"/api?offset=0&limit=1","type":"string"},"last":{"description":"Link to last page.","example":"/api?offset=7&limit=1","type":"string"},"next":{"description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true,"type":"string"},"previous":{"description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true,"type":"string"}},"required":["first","last","next","previous"],"type":"object"},"Meta":{"properties":{"data_format":{"description":"Format of the output data, either JSON (default) or CSV.","example":"JSON","type":"string"},"filter":{"description":"Full text filter","example":"CVE-2016-0800","nullable":true,"type":"string"},"limit":{"description":"Maximum number of paginated results.","example":25,"type":"integer"},"offset":{"description":"First record of paginated response.","example":0,"type":"integer"},"page":{"description":"Page number of paginated response.","example":1,"type":"integer"},"page_size":{"description":"Number of records per page of paginated response.","example":25,"type":"integer"},"pages":{"description":"Total number of pages of paginated response.","example":1,"type":"integer"},"sort":{"description":"Sorting filter.","example":"-inventory_id","nullable":true,"type":"string"},"total_items":{"description":"Total number of records.","example":37,"type":"integer"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"],"type":"object"},"MetaAffectedSystems":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"properties":{"cves_without_errata":{"description":"CVEs without Errata feature flag","nullable":true,"type":"boolean"},"first_reported_from":{"description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"first_reported_to":{"description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"group_ids":{"description":"ID of the inventory group.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","nullable":true,"type":"string"},"group_names":{"description":"Name of the inventory group.","example":"Production,Stage","nullable":true,"type":"string"},"patch_access":{"description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true,"type":"boolean"},"rhel_version":{"description":"Filter base on system RHEL version.","example":"8.2","nullable":true,"type":"string"},"rule_key":{"description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","nullable":true,"type":"string"},"rule_presence":{"description":"Filter based on presence of security rule","example":"true,false","nullable":true,"type":"string"},"status_id":{"description":"Filer based on CVE status ID.","example":"1,4","nullable":true,"type":"string"}},"required":["status_id","rule_key","rule_presence","patch_access","rhel_version","first_reported_from","first_reported_to","cves_without_errata","group_names","group_ids"],"type":"object"}]},"MetaCves":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"properties":{"business_risk_id":{"description":"Filter based on business risk IDs.","example":"1,3","nullable":true,"type":"string"},"cves_without_errata":{"description":"CVEs without Errata feature flag","nullable":true,"type":"boolean"},"cvss_from":{"description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true,"type":"number"},"cvss_to":{"description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true,"type":"number"},"first_reported_from":{"description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"first_reported_to":{"description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"impact":{"description":"Filter based on impact IDs.","example":"5,7","nullable":true,"type":"string"},"patch_access":{"description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true,"type":"boolean"},"public_from":{"description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"public_to":{"description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"rule_presence":{"description":"Filter based on presence of security rule","example":"true,false","nullable":true,"type":"string"},"status_id":{"description":"Filer based on CVE status ID.","example":"1,4","nullable":true,"type":"string"}},"required":["business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","status_id","rule_presence","patch_access","first_reported_from","first_reported_to","cves_without_errata"],"type":"object"}]},"MetaCvesSystems":{"allOf":[{"$ref":"#/components/schemas/MetaCves"},{"properties":{"opt_out":{"description":"If given system was opted out.","example":true,"type":"boolean"}},"required":["opt_out"],"type":"object"}]},"MetaPermissions":{"properties":{"permissions":{"description":"Fetched permissions from RBAC for given user","items":{"example":"vulnerability:vulnerability_results:read","type":"string"},"nullable":false,"type":"array"}},"required":["permissions"],"type":"object"},"MetaSystems":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"properties":{"excluded":{"description":"Display setting of opted out systems.","example":"true,false","nullable":true,"type":"string"},"rhel_version":{"description":"Filter base on system RHEL version.","example":"8.2","nullable":true,"type":"string"}},"required":["excluded","rhel_version"],"type":"object"}]},"MetaVulnerabilitiesOut":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"properties":{"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":"true,false","nullable":true,"type":"string"},"affecting":{"description":"Description of CVE showing preferences","example":"True,False","nullable":true,"type":"string"},"business_risk_id":{"description":"Filter based on business risk IDs.","example":"1,3","nullable":true,"type":"string"},"cves_without_errata":{"description":"CVEs without Errata feature flag","nullable":true,"type":"boolean"},"cvss_from":{"description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true,"type":"number"},"cvss_to":{"description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true,"type":"number"},"impact":{"description":"Filter based on impact IDs.","example":"5,7","nullable":true,"type":"string"},"public_from":{"description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"public_to":{"description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"rhel_version":{"description":"Filter base on system RHEL version.","example":"8.2","nullable":true,"type":"string"},"rule_presence":{"description":"Filter based on presence of security rule","example":"true,false","nullable":true,"type":"string"},"system_count":{"description":"Total number of systems managed by vulnerability application.","example":25641,"type":"integer"}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available"],"type":"object"}]},"MitigatedSystemsIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"description":"Smallest dataset for frontend to work.","properties":{"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"rule_id":{"description":"ID of associated security rule.","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["inventory_id","rule_id","status_id","status_text"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"],"type":"object"},"MitigatedSystemsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"advisories_list":{"description":"List of advisories for system","items":{"description":"Advisory id","example":"RHSA-2019:1481","type":"string"},"type":"array"},"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":true,"type":"boolean"},"culled_timestamp":{"description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"cve_status_id":{"description":"Internal ID of the CVE status.","example":4,"type":"integer"},"display_name":{"description":"System's name.","example":"system.example.com","nullable":true,"type":"string"},"insights_id":{"description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true,"type":"string"},"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"last_evaluation":{"description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"mitigation_reason":{"description":"Reason why the system is not vulnerable","example":"SELinux mitigates the issue","type":"string"},"os":{"description":"Operating system.","example":"RHEL 8.4","type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"reporter":{"description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3],"type":"number"},"rule_id":{"description":"ID(s) of associated security rule(s)..","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"},"rules_evaluation":{"description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_timestamp":{"description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_warning_timestamp":{"description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_name":{"description":"Status of the vulnerability for the application's point of view.","example":"Resolved","type":"string"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"},"tags":{"items":{"properties":{"key":{"description":"Key of the single tag.","example":"CVE","type":"string"},"namespace":{"description":"Namespace of single tag.","example":"vulnerability","nullable":true,"type":"string"},"value":{"description":"Value of the single tag.","example":"CVE-2017-1","nullable":true,"type":"string"}},"required":["namespace","key","value"],"type":"object"},"type":"array"},"updated":{"description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"}},"required":["cve_status_id","culled_timestamp","display_name","inventory_id","insights_id","last_evaluation","mitigation_reason","os","reporter","rules_evaluation","stale_timestamp","stale_warning_timestamp","status_id","status_name","status_text","tags","updated","advisory_available","remediation"],"type":"object"},"id":{"description":"Host id.","example":"INV-ID-0000-1234","type":"string"},"type":{"description":"Type of the record.","example":"system","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"],"type":"object"},"OptOutIn":{"properties":{"inventory_id":{"$ref":"#/components/schemas/InventoryIdOrList"},"opt_out":{"description":"Opt out setting to be set.","example":true,"type":"boolean"}},"required":["inventory_id","opt_out"],"type":"object"},"PlaybookTemplate":{"properties":{"data":{"items":{"properties":{"description":{"description":"Playbook template description.","example":"Fix issues caused by CVE_2017_6074_kernel|KERNEL_CVE_2017_6074.","type":"string"},"play":{"description":"Actual playbook template.","type":"string"},"reboot_required":{"description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true,"type":"boolean"},"resolution_type":{"description":"Type of the resolution provided by playbook.","type":"string"},"version":{"description":"Revision of the playbook template.","example":"93a1ced8a259666f0505cd20b7cb8e7a1c65b868","type":"string"}},"required":["description","play","version","resolution_type"],"type":"object"},"type":"array"}},"type":"object"},"StatusIn":{"properties":{"cve":{"$ref":"#/components/schemas/CveOrList"},"inventory_id":{"$ref":"#/components/schemas/InventoryIdOrList"},"status_id":{"description":"Status ID to be set, obtained by GET method. If not specified, global CVE status is set.","example":3,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["cve"],"type":"object"},"StatusListOut":{"properties":{"data":{"description":"List of available status/status_id pairs.","items":{"properties":{"id":{"description":"Internal status_id.","example":3,"type":"integer"},"name":{"description":"Represenation of internal status_id.","example":"Scheduled for Patch","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"meta":{"properties":{"total_items":{"description":"Total number of available status/status_id pairs.","example":1,"type":"integer"}},"required":["total_items"],"type":"object"}},"required":["data","meta"],"type":"object"},"StatusOut":{"properties":{"meta":{"$ref":"#/components/schemas/MetaPermissions"},"updated":{"description":"List of updated objects/updated object IDs.","items":{"properties":{"cve":{"example":"CVE-2016-0800","type":"string"},"inventory_id":{"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","type":"string"}},"required":["inventory_id","cve"],"type":"object"},"type":"array"}},"required":["updated"],"type":"object"},"SystemCvesIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"description":"CVE id and minimal information for frontend","properties":{"cve_status_id":{"description":"Internal ID of the CVE status.","example":4,"type":"integer"},"cve_status_text":{"description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true,"type":"string"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"rule_id":{"description":"ID(s) of associated security rule(s)..","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["id","rule_id","status_id","status_text","cve_status_id","cve_status_text","remediation"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaCves"}},"required":["data","links","meta"],"type":"object"},"SystemCvesOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"advisories_list":{"description":"List of advisories for CVE","items":{"description":"Advisory id","example":"RHSA-2019:1481","type":"string"},"type":"array"},"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":true,"type":"boolean"},"business_risk":{"description":"Business risk of the vulnerability.","example":"Low","type":"string"},"business_risk_id":{"description":"Internal ID of the vulnerability business risk.","example":1,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true,"type":"string"},"cve_status_id":{"description":"Internal ID of the CVE status.","example":4,"type":"integer"},"cve_status_text":{"description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true,"type":"string"},"cvss2_score":{"description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true,"type":"string"},"cvss3_score":{"description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true,"type":"string"},"description":{"description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could...","type":"string"},"first_reported":{"description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00","type":"string"},"impact":{"description":"Red Hat security impact of the CVE.","example":"Important","type":"string"},"known_exploit":{"description":"Shows whether a CVE has known exploits or not","example":true,"type":"boolean"},"public_date":{"description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true,"type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"reporter":{"description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3],"type":"number"},"rule":{"nullable":true,"properties":{"change_risk":{"description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true,"type":"integer"},"description":{"description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true,"type":"string"},"generate_autoplaybook":{"description":"Indicates whether a playbook should be auto-generated.","example":true,"nullable":true,"type":"boolean"},"kbase_node_id":{"description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true,"type":"integer"},"playbook_count":{"description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true,"type":"integer"},"reboot_required":{"description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true,"type":"boolean"},"rule_id":{"description":"ID(s) of associated security rule(s).","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"},"summary":{"description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true,"type":"string"}},"required":["change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","generate_autoplaybook"],"type":"object"},"status":{"description":"Status of the vulnerability for the application's point of view.","example":"Resolved","type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"},"synopsis":{"description":"Synopsis of the CVE.","example":"CVE-2016-0800","type":"string"}},"required":["business_risk","business_risk_id","business_risk_text","cve_status_id","cve_status_text","cvss2_score","cvss3_score","description","first_reported","impact","public_date","reporter","rule","status","status_id","status_text","synopsis","known_exploit","advisory_available","remediation"],"type":"object"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":{"description":"Type of the record.","example":"cve","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaCves"}},"required":["data","links","meta"],"type":"object"},"SystemDetailsOut":{"properties":{"data":{"properties":{"last_evaluation":{"description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"last_upload":{"description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"opt_out":{"description":"System opt out status.","example":true,"type":"boolean"},"os":{"description":"Operating system.","example":"RHEL 8.4","type":"string"},"rules_evaluation":{"description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale":{"description":"System stale status.","example":true,"type":"boolean"},"tags":{"items":{"properties":{"key":{"description":"Key of the single tag.","example":"CVE","type":"string"},"namespace":{"description":"Namespace of single tag.","example":"vulnerability","nullable":true,"type":"string"},"value":{"description":"Value of the single tag.","example":"CVE-2017-1","nullable":true,"type":"string"}},"required":["namespace","key","value"],"type":"object"},"type":"array"},"updated":{"description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"}},"required":["last_evaluation","rules_evaluation","opt_out","last_upload","tags","os"],"type":"object"},"meta":{"$ref":"#/components/schemas/MetaPermissions"}},"required":["data","meta"],"type":"object"},"SystemIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"display_name":{"description":"System's name.","example":"system.example.com","nullable":true,"type":"string"},"id":{"description":"Inventory ID.","example":"INV-ID00-0000-1234","type":"string"},"opt_out":{"description":"Whether the system is active or not.","example":false,"nullable":true,"type":"boolean"}},"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaSystems"}},"required":["data","links","meta"],"type":"object"},"SystemListOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"culled_timestamp":{"description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"cve_count":{"description":"Number of CVE exposures for the system.","example":7,"nullable":true,"type":"integer"},"display_name":{"description":"System's name,","example":"system.example.com","nullable":true,"type":"string"},"insights_id":{"description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true,"type":"string"},"inventory_group":{"items":{"properties":{"id":{"description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000","type":"string"},"name":{"description":"Name of inventory group.","example":"group01","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"last_evaluation":{"description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"last_upload":{"description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"opt_out":{"description":"Opt out status of the system.","example":false,"type":"boolean"},"os":{"description":"Operating system.","example":"RHEL 8.4","type":"string"},"rules_evaluation":{"description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_timestamp":{"description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_warning_timestamp":{"description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"tags":{"description":"Tags given to the system.","items":{"properties":{"key":{"description":"Key of the single tag.","example":"CVE","type":"string"},"namespace":{"description":"Namespace of single tag.","example":"vulnerability","nullable":true,"type":"string"},"value":{"description":"Value of the single tag.","example":"CVE-2017-1","nullable":true,"type":"string"}},"required":["namespace","key","value"],"type":"object"},"nullable":true,"type":"array"},"updated":{"description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"}},"required":["cve_count","display_name","inventory_id","insights_id","last_evaluation","rules_evaluation","opt_out","last_upload","os","stale_timestamp","stale_warning_timestamp","tags","culled_timestamp","inventory_group"],"type":"object"},"id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"type":{"description":"Type of the record.","example":"system","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaSystems"}},"required":["data","links","meta"],"type":"object"},"VersionOut":{"properties":{"application_version":{"description":"Version of application.","example":"0.1.2","type":"string"},"database_version":{"description":"Version of database schema.","example":1,"oneOf":[{"type":"string"},{"type":"number"}]}},"required":["application_version","database_version"],"type":"object"},"VulnerabilitiesIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"description":"CVE id and minimal information.","properties":{"business_risk_id":{"description":"Internal ID of the vulnerability business risk.","example":1,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true,"type":"string"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":1,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not Relevant","nullable":true,"type":"string"}},"type":"object"},"required":["business_risk_id","business_risk_text","id","status_id","status_text"],"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaVulnerabilitiesOut"}},"required":["data","links","meta"],"type":"object"},"VulnerabilitiesOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":true,"type":"boolean"},"business_risk":{"description":"Business risk of the vulnerability.","example":"Low","type":"string"},"business_risk_id":{"description":"Internal ID of the vulnerability business risk.","example":1,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true,"type":"string"},"cvss2_score":{"description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true,"type":"string"},"cvss3_score":{"description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true,"type":"string"},"description":{"description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could...","type":"string"},"impact":{"description":"Red Hat security impact of the CVE.","example":"Important","type":"string"},"known_exploit":{"description":"Shows whether a CVE has known exploits or not","example":true,"type":"boolean"},"public_date":{"description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true,"type":"string"},"rules":{"items":{"$ref":"#/components/schemas/InsightsRule"},"type":"array"},"status":{"description":"Status of the vulnerability.","example":"Not Reviewed","type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":1,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not Relevant","nullable":true,"type":"string"},"synopsis":{"description":"Synopsis of the CVE.","example":"CVE-2016-0800","type":"string"},"systems_affected":{"description":"Number of systems affected by the CVE.","example":7,"type":"integer"},"systems_status_divergent":{"description":"How many systems-CVE pairs have different status than CVE-level.","example":20,"type":"integer"}},"required":["business_risk","business_risk_id","business_risk_text","cvss2_score","cvss3_score","description","impact","public_date","rules","status","status_id","status_text","synopsis","systems_affected","systems_status_divergent","known_exploit","advisory_available"],"type":"object"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":{"description":"Type of the record.","example":"cve","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaVulnerabilitiesOut"}},"required":["data","links","meta"],"type":"object"},"VulnerabilitiesPostIn":{"properties":{"cve_list":{"description":"Array of CVEs to provide info about","items":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":"array"}},"required":["cve_list"],"type":"object"},"VulnerabilitiesPostOut":{"properties":{"data":{"items":{"properties":{"attributes":{"properties":{"cvss_score":{"description":"String representation of cvss3 or cvvs2 (if v3 is not present) score of the CVE.","example":"5.800","nullable":true,"type":"string"},"impact":{"description":"Red Hat security impact of the CVE.","example":"Important","type":"string"},"synopsis":{"description":"Synopsis of the CVE.","example":"CVE-2016-0800","type":"string"}},"required":["cvss_score","impact","synopsis"],"type":"object"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":{"description":"Type of the record.","example":"cve","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"}]}},"required":["data","links","meta"],"type":"object"}},"securitySchemes":{"ApiKeyAuth":{"description":"Identity header provided by 3scale (for non-prod testing only).","in":"header","name":"x-rh-identity","type":"apiKey","x-apikeyInfoFunc":"manager.base.auth"},"BasicAuth":{"description":"Username and password login.","scheme":"basic","type":"http","x-basicInfoFunc":"manager.base.basic_auth"}}},"info":{"title":"Vulnerability Engine Manager","version":"2.19.1"},"openapi":"3.0.0","paths":{"/announcement":{"get":{"description":"This endpoint provides vulnerability service announcements. Remain informed about important alerts for the vulnerability service. Announcements are issued by Insights Product Managers and other subject matter experts.\n","operationId":"getAnnouncement","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AnnouncementOut"}}},"description":"Announcement."}},"summary":"Announce important updates","x-methodName":"getAnnouncement"}},"/apistatus":{"get":{"description":"Checks database availability and API response threshold time.","operationId":"getApiStatus","responses":{"200":{"description":"API is healthy"},"408":{"description":"API is down (time out)"},"503":{"description":"Database is unavaiable"}},"summary":"Health status of application","x-methodName":"getApiStatus"}},"/business_risk":{"get":{"description":"This endpoint helps you determine the numeric business risk for a given CVE. A business risk is a label you can set for a given CVE. Choose one of five business risk options ranging from 0-4, where 0 is not defined and 4 indicates a critical risk. You must call this endpoint to choose a numerical value before calling the *PATCH/cves/business_risk* endpoint.\n","operationId":"getBusinessRiskList","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BusinessRiskListOut"}}},"description":"List of business risk/business_risk_id pairs."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Access business risk values","x-methodName":"getBusinessRiskList"}},"/cves/business_risk":{"patch":{"description":"This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path.\n","operationId":"setCveBusinessRisk","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CveRiskIn","x-body-name":"data"}}},"description":"Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkChangeOut"}}},"description":"Business risk successfully updated."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."},"503":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Service is running in read-only mode."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Set business risk for a CVE","x-methodName":"setCveBusinessRisk"}},"/cves/status":{"patch":{"description":"This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path.\n","operationId":"setCveStatus","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CveStatusIn","x-body-name":"data"}}},"description":"Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkChangeOut"}}},"description":"Status successfully updated."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."},"503":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Service is running in read-only mode."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Set status for a CVE","x-methodName":"setCveStatus"}},"/cves/{cve_id}":{"get":{"description":"This endpoint returns the CVE identification number, description, scores and other metadata. The metadata includes the description, CVSS 2/3 Score, CVSS 2/3 attack vector, severity, public date, modified date, business risk, status, a URL to Red Hat web pages, a list of advisories remediating the CVE, and information regarding known exploits for the CVE.\n","operationId":"getCveDetails","parameters":[{"$ref":"#/components/parameters/cve_id"},{"$ref":"#/components/parameters/advisory_available"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CveDetailOut"}}},"description":"CVE details"},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get CVE details","x-methodName":"getCveDetails"}},"/cves/{cve_id}/affected_systems":{"get":{"description":"This is a report of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected servers along with last check-in, system name and more.\n","operationId":"getAffectedSystemsByCve","parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/cve_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/rule_key_deprecated"},{"$ref":"#/components/parameters/rule_presence_deprecated"},{"$ref":"#/components/parameters/rule"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/host_type"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AffectedSystemsOut"}}},"description":"Report of affected systems for a given CVE."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Determine affected systems for a given CVE","x-methodName":"getAffectedSystemsByCve"}},"/cves/{cve_id}/affected_systems/ids":{"get":{"description":"This is a report of identification numbers of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected systems.\n","operationId":"getAffectedSystemsIdsByCve","parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/cve_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/rule_key_deprecated"},{"$ref":"#/components/parameters/rule_presence_deprecated"},{"$ref":"#/components/parameters/rule"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/host_type"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AffectedSystemsIdsOut"}}},"description":"Report of IDs of affected systems for a given CVE."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get identification numbers of affected systems for a given CVE","x-methodName":"getAffectedSystemsIdsByCve"}},"/dashbar":{"get":{"description":"These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence, severity and other details.\n","operationId":"getDashbar","parameters":[{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/DashbarOut"}}},"description":"Dashbar aggregations."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get aggregations for the dashbar","x-methodName":"getDashbar"}},"/dashboard":{"get":{"description":"These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity, and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence and severity.\n","operationId":"getDashboard","parameters":[{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}},"description":"Dashboard."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get a macro level overview of aggregated vulnerabilities","x-methodName":"getDashboard"}},"/feature/cves_without_errata":{"patch":{"description":"Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints.\n","operationId":"setCvesWithoutErrata","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CvesWithoutErrataIn","x-body-name":"data"}}},"description":"Values to be set.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CvesWithoutErrataOut"}}},"description":"CVEs without Errata feature successfully updated."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Set a feature flag for CVEs without errata","x-methodName":"setCvesWithoutErrata"}},"/playbooks/templates/{rule_id}":{"get":{"description":"This returns an Ansible playbook template for a given rule identification number. Use this endpoint to return an Ansible playbook template for a given rule error key. The template is used to remediate issues on your system.\n","operationId":"getPlaybookTemplate","parameters":[{"description":"Insights security rule ID.","example":"CVE_2017_8779_rpc|CVE_2017_8779_WARN","in":"path","name":"rule_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/PlaybookTemplate"}}},"description":"Playbook template response"},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given rule id does not exist."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get an Ansible Playbook template for CVEs with security rules","x-methodName":"getPlaybookTemplate"}},"/report/executive":{"get":{"description":"This returns an overview of vulnerabilities affecting a given account. Use this request when you need to download a high-level, executive report summarizing the security exposure of your infrastructure. These reports are designed for an executive audience and include data such as the number of RHEL systems analyzed, the number of security rules in your infrastructure, percentage of CVEs with a certain severity and more.\n","operationId":"getExecutiveReport","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ExecutiveReport"}}},"description":"Executive report."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Generate an executive report","x-methodName":"getExecutiveReport"}},"/status":{"get":{"description":"This endpoint returns a list of possible values for setting status for a CVE or system-CVE pair. Call this api when you want to know which values are available for setting a status. A list of numbers will be returned. You must call this endpoint before calling the *PATCH/cves/status* endpoint.\n","operationId":"getStatusList","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/StatusListOut"}}},"description":"List of status/status_id pairs."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Access available status values","x-methodName":"getStatusList"},"patch":{"description":"This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs.\n","operationId":"setStatus","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/StatusIn","x-body-name":"data"}}},"description":"Values to be set.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/StatusOut"}}},"description":"Status successfully updated."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given host/CVE does not exist."},"503":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Service is running in read-only mode."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Set status for system vulnerabilities","x-methodName":"setStatus"}},"/systems":{"get":{"description":"List systems that are accessible when you are logged into your account. Use this endpoint to view basic system attributes such as display name and system type.\n","operationId":"getSystemsList","parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/stale"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/excluded"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemListOut"}}},"description":"System list"}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"List systems","x-methodName":"getSystemsList"}},"/systems/ids":{"get":{"description":"This lists systems including those that have opted out of the current query. Use this when you do not want to see a registered system or systems in your reports.\n","operationId":"getSystemsIds","parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/stale"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/excluded"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemIdsOut"}}},"description":"System list"}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"List systems identification numbers along with opt out state","x-methodName":"getSystemsIds"}},"/systems/opt_out":{"patch":{"description":"Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems.\n","operationId":"setSystemsOptOut","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OptOutIn","x-body-name":"data"}}},"description":"Values to be set.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkChangeOut"}}},"description":"System(s) setting has been updated."},"503":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Service is running in read-only mode."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Opt a system in or out of the vulnerability service","x-methodName":"setSystemsOptOut"}},"/systems/{inventory_id}":{"get":{"description":"This allows you to get information about systems related to an inventory identification number. This includes details such as operating system, inventory tags, last update, opt-out status, and more.\n","operationId":"getSystemDetails","parameters":[{"$ref":"#/components/parameters/inventory_id"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemDetailsOut"}}},"description":"System details"},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"System has not been found in the database."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get system details","x-methodName":"getSystemDetails"}},"/systems/{inventory_id}/cves":{"get":{"description":"This endpoint displays detailed information about all CVEs for which a system is exposed. Use this endpoint to discover which CVEs are affecting a given system. CVE metadata is included.\n","operationId":"getCveListBySystem","parameters":[{"$ref":"#/components/parameters/inventory_id"},{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rule_key"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/report"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemCvesOut"}}},"description":"CVE report."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"System has not been found in the database."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get a CVE report for a system","x-methodName":"getCveListBySystem"}},"/systems/{inventory_id}/cves/ids":{"get":{"description":"This endpoint displays identification numbers of all CVEs for which a system is exposed. Use this endpoint to learn which CVEs are affecting a given system.\n","operationId":"getCveIdsBySystem","parameters":[{"$ref":"#/components/parameters/inventory_id"},{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rule_key"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemCvesIdsOut"}}},"description":"CVE Ids report."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"System has not been found in the database."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get a CVE identification number report for a system","x-methodName":"getCveIdsBySystem"}},"/version":{"get":{"description":"This endpoint will provide you with the application version. Use this endpoint to track application changes.\n","operationId":"getVersion","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VersionOut"}}},"description":"Application version."}},"summary":"Get application version","x-methodName":"getVersion"}},"/vulnerabilities/cves":{"get":{"description":"This provides an overview of vulnerabilities across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account, including some CVE metadata, how many systems are affected by each CVE, and more.\n","operationId":"getCveList","parameters":[{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/affecting"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/advanced_report"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/affecting_host_type"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesOut"}}},"description":"Vulnerabilities overview."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get a vulnerabilities overview","x-methodName":"getCveList"},"post":{"description":"This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request.\n","operationId":"getCveList","parameters":[{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesPostIn","x-body-name":"data"}}},"description":"List of CVEs to provide info about.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesPostOut"}}},"description":"Vulnerabilities overview."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Send a vulnerabilities overview","x-methodName":"getCveList"}},"/vulnerabilities/cves/ids":{"get":{"description":"This is an overview of vulnerabilities identification numbers across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account.\n","operationId":"getCveIdsList","parameters":[{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/affecting"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/advisory_available"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesIdsOut"}}},"description":"Vulnerabilities IDs overview."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get an overview of Vulnerabilities' identification numbers","x-methodName":"getCveIdsList"}}},"servers":[{"url":"/api/vulnerability/v1"}]} \ No newline at end of file +{"components":{"parameters":{"account_id":{"description":"Account ID of user.","example":"123456","in":"path","name":"account_id","required":true,"schema":{"type":"string"}},"advanced_report":{"description":"Needs to be used when endpoint data is used for Report by CVEs feature, checks RBAC permission for advanced report.","example":false,"in":"query","name":"advanced_report","schema":{"type":"boolean"}},"advisory":{"description":"Filter by advisory name, works only with show_advisories=true","example":"RHSA-2019:1481","in":"query","name":"advisory","schema":{"type":"string"}},"advisory_available":{"description":"String of booleans (array of booleans), where true shows CVE-system pairs with available advisory, false shows CVE-system pairs without available advisory.","example":"true,false","in":"query","name":"advisory_available","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"affecting":{"description":"Comma seprated string with bools (array of bools). True value controls displaying CVEs with at least one system affected. False value toggles CVEs with no systems affected. Defaults to showing only CVEs with at least one system affected.","example":"true,false","in":"query","name":"affecting","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"affecting_host_type":{"description":"Controls, whenever CVE has 1 or more affecting systems. Value \"edge\" returns CVEs with one or more vulnerable immutable systems, value \"rpmdnf\" returns CVEs with one or more vulnerable conventional systems. Value \"none\" returns CVEs not affecting systems of any kind.","example":"edge,nil","in":"query","name":"affecting_host_type","schema":{"items":{"enum":["rpmdnf","edge","none"],"type":"string"},"maxItems":3,"type":"array"}},"ansible":{"description":"Boolean value which shows systems managed by Ansible Automation Platform.","example":false,"in":"query","name":"ansible","schema":{"type":"boolean"}},"business_risk_id":{"description":"Filter based on business risk IDs.","in":"query","name":"business_risk_id","schema":{"example":"1,3","type":"string"}},"cve_filter":{"description":"Full text filter for CVE and it's description text.","example":"CVE-2017","in":"query","name":"filter","schema":{"type":"string"}},"cve_id":{"description":"CVE id.","example":"CVE-2016-0800","in":"path","name":"cve_id","required":true,"schema":{"type":"string"}},"cve_sort":{"description":"Sorting used for response.","example":"-synopsis","in":"query","name":"sort","schema":{"type":"string"}},"cvss_from":{"description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"in":"query","name":"cvss_from","schema":{"type":"number"}},"cvss_to":{"description":"Filter based on cvss score, up to the value.","example":7.2,"in":"query","name":"cvss_to","schema":{"type":"number"}},"data_format":{"description":"Format of the output data, either JSON (default) or CSV.","in":"query","name":"data_format","schema":{"example":"json","type":"string"}},"excluded":{"description":"Comma seprated string with bools (array of bools). True boolean value displays systems which are excluded. False value displays systems excluded from vulnerability analysis. Defaults to showing only those systems which are not excluded.","example":"true,false","in":"query","name":"excluded","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"filter":{"description":"Full text filter for the display name of system.","example":"INV-ID-1234","in":"query","name":"filter","schema":{"type":"string"}},"first_reported_from":{"description":"Filter for CVEs/Systems where the vulnerability appeared after given date.","example":"2017-09-18T00:00:00+00:00","in":"query","name":"first_reported_from","required":false,"schema":{"description":"Datetime string","type":"string"}},"first_reported_to":{"description":"Filter for CVEs/Systems where the vulnerability appeared before given date.","example":"2017-09-18T00:00:00+00:00","in":"query","name":"first_reported_to","required":false,"schema":{"description":"Datetime string","type":"string"}},"group_ids":{"description":"IDs of the inventory groups.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","in":"query","name":"group_ids","schema":{"items":{"type":"string"},"type":"array"}},"group_names":{"description":"Names of the inventory groups.","example":"Production,Stage","in":"query","name":"group_names","schema":{"items":{"type":"string"},"type":"array"}},"host_type":{"description":"For filtering out the systems based on their type. Value \"rpmdnf\" for RPMDNF systems, \"edge\" for OSTree systems.","in":"query","name":"host_type","schema":{"items":{"enum":["rpmdnf","edge"],"type":"string"},"maxItems":2,"type":"array"}},"impact":{"description":"Filter based on impact IDs.","example":"5,7","in":"query","name":"impact","schema":{"type":"string"}},"inventory_id":{"description":"Inventory ID.","example":"INV-ID-0000-1234","in":"path","name":"inventory_id","required":true,"schema":{"format":"uuid","type":"string"}},"known_exploit":{"description":"String of booleans (array of booleans), where true shows CVEs with known exploits, false shows CVEs without known exploits.","example":"true,false","in":"query","name":"known_exploit","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"limit":{"description":"Maximum number of records per page. Limit/Offset pagination wins over page/page_size pagination.","example":25,"in":"query","name":"limit","schema":{"maximum":9007199254740991,"minimum":1,"type":"integer"}},"mssql":{"description":"Boolean value which shows systems managed by MSSQL.","example":false,"in":"query","name":"mssql","schema":{"type":"boolean"}},"offset":{"description":"Offset of first record of paginated response. Limit/Offset pagination wins over page/page_size pagination.","example":1,"in":"query","name":"offset","schema":{"maximum":9007199254740991,"minimum":0,"type":"integer"}},"page":{"description":"Page number of paginated response. Limit/Offset pagination wins over page/page_size pagination.","example":1,"in":"query","name":"page","schema":{"maximum":9007199254740991,"minimum":1,"type":"integer"}},"page_size":{"description":"Page size of paginated response. Limit/Offset pagination wins over page/page_size pagination.","example":25,"in":"query","name":"page_size","schema":{"maximum":9007199254740991,"minimum":1,"type":"integer"}},"public_from":{"description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","in":"query","name":"public_from","schema":{"type":"string"}},"public_to":{"description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","in":"query","name":"public_to","schema":{"type":"string"}},"remediation":{"description":"Filer based on available remediation type id.","in":"query","name":"remediation","schema":{"example":1,"type":"string"}},"report":{"description":"Needs to be used when endpoint data is used for report generation, checks RBAC permission for report and export feature.","example":false,"in":"query","name":"report","required":false,"schema":{"type":"boolean"}},"rhel_version":{"description":"Filters results by RHEL OS version. Automatically flters out systems which are not RHEL or have uknown OS.","in":"query","name":"rhel_version","required":false,"schema":{"description":"List of RHEL versions. E.g. 7,8.1 will filter out everything which is not RHEL 7.x or RHEL 8.1","type":"string"}},"rule":{"description":"Filters CVEs or systems by security rule, has two functionalities. If value is false, shows results without security rules, every other value is taken as rule error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","in":"query","name":"rule","schema":{"items":{"minLength":1,"type":"string"},"type":"array"}},"rule_key":{"description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","in":"query","name":"rule_key","schema":{"items":{"type":"string"},"type":"array"}},"rule_key_deprecated":{"deprecated":true,"description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","in":"query","name":"rule_key","schema":{"items":{"type":"string"},"type":"array"}},"rule_presence":{"description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","example":"true,false","in":"query","name":"rule_presence","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"rule_presence_deprecated":{"deprecated":true,"description":"Comma seprated string with bools. If true shows only CVEs with security rule associated, if false shows CVEs without rules. true, false shows all.","example":"true,false","in":"query","name":"rule_presence","schema":{"items":{"type":"boolean"},"maxItems":2,"type":"array"}},"sap_sids":{"description":"List of SAP IDs to filter with","example":"ABC,CDE","in":"query","name":"sap_sids","schema":{"items":{"type":"string"},"type":"array"}},"sap_system":{"description":"Boolean value which shows systems managed by SAP.","example":false,"in":"query","name":"sap_system","schema":{"type":"boolean"}},"show_advisories":{"description":"If true shows advisories list","example":false,"in":"query","name":"show_advisories","schema":{"type":"boolean"}},"sort":{"description":"Sorting used for response.","example":"-inventory_id","in":"query","name":"sort","schema":{"type":"string"}},"stale":{"description":"If set to true, shows stale systems. If not set defaults to false.","in":"query","name":"stale","schema":{"type":"boolean"}},"status_id":{"description":"Filer based on CVE status ID.","in":"query","name":"status_id","schema":{"example":"1,4","type":"string"}},"tags":{"description":"Filter based on hosts tags. Tags needs to be in query format, that means /= or / if value is null. Characters '/', '=' in tag values needs to be escaped by url encoding.","example":"vulnerability/usage=server","in":"query","name":"tags","schema":{"items":{"pattern":"^([^=/]+\\/){1}([^=/])+(=[^=/]+)?$","type":"string"},"type":"array"}},"uuid":{"description":"Filter based on UUID of inventory.","example":"2ee58c62-809f-11ea-bc55-0242ac130003","in":"query","name":"uuid","schema":{"type":"string"}}},"schemas":{"AffectedSystemsIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"description":"Smallest dataset for frontend to work.","properties":{"display_name":{"description":"System's name.","example":"system.example.com","type":"string"},"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"mitigation_reason":{"description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true,"type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"rule_id":{"description":"ID of associated security rule.","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["inventory_id","rule_id","status_id","status_text","display_name","remediation"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"],"type":"object"},"AffectedSystemsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"advisories_list":{"description":"List of advisories for system","items":{"description":"Advisory id","example":"RHSA-2019:1481","type":"string"},"type":"array"},"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":true,"type":"boolean"},"culled_timestamp":{"description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"cve_status_id":{"description":"Internal ID of the CVE status.","example":4,"type":"integer"},"display_name":{"description":"System's name.","example":"system.example.com","nullable":true,"type":"string"},"first_reported":{"description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00","type":"string"},"insights_id":{"description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true,"type":"string"},"inventory_group":{"items":{"properties":{"id":{"description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000","type":"string"},"name":{"description":"Name of inventory group.","example":"group01","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"last_evaluation":{"description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"mitigation_reason":{"description":"Reason why the system is not vulnerable.","example":"SELinux mitigates the issue","nullable":true,"type":"string"},"os":{"description":"Operating system.","example":"RHEL 8.4","type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"reporter":{"description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3],"type":"number"},"rule":{"description":"Details of associated security rule.","nullable":true,"properties":{"details":{"description":"Additional information specific to the system rule hit.","type":"object"},"resolution":{"description":"Details of recommended resolution.","properties":{"resolution":{"description":"Recommended resolution of the issue.","example":"Red Hat recommends that you update the dnsmasq package","nullable":true,"type":"string"}},"required":["resolution"],"type":"object"},"rule":{"properties":{"description":{"description":"Description of the associated security rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true,"type":"string"},"more_info":{"description":"Additional information about the issue.","example":"For more information about this specific flaw, see its ...","nullable":true,"type":"string"},"node_id":{"description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true,"type":"integer"},"reason":{"description":"Reason of why rule did hit.","example":"This system is vulnerable because it is running a vulnerable package.","nullable":true,"type":"string"},"rule_id":{"description":"ID of associated security rule.","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"}},"required":["description","more_info","node_id","reason","rule_id"],"type":"object"}},"required":["details","resolution","rule"],"type":"object"},"rules_evaluation":{"description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_timestamp":{"description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_warning_timestamp":{"description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_name":{"description":"Status of the vulnerability for the application's point of view.","example":"Resolved","type":"string"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"},"tags":{"items":{"properties":{"key":{"description":"Key of the single tag.","example":"CVE","type":"string"},"namespace":{"description":"Namespace of single tag.","example":"vulnerability","nullable":true,"type":"string"},"value":{"description":"Value of the single tag.","example":"CVE-2017-1","nullable":true,"type":"string"}},"required":["namespace","key","value"],"type":"object"},"type":"array"},"updated":{"description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"}},"required":["cve_status_id","culled_timestamp","display_name","first_reported","inventory_id","insights_id","last_evaluation","os","reporter","rule","rules_evaluation","stale_timestamp","stale_warning_timestamp","status_id","status_name","status_text","tags","updated","advisory_available","remediation","mitigation_reason","inventory_group"],"type":"object"},"id":{"description":"Host id.","example":"INV-ID-0000-1234","type":"string"},"type":{"description":"Type of the record.","example":"system","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"],"type":"object"},"AnnouncementOut":{"properties":{"last_updated":{"description":"Datetime string.","example":"2004-10-19 10:23:54+02","type":"string"},"message":{"description":"Announcement message.","example":"Hello from Vulnerability team :).","type":"string"}},"required":["message","last_updated"],"type":"object"},"BulkChangeOut":{"properties":{"meta":{"$ref":"#/components/schemas/MetaPermissions"},"updated":{"description":"List of updated objects/updated object IDs.","items":{"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","type":"string"},"type":"array"}},"required":["updated"],"type":"object"},"BusinessRiskListOut":{"properties":{"data":{"description":"List of available business risk/business_risk_id pairs.","items":{"properties":{"id":{"description":"Internal business_risk_id.","example":3,"type":"integer"},"name":{"description":"Represenation of internal business_risk_id.","example":"Low","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"meta":{"properties":{"total_items":{"description":"Total number of available business risk/business_risk_id pairs.","example":1,"type":"integer"}},"required":["total_items"],"type":"object"}},"required":["data","meta"],"type":"object"},"CveDetailOut":{"properties":{"data":{"properties":{"attributes":{"properties":{"advisories_list":{"description":"List of advisory names or detailed advisory information","items":{"oneOf":[{"example":"RHSA-2015:0809","type":"string"},{"properties":{"attributes":{"properties":{"advisory_type":{"example":3,"type":"integer"},"applicable_systems":{"example":2559,"type":"integer"},"description":{"example":"The bash packages provide Bash (Bourne-again shell), which is the default shell for Red Hat Enterprise Linux...","type":"string"},"public_date":{"example":"2020-09-01T15:22:07Z","type":"string"},"severity":{"example":2,"type":"integer"},"synopsis":{"example":"Moderate: bash security update","type":"string"}},"required":["applicable_systems"],"type":"object"},"id":{"example":"RHSA-2020:3592","type":"string"},"type":{"example":"advisory","type":"string"}},"required":["id","type"],"type":"object"}]},"nullable":true,"type":"array"},"affected_but_not_vulnerable":{"description":"Number of systems that are affected by given CVE but are not vulnerable.","example":0,"nullable":true,"type":"integer"},"business_risk":{"description":"Business risk of the vulnerability.","example":"Low","type":"string"},"business_risk_id":{"description":"Internal ID of the vulnerability business risk.","example":1,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true,"type":"string"},"celebrity_name":{"description":"\"Celebrity\" name of the CVE.","example":"Spectre/Meltdown","nullable":true,"type":"string"},"cvss2_metrics":{"description":"cvss2 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true,"type":"string"},"cvss2_score":{"description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true,"type":"string"},"cvss3_metrics":{"description":"cvss3 metrics of the CVE.","example":"AV:N/AC:M/Au:N/C:P/I:P/A:N","nullable":true,"type":"string"},"cvss3_score":{"description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true,"type":"string"},"description":{"description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could...","type":"string"},"impact":{"description":"Red Hat security impact of the CVE.","example":"Important","type":"string"},"known_exploit":{"description":"Shows whether a CVE has known exploits or not","example":true,"type":"boolean"},"modified_date":{"description":"String representation of ISO-8601 formatted date of last modification of the CVE.","example":"2019-03-07T08:15:36+00:00","nullable":true,"type":"string"},"public_date":{"description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true,"type":"string"},"redhat_url":{"description":"Additional resource about the CVE, provided by Red Hat.","example":"https://access.redhat.com/security/cve/cve-2016-0800","nullable":true,"type":"string"},"rules":{"items":{"$ref":"#/components/schemas/InsightsRule"},"type":"array"},"secondary_url":{"description":"Additional resources about the CVE.","example":"https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-0800","nullable":true,"type":"string"},"status":{"description":"Status of the vulnerability.","example":"Not Reviewed","type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":1,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"},"synopsis":{"description":"Synopsis of the CVE.","example":"CVE-2016-0800","type":"string"},"systems_status_detail":{"description":"Counts of systems with given status type.","type":"object"},"systems_status_divergent":{"description":"How many systems-CVE pairs have different status than CVE-level.","example":20,"type":"integer"}},"required":["business_risk","business_risk_id","business_risk_text","celebrity_name","cvss2_metrics","cvss2_score","cvss3_metrics","cvss3_score","description","impact","modified_date","public_date","redhat_url","rules","secondary_url","status","status_id","status_text","synopsis","systems_status_detail","systems_status_divergent","advisories_list","known_exploit","affected_but_not_vulnerable"],"type":"object"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":{"description":"Type of the record.","example":"cve","type":"string"}},"required":["id","type","attributes"],"type":"object"},"meta":{"$ref":"#/components/schemas/MetaPermissions"}},"type":"object"},"CveOrList":{"example":"CVE-2016-0800","oneOf":[{"description":"CVE name.","example":"CVE-2016-0800","type":"string"},{"description":"List of CVEs for a bulk change.","items":{"example":"CVE-2016-0800","type":"string"},"type":"array"}]},"CveRiskIn":{"properties":{"business_risk_id":{"description":"Business risk ID to be set, obtained by GET method.","example":3,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"Not relevant","nullable":true,"type":"string"},"cve":{"$ref":"#/components/schemas/CveOrList"}},"required":["cve"],"type":"object"},"CveStatusIn":{"properties":{"cve":{"$ref":"#/components/schemas/CveOrList"},"status_id":{"description":"Status ID to be set, obtained by GET method.","example":3,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["cve"],"type":"object"},"CvesWithoutErrataIn":{"properties":{"enable":{"description":"Enable or disable CVEs without Errata feature.","example":true,"type":"boolean"}},"required":["enable"],"type":"object"},"CvesWithoutErrataOut":{"properties":{"meta":{"$ref":"#/components/schemas/MetaPermissions"},"updated":{"properties":{"cves_without_errata":{"properties":{"enabled":{"type":"boolean"}},"type":"object"},"org_id":{"type":"string"}},"type":"object"}},"required":["updated","meta"],"type":"object"},"DashbarOut":{"properties":{"critical_cves":{"type":"number"},"cves_with_rule":{"type":"number"},"exploitable_cves":{"type":"number"},"important_cves":{"type":"number"}},"type":"object"},"Dashboard":{"properties":{"cves_by_severity":{"description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"properties":{"count":{"description":"Number of CVEs with CVSS score lower than 4.","example":1902,"type":"integer"},"known_exploits":{"description":"Number of CVEs in given bracket with a known exploit.","example":6,"type":"number"},"percentage":{"description":"Percentage of CVEs with CVSS score lower than 4.","example":60,"type":"number"}},"required":["count","percentage"],"type":"object"},"4to7.9":{"properties":{"count":{"description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400,"type":"integer"},"known_exploits":{"description":"Number of CVEs in given bracket with a known exploit.","example":6,"type":"number"},"percentage":{"description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15,"type":"number"}},"required":["count","percentage"],"type":"object"},"8to10":{"properties":{"count":{"description":"Number of CVEs with CVSS score higher or equal to 8.","example":109,"type":"integer"},"known_exploits":{"description":"Number of CVEs in given bracket with a known exploit.","example":6,"type":"number"},"percentage":{"description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2,"type":"number"}},"required":["count","percentage"],"type":"object"},"na":{"properties":{"count":{"description":"Number of CVEs with N/A CVSS score.","example":109,"type":"integer"},"known_exploits":{"description":"Number of CVEs in given bracket with a known exploit.","example":6,"type":"number"},"percentage":{"description":"Percentage of CVEs with N/A CVSS score.","example":2,"type":"number"}},"required":["count","percentage"],"type":"object"}},"required":["0to3.9","4to7.9","8to10","na"],"type":"object"},"cves_total":{"description":"Number of unique CVEs discovered on the managed systems.","example":1902,"type":"integer"},"exploited_cves_count":{"description":"unique number of CVEs having known exploit affecting at least one system","example":5,"type":"integer"},"recent_cves":{"description":"Number of recently published CVEs identified on managed systems","properties":{"last30days":{"description":"Number of CVEs identified on managed systems published in last 30 days.","example":62,"type":"integer"},"last7days":{"description":"Number of CVEs identified on managed systems published in last 7 days.","example":14,"type":"integer"},"last90days":{"description":"Number of CVEs identified on managed systems published in last 90 days.","example":156,"type":"integer"}},"required":["last7days","last30days","last90days"],"type":"object"},"recent_rules":{"description":"List of recently (14 days) released security rules.","items":{"description":"Security rule.","properties":{"associated_cves":{"description":"List of CVEs associated with the security rule.","items":{"description":"CVE name.","example":"CVE-2016-0800","type":"string"},"type":"array"},"description":{"description":"Description of the issue related with the security rule.","example":"A heap-based buffer overflow was found in the way ...","type":"string"},"id":{"description":"ID of the security rule.","example":"CVE_2019_11135_cpu_taa|CVE_2019_11135_CPU_TAA_KERNEL","type":"string"},"name":{"description":"Name of the security rule.","example":"sudo privilege escalation","type":"string"},"node_id":{"description":"Node id of access.redhat.com/node/* article.","example":5737621,"nullable":true,"type":"number"},"public_date":{"description":"String representation of ISO-8601 formatted date of release of the security rule.","example":"2016-03-01T00:00:00+00:00","nullable":true,"type":"string"},"severity":{"description":"Number representation of the security rule severity.","example":3,"type":"number"},"systems_affected":{"description":"Number of systems triggering the security rule.","example":178,"type":"number"}},"type":"object"},"required":["associated_cves","description","name","node_id","severity","systems_affected"],"type":"array"},"rules_cves_total":{"description":"Total number of CVEs with associated security rules affecting given account.","example":12,"type":"integer"},"system_count":{"description":"Total systems registered to Vulnerability service (with applied filtering).","example":241,"type":"integer"}},"required":["cves_total","cves_by_severity","recent_cves","recent_rules","rules_cves_total","system_count","exploited_cves_count"],"type":"object"},"Errors":{"properties":{"errors":{"items":{"properties":{"detail":{"oneOf":[{"description":"Error detail.","example":"Record not found.","type":"string"},{"description":"Returned with RBAC (user permissions) related issue","properties":{"msg":{"description":"Error detail related to RBAC problem","type":"string"},"permissions":{"description":"Array with RBAC permissions of user","items":{"type":"string"},"type":"array"}},"type":"object"}]},"status":{"description":"String representation of HTTP status code.","example":404,"type":"string"}},"required":["detail","status"],"type":"object"},"minItems":1,"type":"array"}},"required":["errors"],"type":"object"},"ExecutiveReport":{"properties":{"cves_by_severity":{"description":"Number of CVEs discovered on the managed systems, divided into buckets based on their CVSSv3 score (CVSSv2 is used when CVSSv3 is not available).","properties":{"0to3.9":{"properties":{"count":{"description":"Number of CVEs with CVSS score lower than 4.","example":1902,"type":"integer"},"percentage":{"description":"Percentage of CVEs with CVSS score lower than 4.","example":60,"type":"number"}},"required":["count","percentage"],"type":"object"},"4to7.9":{"properties":{"count":{"description":"Number of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":400,"type":"integer"},"percentage":{"description":"Percentage of CVEs with CVSS score higher or equal to 4 and lower then 8.","example":15,"type":"number"}},"required":["count","percentage"],"type":"object"},"8to10":{"properties":{"count":{"description":"Number of CVEs with CVSS score higher or equal to 8.","example":109,"type":"integer"},"percentage":{"description":"Percentage of CVEs with CVSS score higher or equal to 8.","example":2,"type":"number"}},"required":["count","percentage"],"type":"object"},"na":{"properties":{"count":{"description":"Number of CVEs with N/A CVSS score.","example":109,"type":"integer"},"percentage":{"description":"Percentage of CVEs with N/A CVSS score.","example":2,"type":"number"}},"required":["count","percentage"],"type":"object"}},"required":["0to3.9","4to7.9","8to10","na"],"type":"object"},"cves_total":{"description":"Number of unique CVEs discovered on the managed systems.","example":1902,"type":"integer"},"meta":{"$ref":"#/components/schemas/MetaPermissions"},"recent_cves":{"description":"Number of recently published CVEs identified on managed systems","properties":{"last30days":{"description":"Number of CVEs identified on managed systems published in last 30 days.","example":62,"type":"integer"},"last7days":{"description":"Number of CVEs identified on managed systems published in last 7 days.","example":14,"type":"integer"},"last90days":{"description":"Number of CVEs identified on managed systems published in last 90 days.","example":156,"type":"integer"}},"required":["last7days","last30days","last90days"],"type":"object"},"rules_by_severity":{"description":"Information about how much systems are affected by a security rule, broken down by rule severity.","properties":{"1":{"properties":{"rule_count":{"description":"How many unique rules with at least system affected are present.","example":12,"type":"integer"},"systems_affected":{"description":"How many unique systems are affected by at least one rules with given severity","example":443,"type":"integer"}},"required":["rule_count","systems_affected"],"type":"object"},"2":{"properties":{"rule_count":{"description":"How many unique rules with at least system affected are present.","example":12,"type":"integer"},"systems_affected":{"description":"How many unique systems are affected by at least one rules with given severity","example":443,"type":"integer"}},"required":["rule_count","systems_affected"],"type":"object"},"3":{"properties":{"rule_count":{"description":"How many unique rules with at least system affected are present.","example":12,"type":"integer"},"systems_affected":{"description":"How many unique systems are affected by at least one rules with given severity","example":443,"type":"integer"}},"required":["rule_count","systems_affected"],"type":"object"},"4":{"properties":{"rule_count":{"description":"How many unique rules with at least system affected are present.","example":12,"type":"integer"},"systems_affected":{"description":"How many unique systems are affected by at least one rules with given severity","example":443,"type":"integer"}},"required":["rule_count","systems_affected"],"type":"object"}},"required":["1","2","3","4"],"type":"object"},"rules_total":{"description":"Number of unique CVEs discovered on the managed systems.","example":1902,"type":"integer"},"system_count":{"description":"Total number of systems managed by vulnerability application.","example":25641,"type":"integer"},"top_cves":{"items":{"properties":{"cvss2_score":{"description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true,"type":"string"},"cvss3_score":{"description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true,"type":"string"},"description":{"description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could...","type":"string"},"known_exploit":{"description":"Shows whether a CVE has known exploits or not","example":true,"type":"boolean"},"rule_presence":{"description":"Indicator of security rule presence","example":true,"type":"boolean"},"security_rule":{"deprecated":true,"description":"Indicator of security rule presence","example":true,"type":"boolean"},"synopsis":{"description":"CVE synopsis","example":"CVE-2016-0800","type":"string"},"systems_affected":{"description":"Systems affected by the CVE.","example":1795,"type":"integer"}},"required":["synopsis","cvss2_score","cvss3_score","description","systems_affected","known_exploit"],"type":"object"},"type":"array"},"top_rules":{"items":{"properties":{"associated_cves":{"description":"All CVEs associated with the rule","items":{"example":"CVE-2019-1125","type":"string"},"type":"array"},"description":{"description":"Brief description of the issue.","example":"Privilege Escalation with running service (no fix available for this version)","type":"string"},"name":{"description":"Name of the security rule.","example":"httpd denial of service with running services","type":"string"},"rule_id":{"description":"ID of associated security rule.","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"},"severity":{"description":"Severity of the security rule.","example":3,"type":"integer"},"systems_affected":{"description":"Number of systems affected by the rule.","example":443,"type":"integer"}},"required":["associated_cves","description","name","rule_id","severity","systems_affected"],"type":"object"},"type":"array"}},"required":["system_count","cves_total","cves_by_severity","rules_by_severity","rules_total","recent_cves"],"type":"object"},"InsightsRule":{"properties":{"associated_cves":{"description":"List of CVEs associated with the rule.","items":{"example":"CVE-2016-0800","type":"string"},"type":"array"},"change_risk":{"description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true,"type":"integer"},"description":{"description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true,"type":"string"},"kbase_node_id":{"description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true,"type":"integer"},"playbook_count":{"description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true,"type":"integer"},"publish_date":{"description":"Date when the rule was published.","example":"2018-05-15T13:00:00Z","nullable":true,"type":"string"},"reboot_required":{"description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true,"type":"boolean"},"rule_id":{"description":"ID(s) of associated security rule(s).","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"},"rule_impact":{"description":"Shows rules impact number from 1 to 4","example":1,"nullable":true,"type":"integer"},"summary":{"description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true,"type":"string"},"systems_affected":{"description":"Number of systems affected by the rule.","example":72,"type":"integer"}},"required":["associated_cves","change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","rule_impact","publish_date"],"type":"object"},"InventoryIdOrList":{"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","oneOf":[{"description":"Inventory ID.","example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","type":"string"},{"description":"List of inventory IDs for a bulk change.","items":{"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","type":"string"},"type":"array"}]},"Links":{"properties":{"first":{"description":"Link to first page.","example":"/api?offset=0&limit=1","type":"string"},"last":{"description":"Link to last page.","example":"/api?offset=7&limit=1","type":"string"},"next":{"description":"Link to next page.","example":"/api?offset=5&limit=1","nullable":true,"type":"string"},"previous":{"description":"Link to next page.","example":"/api?offset=3&limit=1","nullable":true,"type":"string"}},"required":["first","last","next","previous"],"type":"object"},"Meta":{"properties":{"data_format":{"description":"Format of the output data, either JSON (default) or CSV.","example":"JSON","type":"string"},"filter":{"description":"Full text filter","example":"CVE-2016-0800","nullable":true,"type":"string"},"limit":{"description":"Maximum number of paginated results.","example":25,"type":"integer"},"offset":{"description":"First record of paginated response.","example":0,"type":"integer"},"page":{"description":"Page number of paginated response.","example":1,"type":"integer"},"page_size":{"description":"Number of records per page of paginated response.","example":25,"type":"integer"},"pages":{"description":"Total number of pages of paginated response.","example":1,"type":"integer"},"sort":{"description":"Sorting filter.","example":"-inventory_id","nullable":true,"type":"string"},"total_items":{"description":"Total number of records.","example":37,"type":"integer"}},"required":["filter","limit","offset","page","page_size","pages","sort","total_items","data_format"],"type":"object"},"MetaAffectedSystems":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"properties":{"cves_without_errata":{"description":"CVEs without Errata feature flag","nullable":true,"type":"boolean"},"first_reported_from":{"description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"first_reported_to":{"description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"group_ids":{"description":"ID of the inventory group.","example":"00000000-1111-0000-0000-000000000000,00000000-2222-0000-0000-000000000000","nullable":true,"type":"string"},"group_names":{"description":"Name of the inventory group.","example":"Production,Stage","nullable":true,"type":"string"},"patch_access":{"description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true,"type":"boolean"},"rhel_version":{"description":"Filter base on system RHEL version.","example":"8.2","nullable":true,"type":"string"},"rule_key":{"description":"Filters security rules by its error key.","example":"CVE_2018_3639_cpu_kernel|CVE_2018_3639_CPU_BAD_MICROCODE_2,CVE_2018_12207_cpu_kernel|CVE_2018_12207_CPU_KERNEL_FOR_SURE","nullable":true,"type":"string"},"rule_presence":{"description":"Filter based on presence of security rule","example":"true,false","nullable":true,"type":"string"},"status_id":{"description":"Filer based on CVE status ID.","example":"1,4","nullable":true,"type":"string"}},"required":["status_id","rule_key","rule_presence","patch_access","rhel_version","first_reported_from","first_reported_to","cves_without_errata","group_names","group_ids"],"type":"object"}]},"MetaCves":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"properties":{"business_risk_id":{"description":"Filter based on business risk IDs.","example":"1,3","nullable":true,"type":"string"},"cves_without_errata":{"description":"CVEs without Errata feature flag","nullable":true,"type":"boolean"},"cvss_from":{"description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true,"type":"number"},"cvss_to":{"description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true,"type":"number"},"first_reported_from":{"description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"first_reported_to":{"description":"Filter system-cve pairs based on first time of detection of CVE.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"impact":{"description":"Filter based on impact IDs.","example":"5,7","nullable":true,"type":"string"},"patch_access":{"description":"If show_advisories=true shows access to patch service else null","example":true,"nullable":true,"type":"boolean"},"public_from":{"description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"public_to":{"description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"rule_presence":{"description":"Filter based on presence of security rule","example":"true,false","nullable":true,"type":"string"},"status_id":{"description":"Filer based on CVE status ID.","example":"1,4","nullable":true,"type":"string"}},"required":["business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","status_id","rule_presence","patch_access","first_reported_from","first_reported_to","cves_without_errata"],"type":"object"}]},"MetaCvesSystems":{"allOf":[{"$ref":"#/components/schemas/MetaCves"},{"properties":{"opt_out":{"description":"If given system was opted out.","example":true,"type":"boolean"}},"required":["opt_out"],"type":"object"}]},"MetaPermissions":{"properties":{"permissions":{"description":"Fetched permissions from RBAC for given user","items":{"example":"vulnerability:vulnerability_results:read","type":"string"},"nullable":false,"type":"array"}},"required":["permissions"],"type":"object"},"MetaSystems":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"properties":{"excluded":{"description":"Display setting of opted out systems.","example":"true,false","nullable":true,"type":"string"},"rhel_version":{"description":"Filter base on system RHEL version.","example":"8.2","nullable":true,"type":"string"}},"required":["excluded","rhel_version"],"type":"object"}]},"MetaVulnerabilitiesOut":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"},{"properties":{"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":"true,false","nullable":true,"type":"string"},"affecting":{"description":"Description of CVE showing preferences","example":"True,False","nullable":true,"type":"string"},"business_risk_id":{"description":"Filter based on business risk IDs.","example":"1,3","nullable":true,"type":"string"},"cves_without_errata":{"description":"CVEs without Errata feature flag","nullable":true,"type":"boolean"},"cvss_from":{"description":"Filter based on cvss score, starting from the value. Use -1 to include also CVEs with N/A cvss score.","example":4.6,"nullable":true,"type":"number"},"cvss_to":{"description":"Filter based on cvss score, up to the value.","example":7.2,"nullable":true,"type":"number"},"impact":{"description":"Filter based on impact IDs.","example":"5,7","nullable":true,"type":"string"},"public_from":{"description":"Filter CVEs based on their published date, starting from the date.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"public_to":{"description":"Filter CVEs based on their published date, up to the date.","example":"2017-09-18T00:00:00+00:00","nullable":true,"type":"string"},"rhel_version":{"description":"Filter base on system RHEL version.","example":"8.2","nullable":true,"type":"string"},"rule_presence":{"description":"Filter based on presence of security rule","example":"true,false","nullable":true,"type":"string"},"system_count":{"description":"Total number of systems managed by vulnerability application.","example":25641,"type":"integer"}},"required":["affecting","business_risk_id","cvss_from","cvss_to","public_from","public_to","impact","rhel_version","rule_presence","cves_without_errata","advisory_available"],"type":"object"}]},"MitigatedSystemsIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"description":"Smallest dataset for frontend to work.","properties":{"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"rule_id":{"description":"ID of associated security rule.","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["inventory_id","rule_id","status_id","status_text"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"],"type":"object"},"MitigatedSystemsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"advisories_list":{"description":"List of advisories for system","items":{"description":"Advisory id","example":"RHSA-2019:1481","type":"string"},"type":"array"},"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":true,"type":"boolean"},"culled_timestamp":{"description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"cve_status_id":{"description":"Internal ID of the CVE status.","example":4,"type":"integer"},"display_name":{"description":"System's name.","example":"system.example.com","nullable":true,"type":"string"},"insights_id":{"description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true,"type":"string"},"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"last_evaluation":{"description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"mitigation_reason":{"description":"Reason why the system is not vulnerable","example":"SELinux mitigates the issue","type":"string"},"os":{"description":"Operating system.","example":"RHEL 8.4","type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"reporter":{"description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3],"type":"number"},"rule_id":{"description":"ID(s) of associated security rule(s)..","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"},"rules_evaluation":{"description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_timestamp":{"description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_warning_timestamp":{"description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_name":{"description":"Status of the vulnerability for the application's point of view.","example":"Resolved","type":"string"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"},"tags":{"items":{"properties":{"key":{"description":"Key of the single tag.","example":"CVE","type":"string"},"namespace":{"description":"Namespace of single tag.","example":"vulnerability","nullable":true,"type":"string"},"value":{"description":"Value of the single tag.","example":"CVE-2017-1","nullable":true,"type":"string"}},"required":["namespace","key","value"],"type":"object"},"type":"array"},"updated":{"description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"}},"required":["cve_status_id","culled_timestamp","display_name","inventory_id","insights_id","last_evaluation","mitigation_reason","os","reporter","rules_evaluation","stale_timestamp","stale_warning_timestamp","status_id","status_name","status_text","tags","updated","advisory_available","remediation"],"type":"object"},"id":{"description":"Host id.","example":"INV-ID-0000-1234","type":"string"},"type":{"description":"Type of the record.","example":"system","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaAffectedSystems"}},"required":["data","links","meta"],"type":"object"},"OptOutIn":{"properties":{"inventory_id":{"$ref":"#/components/schemas/InventoryIdOrList"},"opt_out":{"description":"Opt out setting to be set.","example":true,"type":"boolean"}},"required":["inventory_id","opt_out"],"type":"object"},"PlaybookTemplate":{"properties":{"data":{"items":{"properties":{"description":{"description":"Playbook template description.","example":"Fix issues caused by CVE_2017_6074_kernel|KERNEL_CVE_2017_6074.","type":"string"},"play":{"description":"Actual playbook template.","type":"string"},"reboot_required":{"description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true,"type":"boolean"},"resolution_type":{"description":"Type of the resolution provided by playbook.","type":"string"},"version":{"description":"Revision of the playbook template.","example":"93a1ced8a259666f0505cd20b7cb8e7a1c65b868","type":"string"}},"required":["description","play","version","resolution_type"],"type":"object"},"type":"array"}},"type":"object"},"StatusIn":{"properties":{"cve":{"$ref":"#/components/schemas/CveOrList"},"inventory_id":{"$ref":"#/components/schemas/InventoryIdOrList"},"status_id":{"description":"Status ID to be set, obtained by GET method. If not specified, global CVE status is set.","example":3,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["cve"],"type":"object"},"StatusListOut":{"properties":{"data":{"description":"List of available status/status_id pairs.","items":{"properties":{"id":{"description":"Internal status_id.","example":3,"type":"integer"},"name":{"description":"Represenation of internal status_id.","example":"Scheduled for Patch","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"meta":{"properties":{"total_items":{"description":"Total number of available status/status_id pairs.","example":1,"type":"integer"}},"required":["total_items"],"type":"object"}},"required":["data","meta"],"type":"object"},"StatusOut":{"properties":{"meta":{"$ref":"#/components/schemas/MetaPermissions"},"updated":{"description":"List of updated objects/updated object IDs.","items":{"properties":{"cve":{"example":"CVE-2016-0800","type":"string"},"inventory_id":{"example":"f35b1e1d-d231-43f2-8e4f-8f9cb01e3aa2","type":"string"}},"required":["inventory_id","cve"],"type":"object"},"type":"array"}},"required":["updated"],"type":"object"},"SystemCvesIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"description":"CVE id and minimal information for frontend","properties":{"cve_status_id":{"description":"Internal ID of the CVE status.","example":4,"type":"integer"},"cve_status_text":{"description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true,"type":"string"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"rule_id":{"description":"ID(s) of associated security rule(s)..","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","nullable":true,"type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"}},"required":["id","rule_id","status_id","status_text","cve_status_id","cve_status_text","remediation"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaCves"}},"required":["data","links","meta"],"type":"object"},"SystemCvesOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"advisories_list":{"description":"List of advisories for CVE","items":{"description":"Advisory id","example":"RHSA-2019:1481","type":"string"},"type":"array"},"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":true,"type":"boolean"},"business_risk":{"description":"Business risk of the vulnerability.","example":"Low","type":"string"},"business_risk_id":{"description":"Internal ID of the vulnerability business risk.","example":1,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true,"type":"string"},"cve_status_id":{"description":"Internal ID of the CVE status.","example":4,"type":"integer"},"cve_status_text":{"description":"Status text to the whole cve.","example":"Not relevant for all","nullable":true,"type":"string"},"cvss2_score":{"description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true,"type":"string"},"cvss3_score":{"description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true,"type":"string"},"description":{"description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could...","type":"string"},"first_reported":{"description":"Date of when the CVE was first reported on the system.","example":"2018-09-22T16:00:00+00:00","type":"string"},"impact":{"description":"Red Hat security impact of the CVE.","example":"Important","type":"string"},"known_exploit":{"description":"Shows whether a CVE has known exploits or not","example":true,"type":"boolean"},"public_date":{"description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true,"type":"string"},"remediation":{"description":"Type of available remediation, 0 for none, 1 for manual, 2 for playbook.","enum":[0,1,2],"type":"number"},"reporter":{"description":"Reporter of the vulnerability, 1 for VMaaS, 2 for security rule, 3 for both VMaaS and rule.","enum":[0,1,2,3],"type":"number"},"rule":{"nullable":true,"properties":{"change_risk":{"description":"Indicates how likely remediation can change environment on the remediatied system.","example":1,"nullable":true,"type":"integer"},"description":{"description":"Description of the rule.","example":"CVE-2017-14491 dnsmasq code execution with listening processes","nullable":true,"type":"string"},"generate_autoplaybook":{"description":"Indicates whether a playbook should be auto-generated.","example":true,"nullable":true,"type":"boolean"},"kbase_node_id":{"description":"ID of associated Red Hat knowledgebase article.","example":3199382,"nullable":true,"type":"integer"},"playbook_count":{"description":"Number of available Ansible playbooks for remediation/mitigation.","example":1,"nullable":true,"type":"integer"},"reboot_required":{"description":"Indicator whter reboot is required to mitigate vulnerability.","example":false,"nullable":true,"type":"boolean"},"rule_id":{"description":"ID(s) of associated security rule(s).","example":"CVE_2017_14491_dnsmasq|CVE_2017_14491_ERROR","type":"string"},"summary":{"description":"Summary of the rule.","example":"A buffer overflow vulnerability was found in `Dnsmasq`, a popular lightweight DNS and DHCP server....","nullable":true,"type":"string"}},"required":["change_risk","description","kbase_node_id","playbook_count","reboot_required","rule_id","summary","generate_autoplaybook"],"type":"object"},"status":{"description":"Status of the vulnerability for the application's point of view.","example":"Resolved","type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":4,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not relevant","nullable":true,"type":"string"},"synopsis":{"description":"Synopsis of the CVE.","example":"CVE-2016-0800","type":"string"}},"required":["business_risk","business_risk_id","business_risk_text","cve_status_id","cve_status_text","cvss2_score","cvss3_score","description","first_reported","impact","public_date","reporter","rule","status","status_id","status_text","synopsis","known_exploit","advisory_available","remediation"],"type":"object"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":{"description":"Type of the record.","example":"cve","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaCves"}},"required":["data","links","meta"],"type":"object"},"SystemDetailsOut":{"properties":{"data":{"properties":{"last_evaluation":{"description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"last_upload":{"description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"opt_out":{"description":"System opt out status.","example":true,"type":"boolean"},"os":{"description":"Operating system.","example":"RHEL 8.4","type":"string"},"rules_evaluation":{"description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale":{"description":"System stale status.","example":true,"type":"boolean"},"tags":{"items":{"properties":{"key":{"description":"Key of the single tag.","example":"CVE","type":"string"},"namespace":{"description":"Namespace of single tag.","example":"vulnerability","nullable":true,"type":"string"},"value":{"description":"Value of the single tag.","example":"CVE-2017-1","nullable":true,"type":"string"}},"required":["namespace","key","value"],"type":"object"},"type":"array"},"updated":{"description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"}},"required":["last_evaluation","rules_evaluation","opt_out","last_upload","tags","os"],"type":"object"},"meta":{"$ref":"#/components/schemas/MetaPermissions"}},"required":["data","meta"],"type":"object"},"SystemIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"display_name":{"description":"System's name.","example":"system.example.com","nullable":true,"type":"string"},"id":{"description":"Inventory ID.","example":"INV-ID00-0000-1234","type":"string"},"opt_out":{"description":"Whether the system is active or not.","example":false,"nullable":true,"type":"boolean"}},"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaSystems"}},"required":["data","links","meta"],"type":"object"},"SystemListOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"culled_timestamp":{"description":"Timestamp from which the host is considered deleted.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"cve_count":{"description":"Number of CVE exposures for the system.","example":7,"nullable":true,"type":"integer"},"display_name":{"description":"System's name,","example":"system.example.com","nullable":true,"type":"string"},"insights_id":{"description":"Insights host ID.","example":"0035f6bc-cdb0-4763-8fcd-1dc58f716359","nullable":true,"type":"string"},"inventory_group":{"items":{"properties":{"id":{"description":"ID of inventory group.","example":"00000000-1111-0000-0000-000000000000","type":"string"},"name":{"description":"Name of inventory group.","example":"group01","type":"string"}},"required":["id","name"],"type":"object"},"type":"array"},"inventory_id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"last_evaluation":{"description":"Date of last evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"last_upload":{"description":"Date of the latest upload of archive.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"opt_out":{"description":"Opt out status of the system.","example":false,"type":"boolean"},"os":{"description":"Operating system.","example":"RHEL 8.4","type":"string"},"rules_evaluation":{"description":"Date of last security rules evaluation.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_timestamp":{"description":"Date when stale system becomes stale.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"stale_warning_timestamp":{"description":"Date when stale system becomes hidden in the application.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"},"tags":{"description":"Tags given to the system.","items":{"properties":{"key":{"description":"Key of the single tag.","example":"CVE","type":"string"},"namespace":{"description":"Namespace of single tag.","example":"vulnerability","nullable":true,"type":"string"},"value":{"description":"Value of the single tag.","example":"CVE-2017-1","nullable":true,"type":"string"}},"required":["namespace","key","value"],"type":"object"},"nullable":true,"type":"array"},"updated":{"description":"Date of the lastest upload of archive taken from Inventory syndicated data.","example":"2018-09-22T16:00:00+00:00","nullable":true,"type":"string"}},"required":["cve_count","display_name","inventory_id","insights_id","last_evaluation","rules_evaluation","opt_out","last_upload","os","stale_timestamp","stale_warning_timestamp","tags","culled_timestamp","inventory_group"],"type":"object"},"id":{"description":"Host ID.","example":"INV-ID00-0000-1234","type":"string"},"type":{"description":"Type of the record.","example":"system","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaSystems"}},"required":["data","links","meta"],"type":"object"},"VersionOut":{"properties":{"application_version":{"description":"Version of application.","example":"0.1.2","type":"string"},"database_version":{"description":"Version of database schema.","example":1,"oneOf":[{"type":"string"},{"type":"number"}]}},"required":["application_version","database_version"],"type":"object"},"VulnerabilitiesIdsOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"description":"CVE id and minimal information.","properties":{"business_risk_id":{"description":"Internal ID of the vulnerability business risk.","example":1,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true,"type":"string"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":1,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not Relevant","nullable":true,"type":"string"}},"type":"object"},"required":["business_risk_id","business_risk_text","id","status_id","status_text"],"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaVulnerabilitiesOut"}},"required":["data","links","meta"],"type":"object"},"VulnerabilitiesOut":{"properties":{"data":{"oneOf":[{"description":"CSV export of the JSON.","type":"string"},{"items":{"properties":{"attributes":{"properties":{"advisory_available":{"description":"Shows whether a CVE has available advisory or not","example":true,"type":"boolean"},"business_risk":{"description":"Business risk of the vulnerability.","example":"Low","type":"string"},"business_risk_id":{"description":"Internal ID of the vulnerability business risk.","example":1,"type":"integer"},"business_risk_text":{"description":"Complementary text to the business risk.","example":"QA environment => Low business risk","nullable":true,"type":"string"},"cvss2_score":{"description":"String representation of cvss2 score of the CVE.","example":"5.800","nullable":true,"type":"string"},"cvss3_score":{"description":"String representation of cvss3 score of the CVE.","example":"4.400","nullable":true,"type":"string"},"description":{"description":"Description of the CVE.","example":"A padding oracle flaw was found in the Secure Sockets Layer version 2.0 (SSLv2) protocol. An attacker could...","type":"string"},"impact":{"description":"Red Hat security impact of the CVE.","example":"Important","type":"string"},"known_exploit":{"description":"Shows whether a CVE has known exploits or not","example":true,"type":"boolean"},"public_date":{"description":"String representation of ISO-8601 formatted date of first public disclosure of the CVE.","example":"2016-03-01T00:00:00+00:00","nullable":true,"type":"string"},"rules":{"items":{"$ref":"#/components/schemas/InsightsRule"},"type":"array"},"status":{"description":"Status of the vulnerability.","example":"Not Reviewed","type":"string"},"status_id":{"description":"Internal ID of the vulnerability status.","example":1,"type":"integer"},"status_text":{"description":"Complementary text to the status.","example":"Not Relevant","nullable":true,"type":"string"},"synopsis":{"description":"Synopsis of the CVE.","example":"CVE-2016-0800","type":"string"},"systems_affected":{"description":"Number of systems affected by the CVE.","example":7,"type":"integer"},"systems_status_divergent":{"description":"How many systems-CVE pairs have different status than CVE-level.","example":20,"type":"integer"}},"required":["business_risk","business_risk_id","business_risk_text","cvss2_score","cvss3_score","description","impact","public_date","rules","status","status_id","status_text","synopsis","systems_affected","systems_status_divergent","known_exploit","advisory_available"],"type":"object"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":{"description":"Type of the record.","example":"cve","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"}]},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/MetaVulnerabilitiesOut"}},"required":["data","links","meta"],"type":"object"},"VulnerabilitiesPostIn":{"properties":{"cve_list":{"description":"Array of CVEs to provide info about","items":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":"array"}},"required":["cve_list"],"type":"object"},"VulnerabilitiesPostOut":{"properties":{"data":{"items":{"properties":{"attributes":{"properties":{"cvss_score":{"description":"String representation of cvss3 or cvvs2 (if v3 is not present) score of the CVE.","example":"5.800","nullable":true,"type":"string"},"impact":{"description":"Red Hat security impact of the CVE.","example":"Important","type":"string"},"synopsis":{"description":"Synopsis of the CVE.","example":"CVE-2016-0800","type":"string"}},"required":["cvss_score","impact","synopsis"],"type":"object"},"id":{"description":"CVE id.","example":"CVE-2016-0800","type":"string"},"type":{"description":"Type of the record.","example":"cve","type":"string"}},"required":["id","type","attributes"],"type":"object"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"allOf":[{"$ref":"#/components/schemas/Meta"},{"$ref":"#/components/schemas/MetaPermissions"}]}},"required":["data","links","meta"],"type":"object"}},"securitySchemes":{"ApiKeyAuth":{"description":"Identity header provided by 3scale (for non-prod testing only).","in":"header","name":"x-rh-identity","type":"apiKey","x-apikeyInfoFunc":"manager.base.auth"},"BasicAuth":{"description":"Username and password login.","scheme":"basic","type":"http","x-basicInfoFunc":"manager.base.basic_auth"}}},"info":{"title":"Vulnerability Engine Manager","version":"2.21.1"},"openapi":"3.0.0","paths":{"/announcement":{"get":{"description":"This endpoint provides vulnerability service announcements. Remain informed about important alerts for the vulnerability service. Announcements are issued by Insights Product Managers and other subject matter experts.\n","operationId":"getAnnouncement","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AnnouncementOut"}}},"description":"Announcement."}},"summary":"Announce important updates","x-methodName":"getAnnouncement"}},"/apistatus":{"get":{"description":"Checks database availability and API response threshold time.","operationId":"getApiStatus","responses":{"200":{"description":"API is healthy"},"408":{"description":"API is down (time out)"},"503":{"description":"Database is unavaiable"}},"summary":"Determine the health of the application","x-methodName":"getApiStatus"}},"/business_risk":{"get":{"description":"This endpoint helps you determine the numeric business risk for a given CVE. A business risk is a label you can set for a given CVE. Choose one of five business risk options ranging from 0-4, where 0 is not defined and 4 indicates a critical risk. You must call this endpoint to choose a numerical value before calling the *PATCH/cves/business_risk* endpoint.\n","operationId":"getBusinessRiskList","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BusinessRiskListOut"}}},"description":"List of business risk/business_risk_id pairs."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Access business risk values","x-methodName":"getBusinessRiskList"}},"/cves/business_risk":{"patch":{"description":"This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path.\n","operationId":"setCveBusinessRisk","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CveRiskIn","x-body-name":"data"}}},"description":"Values to be set. At least one of the \"business_risk_id\" or \"business_risk_text\" parameters is required.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkChangeOut"}}},"description":"Business risk successfully updated."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."},"503":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Service is running in read-only mode."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Set business risk for a CVE","x-methodName":"setCveBusinessRisk"}},"/cves/status":{"patch":{"description":"This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path.\n","operationId":"setCveStatus","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CveStatusIn","x-body-name":"data"}}},"description":"Values to be set. At least one of the \"status_id\" or \"status_text\" parameters is required.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkChangeOut"}}},"description":"Status successfully updated."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."},"503":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Service is running in read-only mode."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Set status for a CVE","x-methodName":"setCveStatus"}},"/cves/{cve_id}":{"get":{"description":"This endpoint returns the CVE identification number, description, scores and other metadata. The metadata includes the description, CVSS 2/3 Score, CVSS 2/3 attack vector, severity, public date, modified date, business risk, status, a URL to Red Hat web pages, a list of advisories remediating the CVE, and information regarding known exploits for the CVE.\n","operationId":"getCveDetails","parameters":[{"$ref":"#/components/parameters/cve_id"},{"$ref":"#/components/parameters/advisory_available"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CveDetailOut"}}},"description":"CVE details"},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get CVE details","x-methodName":"getCveDetails"}},"/cves/{cve_id}/affected_systems":{"get":{"description":"This is a report of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected servers along with last check-in, system name and more.\n","operationId":"getAffectedSystemsByCve","parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/cve_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/rule_key_deprecated"},{"$ref":"#/components/parameters/rule_presence_deprecated"},{"$ref":"#/components/parameters/rule"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/host_type"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AffectedSystemsOut"}}},"description":"Report of affected systems for a given CVE."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Determine affected systems for a given CVE","x-methodName":"getAffectedSystemsByCve"}},"/cves/{cve_id}/affected_systems/ids":{"get":{"description":"This is a report of identification numbers of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected systems.\n","operationId":"getAffectedSystemsIdsByCve","parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/cve_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/rule_key_deprecated"},{"$ref":"#/components/parameters/rule_presence_deprecated"},{"$ref":"#/components/parameters/rule"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/host_type"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AffectedSystemsIdsOut"}}},"description":"Report of IDs of affected systems for a given CVE."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given CVE does not exist."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get identification numbers of affected systems for a given CVE","x-methodName":"getAffectedSystemsIdsByCve"}},"/dashbar":{"get":{"description":"These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence, severity and other details.\n","operationId":"getDashbar","parameters":[{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/DashbarOut"}}},"description":"Dashbar aggregations."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get aggregations for the dashbar","x-methodName":"getDashbar"}},"/dashboard":{"get":{"description":"These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity, and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence and severity.\n","operationId":"getDashboard","parameters":[{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}},"description":"Dashboard."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get a macro level overview of aggregated vulnerabilities","x-methodName":"getDashboard"}},"/feature/cves_without_errata":{"patch":{"description":"Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints.\n","operationId":"setCvesWithoutErrata","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CvesWithoutErrataIn","x-body-name":"data"}}},"description":"Values to be set.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CvesWithoutErrataOut"}}},"description":"CVEs without Errata feature successfully updated."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Set a feature flag for CVEs without errata","x-methodName":"setCvesWithoutErrata"}},"/playbooks/templates/{rule_id}":{"get":{"description":"This returns an Ansible playbook template for a given rule identification number. Use this endpoint to return an Ansible playbook template for a given rule error key. The template is used to remediate issues on your system.\n","operationId":"getPlaybookTemplate","parameters":[{"description":"Insights security rule ID.","example":"CVE_2017_8779_rpc|CVE_2017_8779_WARN","in":"path","name":"rule_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/PlaybookTemplate"}}},"description":"Playbook template response"},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given rule id does not exist."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get an Ansible Playbook template for CVEs with security rules","x-methodName":"getPlaybookTemplate"}},"/report/executive":{"get":{"description":"This returns an overview of vulnerabilities affecting a given account. Use this request when you need to download a high-level, executive report summarizing the security exposure of your infrastructure. These reports are designed for an executive audience and include data such as the number of RHEL systems analyzed, the number of security rules in your infrastructure, percentage of CVEs with a certain severity and more.\n","operationId":"getExecutiveReport","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ExecutiveReport"}}},"description":"Executive report."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Generate an executive report","x-methodName":"getExecutiveReport"}},"/status":{"get":{"description":"This endpoint returns a list of possible values for setting status for a CVE or system-CVE pair. Call this api when you want to know which values are available for setting a status. A list of numbers will be returned. You must call this endpoint before calling the *PATCH/cves/status* endpoint.\n","operationId":"getStatusList","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/StatusListOut"}}},"description":"List of status/status_id pairs."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Access available status values","x-methodName":"getStatusList"},"patch":{"description":"This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs.\n","operationId":"setStatus","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/StatusIn","x-body-name":"data"}}},"description":"Values to be set.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/StatusOut"}}},"description":"Status successfully updated."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Given host/CVE does not exist."},"503":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Service is running in read-only mode."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Set status for system vulnerabilities","x-methodName":"setStatus"}},"/systems":{"get":{"description":"List systems that are accessible when you are logged into your account. Use this endpoint to view basic system attributes such as display name and system type.\n","operationId":"getSystemsList","parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/stale"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/excluded"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemListOut"}}},"description":"System list"}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"List systems","x-methodName":"getSystemsList"}},"/systems/ids":{"get":{"description":"This lists systems including those that have opted out of the current query. Use this when you do not want to see a registered system or systems in your reports.\n","operationId":"getSystemsIds","parameters":[{"$ref":"#/components/parameters/filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/stale"},{"$ref":"#/components/parameters/uuid"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/excluded"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemIdsOut"}}},"description":"System list"}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"List systems identification numbers along with opt out state","x-methodName":"getSystemsIds"}},"/systems/opt_out":{"patch":{"description":"Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems.\n","operationId":"setSystemsOptOut","requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OptOutIn","x-body-name":"data"}}},"description":"Values to be set.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/BulkChangeOut"}}},"description":"System(s) setting has been updated."},"503":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"Service is running in read-only mode."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Opt a system in or out of the vulnerability service","x-methodName":"setSystemsOptOut"}},"/systems/{inventory_id}":{"get":{"description":"This allows you to get information about systems related to an inventory identification number. This includes details such as operating system, inventory tags, last update, opt-out status, and more.\n","operationId":"getSystemDetails","parameters":[{"$ref":"#/components/parameters/inventory_id"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemDetailsOut"}}},"description":"System details"},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"System has not been found in the database."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get system details","x-methodName":"getSystemDetails"}},"/systems/{inventory_id}/cves":{"get":{"description":"This endpoint displays detailed information about all CVEs for which a system is exposed. Use this endpoint to discover which CVEs are affecting a given system. CVE metadata is included.\n","operationId":"getCveListBySystem","parameters":[{"$ref":"#/components/parameters/inventory_id"},{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rule_key"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"},{"$ref":"#/components/parameters/report"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemCvesOut"}}},"description":"CVE report."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"System has not been found in the database."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get a CVE report for a system","x-methodName":"getCveListBySystem"}},"/systems/{inventory_id}/cves/ids":{"get":{"description":"This endpoint displays identification numbers of all CVEs for which a system is exposed. Use this endpoint to learn which CVEs are affecting a given system.\n","operationId":"getCveIdsBySystem","parameters":[{"$ref":"#/components/parameters/inventory_id"},{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/show_advisories"},{"$ref":"#/components/parameters/advisory"},{"$ref":"#/components/parameters/rule_key"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/first_reported_from"},{"$ref":"#/components/parameters/first_reported_to"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/remediation"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/SystemCvesIdsOut"}}},"description":"CVE Ids report."},"404":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/Errors"}}},"description":"System has not been found in the database."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get a CVE identification number report for a system","x-methodName":"getCveIdsBySystem"}},"/version":{"get":{"description":"This endpoint will provide you with the application version. Use this endpoint to track application changes.\n","operationId":"getVersion","responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VersionOut"}}},"description":"Application version."}},"summary":"Get application version","x-methodName":"getVersion"}},"/vulnerabilities/cves":{"get":{"description":"This provides an overview of vulnerabilities across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account, including some CVE metadata, how many systems are affected by each CVE, and more.\n","operationId":"getCveList","parameters":[{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/affecting"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/report"},{"$ref":"#/components/parameters/advanced_report"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/advisory_available"},{"$ref":"#/components/parameters/group_names"},{"$ref":"#/components/parameters/group_ids"},{"$ref":"#/components/parameters/affecting_host_type"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesOut"}}},"description":"Vulnerabilities overview."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get a vulnerabilities overview","x-methodName":"getCveList"},"post":{"description":"This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request.\n","operationId":"getCveList","parameters":[{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/sort"}],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesPostIn","x-body-name":"data"}}},"description":"List of CVEs to provide info about.","required":true},"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesPostOut"}}},"description":"Vulnerabilities overview."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Send a vulnerabilities overview","x-methodName":"getCveList"}},"/vulnerabilities/cves/ids":{"get":{"description":"This is an overview of vulnerabilities identification numbers across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account.\n","operationId":"getCveIdsList","parameters":[{"$ref":"#/components/parameters/cve_filter"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/page_size"},{"$ref":"#/components/parameters/cve_sort"},{"$ref":"#/components/parameters/cvss_from"},{"$ref":"#/components/parameters/cvss_to"},{"$ref":"#/components/parameters/public_from"},{"$ref":"#/components/parameters/public_to"},{"$ref":"#/components/parameters/impact"},{"$ref":"#/components/parameters/data_format"},{"$ref":"#/components/parameters/business_risk_id"},{"$ref":"#/components/parameters/status_id"},{"$ref":"#/components/parameters/rule_presence"},{"$ref":"#/components/parameters/tags"},{"$ref":"#/components/parameters/sap_sids"},{"$ref":"#/components/parameters/sap_system"},{"$ref":"#/components/parameters/known_exploit"},{"$ref":"#/components/parameters/affecting"},{"$ref":"#/components/parameters/rhel_version"},{"$ref":"#/components/parameters/ansible"},{"$ref":"#/components/parameters/mssql"},{"$ref":"#/components/parameters/advisory_available"}],"responses":{"200":{"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/VulnerabilitiesIdsOut"}}},"description":"Vulnerabilities IDs overview."}},"security":[{"ApiKeyAuth":[]},{"BasicAuth":[]}],"summary":"Get an overview of Vulnerabilities' identification numbers","x-methodName":"getCveIdsList"}}},"servers":[{"url":"/api/vulnerability/v1"}]} \ No newline at end of file diff --git a/packages/vulnerabilities/base.ts b/packages/vulnerabilities/base.ts index 708db61f2..7dcb11919 100644 --- a/packages/vulnerabilities/base.ts +++ b/packages/vulnerabilities/base.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.19.1 + * The version of the OpenAPI document: 2.21.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/configuration.ts b/packages/vulnerabilities/configuration.ts index 8940ba134..48b390d94 100644 --- a/packages/vulnerabilities/configuration.ts +++ b/packages/vulnerabilities/configuration.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.19.1 + * The version of the OpenAPI document: 2.21.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/doc/classes/DefaultApi.md b/packages/vulnerabilities/doc/classes/DefaultApi.md index cf6763ee6..4c38cbcfd 100644 --- a/packages/vulnerabilities/doc/classes/DefaultApi.md +++ b/packages/vulnerabilities/doc/classes/DefaultApi.md @@ -120,7 +120,7 @@ BaseAPI.configuration ### getAffectedSystemsByCve -▸ **getAffectedSystemsByCve**(`cveId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `statusId?`, `dataFormat?`, `uuid?`, `ruleKey?`, `rulePresence?`, `rule?`, `tags?`, `sapSids?`, `sapSystem?`, `showAdvisories?`, `advisory?`, `rhelVersion?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `report?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `hostType?`, `options?`): `Promise`<`AxiosResponse`<[`AffectedSystemsOut`](../interfaces/AffectedSystemsOut.md), `any`\>\> +▸ **getAffectedSystemsByCve**(`cveId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `statusId?`, `dataFormat?`, `uuid?`, `ruleKey?`, `rulePresence?`, `rule?`, `tags?`, `sapSids?`, `sapSystem?`, `showAdvisories?`, `advisory?`, `rhelVersion?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `report?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `hostType?`, `options?`): `Promise`<`AxiosResponse`<[`AffectedSystemsOut`](../interfaces/AffectedSystemsOut.md)\>\> This is a report of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected servers along with last check-in, system name and more. @@ -171,7 +171,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AffectedSystemsOut`](../interfaces/AffectedSystemsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AffectedSystemsOut`](../interfaces/AffectedSystemsOut.md)\>\> #### Defined in @@ -181,7 +181,7 @@ ___ ### getAffectedSystemsIdsByCve -▸ **getAffectedSystemsIdsByCve**(`cveId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `statusId?`, `dataFormat?`, `uuid?`, `ruleKey?`, `rulePresence?`, `rule?`, `tags?`, `sapSids?`, `sapSystem?`, `showAdvisories?`, `advisory?`, `rhelVersion?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `hostType?`, `options?`): `Promise`<`AxiosResponse`<[`AffectedSystemsIdsOut`](../interfaces/AffectedSystemsIdsOut.md), `any`\>\> +▸ **getAffectedSystemsIdsByCve**(`cveId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `statusId?`, `dataFormat?`, `uuid?`, `ruleKey?`, `rulePresence?`, `rule?`, `tags?`, `sapSids?`, `sapSystem?`, `showAdvisories?`, `advisory?`, `rhelVersion?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `hostType?`, `options?`): `Promise`<`AxiosResponse`<[`AffectedSystemsIdsOut`](../interfaces/AffectedSystemsIdsOut.md)\>\> This is a report of identification numbers of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected systems. @@ -231,7 +231,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AffectedSystemsIdsOut`](../interfaces/AffectedSystemsIdsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AffectedSystemsIdsOut`](../interfaces/AffectedSystemsIdsOut.md)\>\> #### Defined in @@ -241,7 +241,7 @@ ___ ### getAnnouncement -▸ **getAnnouncement**(`options?`): `Promise`<`AxiosResponse`<[`AnnouncementOut`](../interfaces/AnnouncementOut.md), `any`\>\> +▸ **getAnnouncement**(`options?`): `Promise`<`AxiosResponse`<[`AnnouncementOut`](../interfaces/AnnouncementOut.md)\>\> This endpoint provides vulnerability service announcements. Remain informed about important alerts for the vulnerability service. Announcements are issued by Insights Product Managers and other subject matter experts. @@ -263,7 +263,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AnnouncementOut`](../interfaces/AnnouncementOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AnnouncementOut`](../interfaces/AnnouncementOut.md)\>\> #### Defined in @@ -273,13 +273,13 @@ ___ ### getApiStatus -▸ **getApiStatus**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **getApiStatus**(`options?`): `Promise`<`AxiosResponse`<`void`\>\> Checks database availability and API response threshold time. **`Summary`** -Health status of application +Determine the health of the application **`Throws`** @@ -295,7 +295,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -305,7 +305,7 @@ ___ ### getBusinessRiskList -▸ **getBusinessRiskList**(`options?`): `Promise`<`AxiosResponse`<[`BusinessRiskListOut`](../interfaces/BusinessRiskListOut.md), `any`\>\> +▸ **getBusinessRiskList**(`options?`): `Promise`<`AxiosResponse`<[`BusinessRiskListOut`](../interfaces/BusinessRiskListOut.md)\>\> This endpoint helps you determine the numeric business risk for a given CVE. A business risk is a label you can set for a given CVE. Choose one of five business risk options ranging from 0-4, where 0 is not defined and 4 indicates a critical risk. You must call this endpoint to choose a numerical value before calling the *PATCH/cves/business_risk* endpoint. @@ -327,7 +327,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`BusinessRiskListOut`](../interfaces/BusinessRiskListOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`BusinessRiskListOut`](../interfaces/BusinessRiskListOut.md)\>\> #### Defined in @@ -337,7 +337,7 @@ ___ ### getCveDetails -▸ **getCveDetails**(`cveId`, `advisoryAvailable?`, `options?`): `Promise`<`AxiosResponse`<[`CveDetailOut`](../interfaces/CveDetailOut.md), `any`\>\> +▸ **getCveDetails**(`cveId`, `advisoryAvailable?`, `options?`): `Promise`<`AxiosResponse`<[`CveDetailOut`](../interfaces/CveDetailOut.md)\>\> This endpoint returns the CVE identification number, description, scores and other metadata. The metadata includes the description, CVSS 2/3 Score, CVSS 2/3 attack vector, severity, public date, modified date, business risk, status, a URL to Red Hat web pages, a list of advisories remediating the CVE, and information regarding known exploits for the CVE. @@ -361,7 +361,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`CveDetailOut`](../interfaces/CveDetailOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`CveDetailOut`](../interfaces/CveDetailOut.md)\>\> #### Defined in @@ -371,7 +371,7 @@ ___ ### getCveIdsBySystem -▸ **getCveIdsBySystem**(`inventoryId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `statusId?`, `dataFormat?`, `businessRiskId?`, `rulePresence?`, `showAdvisories?`, `advisory?`, `ruleKey?`, `knownExploit?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `options?`): `Promise`<`AxiosResponse`<[`SystemCvesIdsOut`](../interfaces/SystemCvesIdsOut.md), `any`\>\> +▸ **getCveIdsBySystem**(`inventoryId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `statusId?`, `dataFormat?`, `businessRiskId?`, `rulePresence?`, `showAdvisories?`, `advisory?`, `ruleKey?`, `knownExploit?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `options?`): `Promise`<`AxiosResponse`<[`SystemCvesIdsOut`](../interfaces/SystemCvesIdsOut.md)\>\> This endpoint displays identification numbers of all CVEs for which a system is exposed. Use this endpoint to learn which CVEs are affecting a given system. @@ -417,7 +417,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemCvesIdsOut`](../interfaces/SystemCvesIdsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemCvesIdsOut`](../interfaces/SystemCvesIdsOut.md)\>\> #### Defined in @@ -427,7 +427,7 @@ ___ ### getCveIdsList -▸ **getCveIdsList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `dataFormat?`, `businessRiskId?`, `statusId?`, `rulePresence?`, `tags?`, `sapSids?`, `sapSystem?`, `knownExploit?`, `affecting?`, `rhelVersion?`, `ansible?`, `mssql?`, `advisoryAvailable?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesIdsOut`](../interfaces/VulnerabilitiesIdsOut.md), `any`\>\> +▸ **getCveIdsList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `dataFormat?`, `businessRiskId?`, `statusId?`, `rulePresence?`, `tags?`, `sapSids?`, `sapSystem?`, `knownExploit?`, `affecting?`, `rhelVersion?`, `ansible?`, `mssql?`, `advisoryAvailable?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesIdsOut`](../interfaces/VulnerabilitiesIdsOut.md)\>\> This is an overview of vulnerabilities identification numbers across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account. @@ -473,7 +473,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VulnerabilitiesIdsOut`](../interfaces/VulnerabilitiesIdsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VulnerabilitiesIdsOut`](../interfaces/VulnerabilitiesIdsOut.md)\>\> #### Defined in @@ -483,7 +483,7 @@ ___ ### getCveList -▸ **getCveList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `dataFormat?`, `businessRiskId?`, `statusId?`, `rulePresence?`, `tags?`, `sapSids?`, `sapSystem?`, `knownExploit?`, `affecting?`, `rhelVersion?`, `report?`, `advancedReport?`, `ansible?`, `mssql?`, `advisoryAvailable?`, `groupNames?`, `groupIds?`, `affectingHostType?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesOut`](../interfaces/VulnerabilitiesOut.md), `any`\>\> +▸ **getCveList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `dataFormat?`, `businessRiskId?`, `statusId?`, `rulePresence?`, `tags?`, `sapSids?`, `sapSystem?`, `knownExploit?`, `affecting?`, `rhelVersion?`, `report?`, `advancedReport?`, `ansible?`, `mssql?`, `advisoryAvailable?`, `groupNames?`, `groupIds?`, `affectingHostType?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesOut`](../interfaces/VulnerabilitiesOut.md)\>\> This provides an overview of vulnerabilities across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account, including some CVE metadata, how many systems are affected by each CVE, and more. @@ -534,7 +534,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VulnerabilitiesOut`](../interfaces/VulnerabilitiesOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VulnerabilitiesOut`](../interfaces/VulnerabilitiesOut.md)\>\> #### Defined in @@ -544,7 +544,7 @@ ___ ### getCveListBySystem -▸ **getCveListBySystem**(`inventoryId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `statusId?`, `dataFormat?`, `businessRiskId?`, `rulePresence?`, `showAdvisories?`, `advisory?`, `ruleKey?`, `knownExploit?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `report?`, `options?`): `Promise`<`AxiosResponse`<[`SystemCvesOut`](../interfaces/SystemCvesOut.md), `any`\>\> +▸ **getCveListBySystem**(`inventoryId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `statusId?`, `dataFormat?`, `businessRiskId?`, `rulePresence?`, `showAdvisories?`, `advisory?`, `ruleKey?`, `knownExploit?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `report?`, `options?`): `Promise`<`AxiosResponse`<[`SystemCvesOut`](../interfaces/SystemCvesOut.md)\>\> This endpoint displays detailed information about all CVEs for which a system is exposed. Use this endpoint to discover which CVEs are affecting a given system. CVE metadata is included. @@ -591,7 +591,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemCvesOut`](../interfaces/SystemCvesOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemCvesOut`](../interfaces/SystemCvesOut.md)\>\> #### Defined in @@ -601,7 +601,7 @@ ___ ### getCveList\_1 -▸ **getCveList_1**(`vulnerabilitiesPostIn`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesPostOut`](../interfaces/VulnerabilitiesPostOut.md), `any`\>\> +▸ **getCveList_1**(`vulnerabilitiesPostIn`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesPostOut`](../interfaces/VulnerabilitiesPostOut.md)\>\> This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. @@ -630,7 +630,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VulnerabilitiesPostOut`](../interfaces/VulnerabilitiesPostOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VulnerabilitiesPostOut`](../interfaces/VulnerabilitiesPostOut.md)\>\> #### Defined in @@ -640,7 +640,7 @@ ___ ### getDashbar -▸ **getDashbar**(`tags?`, `sapSids?`, `sapSystem?`, `ansible?`, `mssql?`, `options?`): `Promise`<`AxiosResponse`<[`DashbarOut`](../interfaces/DashbarOut.md), `any`\>\> +▸ **getDashbar**(`tags?`, `sapSids?`, `sapSystem?`, `ansible?`, `mssql?`, `options?`): `Promise`<`AxiosResponse`<[`DashbarOut`](../interfaces/DashbarOut.md)\>\> These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence, severity and other details. @@ -667,7 +667,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`DashbarOut`](../interfaces/DashbarOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`DashbarOut`](../interfaces/DashbarOut.md)\>\> #### Defined in @@ -677,7 +677,7 @@ ___ ### getDashboard -▸ **getDashboard**(`tags?`, `sapSids?`, `sapSystem?`, `ansible?`, `mssql?`, `options?`): `Promise`<`AxiosResponse`<[`Dashboard`](../interfaces/Dashboard.md), `any`\>\> +▸ **getDashboard**(`tags?`, `sapSids?`, `sapSystem?`, `ansible?`, `mssql?`, `options?`): `Promise`<`AxiosResponse`<[`Dashboard`](../interfaces/Dashboard.md)\>\> These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity, and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence and severity. @@ -704,7 +704,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Dashboard`](../interfaces/Dashboard.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Dashboard`](../interfaces/Dashboard.md)\>\> #### Defined in @@ -714,7 +714,7 @@ ___ ### getExecutiveReport -▸ **getExecutiveReport**(`options?`): `Promise`<`AxiosResponse`<[`ExecutiveReport`](../interfaces/ExecutiveReport.md), `any`\>\> +▸ **getExecutiveReport**(`options?`): `Promise`<`AxiosResponse`<[`ExecutiveReport`](../interfaces/ExecutiveReport.md)\>\> This returns an overview of vulnerabilities affecting a given account. Use this request when you need to download a high-level, executive report summarizing the security exposure of your infrastructure. These reports are designed for an executive audience and include data such as the number of RHEL systems analyzed, the number of security rules in your infrastructure, percentage of CVEs with a certain severity and more. @@ -736,7 +736,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ExecutiveReport`](../interfaces/ExecutiveReport.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ExecutiveReport`](../interfaces/ExecutiveReport.md)\>\> #### Defined in @@ -746,7 +746,7 @@ ___ ### getPlaybookTemplate -▸ **getPlaybookTemplate**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookTemplate`](../interfaces/PlaybookTemplate.md), `any`\>\> +▸ **getPlaybookTemplate**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookTemplate`](../interfaces/PlaybookTemplate.md)\>\> This returns an Ansible playbook template for a given rule identification number. Use this endpoint to return an Ansible playbook template for a given rule error key. The template is used to remediate issues on your system. @@ -769,7 +769,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`PlaybookTemplate`](../interfaces/PlaybookTemplate.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PlaybookTemplate`](../interfaces/PlaybookTemplate.md)\>\> #### Defined in @@ -779,7 +779,7 @@ ___ ### getStatusList -▸ **getStatusList**(`options?`): `Promise`<`AxiosResponse`<[`StatusListOut`](../interfaces/StatusListOut.md), `any`\>\> +▸ **getStatusList**(`options?`): `Promise`<`AxiosResponse`<[`StatusListOut`](../interfaces/StatusListOut.md)\>\> This endpoint returns a list of possible values for setting status for a CVE or system-CVE pair. Call this api when you want to know which values are available for setting a status. A list of numbers will be returned. You must call this endpoint before calling the *PATCH/cves/status* endpoint. @@ -801,7 +801,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`StatusListOut`](../interfaces/StatusListOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`StatusListOut`](../interfaces/StatusListOut.md)\>\> #### Defined in @@ -811,7 +811,7 @@ ___ ### getSystemDetails -▸ **getSystemDetails**(`inventoryId`, `options?`): `Promise`<`AxiosResponse`<[`SystemDetailsOut`](../interfaces/SystemDetailsOut.md), `any`\>\> +▸ **getSystemDetails**(`inventoryId`, `options?`): `Promise`<`AxiosResponse`<[`SystemDetailsOut`](../interfaces/SystemDetailsOut.md)\>\> This allows you to get information about systems related to an inventory identification number. This includes details such as operating system, inventory tags, last update, opt-out status, and more. @@ -834,7 +834,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemDetailsOut`](../interfaces/SystemDetailsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemDetailsOut`](../interfaces/SystemDetailsOut.md)\>\> #### Defined in @@ -844,7 +844,7 @@ ___ ### getSystemsIds -▸ **getSystemsIds**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `dataFormat?`, `stale?`, `uuid?`, `tags?`, `sapSids?`, `sapSystem?`, `excluded?`, `rhelVersion?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `options?`): `Promise`<`AxiosResponse`<[`SystemIdsOut`](../interfaces/SystemIdsOut.md), `any`\>\> +▸ **getSystemsIds**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `dataFormat?`, `stale?`, `uuid?`, `tags?`, `sapSids?`, `sapSystem?`, `excluded?`, `rhelVersion?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `options?`): `Promise`<`AxiosResponse`<[`SystemIdsOut`](../interfaces/SystemIdsOut.md)\>\> This lists systems including those that have opted out of the current query. Use this when you do not want to see a registered system or systems in your reports. @@ -884,7 +884,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemIdsOut`](../interfaces/SystemIdsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemIdsOut`](../interfaces/SystemIdsOut.md)\>\> #### Defined in @@ -894,7 +894,7 @@ ___ ### getSystemsList -▸ **getSystemsList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `dataFormat?`, `stale?`, `uuid?`, `tags?`, `sapSids?`, `sapSystem?`, `excluded?`, `rhelVersion?`, `report?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `options?`): `Promise`<`AxiosResponse`<[`SystemListOut`](../interfaces/SystemListOut.md), `any`\>\> +▸ **getSystemsList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `dataFormat?`, `stale?`, `uuid?`, `tags?`, `sapSids?`, `sapSystem?`, `excluded?`, `rhelVersion?`, `report?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `options?`): `Promise`<`AxiosResponse`<[`SystemListOut`](../interfaces/SystemListOut.md)\>\> List systems that are accessible when you are logged into your account. Use this endpoint to view basic system attributes such as display name and system type. @@ -935,7 +935,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemListOut`](../interfaces/SystemListOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemListOut`](../interfaces/SystemListOut.md)\>\> #### Defined in @@ -945,7 +945,7 @@ ___ ### getVersion -▸ **getVersion**(`options?`): `Promise`<`AxiosResponse`<[`VersionOut`](../interfaces/VersionOut.md), `any`\>\> +▸ **getVersion**(`options?`): `Promise`<`AxiosResponse`<[`VersionOut`](../interfaces/VersionOut.md)\>\> This endpoint will provide you with the application version. Use this endpoint to track application changes. @@ -967,7 +967,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VersionOut`](../interfaces/VersionOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VersionOut`](../interfaces/VersionOut.md)\>\> #### Defined in @@ -977,7 +977,7 @@ ___ ### setCveBusinessRisk -▸ **setCveBusinessRisk**(`cveRiskIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +▸ **setCveBusinessRisk**(`cveRiskIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. @@ -1000,7 +1000,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> #### Defined in @@ -1010,7 +1010,7 @@ ___ ### setCveStatus -▸ **setCveStatus**(`cveStatusIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +▸ **setCveStatus**(`cveStatusIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. @@ -1033,7 +1033,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> #### Defined in @@ -1043,7 +1043,7 @@ ___ ### setCvesWithoutErrata -▸ **setCvesWithoutErrata**(`cvesWithoutErrataIn`, `options?`): `Promise`<`AxiosResponse`<[`CvesWithoutErrataOut`](../interfaces/CvesWithoutErrataOut.md), `any`\>\> +▸ **setCvesWithoutErrata**(`cvesWithoutErrataIn`, `options?`): `Promise`<`AxiosResponse`<[`CvesWithoutErrataOut`](../interfaces/CvesWithoutErrataOut.md)\>\> Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. @@ -1066,7 +1066,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`CvesWithoutErrataOut`](../interfaces/CvesWithoutErrataOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`CvesWithoutErrataOut`](../interfaces/CvesWithoutErrataOut.md)\>\> #### Defined in @@ -1076,7 +1076,7 @@ ___ ### setStatus -▸ **setStatus**(`statusIn`, `options?`): `Promise`<`AxiosResponse`<[`StatusOut`](../interfaces/StatusOut.md), `any`\>\> +▸ **setStatus**(`statusIn`, `options?`): `Promise`<`AxiosResponse`<[`StatusOut`](../interfaces/StatusOut.md)\>\> This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. @@ -1099,7 +1099,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`StatusOut`](../interfaces/StatusOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`StatusOut`](../interfaces/StatusOut.md)\>\> #### Defined in @@ -1109,7 +1109,7 @@ ___ ### setSystemsOptOut -▸ **setSystemsOptOut**(`optOutIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +▸ **setSystemsOptOut**(`optOutIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. @@ -1132,7 +1132,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> #### Defined in diff --git a/packages/vulnerabilities/doc/interfaces/ConfigurationParameters.md b/packages/vulnerabilities/doc/interfaces/ConfigurationParameters.md index 47704995e..c115f19bc 100644 --- a/packages/vulnerabilities/doc/interfaces/ConfigurationParameters.md +++ b/packages/vulnerabilities/doc/interfaces/ConfigurationParameters.md @@ -5,7 +5,7 @@ Vulnerability Engine Manager No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) -The version of the OpenAPI document: 2.19.1 +The version of the OpenAPI document: 2.21.1 NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech diff --git a/packages/vulnerabilities/git-api/api.ts b/packages/vulnerabilities/git-api/api.ts index 39dd3f483..1895bb9d6 100644 --- a/packages/vulnerabilities/git-api/api.ts +++ b/packages/vulnerabilities/git-api/api.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.19.1 + * The version of the OpenAPI document: 2.21.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). @@ -3191,7 +3191,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }, /** * Checks database availability and API response threshold time. - * @summary Health status of application + * @summary Determine the health of the application * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5090,7 +5090,7 @@ export const DefaultApiFp = function(configuration?: Configuration) { }, /** * Checks database availability and API response threshold time. - * @summary Health status of application + * @summary Determine the health of the application * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -5634,7 +5634,7 @@ export const DefaultApiFactory = function (configuration?: Configuration, basePa }, /** * Checks database availability and API response threshold time. - * @summary Health status of application + * @summary Determine the health of the application * @param {*} [options] Override http request option. * @throws {RequiredError} */ @@ -6097,7 +6097,7 @@ export class DefaultApi extends BaseAPI { /** * Checks database availability and API response threshold time. - * @summary Health status of application + * @summary Determine the health of the application * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi diff --git a/packages/vulnerabilities/git-api/base.ts b/packages/vulnerabilities/git-api/base.ts index 708db61f2..7dcb11919 100644 --- a/packages/vulnerabilities/git-api/base.ts +++ b/packages/vulnerabilities/git-api/base.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.19.1 + * The version of the OpenAPI document: 2.21.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/git-api/configuration.ts b/packages/vulnerabilities/git-api/configuration.ts index 8940ba134..48b390d94 100644 --- a/packages/vulnerabilities/git-api/configuration.ts +++ b/packages/vulnerabilities/git-api/configuration.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.19.1 + * The version of the OpenAPI document: 2.21.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/git-api/doc/classes/DefaultApi.md b/packages/vulnerabilities/git-api/doc/classes/DefaultApi.md index c22fc8847..aec31a99c 100644 --- a/packages/vulnerabilities/git-api/doc/classes/DefaultApi.md +++ b/packages/vulnerabilities/git-api/doc/classes/DefaultApi.md @@ -120,7 +120,7 @@ BaseAPI.configuration ### getAffectedSystemsByCve -▸ **getAffectedSystemsByCve**(`cveId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `statusId?`, `dataFormat?`, `uuid?`, `ruleKey?`, `rulePresence?`, `rule?`, `tags?`, `sapSids?`, `sapSystem?`, `showAdvisories?`, `advisory?`, `rhelVersion?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `report?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `hostType?`, `options?`): `Promise`<`AxiosResponse`<[`AffectedSystemsOut`](../interfaces/AffectedSystemsOut.md), `any`\>\> +▸ **getAffectedSystemsByCve**(`cveId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `statusId?`, `dataFormat?`, `uuid?`, `ruleKey?`, `rulePresence?`, `rule?`, `tags?`, `sapSids?`, `sapSystem?`, `showAdvisories?`, `advisory?`, `rhelVersion?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `report?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `hostType?`, `options?`): `Promise`<`AxiosResponse`<[`AffectedSystemsOut`](../interfaces/AffectedSystemsOut.md)\>\> This is a report of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected servers along with last check-in, system name and more. @@ -171,7 +171,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AffectedSystemsOut`](../interfaces/AffectedSystemsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AffectedSystemsOut`](../interfaces/AffectedSystemsOut.md)\>\> #### Defined in @@ -181,7 +181,7 @@ ___ ### getAffectedSystemsIdsByCve -▸ **getAffectedSystemsIdsByCve**(`cveId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `statusId?`, `dataFormat?`, `uuid?`, `ruleKey?`, `rulePresence?`, `rule?`, `tags?`, `sapSids?`, `sapSystem?`, `showAdvisories?`, `advisory?`, `rhelVersion?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `hostType?`, `options?`): `Promise`<`AxiosResponse`<[`AffectedSystemsIdsOut`](../interfaces/AffectedSystemsIdsOut.md), `any`\>\> +▸ **getAffectedSystemsIdsByCve**(`cveId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `statusId?`, `dataFormat?`, `uuid?`, `ruleKey?`, `rulePresence?`, `rule?`, `tags?`, `sapSids?`, `sapSystem?`, `showAdvisories?`, `advisory?`, `rhelVersion?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `hostType?`, `options?`): `Promise`<`AxiosResponse`<[`AffectedSystemsIdsOut`](../interfaces/AffectedSystemsIdsOut.md)\>\> This is a report of identification numbers of affected systems for a given CVE. Use this request to obtain server identification numbers of all affected systems. @@ -231,7 +231,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AffectedSystemsIdsOut`](../interfaces/AffectedSystemsIdsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AffectedSystemsIdsOut`](../interfaces/AffectedSystemsIdsOut.md)\>\> #### Defined in @@ -241,7 +241,7 @@ ___ ### getAnnouncement -▸ **getAnnouncement**(`options?`): `Promise`<`AxiosResponse`<[`AnnouncementOut`](../interfaces/AnnouncementOut.md), `any`\>\> +▸ **getAnnouncement**(`options?`): `Promise`<`AxiosResponse`<[`AnnouncementOut`](../interfaces/AnnouncementOut.md)\>\> This endpoint provides vulnerability service announcements. Remain informed about important alerts for the vulnerability service. Announcements are issued by Insights Product Managers and other subject matter experts. @@ -263,7 +263,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`AnnouncementOut`](../interfaces/AnnouncementOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`AnnouncementOut`](../interfaces/AnnouncementOut.md)\>\> #### Defined in @@ -273,13 +273,13 @@ ___ ### getApiStatus -▸ **getApiStatus**(`options?`): `Promise`<`AxiosResponse`<`void`, `any`\>\> +▸ **getApiStatus**(`options?`): `Promise`<`AxiosResponse`<`void`\>\> Checks database availability and API response threshold time. **`Summary`** -Health status of application +Determine the health of the application **`Throws`** @@ -295,7 +295,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<`void`, `any`\>\> +`Promise`<`AxiosResponse`<`void`\>\> #### Defined in @@ -305,7 +305,7 @@ ___ ### getBusinessRiskList -▸ **getBusinessRiskList**(`options?`): `Promise`<`AxiosResponse`<[`BusinessRiskListOut`](../interfaces/BusinessRiskListOut.md), `any`\>\> +▸ **getBusinessRiskList**(`options?`): `Promise`<`AxiosResponse`<[`BusinessRiskListOut`](../interfaces/BusinessRiskListOut.md)\>\> This endpoint helps you determine the numeric business risk for a given CVE. A business risk is a label you can set for a given CVE. Choose one of five business risk options ranging from 0-4, where 0 is not defined and 4 indicates a critical risk. You must call this endpoint to choose a numerical value before calling the *PATCH/cves/business_risk* endpoint. @@ -327,7 +327,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`BusinessRiskListOut`](../interfaces/BusinessRiskListOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`BusinessRiskListOut`](../interfaces/BusinessRiskListOut.md)\>\> #### Defined in @@ -337,7 +337,7 @@ ___ ### getCveDetails -▸ **getCveDetails**(`cveId`, `advisoryAvailable?`, `options?`): `Promise`<`AxiosResponse`<[`CveDetailOut`](../interfaces/CveDetailOut.md), `any`\>\> +▸ **getCveDetails**(`cveId`, `advisoryAvailable?`, `options?`): `Promise`<`AxiosResponse`<[`CveDetailOut`](../interfaces/CveDetailOut.md)\>\> This endpoint returns the CVE identification number, description, scores and other metadata. The metadata includes the description, CVSS 2/3 Score, CVSS 2/3 attack vector, severity, public date, modified date, business risk, status, a URL to Red Hat web pages, a list of advisories remediating the CVE, and information regarding known exploits for the CVE. @@ -361,7 +361,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`CveDetailOut`](../interfaces/CveDetailOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`CveDetailOut`](../interfaces/CveDetailOut.md)\>\> #### Defined in @@ -371,7 +371,7 @@ ___ ### getCveIdsBySystem -▸ **getCveIdsBySystem**(`inventoryId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `statusId?`, `dataFormat?`, `businessRiskId?`, `rulePresence?`, `showAdvisories?`, `advisory?`, `ruleKey?`, `knownExploit?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `options?`): `Promise`<`AxiosResponse`<[`SystemCvesIdsOut`](../interfaces/SystemCvesIdsOut.md), `any`\>\> +▸ **getCveIdsBySystem**(`inventoryId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `statusId?`, `dataFormat?`, `businessRiskId?`, `rulePresence?`, `showAdvisories?`, `advisory?`, `ruleKey?`, `knownExploit?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `options?`): `Promise`<`AxiosResponse`<[`SystemCvesIdsOut`](../interfaces/SystemCvesIdsOut.md)\>\> This endpoint displays identification numbers of all CVEs for which a system is exposed. Use this endpoint to learn which CVEs are affecting a given system. @@ -417,7 +417,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemCvesIdsOut`](../interfaces/SystemCvesIdsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemCvesIdsOut`](../interfaces/SystemCvesIdsOut.md)\>\> #### Defined in @@ -427,7 +427,7 @@ ___ ### getCveIdsList -▸ **getCveIdsList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `dataFormat?`, `businessRiskId?`, `statusId?`, `rulePresence?`, `tags?`, `sapSids?`, `sapSystem?`, `knownExploit?`, `affecting?`, `rhelVersion?`, `ansible?`, `mssql?`, `advisoryAvailable?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesIdsOut`](../interfaces/VulnerabilitiesIdsOut.md), `any`\>\> +▸ **getCveIdsList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `dataFormat?`, `businessRiskId?`, `statusId?`, `rulePresence?`, `tags?`, `sapSids?`, `sapSystem?`, `knownExploit?`, `affecting?`, `rhelVersion?`, `ansible?`, `mssql?`, `advisoryAvailable?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesIdsOut`](../interfaces/VulnerabilitiesIdsOut.md)\>\> This is an overview of vulnerabilities identification numbers across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account. @@ -473,7 +473,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VulnerabilitiesIdsOut`](../interfaces/VulnerabilitiesIdsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VulnerabilitiesIdsOut`](../interfaces/VulnerabilitiesIdsOut.md)\>\> #### Defined in @@ -483,7 +483,7 @@ ___ ### getCveList -▸ **getCveList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `dataFormat?`, `businessRiskId?`, `statusId?`, `rulePresence?`, `tags?`, `sapSids?`, `sapSystem?`, `knownExploit?`, `affecting?`, `rhelVersion?`, `report?`, `advancedReport?`, `ansible?`, `mssql?`, `advisoryAvailable?`, `groupNames?`, `groupIds?`, `affectingHostType?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesOut`](../interfaces/VulnerabilitiesOut.md), `any`\>\> +▸ **getCveList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `dataFormat?`, `businessRiskId?`, `statusId?`, `rulePresence?`, `tags?`, `sapSids?`, `sapSystem?`, `knownExploit?`, `affecting?`, `rhelVersion?`, `report?`, `advancedReport?`, `ansible?`, `mssql?`, `advisoryAvailable?`, `groupNames?`, `groupIds?`, `affectingHostType?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesOut`](../interfaces/VulnerabilitiesOut.md)\>\> This provides an overview of vulnerabilities across your entire system inventory. Use this endpoint to get an overview of which CVEs are affecting your account, including some CVE metadata, how many systems are affected by each CVE, and more. @@ -534,7 +534,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VulnerabilitiesOut`](../interfaces/VulnerabilitiesOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VulnerabilitiesOut`](../interfaces/VulnerabilitiesOut.md)\>\> #### Defined in @@ -544,7 +544,7 @@ ___ ### getCveListBySystem -▸ **getCveListBySystem**(`inventoryId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `statusId?`, `dataFormat?`, `businessRiskId?`, `rulePresence?`, `showAdvisories?`, `advisory?`, `ruleKey?`, `knownExploit?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `report?`, `options?`): `Promise`<`AxiosResponse`<[`SystemCvesOut`](../interfaces/SystemCvesOut.md), `any`\>\> +▸ **getCveListBySystem**(`inventoryId`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `cvssFrom?`, `cvssTo?`, `publicFrom?`, `publicTo?`, `impact?`, `statusId?`, `dataFormat?`, `businessRiskId?`, `rulePresence?`, `showAdvisories?`, `advisory?`, `ruleKey?`, `knownExploit?`, `firstReportedFrom?`, `firstReportedTo?`, `advisoryAvailable?`, `remediation?`, `report?`, `options?`): `Promise`<`AxiosResponse`<[`SystemCvesOut`](../interfaces/SystemCvesOut.md)\>\> This endpoint displays detailed information about all CVEs for which a system is exposed. Use this endpoint to discover which CVEs are affecting a given system. CVE metadata is included. @@ -591,7 +591,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemCvesOut`](../interfaces/SystemCvesOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemCvesOut`](../interfaces/SystemCvesOut.md)\>\> #### Defined in @@ -601,7 +601,7 @@ ___ ### getCveList\_1 -▸ **getCveList_1**(`vulnerabilitiesPostIn`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesPostOut`](../interfaces/VulnerabilitiesPostOut.md), `any`\>\> +▸ **getCveList_1**(`vulnerabilitiesPostIn`, `filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `options?`): `Promise`<`AxiosResponse`<[`VulnerabilitiesPostOut`](../interfaces/VulnerabilitiesPostOut.md)\>\> This is an overview of vulnerabilities for specific CVEs provided in the body. Use this endpoint to get a CVSS score, and learn the severity for a list of CVEs provided in the request. @@ -630,7 +630,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VulnerabilitiesPostOut`](../interfaces/VulnerabilitiesPostOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VulnerabilitiesPostOut`](../interfaces/VulnerabilitiesPostOut.md)\>\> #### Defined in @@ -640,7 +640,7 @@ ___ ### getDashbar -▸ **getDashbar**(`tags?`, `sapSids?`, `sapSystem?`, `ansible?`, `mssql?`, `options?`): `Promise`<`AxiosResponse`<[`DashbarOut`](../interfaces/DashbarOut.md), `any`\>\> +▸ **getDashbar**(`tags?`, `sapSids?`, `sapSystem?`, `ansible?`, `mssql?`, `options?`): `Promise`<`AxiosResponse`<[`DashbarOut`](../interfaces/DashbarOut.md)\>\> These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence, severity and other details. @@ -667,7 +667,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`DashbarOut`](../interfaces/DashbarOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`DashbarOut`](../interfaces/DashbarOut.md)\>\> #### Defined in @@ -677,7 +677,7 @@ ___ ### getDashboard -▸ **getDashboard**(`tags?`, `sapSids?`, `sapSystem?`, `ansible?`, `mssql?`, `options?`): `Promise`<`AxiosResponse`<[`Dashboard`](../interfaces/Dashboard.md), `any`\>\> +▸ **getDashboard**(`tags?`, `sapSids?`, `sapSystem?`, `ansible?`, `mssql?`, `options?`): `Promise`<`AxiosResponse`<[`Dashboard`](../interfaces/Dashboard.md)\>\> These are aggregations summarizing your account such as number of unique CVEs, list of security rules, CVEs by severity, and more. Use this endpoint to obtain a snapshot of all the CVES and details about their prevalence and severity. @@ -704,7 +704,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`Dashboard`](../interfaces/Dashboard.md), `any`\>\> +`Promise`<`AxiosResponse`<[`Dashboard`](../interfaces/Dashboard.md)\>\> #### Defined in @@ -714,7 +714,7 @@ ___ ### getExecutiveReport -▸ **getExecutiveReport**(`options?`): `Promise`<`AxiosResponse`<[`ExecutiveReport`](../interfaces/ExecutiveReport.md), `any`\>\> +▸ **getExecutiveReport**(`options?`): `Promise`<`AxiosResponse`<[`ExecutiveReport`](../interfaces/ExecutiveReport.md)\>\> This returns an overview of vulnerabilities affecting a given account. Use this request when you need to download a high-level, executive report summarizing the security exposure of your infrastructure. These reports are designed for an executive audience and include data such as the number of RHEL systems analyzed, the number of security rules in your infrastructure, percentage of CVEs with a certain severity and more. @@ -736,7 +736,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`ExecutiveReport`](../interfaces/ExecutiveReport.md), `any`\>\> +`Promise`<`AxiosResponse`<[`ExecutiveReport`](../interfaces/ExecutiveReport.md)\>\> #### Defined in @@ -746,7 +746,7 @@ ___ ### getPlaybookTemplate -▸ **getPlaybookTemplate**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookTemplate`](../interfaces/PlaybookTemplate.md), `any`\>\> +▸ **getPlaybookTemplate**(`ruleId`, `options?`): `Promise`<`AxiosResponse`<[`PlaybookTemplate`](../interfaces/PlaybookTemplate.md)\>\> This returns an Ansible playbook template for a given rule identification number. Use this endpoint to return an Ansible playbook template for a given rule error key. The template is used to remediate issues on your system. @@ -769,7 +769,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`PlaybookTemplate`](../interfaces/PlaybookTemplate.md), `any`\>\> +`Promise`<`AxiosResponse`<[`PlaybookTemplate`](../interfaces/PlaybookTemplate.md)\>\> #### Defined in @@ -779,7 +779,7 @@ ___ ### getStatusList -▸ **getStatusList**(`options?`): `Promise`<`AxiosResponse`<[`StatusListOut`](../interfaces/StatusListOut.md), `any`\>\> +▸ **getStatusList**(`options?`): `Promise`<`AxiosResponse`<[`StatusListOut`](../interfaces/StatusListOut.md)\>\> This endpoint returns a list of possible values for setting status for a CVE or system-CVE pair. Call this api when you want to know which values are available for setting a status. A list of numbers will be returned. You must call this endpoint before calling the *PATCH/cves/status* endpoint. @@ -801,7 +801,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`StatusListOut`](../interfaces/StatusListOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`StatusListOut`](../interfaces/StatusListOut.md)\>\> #### Defined in @@ -811,7 +811,7 @@ ___ ### getSystemDetails -▸ **getSystemDetails**(`inventoryId`, `options?`): `Promise`<`AxiosResponse`<[`SystemDetailsOut`](../interfaces/SystemDetailsOut.md), `any`\>\> +▸ **getSystemDetails**(`inventoryId`, `options?`): `Promise`<`AxiosResponse`<[`SystemDetailsOut`](../interfaces/SystemDetailsOut.md)\>\> This allows you to get information about systems related to an inventory identification number. This includes details such as operating system, inventory tags, last update, opt-out status, and more. @@ -834,7 +834,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemDetailsOut`](../interfaces/SystemDetailsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemDetailsOut`](../interfaces/SystemDetailsOut.md)\>\> #### Defined in @@ -844,7 +844,7 @@ ___ ### getSystemsIds -▸ **getSystemsIds**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `dataFormat?`, `stale?`, `uuid?`, `tags?`, `sapSids?`, `sapSystem?`, `excluded?`, `rhelVersion?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `options?`): `Promise`<`AxiosResponse`<[`SystemIdsOut`](../interfaces/SystemIdsOut.md), `any`\>\> +▸ **getSystemsIds**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `dataFormat?`, `stale?`, `uuid?`, `tags?`, `sapSids?`, `sapSystem?`, `excluded?`, `rhelVersion?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `options?`): `Promise`<`AxiosResponse`<[`SystemIdsOut`](../interfaces/SystemIdsOut.md)\>\> This lists systems including those that have opted out of the current query. Use this when you do not want to see a registered system or systems in your reports. @@ -884,7 +884,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemIdsOut`](../interfaces/SystemIdsOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemIdsOut`](../interfaces/SystemIdsOut.md)\>\> #### Defined in @@ -894,7 +894,7 @@ ___ ### getSystemsList -▸ **getSystemsList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `dataFormat?`, `stale?`, `uuid?`, `tags?`, `sapSids?`, `sapSystem?`, `excluded?`, `rhelVersion?`, `report?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `options?`): `Promise`<`AxiosResponse`<[`SystemListOut`](../interfaces/SystemListOut.md), `any`\>\> +▸ **getSystemsList**(`filter?`, `limit?`, `offset?`, `page?`, `pageSize?`, `sort?`, `dataFormat?`, `stale?`, `uuid?`, `tags?`, `sapSids?`, `sapSystem?`, `excluded?`, `rhelVersion?`, `report?`, `ansible?`, `mssql?`, `groupNames?`, `groupIds?`, `options?`): `Promise`<`AxiosResponse`<[`SystemListOut`](../interfaces/SystemListOut.md)\>\> List systems that are accessible when you are logged into your account. Use this endpoint to view basic system attributes such as display name and system type. @@ -935,7 +935,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`SystemListOut`](../interfaces/SystemListOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`SystemListOut`](../interfaces/SystemListOut.md)\>\> #### Defined in @@ -945,7 +945,7 @@ ___ ### getVersion -▸ **getVersion**(`options?`): `Promise`<`AxiosResponse`<[`VersionOut`](../interfaces/VersionOut.md), `any`\>\> +▸ **getVersion**(`options?`): `Promise`<`AxiosResponse`<[`VersionOut`](../interfaces/VersionOut.md)\>\> This endpoint will provide you with the application version. Use this endpoint to track application changes. @@ -967,7 +967,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`VersionOut`](../interfaces/VersionOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`VersionOut`](../interfaces/VersionOut.md)\>\> #### Defined in @@ -977,7 +977,7 @@ ___ ### setCveBusinessRisk -▸ **setCveBusinessRisk**(`cveRiskIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +▸ **setCveBusinessRisk**(`cveRiskIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> This sets a business risk for a specific CVE. Set a value of low, medium, high or critical for a given CVE. These values are obtained by the business risk path *GET/business_risk*. To set a business risk, you must call the GET/business_risk endpoint first, followed by the *PATCH/cves/business_risk* path. @@ -1000,7 +1000,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> #### Defined in @@ -1010,7 +1010,7 @@ ___ ### setCveStatus -▸ **setCveStatus**(`cveStatusIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +▸ **setCveStatus**(`cveStatusIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> This sets the status for a specific CVE. Set a status value for a given CVE (e.g. in-review, on-hold, scheduled for a patch, or resolved). These values are obtained by sending a *GET/status* request. To set a status, you must call the *GET/business_risk* first, followed by the *PATCH/cves/status* path. @@ -1033,7 +1033,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> #### Defined in @@ -1043,7 +1043,7 @@ ___ ### setCvesWithoutErrata -▸ **setCvesWithoutErrata**(`cvesWithoutErrataIn`, `options?`): `Promise`<`AxiosResponse`<[`CvesWithoutErrataOut`](../interfaces/CvesWithoutErrataOut.md), `any`\>\> +▸ **setCvesWithoutErrata**(`cvesWithoutErrataIn`, `options?`): `Promise`<`AxiosResponse`<[`CvesWithoutErrataOut`](../interfaces/CvesWithoutErrataOut.md)\>\> Use this endpoint to enable/disable reporting CVEs that do not have advisories (errata) for your customer account. If the feature is disabled, CVEs without advisories will be hidden in outputs of all endpoints. @@ -1066,7 +1066,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`CvesWithoutErrataOut`](../interfaces/CvesWithoutErrataOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`CvesWithoutErrataOut`](../interfaces/CvesWithoutErrataOut.md)\>\> #### Defined in @@ -1076,7 +1076,7 @@ ___ ### setStatus -▸ **setStatus**(`statusIn`, `options?`): `Promise`<`AxiosResponse`<[`StatusOut`](../interfaces/StatusOut.md), `any`\>\> +▸ **setStatus**(`statusIn`, `options?`): `Promise`<`AxiosResponse`<[`StatusOut`](../interfaces/StatusOut.md)\>\> This endpoint sets status for given systems and CVEs. Use this endpoint when you need to set a status value for system-CVE pairs. @@ -1099,7 +1099,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`StatusOut`](../interfaces/StatusOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`StatusOut`](../interfaces/StatusOut.md)\>\> #### Defined in @@ -1109,7 +1109,7 @@ ___ ### setSystemsOptOut -▸ **setSystemsOptOut**(`optOutIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +▸ **setSystemsOptOut**(`optOutIn`, `options?`): `Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> Opt a specific system in or out of vulnerability analysis. Use this when you want to use other Insights services but do not want to see specific systems in vulnerability reports. This allows you to hide select systems. @@ -1132,7 +1132,7 @@ DefaultApi #### Returns -`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md), `any`\>\> +`Promise`<`AxiosResponse`<[`BulkChangeOut`](../interfaces/BulkChangeOut.md)\>\> #### Defined in diff --git a/packages/vulnerabilities/git-api/doc/interfaces/ConfigurationParameters.md b/packages/vulnerabilities/git-api/doc/interfaces/ConfigurationParameters.md index 9ec0f9598..3c287775b 100644 --- a/packages/vulnerabilities/git-api/doc/interfaces/ConfigurationParameters.md +++ b/packages/vulnerabilities/git-api/doc/interfaces/ConfigurationParameters.md @@ -5,7 +5,7 @@ Vulnerability Engine Manager No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) -The version of the OpenAPI document: 2.19.1 +The version of the OpenAPI document: 2.21.1 NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). https://openapi-generator.tech diff --git a/packages/vulnerabilities/git-api/index.ts b/packages/vulnerabilities/git-api/index.ts index c4ba33931..3b883da97 100644 --- a/packages/vulnerabilities/git-api/index.ts +++ b/packages/vulnerabilities/git-api/index.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.19.1 + * The version of the OpenAPI document: 2.21.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/packages/vulnerabilities/index.ts b/packages/vulnerabilities/index.ts index d313c05a1..d94783fbc 100644 --- a/packages/vulnerabilities/index.ts +++ b/packages/vulnerabilities/index.ts @@ -3,7 +3,7 @@ * Vulnerability Engine Manager * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * - * The version of the OpenAPI document: 2.19.1 + * The version of the OpenAPI document: 2.21.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).