diff --git a/packages/host-inventory/custom.d.ts b/packages/host-inventory/custom.d.ts deleted file mode 100644 index 32534cb16..000000000 --- a/packages/host-inventory/custom.d.ts +++ /dev/null @@ -1 +0,0 @@ -declare module 'url'; \ No newline at end of file diff --git a/packages/host-inventory/doc/.nojekyll b/packages/host-inventory/doc/.nojekyll deleted file mode 100644 index e2ac6616a..000000000 --- a/packages/host-inventory/doc/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/packages/host-inventory/doc/README.md b/packages/host-inventory/doc/README.md deleted file mode 100644 index a22707ba2..000000000 --- a/packages/host-inventory/doc/README.md +++ /dev/null @@ -1,69 +0,0 @@ -@redhat-cloud-services/host-inventory-client / [Exports](modules.md) - -# Javascript client for Inventory API -If you want to use [RedHatInsights/insights-host-inventory](https://github.com/RedHatInsights/insights-host-inventory) you shouldn't use get requests directly, but rather use this client to integrate with inventory service. - -## Install -NPM -```bash -npm install --save @redhat-cloud-services/host-inventory-client -``` - -Or Yarn -```bash -yarn add @redhat-cloud-services/host-inventory-client -``` - -### Usage -This client is using typescript and axios. Types are distributed with this package, so no need to define or install them separately. - -To correctly bootstrap this API you should use this config (no need to define it multiple times, just one config and reimport it anywhere you want to use it). -```JS -// api.js -import axios from 'axios'; -import { HostsApi } from '@redhat-cloud-services/host-inventory-client'; -const instance = axios.create(); - -// BASE_PATH should be set in your constants file -const hostsApi = new HostsApi(undefined, BASE_PATH, instance); -export hostsApi; -``` - -If you want to add some interceptors you can use axios build in interceptors -```JS -// api.js -import axios from 'axios'; -import { HostsApi } from '@redhat-cloud-services/host-inventory-client'; -const instance = axios.create(); - -// Request interceptor -instance.interceptors.request.use((request) => { - // some logic to do with request -}); - -// Response interceptor -instance.interceptors.response.use((response) => { - // some logic to do with request -}); - -// Error interceptor -instance.interceptors.response.use(null, (error) => { - // some logic to do with error -}); - -// BASE_PATH should be set in your constants file -const hostsApi = new HostsApi(undefined, BASE_PATH, instance); -export hostsApi; -``` - -## Building - -Run `nx build @redhat-cloud-services/host-inventory-client` to build the library. - -## Running unit tests - -Run `nx test @redhat-cloud-services/host-inventory-client` to execute the unit tests via [Jest](https://jestjs.io). - -## API documentation - -* [README](doc/README.md) diff --git a/packages/host-inventory/doc/classes/AccountsStalenessApi.md b/packages/host-inventory/doc/classes/AccountsStalenessApi.md deleted file mode 100644 index 0ec1c50fc..000000000 --- a/packages/host-inventory/doc/classes/AccountsStalenessApi.md +++ /dev/null @@ -1,265 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / AccountsStalenessApi - -# Class: AccountsStalenessApi - -AccountsStalenessApi - object-oriented interface - -**`Export`** - -AccountsStalenessApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`AccountsStalenessApi`** - -## Table of contents - -### Constructors - -- [constructor](AccountsStalenessApi.md#constructor) - -### Properties - -- [axios](AccountsStalenessApi.md#axios) -- [basePath](AccountsStalenessApi.md#basepath) -- [configuration](AccountsStalenessApi.md#configuration) - -### Methods - -- [apiStalenessCreateStaleness](AccountsStalenessApi.md#apistalenesscreatestaleness) -- [apiStalenessDeleteStaleness](AccountsStalenessApi.md#apistalenessdeletestaleness) -- [apiStalenessGetDefaultStaleness](AccountsStalenessApi.md#apistalenessgetdefaultstaleness) -- [apiStalenessGetStaleness](AccountsStalenessApi.md#apistalenessgetstaleness) -- [apiStalenessUpdateStaleness](AccountsStalenessApi.md#apistalenessupdatestaleness) - -## Constructors - -### constructor - -• **new AccountsStalenessApi**(`configuration?`, `basePath?`, `axios?`): [`AccountsStalenessApi`](AccountsStalenessApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`AccountsStalenessApi`](AccountsStalenessApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L49) - -## Methods - -### apiStalenessCreateStaleness - -▸ **apiStalenessCreateStaleness**(`stalenessIn`, `options?`): `Promise`\<`AxiosResponse`\<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> - -Create account staleness record. Required permissions: inventory:TODO:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `stalenessIn` | [`StalenessIn`](../interfaces/StalenessIn.md) | Data required to create a record for a account staleness. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> - -**`Summary`** - -Create account staleness record - -**`Throws`** - -**`Memberof`** - -AccountsStalenessApi - -#### Defined in - -[api.ts:3290](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L3290) - -___ - -### apiStalenessDeleteStaleness - -▸ **apiStalenessDeleteStaleness**(`options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Delete an account staleness

Required permissions: inventory:staleness:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Delete an account staleness - -**`Throws`** - -**`Memberof`** - -AccountsStalenessApi - -#### Defined in - -[api.ts:3301](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L3301) - -___ - -### apiStalenessGetDefaultStaleness - -▸ **apiStalenessGetDefaultStaleness**(`options?`): `Promise`\<`AxiosResponse`\<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> - -Read the entire list of all accounts staleness available. Required permissions: inventory:TODO:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> - -**`Summary`** - -Read the entire list of account staleness - -**`Throws`** - -**`Memberof`** - -AccountsStalenessApi - -#### Defined in - -[api.ts:3312](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L3312) - -___ - -### apiStalenessGetStaleness - -▸ **apiStalenessGetStaleness**(`options?`): `Promise`\<`AxiosResponse`\<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> - -Read the entire list of all accounts staleness available. Required permissions: inventory:TODO:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> - -**`Summary`** - -Read the entire list of account staleness - -**`Throws`** - -**`Memberof`** - -AccountsStalenessApi - -#### Defined in - -[api.ts:3323](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L3323) - -___ - -### apiStalenessUpdateStaleness - -▸ **apiStalenessUpdateStaleness**(`stalenessIn`, `options?`): `Promise`\<`AxiosResponse`\<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> - -Update account staleness record. Required permissions: inventory:staleness:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `stalenessIn` | [`StalenessIn`](../interfaces/StalenessIn.md) | Data required to update a record for a account staleness. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`StalenessOutput`](../interfaces/StalenessOutput.md), `any`\>\> - -**`Summary`** - -Update account staleness record - -**`Throws`** - -**`Memberof`** - -AccountsStalenessApi - -#### Defined in - -[api.ts:3335](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L3335) diff --git a/packages/host-inventory/doc/classes/Configuration.md b/packages/host-inventory/doc/classes/Configuration.md deleted file mode 100644 index 41cdf5bad..000000000 --- a/packages/host-inventory/doc/classes/Configuration.md +++ /dev/null @@ -1,146 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / Configuration - -# Class: Configuration - -## Table of contents - -### Constructors - -- [constructor](Configuration.md#constructor) - -### Properties - -- [accessToken](Configuration.md#accesstoken) -- [apiKey](Configuration.md#apikey) -- [baseOptions](Configuration.md#baseoptions) -- [basePath](Configuration.md#basepath) -- [password](Configuration.md#password) -- [username](Configuration.md#username) - -## Constructors - -### constructor - -• **new Configuration**(`param?`): [`Configuration`](Configuration.md) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `param` | [`ConfigurationParameters`](../interfaces/ConfigurationParameters.md) | - -#### Returns - -[`Configuration`](Configuration.md) - -#### Defined in - -[configuration.ts:67](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L67) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `string` - -parameter for oauth2 security - -**`Param`** - -security name - -**`Param`** - -oauth2 scope - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L51) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\> - -parameter for apiKey security - -**`Param`** - -security name - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:30](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L30) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -base options for axios calls - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:65](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L65) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -override base path - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L58) - -___ - -### password - -• `Optional` **password**: `string` - -parameter for basic security - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:44](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L44) - -___ - -### username - -• `Optional` **username**: `string` - -parameter for basic security - -**`Memberof`** - -Configuration - -#### Defined in - -[configuration.ts:37](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L37) diff --git a/packages/host-inventory/doc/classes/GroupsApi.md b/packages/host-inventory/doc/classes/GroupsApi.md deleted file mode 100644 index 5b3e08a88..000000000 --- a/packages/host-inventory/doc/classes/GroupsApi.md +++ /dev/null @@ -1,491 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / GroupsApi - -# Class: GroupsApi - -GroupsApi - object-oriented interface - -**`Export`** - -GroupsApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`GroupsApi`** - -## Table of contents - -### Constructors - -- [constructor](GroupsApi.md#constructor) - -### Properties - -- [axios](GroupsApi.md#axios) -- [basePath](GroupsApi.md#basepath) -- [configuration](GroupsApi.md#configuration) - -### Methods - -- [apiAssignmentRuleCreateAssignmentRule](GroupsApi.md#apiassignmentrulecreateassignmentrule) -- [apiAssignmentRuleGetAssignmentRulesById](GroupsApi.md#apiassignmentrulegetassignmentrulesbyid) -- [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) -- [apiHostGroupAddHostListToGroup](GroupsApi.md#apihostgroupaddhostlisttogroup) -- [apiHostGroupDeleteHostsFromGroup](GroupsApi.md#apihostgroupdeletehostsfromgroup) - -## Constructors - -### constructor - -• **new GroupsApi**(`configuration?`, `basePath?`, `axios?`): [`GroupsApi`](GroupsApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`GroupsApi`](GroupsApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L49) - -## Methods - -### apiAssignmentRuleCreateAssignmentRule - -▸ **apiAssignmentRuleCreateAssignmentRule**(`assignmentRuleIn`, `options?`): `Promise`\<`AxiosResponse`\<[`AssignmentRuleOut`](../interfaces/AssignmentRuleOut.md), `any`\>\> - -Create Assignment Rule object using post request

Required permissions: inventory:groups:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assignmentRuleIn` | [`AssignmentRuleIn`](../interfaces/AssignmentRuleIn.md) | Data required to create Assignment Rule object | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`AssignmentRuleOut`](../interfaces/AssignmentRuleOut.md), `any`\>\> - -**`Summary`** - -Create Assignment Rule object - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4296](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4296) - -___ - -### apiAssignmentRuleGetAssignmentRulesById - -▸ **apiAssignmentRuleGetAssignmentRulesById**(`assignmentRuleIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`\<`AxiosResponse`\<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md), `any`\>\> - -Find one or more assignment rules by their IDs.

Required permissions: inventory:groups:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `assignmentRuleIdList` | `string`[] | A comma-separated list of assignment-rule IDs. | -| `perPage?` | `number` | A number of items to return per page. | -| `page?` | `number` | A page number of the items to return. | -| `orderBy?` | ``"name"`` \| ``"group_id"`` | Ordering field name | -| `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering; defaults to ASC for name, and to DESC for host_ids | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md), `any`\>\> - -**`Summary`** - -Find assignment rules by their IDs - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4312](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4312) - -___ - -### apiAssignmentRuleGetAssignmentRulesList - -▸ **apiAssignmentRuleGetAssignmentRulesList**(`name?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`\<`AxiosResponse`\<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md), `any`\>\> - -Read the entire list of all assignment-rules available to the account. [Not Implemented] Required permissions: inventory:groups:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `name?` | `string` | Filter by assignment-rule name | -| `perPage?` | `number` | A number of items to return per page. | -| `page?` | `number` | A page number of the items to return. | -| `orderBy?` | ``"name"`` \| ``"group_id"`` | Ordering field name | -| `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering; defaults to ASC for name, and to DESC for host_ids | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`AssignmentRuleQueryOutput`](../interfaces/AssignmentRuleQueryOutput.md), `any`\>\> - -**`Summary`** - -Read the entire list of assignment-rules [Not Implemented] - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4328](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4328) - -___ - -### apiGroupCreateGroup - -▸ **apiGroupCreateGroup**(`groupIn`, `options?`): `Promise`\<`AxiosResponse`\<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> - -Creates a new group containing the hosts associated with the host IDs provided.

Required permissions: inventory:groups:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `groupIn` | [`GroupIn`](../interfaces/GroupIn.md) | Data required to create a record for a group. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> - -**`Summary`** - -Create a new group matching the provided name and list of hosts IDs - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4340](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4340) - -___ - -### apiGroupDeleteGroups - -▸ **apiGroupDeleteGroups**(`groupIdList`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Delete a list of groups.

Required permissions: inventory:groups:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `groupIdList` | `string`[] | A comma-separated list of group IDs. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Delete a list of groups - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4352](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4352) - -___ - -### apiGroupDeleteHostsFromDifferentGroups - -▸ **apiGroupDeleteHostsFromDifferentGroups**(`hostIdList`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Delete a list of hosts from the groups they are in.

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

Required permissions: inventory:groups:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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"`` \| ``"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`\>\> - -**`Summary`** - -Read the entire list of groups - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4380](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4380) - -___ - -### apiGroupGetGroupsById - -▸ **apiGroupGetGroupsById**(`groupIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`\<`AxiosResponse`\<[`GroupQueryOutput`](../interfaces/GroupQueryOutput.md), `any`\>\> - -Find one or more groups by their IDs.

Required permissions: inventory:groups:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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"`` \| ``"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`\>\> - -**`Summary`** - -Find groups by their IDs - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4396](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4396) - -___ - -### apiGroupPatchGroupById - -▸ **apiGroupPatchGroupById**(`groupId`, `groupIn`, `options?`): `Promise`\<`AxiosResponse`\<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> - -Merge group information.

Required permissions: inventory:groups:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `groupId` | `string` | Group ID. | -| `groupIn` | [`GroupIn`](../interfaces/GroupIn.md) | A dictionary with new information to merge with the original group. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> - -**`Summary`** - -Merge group information - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4409](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4409) - -___ - -### apiHostGroupAddHostListToGroup - -▸ **apiHostGroupAddHostListToGroup**(`groupId`, `requestBody`, `options?`): `Promise`\<`AxiosResponse`\<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> - -Adds the host list in the request body to the provided group.

Required permissions: inventory:groups:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `groupId` | `string` | Group ID. | -| `requestBody` | `string`[] | A list of hosts IDs to associate with the provided group. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`GroupOutWithHostCount`](../interfaces/GroupOutWithHostCount.md), `any`\>\> - -**`Summary`** - -Add host IDs to the provided group - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4422](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4422) - -___ - -### apiHostGroupDeleteHostsFromGroup - -▸ **apiHostGroupDeleteHostsFromGroup**(`groupId`, `hostIdList`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Delete one or more hosts from a group.

Required permissions: inventory:groups:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `groupId` | `string` | Group ID. | -| `hostIdList` | `string`[] | A comma-separated list of host IDs. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Delete one or more hosts from a group - -**`Throws`** - -**`Memberof`** - -GroupsApi - -#### Defined in - -[api.ts:4435](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4435) diff --git a/packages/host-inventory/doc/classes/HostsApi.md b/packages/host-inventory/doc/classes/HostsApi.md deleted file mode 100644 index 0cb8cef0a..000000000 --- a/packages/host-inventory/doc/classes/HostsApi.md +++ /dev/null @@ -1,566 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / HostsApi - -# Class: HostsApi - -HostsApi - object-oriented interface - -**`Export`** - -HostsApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`HostsApi`** - -## Table of contents - -### Constructors - -- [constructor](HostsApi.md#constructor) - -### Properties - -- [axios](HostsApi.md#axios) -- [basePath](HostsApi.md#basepath) -- [configuration](HostsApi.md#configuration) - -### Methods - -- [apiHostDeleteAllHosts](HostsApi.md#apihostdeleteallhosts) -- [apiHostDeleteHostById](HostsApi.md#apihostdeletehostbyid) -- [apiHostDeleteHostsByFilter](HostsApi.md#apihostdeletehostsbyfilter) -- [apiHostGetHostById](HostsApi.md#apihostgethostbyid) -- [apiHostGetHostList](HostsApi.md#apihostgethostlist) -- [apiHostGetHostSystemProfileById](HostsApi.md#apihostgethostsystemprofilebyid) -- [apiHostGetHostTagCount](HostsApi.md#apihostgethosttagcount) -- [apiHostGetHostTags](HostsApi.md#apihostgethosttags) -- [apiHostHostCheckin](HostsApi.md#apihosthostcheckin) -- [apiHostMergeFacts](HostsApi.md#apihostmergefacts) -- [apiHostPatchHostById](HostsApi.md#apihostpatchhostbyid) -- [apiHostReplaceFacts](HostsApi.md#apihostreplacefacts) - -## Constructors - -### constructor - -• **new HostsApi**(`configuration?`, `basePath?`, `axios?`): [`HostsApi`](HostsApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`HostsApi`](HostsApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L49) - -## Methods - -### apiHostDeleteAllHosts - -▸ **apiHostDeleteAllHosts**(`confirmDeleteAll?`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Delete all hosts on the account. The request must include \"confirm_delete_all=true\".

Required permissions: inventory:hosts:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `confirmDeleteAll?` | `boolean` | Confirmation to delete all hosts on the account | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Delete all hosts on the account - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5751](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5751) - -___ - -### apiHostDeleteHostById - -▸ **apiHostDeleteHostById**(`hostIdList`, `branchId?`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Delete hosts by IDs

Required permissions: inventory:hosts:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hostIdList` | `string`[] | A comma-separated list of host IDs. | -| `branchId?` | `string` | Filter by branch_id | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Delete hosts by IDs - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5764](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5764) - -___ - -### apiHostDeleteHostsByFilter - -▸ **apiHostDeleteHostsByFilter**(`displayName?`, `fqdn?`, `hostnameOrId?`, `insightsId?`, `providerId?`, `providerType?`, `updatedStart?`, `updatedEnd?`, `groupName?`, `registeredWith?`, `staleness?`, `tags?`, `filter?`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Delete the entire list of hosts filtered by the given parameters.

Required permissions: inventory:hosts:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `displayName?` | `string` | Filter by display_name (case-insensitive) | -| `fqdn?` | `string` | Filter by FQDN (case-insensitive) | -| `hostnameOrId?` | `string` | Filter by display_name, fqdn, id (case-insensitive) | -| `insightsId?` | `string` | Filter by insights_id | -| `providerId?` | `string` | Filter by provider_id | -| `providerType?` | ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"`` | Filter by provider_type | -| `updatedStart?` | `string` | Only show hosts last modified after the given date | -| `updatedEnd?` | `string` | Only show hosts last modified before the given date | -| `groupName?` | `string`[] | Filter by group name | -| `registeredWith?` | (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[] | Filters out any host not registered by the specified reporters | -| `staleness?` | (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[] | Culling states of the hosts. | -| `tags?` | `string`[] | filters out hosts not tagged by the given tags | -| `filter?` | `Object` | Filters hosts based on system_profile fields. For example: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"sap_system\": {\"eq\": \"true\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][sap_system][eq]=true\" <br /><br /> Hosts with host_type \"edge\" are filtered out by default. <br /><br /> To get \"edge\" hosts, use this explicit filter: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"host_type\": {\"eq\": \"edge\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][host_type][eq]=edge\" | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Delete the entire list of hosts filtered by the given parameters - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5788](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5788) - -___ - -### apiHostGetHostById - -▸ **apiHostGetHostById**(`hostIdList`, `branchId?`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `fields?`, `options?`): `Promise`\<`AxiosResponse`\<[`HostQueryOutput`](../interfaces/HostQueryOutput.md), `any`\>\> - -Find one or more hosts by their ID.

Required permissions: inventory:hosts:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hostIdList` | `string`[] | A comma-separated list of host IDs. | -| `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?` | ``"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. For example, <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": [\"arch\", \"host_type\"]} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?fields[system_profile]=arch,host_type\" | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`HostQueryOutput`](../interfaces/HostQueryOutput.md), `any`\>\> - -**`Summary`** - -Find hosts by their IDs - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5806](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5806) - -___ - -### 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`\>\> - -Read the entire list of all hosts available to the account.

Required permissions: inventory:hosts:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `displayName?` | `string` | Filter by display_name (case-insensitive) | -| `fqdn?` | `string` | Filter by FQDN (case-insensitive) | -| `hostnameOrId?` | `string` | Filter by display_name, fqdn, id (case-insensitive) | -| `insightsId?` | `string` | Filter by insights_id | -| `providerId?` | `string` | Filter by provider_id | -| `providerType?` | ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"`` | Filter by provider_type | -| `updatedStart?` | `string` | Only show hosts last modified after the given date | -| `updatedEnd?` | `string` | Only show hosts last modified before the given date | -| `groupName?` | `string`[] | Filter by group name | -| `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?` | ``"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?` | (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[] | Culling states of the hosts. Default: fresh, stale and stale_warning | -| `tags?` | `string`[] | filters out hosts not tagged by the given tags | -| `registeredWith?` | (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[] | Filters out any host not registered by the specified reporters | -| `filter?` | `Object` | Filters hosts based on system_profile fields. For example: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"sap_system\": {\"eq\": \"true\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][sap_system][eq]=true\" <br /><br /> Hosts with host_type \"edge\" are filtered out by default. <br /><br /> To get \"edge\" hosts, use this explicit filter: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"host_type\": {\"eq\": \"edge\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][host_type][eq]=edge\" | -| `fields?` | `Object` | Fetches only mentioned system_profile fields. For example, <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": [\"arch\", \"host_type\"]} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?fields[system_profile]=arch,host_type\" | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`HostQueryOutput`](../interfaces/HostQueryOutput.md), `any`\>\> - -**`Summary`** - -Read the entire list of hosts - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5836](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5836) - -___ - -### apiHostGetHostSystemProfileById - -▸ **apiHostGetHostSystemProfileById**(`hostIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `branchId?`, `fields?`, `options?`): `Promise`\<`AxiosResponse`\<[`SystemProfileByHostOut`](../interfaces/SystemProfileByHostOut.md), `any`\>\> - -Find one or more hosts by their ID and return the id and system profile

Required permissions: inventory:hosts:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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?` | ``"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. For example, <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": [\"arch\", \"host_type\"]} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?fields[system_profile]=arch,host_type\" | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SystemProfileByHostOut`](../interfaces/SystemProfileByHostOut.md), `any`\>\> - -**`Summary`** - -Return one or more hosts system profile - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5854](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5854) - -___ - -### apiHostGetHostTagCount - -▸ **apiHostGetHostTagCount**(`hostIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `options?`): `Promise`\<`AxiosResponse`\<[`TagCountOut`](../interfaces/TagCountOut.md), `any`\>\> - -Get the number of tags on a host or hosts

Required permissions: inventory:hosts:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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?` | ``"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`\>\> - -**`Summary`** - -Get the number of tags on a host or hosts - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5870](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5870) - -___ - -### apiHostGetHostTags - -▸ **apiHostGetHostTags**(`hostIdList`, `perPage?`, `page?`, `orderBy?`, `orderHow?`, `search?`, `options?`): `Promise`\<`AxiosResponse`\<[`TagsOut`](../interfaces/TagsOut.md), `any`\>\> - -Get the tags on a host

Required permissions: inventory:hosts:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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?` | ``"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`\>\> - -**`Summary`** - -Get the tags on a host - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5887](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5887) - -___ - -### apiHostHostCheckin - -▸ **apiHostHostCheckin**(`createCheckIn`, `options?`): `Promise`\<`AxiosResponse`\<[`HostOut`](../interfaces/HostOut.md), `any`\>\> - -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 - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `createCheckIn` | [`CreateCheckIn`](../interfaces/CreateCheckIn.md) | Data required to create a check-in record for a host. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`HostOut`](../interfaces/HostOut.md), `any`\>\> - -**`Summary`** - -Update staleness timestamps for a host matching the provided facts - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5899](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5899) - -___ - -### apiHostMergeFacts - -▸ **apiHostMergeFacts**(`hostIdList`, `namespace`, `body`, `branchId?`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Merge one or multiple hosts facts under a namespace.

Required permissions: inventory:hosts:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hostIdList` | `string`[] | A comma-separated list of host IDs. | -| `namespace` | `string` | A namespace of the merged facts. | -| `body` | `object` | A dictionary with the new facts to merge with the original ones. | -| `branchId?` | `string` | Filter by branch_id | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Merge facts under a namespace - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5914](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5914) - -___ - -### apiHostPatchHostById - -▸ **apiHostPatchHostById**(`hostIdList`, `patchHostIn`, `branchId?`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Update hosts

Required permissions: inventory:hosts:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hostIdList` | `string`[] | A comma-separated list of host IDs. | -| `patchHostIn` | [`PatchHostIn`](../interfaces/PatchHostIn.md) | A group of fields to be updated on the hosts | -| `branchId?` | `string` | Filter by branch_id | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Update hosts - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5928](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5928) - -___ - -### apiHostReplaceFacts - -▸ **apiHostReplaceFacts**(`hostIdList`, `namespace`, `body`, `branchId?`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -Replace facts under a namespace

Required permissions: inventory:hosts:write - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `hostIdList` | `string`[] | A comma-separated list of host IDs. | -| `namespace` | `string` | A namespace of the merged facts. | -| `body` | `object` | A dictionary with the new facts to replace the original ones. | -| `branchId?` | `string` | Filter by branch_id | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -Replace facts under a namespace - -**`Throws`** - -**`Memberof`** - -HostsApi - -#### Defined in - -[api.ts:5943](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5943) diff --git a/packages/host-inventory/doc/classes/ResourceTypesApi.md b/packages/host-inventory/doc/classes/ResourceTypesApi.md deleted file mode 100644 index 250e8edd3..000000000 --- a/packages/host-inventory/doc/classes/ResourceTypesApi.md +++ /dev/null @@ -1,169 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ResourceTypesApi - -# Class: ResourceTypesApi - -ResourceTypesApi - object-oriented interface - -**`Export`** - -ResourceTypesApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`ResourceTypesApi`** - -## Table of contents - -### Constructors - -- [constructor](ResourceTypesApi.md#constructor) - -### Properties - -- [axios](ResourceTypesApi.md#axios) -- [basePath](ResourceTypesApi.md#basepath) -- [configuration](ResourceTypesApi.md#configuration) - -### Methods - -- [apiResourceTypeGetResourceTypeGroupsList](ResourceTypesApi.md#apiresourcetypegetresourcetypegroupslist) -- [apiResourceTypeGetResourceTypeList](ResourceTypesApi.md#apiresourcetypegetresourcetypelist) - -## Constructors - -### constructor - -• **new ResourceTypesApi**(`configuration?`, `basePath?`, `axios?`): [`ResourceTypesApi`](ResourceTypesApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`ResourceTypesApi`](ResourceTypesApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L49) - -## Methods - -### apiResourceTypeGetResourceTypeGroupsList - -▸ **apiResourceTypeGetResourceTypeGroupsList**(`name?`, `perPage?`, `page?`, `options?`): `Promise`\<`AxiosResponse`\<[`ResourceTypesGroupsQueryOutput`](../interfaces/ResourceTypesGroupsQueryOutput.md), `any`\>\> - -Returns the list of groups in the current account.

Required permissions: rbac:*:* - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`ResourceTypesGroupsQueryOutput`](../interfaces/ResourceTypesGroupsQueryOutput.md), `any`\>\> - -**`Summary`** - -Get the list of inventory groups in resource-types format - -**`Throws`** - -**`Memberof`** - -ResourceTypesApi - -#### Defined in - -[api.ts:6149](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6149) - -___ - -### apiResourceTypeGetResourceTypeList - -▸ **apiResourceTypeGetResourceTypeList**(`perPage?`, `page?`, `options?`): `Promise`\<`AxiosResponse`\<[`ResourceTypesQueryOutput`](../interfaces/ResourceTypesQueryOutput.md), `any`\>\> - -Returns the list of available RBAC resource types.

Required permissions: rbac:*:* - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `perPage?` | `number` | A number of items to return per page. | -| `page?` | `number` | A page number of the items to return. | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`ResourceTypesQueryOutput`](../interfaces/ResourceTypesQueryOutput.md), `any`\>\> - -**`Summary`** - -Get the list of resource types - -**`Throws`** - -**`Memberof`** - -ResourceTypesApi - -#### Defined in - -[api.ts:6162](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6162) diff --git a/packages/host-inventory/doc/classes/SystemProfileApi.md b/packages/host-inventory/doc/classes/SystemProfileApi.md deleted file mode 100644 index 28c52b9bb..000000000 --- a/packages/host-inventory/doc/classes/SystemProfileApi.md +++ /dev/null @@ -1,253 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileApi - -# Class: SystemProfileApi - -SystemProfileApi - object-oriented interface - -**`Export`** - -SystemProfileApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`SystemProfileApi`** - -## Table of contents - -### Constructors - -- [constructor](SystemProfileApi.md#constructor) - -### Properties - -- [axios](SystemProfileApi.md#axios) -- [basePath](SystemProfileApi.md#basepath) -- [configuration](SystemProfileApi.md#configuration) - -### Methods - -- [apiSystemProfileGetOperatingSystem](SystemProfileApi.md#apisystemprofilegetoperatingsystem) -- [apiSystemProfileGetSapSids](SystemProfileApi.md#apisystemprofilegetsapsids) -- [apiSystemProfileGetSapSystem](SystemProfileApi.md#apisystemprofilegetsapsystem) -- [apiSystemProfileValidateSchema](SystemProfileApi.md#apisystemprofilevalidateschema) - -## Constructors - -### constructor - -• **new SystemProfileApi**(`configuration?`, `basePath?`, `axios?`): [`SystemProfileApi`](SystemProfileApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`SystemProfileApi`](SystemProfileApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L49) - -## Methods - -### apiSystemProfileGetOperatingSystem - -▸ **apiSystemProfileGetOperatingSystem**(`tags?`, `perPage?`, `page?`, `staleness?`, `registeredWith?`, `filter?`, `options?`): `Promise`\<`AxiosResponse`\<[`SystemProfileOperatingSystemOut`](../interfaces/SystemProfileOperatingSystemOut.md), `any`\>\> - -Required permissions: inventory:hosts:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tags?` | `string`[] | filters out hosts not tagged by the given tags | -| `perPage?` | `number` | A number of items to return per page. | -| `page?` | `number` | A page number of the items to return. | -| `staleness?` | (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[] | Culling states of the hosts. Default: fresh, stale and stale_warning | -| `registeredWith?` | (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[] | Filters out any host not registered by the specified reporters | -| `filter?` | `Object` | Filters hosts based on system_profile fields. For example: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"sap_system\": {\"eq\": \"true\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][sap_system][eq]=true\" <br /><br /> Hosts with host_type \"edge\" are filtered out by default. <br /><br /> To get \"edge\" hosts, use this explicit filter: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"host_type\": {\"eq\": \"edge\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][host_type][eq]=edge\" | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SystemProfileOperatingSystemOut`](../interfaces/SystemProfileOperatingSystemOut.md), `any`\>\> - -**`Summary`** - -get all operating system versions and counts on the account - -**`Throws`** - -**`Memberof`** - -SystemProfileApi - -#### Defined in - -[api.ts:6621](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6621) - -___ - -### apiSystemProfileGetSapSids - -▸ **apiSystemProfileGetSapSids**(`search?`, `tags?`, `perPage?`, `page?`, `staleness?`, `registeredWith?`, `filter?`, `options?`): `Promise`\<`AxiosResponse`\<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md), `any`\>\> - -Required permissions: inventory:hosts:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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. | -| `tags?` | `string`[] | filters out hosts not tagged by the given tags | -| `perPage?` | `number` | A number of items to return per page. | -| `page?` | `number` | A page number of the items to return. | -| `staleness?` | (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[] | Culling states of the hosts. Default: fresh, stale and stale_warning | -| `registeredWith?` | (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[] | Filters out any host not registered by the specified reporters | -| `filter?` | `Object` | Filters hosts based on system_profile fields. For example: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"sap_system\": {\"eq\": \"true\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][sap_system][eq]=true\" <br /><br /> Hosts with host_type \"edge\" are filtered out by default. <br /><br /> To get \"edge\" hosts, use this explicit filter: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"host_type\": {\"eq\": \"edge\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][host_type][eq]=edge\" | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md), `any`\>\> - -**`Summary`** - -get all sap sids values and counts on the account - -**`Throws`** - -**`Memberof`** - -SystemProfileApi - -#### Defined in - -[api.ts:6639](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6639) - -___ - -### apiSystemProfileGetSapSystem - -▸ **apiSystemProfileGetSapSystem**(`tags?`, `perPage?`, `page?`, `staleness?`, `registeredWith?`, `filter?`, `options?`): `Promise`\<`AxiosResponse`\<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md), `any`\>\> - -Required permissions: inventory:hosts:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tags?` | `string`[] | filters out hosts not tagged by the given tags | -| `perPage?` | `number` | A number of items to return per page. | -| `page?` | `number` | A page number of the items to return. | -| `staleness?` | (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[] | Culling states of the hosts. Default: fresh, stale and stale_warning | -| `registeredWith?` | (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[] | Filters out any host not registered by the specified reporters | -| `filter?` | `Object` | Filters hosts based on system_profile fields. For example: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"sap_system\": {\"eq\": \"true\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][sap_system][eq]=true\" <br /><br /> Hosts with host_type \"edge\" are filtered out by default. <br /><br /> To get \"edge\" hosts, use this explicit filter: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"host_type\": {\"eq\": \"edge\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][host_type][eq]=edge\" | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`SystemProfileSapSystemOut`](../interfaces/SystemProfileSapSystemOut.md), `any`\>\> - -**`Summary`** - -get all sap system values and counts on the account - -**`Throws`** - -**`Memberof`** - -SystemProfileApi - -#### Defined in - -[api.ts:6656](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6656) - -___ - -### apiSystemProfileValidateSchema - -▸ **apiSystemProfileValidateSchema**(`repoBranch`, `repoFork?`, `days?`, `maxMessages?`, `options?`): `Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -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. - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `repoBranch` | `string` | The branch of the inventory-schemas repo to use | -| `repoFork?` | `string` | The fork of the inventory-schemas repo to use | -| `days?` | `number` | How many days worth of data to validate | -| `maxMessages?` | `number` | Stops polling when this number of messages has been collected | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<`void`, `any`\>\> - -**`Summary`** - -validate system profile schema - -**`Throws`** - -**`Memberof`** - -SystemProfileApi - -#### Defined in - -[api.ts:6671](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6671) diff --git a/packages/host-inventory/doc/classes/TagsApi.md b/packages/host-inventory/doc/classes/TagsApi.md deleted file mode 100644 index 7dd408ab0..000000000 --- a/packages/host-inventory/doc/classes/TagsApi.md +++ /dev/null @@ -1,149 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / TagsApi - -# Class: TagsApi - -TagsApi - object-oriented interface - -**`Export`** - -TagsApi - -## Hierarchy - -- `BaseAPI` - - ↳ **`TagsApi`** - -## Table of contents - -### Constructors - -- [constructor](TagsApi.md#constructor) - -### Properties - -- [axios](TagsApi.md#axios) -- [basePath](TagsApi.md#basepath) -- [configuration](TagsApi.md#configuration) - -### Methods - -- [apiTagGetTags](TagsApi.md#apitaggettags) - -## Constructors - -### constructor - -• **new TagsApi**(`configuration?`, `basePath?`, `axios?`): [`TagsApi`](TagsApi.md) - -#### Parameters - -| Name | Type | Default value | -| :------ | :------ | :------ | -| `configuration?` | [`Configuration`](Configuration.md) | `undefined` | -| `basePath` | `string` | `BASE_PATH` | -| `axios` | `AxiosInstance` | `globalAxios` | - -#### Returns - -[`TagsApi`](TagsApi.md) - -#### Inherited from - -BaseAPI.constructor - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -## Properties - -### axios - -• `Protected` **axios**: `AxiosInstance` = `globalAxios` - -#### Inherited from - -BaseAPI.axios - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### basePath - -• `Protected` **basePath**: `string` = `BASE_PATH` - -#### Inherited from - -BaseAPI.basePath - -#### Defined in - -[base.ts:51](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L51) - -___ - -### configuration - -• `Protected` **configuration**: `undefined` \| [`Configuration`](Configuration.md) - -#### Inherited from - -BaseAPI.configuration - -#### Defined in - -[base.ts:49](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/base.ts#L49) - -## Methods - -### 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`\>\> - -Required permissions: inventory:hosts:read - -#### Parameters - -| Name | Type | Description | -| :------ | :------ | :------ | -| `tags?` | `string`[] | filters out hosts not tagged by the given tags | -| `orderBy?` | ``"tag"`` \| ``"count"`` | Ordering field name | -| `orderHow?` | ``"ASC"`` \| ``"DESC"`` | Direction of the ordering. Default to ASC | -| `perPage?` | `number` | A number of items to return per page. | -| `page?` | `number` | A page number of the items to return. | -| `staleness?` | (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[] | Culling states of the hosts. Default: fresh, stale and stale_warning | -| `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. | -| `displayName?` | `string` | Filter by display_name (case-insensitive) | -| `fqdn?` | `string` | Filter by FQDN (case-insensitive) | -| `hostnameOrId?` | `string` | Filter by display_name, fqdn, id (case-insensitive) | -| `insightsId?` | `string` | Filter by insights_id | -| `providerId?` | `string` | Filter by provider_id | -| `providerType?` | ``"alibaba"`` \| ``"aws"`` \| ``"azure"`` \| ``"gcp"`` \| ``"ibm"`` | Filter by provider_type | -| `updatedStart?` | `string` | Only show hosts last modified after the given date | -| `updatedEnd?` | `string` | Only show hosts last modified before the given date | -| `groupName?` | `string`[] | Filter by group name | -| `registeredWith?` | (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[] | Filters out any host not registered by the specified reporters | -| `filter?` | `Object` | Filters hosts based on system_profile fields. For example: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"sap_system\": {\"eq\": \"true\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][sap_system][eq]=true\" <br /><br /> Hosts with host_type \"edge\" are filtered out by default. <br /><br /> To get \"edge\" hosts, use this explicit filter: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;{\"system_profile\": {\"host_type\": {\"eq\": \"edge\"}}} <br /><br /> which equates to the URL param: <br /><br /> &nbsp;&nbsp;&nbsp;&nbsp;\"?filter[system_profile][host_type][eq]=edge\" | -| `options?` | `any` | Override http request option. | - -#### Returns - -`Promise`\<`AxiosResponse`\<[`ActiveTags`](../interfaces/ActiveTags.md), `any`\>\> - -**`Summary`** - -Get the active host tags for a given account - -**`Throws`** - -**`Memberof`** - -TagsApi - -#### Defined in - -[api.ts:6927](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6927) diff --git a/packages/host-inventory/doc/enums/SystemDefaultId.md b/packages/host-inventory/doc/enums/SystemDefaultId.md deleted file mode 100644 index 64f970788..000000000 --- a/packages/host-inventory/doc/enums/SystemDefaultId.md +++ /dev/null @@ -1,21 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemDefaultId - -# Enumeration: SystemDefaultId - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [SystemDefault](SystemDefaultId.md#systemdefault) - -## Enumeration Members - -### SystemDefault - -• **SystemDefault** = ``"system_default"`` - -#### Defined in - -[api.ts:1586](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1586) diff --git a/packages/host-inventory/doc/enums/SystemProfileGreenbootStatusEnum.md b/packages/host-inventory/doc/enums/SystemProfileGreenbootStatusEnum.md deleted file mode 100644 index 837fd3543..000000000 --- a/packages/host-inventory/doc/enums/SystemProfileGreenbootStatusEnum.md +++ /dev/null @@ -1,32 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileGreenbootStatusEnum - -# Enumeration: SystemProfileGreenbootStatusEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Green](SystemProfileGreenbootStatusEnum.md#green) -- [Red](SystemProfileGreenbootStatusEnum.md#red) - -## Enumeration Members - -### Green - -• **Green** = ``"green"`` - -#### Defined in - -[api.ts:2027](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2027) - -___ - -### Red - -• **Red** = ``"red"`` - -#### Defined in - -[api.ts:2026](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2026) diff --git a/packages/host-inventory/doc/enums/SystemProfileHostTypeEnum.md b/packages/host-inventory/doc/enums/SystemProfileHostTypeEnum.md deleted file mode 100644 index a54703350..000000000 --- a/packages/host-inventory/doc/enums/SystemProfileHostTypeEnum.md +++ /dev/null @@ -1,21 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileHostTypeEnum - -# Enumeration: SystemProfileHostTypeEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Edge](SystemProfileHostTypeEnum.md#edge) - -## Enumeration Members - -### Edge - -• **Edge** = ``"edge"`` - -#### Defined in - -[api.ts:2019](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2019) diff --git a/packages/host-inventory/doc/enums/SystemProfileOperatingSystemNameEnum.md b/packages/host-inventory/doc/enums/SystemProfileOperatingSystemNameEnum.md deleted file mode 100644 index bb71c92dd..000000000 --- a/packages/host-inventory/doc/enums/SystemProfileOperatingSystemNameEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileOperatingSystemNameEnum - -# Enumeration: SystemProfileOperatingSystemNameEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [CentOS](SystemProfileOperatingSystemNameEnum.md#centos) -- [CentOSLinux](SystemProfileOperatingSystemNameEnum.md#centoslinux) -- [RHEL](SystemProfileOperatingSystemNameEnum.md#rhel) - -## Enumeration Members - -### CentOS - -• **CentOS** = ``"CentOS"`` - -#### Defined in - -[api.ts:2383](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2383) - -___ - -### CentOSLinux - -• **CentOSLinux** = ``"CentOS Linux"`` - -#### Defined in - -[api.ts:2384](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2384) - -___ - -### RHEL - -• **RHEL** = ``"RHEL"`` - -#### Defined in - -[api.ts:2382](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2382) diff --git a/packages/host-inventory/doc/enums/SystemProfileSelinuxCurrentModeEnum.md b/packages/host-inventory/doc/enums/SystemProfileSelinuxCurrentModeEnum.md deleted file mode 100644 index 2ebb5bcc7..000000000 --- a/packages/host-inventory/doc/enums/SystemProfileSelinuxCurrentModeEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSelinuxCurrentModeEnum - -# Enumeration: SystemProfileSelinuxCurrentModeEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Disabled](SystemProfileSelinuxCurrentModeEnum.md#disabled) -- [Enforcing](SystemProfileSelinuxCurrentModeEnum.md#enforcing) -- [Permissive](SystemProfileSelinuxCurrentModeEnum.md#permissive) - -## Enumeration Members - -### Disabled - -• **Disabled** = ``"disabled"`` - -#### Defined in - -[api.ts:2012](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2012) - -___ - -### Enforcing - -• **Enforcing** = ``"enforcing"`` - -#### Defined in - -[api.ts:2010](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2010) - -___ - -### Permissive - -• **Permissive** = ``"permissive"`` - -#### Defined in - -[api.ts:2011](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2011) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeRoleEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemPurposeRoleEnum.md deleted file mode 100644 index 32870c41e..000000000 --- a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeRoleEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSystemPurposeRoleEnum - -# Enumeration: SystemProfileSystemPurposeRoleEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [ComputeNode](SystemProfileSystemPurposeRoleEnum.md#computenode) -- [Server](SystemProfileSystemPurposeRoleEnum.md#server) -- [Workstation](SystemProfileSystemPurposeRoleEnum.md#workstation) - -## Enumeration Members - -### ComputeNode - -• **ComputeNode** = ``"Red Hat Enterprise Linux Compute Node"`` - -#### Defined in - -[api.ts:2586](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2586) - -___ - -### Server - -• **Server** = ``"Red Hat Enterprise Linux Server"`` - -#### Defined in - -[api.ts:2584](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2584) - -___ - -### Workstation - -• **Workstation** = ``"Red Hat Enterprise Linux Workstation"`` - -#### Defined in - -[api.ts:2585](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2585) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeSlaEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemPurposeSlaEnum.md deleted file mode 100644 index 36ec7d150..000000000 --- a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeSlaEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSystemPurposeSlaEnum - -# Enumeration: SystemProfileSystemPurposeSlaEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Premium](SystemProfileSystemPurposeSlaEnum.md#premium) -- [SelfSupport](SystemProfileSystemPurposeSlaEnum.md#selfsupport) -- [Standard](SystemProfileSystemPurposeSlaEnum.md#standard) - -## Enumeration Members - -### Premium - -• **Premium** = ``"Premium"`` - -#### Defined in - -[api.ts:2593](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2593) - -___ - -### SelfSupport - -• **SelfSupport** = ``"Self-Support"`` - -#### Defined in - -[api.ts:2595](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2595) - -___ - -### Standard - -• **Standard** = ``"Standard"`` - -#### Defined in - -[api.ts:2594](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2594) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeUsageEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemPurposeUsageEnum.md deleted file mode 100644 index 22fd3e78d..000000000 --- a/packages/host-inventory/doc/enums/SystemProfileSystemPurposeUsageEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSystemPurposeUsageEnum - -# Enumeration: SystemProfileSystemPurposeUsageEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [DevelopmentTest](SystemProfileSystemPurposeUsageEnum.md#developmenttest) -- [DisasterRecovery](SystemProfileSystemPurposeUsageEnum.md#disasterrecovery) -- [Production](SystemProfileSystemPurposeUsageEnum.md#production) - -## Enumeration Members - -### DevelopmentTest - -• **DevelopmentTest** = ``"Development/Test"`` - -#### Defined in - -[api.ts:2576](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2576) - -___ - -### DisasterRecovery - -• **DisasterRecovery** = ``"Disaster Recovery"`` - -#### Defined in - -[api.ts:2577](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2577) - -___ - -### Production - -• **Production** = ``"Production"`` - -#### Defined in - -[api.ts:2575](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2575) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemUpdateMethodEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemUpdateMethodEnum.md deleted file mode 100644 index 86ea75005..000000000 --- a/packages/host-inventory/doc/enums/SystemProfileSystemUpdateMethodEnum.md +++ /dev/null @@ -1,43 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSystemUpdateMethodEnum - -# Enumeration: SystemProfileSystemUpdateMethodEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Dnf](SystemProfileSystemUpdateMethodEnum.md#dnf) -- [RpmOstree](SystemProfileSystemUpdateMethodEnum.md#rpmostree) -- [Yum](SystemProfileSystemUpdateMethodEnum.md#yum) - -## Enumeration Members - -### Dnf - -• **Dnf** = ``"dnf"`` - -#### Defined in - -[api.ts:2034](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2034) - -___ - -### RpmOstree - -• **RpmOstree** = ``"rpm-ostree"`` - -#### Defined in - -[api.ts:2035](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2035) - -___ - -### Yum - -• **Yum** = ``"yum"`` - -#### Defined in - -[api.ts:2036](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2036) diff --git a/packages/host-inventory/doc/enums/SystemProfileSystemdStateEnum.md b/packages/host-inventory/doc/enums/SystemProfileSystemdStateEnum.md deleted file mode 100644 index cbc4aad79..000000000 --- a/packages/host-inventory/doc/enums/SystemProfileSystemdStateEnum.md +++ /dev/null @@ -1,76 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSystemdStateEnum - -# Enumeration: SystemProfileSystemdStateEnum - -**`Export`** - -## Table of contents - -### Enumeration Members - -- [Degraded](SystemProfileSystemdStateEnum.md#degraded) -- [Initializing](SystemProfileSystemdStateEnum.md#initializing) -- [Maintenance](SystemProfileSystemdStateEnum.md#maintenance) -- [Running](SystemProfileSystemdStateEnum.md#running) -- [Starting](SystemProfileSystemdStateEnum.md#starting) -- [Stopping](SystemProfileSystemdStateEnum.md#stopping) - -## Enumeration Members - -### Degraded - -• **Degraded** = ``"degraded"`` - -#### Defined in - -[api.ts:2638](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2638) - -___ - -### Initializing - -• **Initializing** = ``"initializing"`` - -#### Defined in - -[api.ts:2635](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2635) - -___ - -### Maintenance - -• **Maintenance** = ``"maintenance"`` - -#### Defined in - -[api.ts:2639](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2639) - -___ - -### Running - -• **Running** = ``"running"`` - -#### Defined in - -[api.ts:2637](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2637) - -___ - -### Starting - -• **Starting** = ``"starting"`` - -#### Defined in - -[api.ts:2636](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2636) - -___ - -### Stopping - -• **Stopping** = ``"stopping"`` - -#### Defined in - -[api.ts:2640](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2640) diff --git a/packages/host-inventory/doc/interfaces/ActiveTag.md b/packages/host-inventory/doc/interfaces/ActiveTag.md deleted file mode 100644 index f66361a68..000000000 --- a/packages/host-inventory/doc/interfaces/ActiveTag.md +++ /dev/null @@ -1,46 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ActiveTag - -# Interface: ActiveTag - -Information about a host tag - -**`Export`** - -ActiveTag - -## Table of contents - -### Properties - -- [count](ActiveTag.md#count) -- [tag](ActiveTag.md#tag) - -## Properties - -### count - -• **count**: ``null`` \| `number` - -The number of hosts with the given tag. If the value is null this indicates that the count is unknown. - -**`Memberof`** - -ActiveTag - -#### Defined in - -[api.ts:39](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L39) - -___ - -### tag - -• **tag**: [`StructuredTag`](StructuredTag.md) - -**`Memberof`** - -ActiveTag - -#### Defined in - -[api.ts:33](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L33) diff --git a/packages/host-inventory/doc/interfaces/ActiveTags.md b/packages/host-inventory/doc/interfaces/ActiveTags.md deleted file mode 100644 index fddb5be2b..000000000 --- a/packages/host-inventory/doc/interfaces/ActiveTags.md +++ /dev/null @@ -1,95 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ActiveTags - -# Interface: ActiveTags - -**`Export`** - -ActiveTags - -## Table of contents - -### Properties - -- [count](ActiveTags.md#count) -- [page](ActiveTags.md#page) -- [per\_page](ActiveTags.md#per_page) -- [results](ActiveTags.md#results) -- [total](ActiveTags.md#total) - -## Properties - -### count - -• **count**: `number` - -The number of items on the current page - -**`Memberof`** - -ActiveTags - -#### Defined in - -[api.ts:52](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L52) - -___ - -### page - -• **page**: `number` - -The page number - -**`Memberof`** - -ActiveTags - -#### Defined in - -[api.ts:58](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L58) - -___ - -### per\_page - -• **per\_page**: `number` - -The number of items to return per page - -**`Memberof`** - -ActiveTags - -#### Defined in - -[api.ts:64](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L64) - -___ - -### results - -• **results**: [`ActiveTag`](ActiveTag.md)[] - -**`Memberof`** - -ActiveTags - -#### Defined in - -[api.ts:76](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L76) - -___ - -### total - -• **total**: `number` - -Total number of items - -**`Memberof`** - -ActiveTags - -#### Defined in - -[api.ts:70](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L70) diff --git a/packages/host-inventory/doc/interfaces/ActiveTagsAllOf.md b/packages/host-inventory/doc/interfaces/ActiveTagsAllOf.md deleted file mode 100644 index f299c3128..000000000 --- a/packages/host-inventory/doc/interfaces/ActiveTagsAllOf.md +++ /dev/null @@ -1,27 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ActiveTagsAllOf - -# Interface: ActiveTagsAllOf - -**`Export`** - -ActiveTagsAllOf - -## Table of contents - -### Properties - -- [results](ActiveTagsAllOf.md#results) - -## Properties - -### results - -• **results**: [`ActiveTag`](ActiveTag.md)[] - -**`Memberof`** - -ActiveTagsAllOf - -#### Defined in - -[api.ts:89](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L89) diff --git a/packages/host-inventory/doc/interfaces/AssignmentRuleIn.md b/packages/host-inventory/doc/interfaces/AssignmentRuleIn.md deleted file mode 100644 index 995322925..000000000 --- a/packages/host-inventory/doc/interfaces/AssignmentRuleIn.md +++ /dev/null @@ -1,89 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / AssignmentRuleIn - -# Interface: AssignmentRuleIn - -Data for a single Assignment Rule - -**`Export`** - -AssignmentRuleIn - -## Table of contents - -### Properties - -- [description](AssignmentRuleIn.md#description) -- [enabled](AssignmentRuleIn.md#enabled) -- [filter](AssignmentRuleIn.md#filter) -- [group\_id](AssignmentRuleIn.md#group_id) -- [name](AssignmentRuleIn.md#name) - -## Properties - -### description - -• `Optional` **description**: ``null`` \| `string` - -**`Memberof`** - -AssignmentRuleIn - -#### Defined in - -[api.ts:108](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L108) - -___ - -### enabled - -• **enabled**: `boolean` - -**`Memberof`** - -AssignmentRuleIn - -#### Defined in - -[api.ts:126](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L126) - -___ - -### filter - -• **filter**: `object` - -**`Memberof`** - -AssignmentRuleIn - -#### Defined in - -[api.ts:120](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L120) - -___ - -### group\_id - -• **group\_id**: `string` - -**`Memberof`** - -AssignmentRuleIn - -#### Defined in - -[api.ts:114](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L114) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -AssignmentRuleIn - -#### Defined in - -[api.ts:102](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L102) diff --git a/packages/host-inventory/doc/interfaces/AssignmentRuleOut.md b/packages/host-inventory/doc/interfaces/AssignmentRuleOut.md deleted file mode 100644 index 52712c331..000000000 --- a/packages/host-inventory/doc/interfaces/AssignmentRuleOut.md +++ /dev/null @@ -1,168 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / AssignmentRuleOut - -# Interface: AssignmentRuleOut - -Data for a single Assignment Rule response - -**`Export`** - -AssignmentRuleOut - -## Table of contents - -### Properties - -- [account](AssignmentRuleOut.md#account) -- [created](AssignmentRuleOut.md#created) -- [description](AssignmentRuleOut.md#description) -- [enabled](AssignmentRuleOut.md#enabled) -- [filter](AssignmentRuleOut.md#filter) -- [group\_id](AssignmentRuleOut.md#group_id) -- [id](AssignmentRuleOut.md#id) -- [modified](AssignmentRuleOut.md#modified) -- [name](AssignmentRuleOut.md#name) -- [org\_id](AssignmentRuleOut.md#org_id) - -## Properties - -### account - -• `Optional` **account**: ``null`` \| `string` - -A Red Hat Account number that owns the host. - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:151](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L151) - -___ - -### created - -• **created**: `string` - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:187](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L187) - -___ - -### description - -• `Optional` **description**: ``null`` \| `string` - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:163](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L163) - -___ - -### enabled - -• **enabled**: `boolean` - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:181](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L181) - -___ - -### filter - -• **filter**: `object` - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:175](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L175) - -___ - -### group\_id - -• **group\_id**: `string` - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:169](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L169) - -___ - -### id - -• `Optional` **id**: `string` - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:139](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L139) - -___ - -### modified - -• **modified**: `string` - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:193](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L193) - -___ - -### name - -• **name**: `string` - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:157](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L157) - -___ - -### org\_id - -• `Optional` **org\_id**: `string` - -The Org ID of the tenant that owns the host. - -**`Memberof`** - -AssignmentRuleOut - -#### Defined in - -[api.ts:145](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L145) diff --git a/packages/host-inventory/doc/interfaces/AssignmentRuleQueryOutput.md b/packages/host-inventory/doc/interfaces/AssignmentRuleQueryOutput.md deleted file mode 100644 index f498f686a..000000000 --- a/packages/host-inventory/doc/interfaces/AssignmentRuleQueryOutput.md +++ /dev/null @@ -1,99 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / AssignmentRuleQueryOutput - -# Interface: AssignmentRuleQueryOutput - -A paginated assignment-rule search query result with assignment-rule entries and their Inventory metadata. - -**`Export`** - -AssignmentRuleQueryOutput - -## Table of contents - -### Properties - -- [count](AssignmentRuleQueryOutput.md#count) -- [page](AssignmentRuleQueryOutput.md#page) -- [per\_page](AssignmentRuleQueryOutput.md#per_page) -- [results](AssignmentRuleQueryOutput.md#results) -- [total](AssignmentRuleQueryOutput.md#total) - -## Properties - -### count - -• **count**: `number` - -The number of items on the current page - -**`Memberof`** - -AssignmentRuleQueryOutput - -#### Defined in - -[api.ts:206](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L206) - -___ - -### page - -• **page**: `number` - -The page number - -**`Memberof`** - -AssignmentRuleQueryOutput - -#### Defined in - -[api.ts:212](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L212) - -___ - -### per\_page - -• **per\_page**: `number` - -The number of items to return per page - -**`Memberof`** - -AssignmentRuleQueryOutput - -#### Defined in - -[api.ts:218](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L218) - -___ - -### results - -• **results**: [`AssignmentRuleOut`](AssignmentRuleOut.md)[] - -Actual assignment-rule search query result entries. - -**`Memberof`** - -AssignmentRuleQueryOutput - -#### Defined in - -[api.ts:230](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L230) - -___ - -### total - -• **total**: `number` - -Total number of items - -**`Memberof`** - -AssignmentRuleQueryOutput - -#### Defined in - -[api.ts:224](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L224) diff --git a/packages/host-inventory/doc/interfaces/AssignmentRuleQueryOutputAllOf.md b/packages/host-inventory/doc/interfaces/AssignmentRuleQueryOutputAllOf.md deleted file mode 100644 index c7e30999a..000000000 --- a/packages/host-inventory/doc/interfaces/AssignmentRuleQueryOutputAllOf.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / AssignmentRuleQueryOutputAllOf - -# Interface: AssignmentRuleQueryOutputAllOf - -**`Export`** - -AssignmentRuleQueryOutputAllOf - -## Table of contents - -### Properties - -- [results](AssignmentRuleQueryOutputAllOf.md#results) - -## Properties - -### results - -• **results**: [`AssignmentRuleOut`](AssignmentRuleOut.md)[] - -Actual assignment-rule search query result entries. - -**`Memberof`** - -AssignmentRuleQueryOutputAllOf - -#### Defined in - -[api.ts:243](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L243) diff --git a/packages/host-inventory/doc/interfaces/CanonicalFactsIn.md b/packages/host-inventory/doc/interfaces/CanonicalFactsIn.md deleted file mode 100644 index af5e028de..000000000 --- a/packages/host-inventory/doc/interfaces/CanonicalFactsIn.md +++ /dev/null @@ -1,189 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / CanonicalFactsIn - -# Interface: CanonicalFactsIn - -**`Export`** - -CanonicalFactsIn - -## Hierarchy - -- [`CanonicalFactsInAllOf`](CanonicalFactsInAllOf.md) - - ↳ **`CanonicalFactsIn`** - -## Table of contents - -### Properties - -- [bios\_uuid](CanonicalFactsIn.md#bios_uuid) -- [fqdn](CanonicalFactsIn.md#fqdn) -- [insights\_id](CanonicalFactsIn.md#insights_id) -- [ip\_addresses](CanonicalFactsIn.md#ip_addresses) -- [mac\_addresses](CanonicalFactsIn.md#mac_addresses) -- [provider\_id](CanonicalFactsIn.md#provider_id) -- [provider\_type](CanonicalFactsIn.md#provider_type) -- [satellite\_id](CanonicalFactsIn.md#satellite_id) -- [subscription\_manager\_id](CanonicalFactsIn.md#subscription_manager_id) - -## Properties - -### bios\_uuid - -• `Optional` **bios\_uuid**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Inherited from - -[CanonicalFactsInAllOf](CanonicalFactsInAllOf.md).[bios_uuid](CanonicalFactsInAllOf.md#bios_uuid) - -#### Defined in - -[api.ts:281](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L281) - -___ - -### fqdn - -• `Optional` **fqdn**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Inherited from - -[CanonicalFactsInAllOf](CanonicalFactsInAllOf.md).[fqdn](CanonicalFactsInAllOf.md#fqdn) - -#### Defined in - -[api.ts:293](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L293) - -___ - -### insights\_id - -• `Optional` **insights\_id**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Inherited from - -[CanonicalFactsInAllOf](CanonicalFactsInAllOf.md).[insights_id](CanonicalFactsInAllOf.md#insights_id) - -#### Defined in - -[api.ts:263](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L263) - -___ - -### ip\_addresses - -• `Optional` **ip\_addresses**: `string`[] - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Inherited from - -[CanonicalFactsInAllOf](CanonicalFactsInAllOf.md).[ip_addresses](CanonicalFactsInAllOf.md#ip_addresses) - -#### Defined in - -[api.ts:287](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L287) - -___ - -### mac\_addresses - -• `Optional` **mac\_addresses**: `string`[] - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Inherited from - -[CanonicalFactsInAllOf](CanonicalFactsInAllOf.md).[mac_addresses](CanonicalFactsInAllOf.md#mac_addresses) - -#### Defined in - -[api.ts:299](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L299) - -___ - -### provider\_id - -• `Optional` **provider\_id**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Inherited from - -[CanonicalFactsInAllOf](CanonicalFactsInAllOf.md).[provider_id](CanonicalFactsInAllOf.md#provider_id) - -#### Defined in - -[api.ts:305](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L305) - -___ - -### provider\_type - -• `Optional` **provider\_type**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Inherited from - -[CanonicalFactsInAllOf](CanonicalFactsInAllOf.md).[provider_type](CanonicalFactsInAllOf.md#provider_type) - -#### Defined in - -[api.ts:311](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L311) - -___ - -### satellite\_id - -• `Optional` **satellite\_id**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Inherited from - -[CanonicalFactsInAllOf](CanonicalFactsInAllOf.md).[satellite_id](CanonicalFactsInAllOf.md#satellite_id) - -#### Defined in - -[api.ts:275](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L275) - -___ - -### subscription\_manager\_id - -• `Optional` **subscription\_manager\_id**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Inherited from - -[CanonicalFactsInAllOf](CanonicalFactsInAllOf.md).[subscription_manager_id](CanonicalFactsInAllOf.md#subscription_manager_id) - -#### Defined in - -[api.ts:269](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L269) diff --git a/packages/host-inventory/doc/interfaces/CanonicalFactsInAllOf.md b/packages/host-inventory/doc/interfaces/CanonicalFactsInAllOf.md deleted file mode 100644 index ef879f01f..000000000 --- a/packages/host-inventory/doc/interfaces/CanonicalFactsInAllOf.md +++ /dev/null @@ -1,153 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / CanonicalFactsInAllOf - -# Interface: CanonicalFactsInAllOf - -**`Export`** - -CanonicalFactsInAllOf - -## Hierarchy - -- **`CanonicalFactsInAllOf`** - - ↳ [`CanonicalFactsIn`](CanonicalFactsIn.md) - -## Table of contents - -### Properties - -- [bios\_uuid](CanonicalFactsInAllOf.md#bios_uuid) -- [fqdn](CanonicalFactsInAllOf.md#fqdn) -- [insights\_id](CanonicalFactsInAllOf.md#insights_id) -- [ip\_addresses](CanonicalFactsInAllOf.md#ip_addresses) -- [mac\_addresses](CanonicalFactsInAllOf.md#mac_addresses) -- [provider\_id](CanonicalFactsInAllOf.md#provider_id) -- [provider\_type](CanonicalFactsInAllOf.md#provider_type) -- [satellite\_id](CanonicalFactsInAllOf.md#satellite_id) -- [subscription\_manager\_id](CanonicalFactsInAllOf.md#subscription_manager_id) - -## Properties - -### bios\_uuid - -• `Optional` **bios\_uuid**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Defined in - -[api.ts:281](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L281) - -___ - -### fqdn - -• `Optional` **fqdn**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Defined in - -[api.ts:293](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L293) - -___ - -### insights\_id - -• `Optional` **insights\_id**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Defined in - -[api.ts:263](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L263) - -___ - -### ip\_addresses - -• `Optional` **ip\_addresses**: `string`[] - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Defined in - -[api.ts:287](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L287) - -___ - -### mac\_addresses - -• `Optional` **mac\_addresses**: `string`[] - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Defined in - -[api.ts:299](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L299) - -___ - -### provider\_id - -• `Optional` **provider\_id**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Defined in - -[api.ts:305](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L305) - -___ - -### provider\_type - -• `Optional` **provider\_type**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Defined in - -[api.ts:311](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L311) - -___ - -### satellite\_id - -• `Optional` **satellite\_id**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Defined in - -[api.ts:275](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L275) - -___ - -### subscription\_manager\_id - -• `Optional` **subscription\_manager\_id**: `string` - -**`Memberof`** - -CanonicalFactsInAllOf - -#### Defined in - -[api.ts:269](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L269) diff --git a/packages/host-inventory/doc/interfaces/CanonicalFactsOut.md b/packages/host-inventory/doc/interfaces/CanonicalFactsOut.md deleted file mode 100644 index a63523626..000000000 --- a/packages/host-inventory/doc/interfaces/CanonicalFactsOut.md +++ /dev/null @@ -1,165 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / CanonicalFactsOut - -# Interface: CanonicalFactsOut - -**`Export`** - -CanonicalFactsOut - -## Table of contents - -### Properties - -- [bios\_uuid](CanonicalFactsOut.md#bios_uuid) -- [fqdn](CanonicalFactsOut.md#fqdn) -- [insights\_id](CanonicalFactsOut.md#insights_id) -- [ip\_addresses](CanonicalFactsOut.md#ip_addresses) -- [mac\_addresses](CanonicalFactsOut.md#mac_addresses) -- [provider\_id](CanonicalFactsOut.md#provider_id) -- [provider\_type](CanonicalFactsOut.md#provider_type) -- [satellite\_id](CanonicalFactsOut.md#satellite_id) -- [subscription\_manager\_id](CanonicalFactsOut.md#subscription_manager_id) - -## Properties - -### bios\_uuid - -• `Optional` **bios\_uuid**: ``null`` \| `string` - -A UUID of the host machine BIOS. This field is considered to be a canonical fact. - -**`Memberof`** - -CanonicalFactsOut - -#### Defined in - -[api.ts:342](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L342) - -___ - -### fqdn - -• `Optional` **fqdn**: ``null`` \| `string` - -A host’s Fully Qualified Domain Name. This field is considered to be a canonical fact. - -**`Memberof`** - -CanonicalFactsOut - -#### Defined in - -[api.ts:354](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L354) - -___ - -### insights\_id - -• `Optional` **insights\_id**: ``null`` \| `string` - -An ID defined in /etc/insights-client/machine-id. This field is considered a canonical fact. - -**`Memberof`** - -CanonicalFactsOut - -#### Defined in - -[api.ts:324](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L324) - -___ - -### ip\_addresses - -• `Optional` **ip\_addresses**: ``null`` \| `string`[] - -Host’s network IP addresses. This field is considered to be a canonical fact. - -**`Memberof`** - -CanonicalFactsOut - -#### Defined in - -[api.ts:348](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L348) - -___ - -### mac\_addresses - -• `Optional` **mac\_addresses**: ``null`` \| `string`[] - -Host’s network interfaces MAC addresses. This field is considered to be a canonical fact. - -**`Memberof`** - -CanonicalFactsOut - -#### Defined in - -[api.ts:360](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L360) - -___ - -### provider\_id - -• `Optional` **provider\_id**: ``null`` \| `string` - -Host’s reference in the external source e.g. Alibaba, AWS EC2, Azure, GCP, IBM etc. This field is one of the canonical facts and does not work without provider_type. - -**`Memberof`** - -CanonicalFactsOut - -#### Defined in - -[api.ts:366](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L366) - -___ - -### provider\_type - -• `Optional` **provider\_type**: ``null`` \| `string` - -Type of external source e.g. Alibaba, AWS EC2, Azure, GCP, IBM, etc. This field is one of the canonical facts and does not workout provider_id. - -**`Memberof`** - -CanonicalFactsOut - -#### Defined in - -[api.ts:372](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L372) - -___ - -### satellite\_id - -• `Optional` **satellite\_id**: ``null`` \| `string` - -A Red Hat Satellite ID of a RHEL host. This field is considered to be a canonical fact. - -**`Memberof`** - -CanonicalFactsOut - -#### Defined in - -[api.ts:336](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L336) - -___ - -### subscription\_manager\_id - -• `Optional` **subscription\_manager\_id**: ``null`` \| `string` - -A Red Hat Subcription Manager ID of a RHEL host. This field is considered to be a canonical fact. - -**`Memberof`** - -CanonicalFactsOut - -#### Defined in - -[api.ts:330](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L330) diff --git a/packages/host-inventory/doc/interfaces/ConfigurationParameters.md b/packages/host-inventory/doc/interfaces/ConfigurationParameters.md deleted file mode 100644 index f3f0cf5d3..000000000 --- a/packages/host-inventory/doc/interfaces/ConfigurationParameters.md +++ /dev/null @@ -1,83 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ConfigurationParameters - -# Interface: ConfigurationParameters - -Insights Host Inventory REST Interface -REST interface for the Insights Platform Host Inventory application. - -The version of the OpenAPI document: 1.0.0 - -NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). -https://openapi-generator.tech -Do not edit the class manually. - -## Table of contents - -### Properties - -- [accessToken](ConfigurationParameters.md#accesstoken) -- [apiKey](ConfigurationParameters.md#apikey) -- [baseOptions](ConfigurationParameters.md#baseoptions) -- [basePath](ConfigurationParameters.md#basepath) -- [password](ConfigurationParameters.md#password) -- [username](ConfigurationParameters.md#username) - -## Properties - -### accessToken - -• `Optional` **accessToken**: `string` \| (`name?`: `string`, `scopes?`: `string`[]) => `string` - -#### Defined in - -[configuration.ts:19](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L19) - -___ - -### apiKey - -• `Optional` **apiKey**: `string` \| `Promise`\<`string`\> \| (`name`: `string`) => `string` \| (`name`: `string`) => `Promise`\<`string`\> - -#### Defined in - -[configuration.ts:16](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L16) - -___ - -### baseOptions - -• `Optional` **baseOptions**: `any` - -#### Defined in - -[configuration.ts:21](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L21) - -___ - -### basePath - -• `Optional` **basePath**: `string` - -#### Defined in - -[configuration.ts:20](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L20) - -___ - -### password - -• `Optional` **password**: `string` - -#### Defined in - -[configuration.ts:18](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L18) - -___ - -### username - -• `Optional` **username**: `string` - -#### Defined in - -[configuration.ts:17](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/configuration.ts#L17) diff --git a/packages/host-inventory/doc/interfaces/CreateCheckIn.md b/packages/host-inventory/doc/interfaces/CreateCheckIn.md deleted file mode 100644 index 2532a8d7a..000000000 --- a/packages/host-inventory/doc/interfaces/CreateCheckIn.md +++ /dev/null @@ -1,166 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / CreateCheckIn - -# Interface: CreateCheckIn - -Data required to create a check-in record for a host. - -**`Export`** - -CreateCheckIn - -## Table of contents - -### Properties - -- [bios\_uuid](CreateCheckIn.md#bios_uuid) -- [checkin\_frequency](CreateCheckIn.md#checkin_frequency) -- [fqdn](CreateCheckIn.md#fqdn) -- [insights\_id](CreateCheckIn.md#insights_id) -- [ip\_addresses](CreateCheckIn.md#ip_addresses) -- [mac\_addresses](CreateCheckIn.md#mac_addresses) -- [provider\_id](CreateCheckIn.md#provider_id) -- [provider\_type](CreateCheckIn.md#provider_type) -- [satellite\_id](CreateCheckIn.md#satellite_id) -- [subscription\_manager\_id](CreateCheckIn.md#subscription_manager_id) - -## Properties - -### bios\_uuid - -• **bios\_uuid**: `string` - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:403](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L403) - -___ - -### checkin\_frequency - -• `Optional` **checkin\_frequency**: `number` - -How long from now to expect another check-in (in minutes). - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:439](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L439) - -___ - -### fqdn - -• **fqdn**: `string` - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:415](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L415) - -___ - -### insights\_id - -• **insights\_id**: `string` - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:385](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L385) - -___ - -### ip\_addresses - -• **ip\_addresses**: `string`[] - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:409](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L409) - -___ - -### mac\_addresses - -• **mac\_addresses**: `string`[] - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:421](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L421) - -___ - -### provider\_id - -• **provider\_id**: `string` - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:427](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L427) - -___ - -### provider\_type - -• **provider\_type**: `string` - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:433](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L433) - -___ - -### satellite\_id - -• **satellite\_id**: `string` - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:397](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L397) - -___ - -### subscription\_manager\_id - -• **subscription\_manager\_id**: `string` - -**`Memberof`** - -CreateCheckIn - -#### Defined in - -[api.ts:391](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L391) diff --git a/packages/host-inventory/doc/interfaces/CreateCheckInAllOf.md b/packages/host-inventory/doc/interfaces/CreateCheckInAllOf.md deleted file mode 100644 index 96320b9bc..000000000 --- a/packages/host-inventory/doc/interfaces/CreateCheckInAllOf.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / CreateCheckInAllOf - -# Interface: CreateCheckInAllOf - -**`Export`** - -CreateCheckInAllOf - -## Table of contents - -### Properties - -- [checkin\_frequency](CreateCheckInAllOf.md#checkin_frequency) - -## Properties - -### checkin\_frequency - -• `Optional` **checkin\_frequency**: `number` - -How long from now to expect another check-in (in minutes). - -**`Memberof`** - -CreateCheckInAllOf - -#### Defined in - -[api.ts:452](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L452) diff --git a/packages/host-inventory/doc/interfaces/DiskDevice.md b/packages/host-inventory/doc/interfaces/DiskDevice.md deleted file mode 100644 index b5e097741..000000000 --- a/packages/host-inventory/doc/interfaces/DiskDevice.md +++ /dev/null @@ -1,101 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / DiskDevice - -# Interface: DiskDevice - -Representation of one mounted device - -**`Export`** - -DiskDevice - -## Table of contents - -### Properties - -- [device](DiskDevice.md#device) -- [label](DiskDevice.md#label) -- [mount\_point](DiskDevice.md#mount_point) -- [options](DiskDevice.md#options) -- [type](DiskDevice.md#type) - -## Properties - -### device - -• `Optional` **device**: `string` - -**`Memberof`** - -DiskDevice - -#### Defined in - -[api.ts:465](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L465) - -___ - -### label - -• `Optional` **label**: `string` - -User-defined mount label - -**`Memberof`** - -DiskDevice - -#### Defined in - -[api.ts:471](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L471) - -___ - -### mount\_point - -• `Optional` **mount\_point**: `string` - -The mount point - -**`Memberof`** - -DiskDevice - -#### Defined in - -[api.ts:483](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L483) - -___ - -### options - -• `Optional` **options**: `Object` - -An arbitrary object that does not allow empty string keys. - -**`Memberof`** - -DiskDevice - -#### Index signature - -▪ [key: `string`]: `object` - -#### Defined in - -[api.ts:477](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L477) - -___ - -### type - -• `Optional` **type**: `string` - -The mount type - -**`Memberof`** - -DiskDevice - -#### Defined in - -[api.ts:489](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L489) diff --git a/packages/host-inventory/doc/interfaces/DnfModule.md b/packages/host-inventory/doc/interfaces/DnfModule.md deleted file mode 100644 index 866f8d0b4..000000000 --- a/packages/host-inventory/doc/interfaces/DnfModule.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / DnfModule - -# Interface: DnfModule - -Representation of one DNF module - -**`Export`** - -DnfModule - -## Table of contents - -### Properties - -- [name](DnfModule.md#name) -- [stream](DnfModule.md#stream) - -## Properties - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -DnfModule - -#### Defined in - -[api.ts:502](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L502) - -___ - -### stream - -• `Optional` **stream**: `string` - -**`Memberof`** - -DnfModule - -#### Defined in - -[api.ts:508](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L508) diff --git a/packages/host-inventory/doc/interfaces/FactSet.md b/packages/host-inventory/doc/interfaces/FactSet.md deleted file mode 100644 index 57820985c..000000000 --- a/packages/host-inventory/doc/interfaces/FactSet.md +++ /dev/null @@ -1,48 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / FactSet - -# Interface: FactSet - -A set of string facts belonging to a single namespace. - -**`Export`** - -FactSet - -## Table of contents - -### Properties - -- [facts](FactSet.md#facts) -- [namespace](FactSet.md#namespace) - -## Properties - -### facts - -• **facts**: `object` - -The facts themselves. - -**`Memberof`** - -FactSet - -#### Defined in - -[api.ts:527](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L527) - -___ - -### namespace - -• **namespace**: `string` - -A namespace the facts belong to. - -**`Memberof`** - -FactSet - -#### Defined in - -[api.ts:521](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L521) diff --git a/packages/host-inventory/doc/interfaces/GroupIn.md b/packages/host-inventory/doc/interfaces/GroupIn.md deleted file mode 100644 index 4d768f7cf..000000000 --- a/packages/host-inventory/doc/interfaces/GroupIn.md +++ /dev/null @@ -1,48 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / GroupIn - -# Interface: GroupIn - -Data of a single group belonging to an account. - -**`Export`** - -GroupIn - -## Table of contents - -### Properties - -- [host\_ids](GroupIn.md#host_ids) -- [name](GroupIn.md#name) - -## Properties - -### host\_ids - -• `Optional` **host\_ids**: ``null`` \| `string`[] - -A comma-separated list of host IDs that belong to the group. - -**`Memberof`** - -GroupIn - -#### Defined in - -[api.ts:546](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L546) - -___ - -### name - -• `Optional` **name**: `string` - -A group’s human-readable name. - -**`Memberof`** - -GroupIn - -#### Defined in - -[api.ts:540](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L540) diff --git a/packages/host-inventory/doc/interfaces/GroupOut.md b/packages/host-inventory/doc/interfaces/GroupOut.md deleted file mode 100644 index f342d687d..000000000 --- a/packages/host-inventory/doc/interfaces/GroupOut.md +++ /dev/null @@ -1,114 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / GroupOut - -# Interface: GroupOut - -Data of a single group belonging to an account. - -**`Export`** - -GroupOut - -## Table of contents - -### Properties - -- [account](GroupOut.md#account) -- [created](GroupOut.md#created) -- [id](GroupOut.md#id) -- [name](GroupOut.md#name) -- [org\_id](GroupOut.md#org_id) -- [updated](GroupOut.md#updated) - -## Properties - -### account - -• `Optional` **account**: ``null`` \| `string` - -A Red Hat Account number that owns the host. - -**`Memberof`** - -GroupOut - -#### Defined in - -[api.ts:571](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L571) - -___ - -### created - -• `Optional` **created**: `string` - -A timestamp when the entry was created. - -**`Memberof`** - -GroupOut - -#### Defined in - -[api.ts:583](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L583) - -___ - -### id - -• `Optional` **id**: `string` - -**`Memberof`** - -GroupOut - -#### Defined in - -[api.ts:559](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L559) - -___ - -### name - -• `Optional` **name**: `string` - -A group’s human-readable name. - -**`Memberof`** - -GroupOut - -#### Defined in - -[api.ts:565](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L565) - -___ - -### org\_id - -• `Optional` **org\_id**: `string` - -The Org ID of the tenant that owns the host. - -**`Memberof`** - -GroupOut - -#### Defined in - -[api.ts:577](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L577) - -___ - -### updated - -• `Optional` **updated**: `string` - -A timestamp when the entry was last updated. - -**`Memberof`** - -GroupOut - -#### Defined in - -[api.ts:589](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L589) diff --git a/packages/host-inventory/doc/interfaces/GroupOutWithHostCount.md b/packages/host-inventory/doc/interfaces/GroupOutWithHostCount.md deleted file mode 100644 index 202d25ca0..000000000 --- a/packages/host-inventory/doc/interfaces/GroupOutWithHostCount.md +++ /dev/null @@ -1,131 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / GroupOutWithHostCount - -# Interface: GroupOutWithHostCount - -Data of a single group belonging to an account. - -**`Export`** - -GroupOutWithHostCount - -## Table of contents - -### Properties - -- [account](GroupOutWithHostCount.md#account) -- [created](GroupOutWithHostCount.md#created) -- [host\_count](GroupOutWithHostCount.md#host_count) -- [id](GroupOutWithHostCount.md#id) -- [name](GroupOutWithHostCount.md#name) -- [org\_id](GroupOutWithHostCount.md#org_id) -- [updated](GroupOutWithHostCount.md#updated) - -## Properties - -### account - -• `Optional` **account**: ``null`` \| `string` - -A Red Hat Account number that owns the host. - -**`Memberof`** - -GroupOutWithHostCount - -#### Defined in - -[api.ts:614](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L614) - -___ - -### created - -• `Optional` **created**: `string` - -A timestamp when the entry was created. - -**`Memberof`** - -GroupOutWithHostCount - -#### Defined in - -[api.ts:626](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L626) - -___ - -### host\_count - -• `Optional` **host\_count**: `number` - -The number of hosts associated with the group. - -**`Memberof`** - -GroupOutWithHostCount - -#### Defined in - -[api.ts:638](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L638) - -___ - -### id - -• `Optional` **id**: `string` - -**`Memberof`** - -GroupOutWithHostCount - -#### Defined in - -[api.ts:602](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L602) - -___ - -### name - -• `Optional` **name**: `string` - -A group’s human-readable name. - -**`Memberof`** - -GroupOutWithHostCount - -#### Defined in - -[api.ts:608](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L608) - -___ - -### org\_id - -• `Optional` **org\_id**: `string` - -The Org ID of the tenant that owns the host. - -**`Memberof`** - -GroupOutWithHostCount - -#### Defined in - -[api.ts:620](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L620) - -___ - -### updated - -• `Optional` **updated**: `string` - -A timestamp when the entry was last updated. - -**`Memberof`** - -GroupOutWithHostCount - -#### Defined in - -[api.ts:632](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L632) diff --git a/packages/host-inventory/doc/interfaces/GroupOutWithHostCountAllOf.md b/packages/host-inventory/doc/interfaces/GroupOutWithHostCountAllOf.md deleted file mode 100644 index 9c6d37989..000000000 --- a/packages/host-inventory/doc/interfaces/GroupOutWithHostCountAllOf.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / GroupOutWithHostCountAllOf - -# Interface: GroupOutWithHostCountAllOf - -**`Export`** - -GroupOutWithHostCountAllOf - -## Table of contents - -### Properties - -- [host\_count](GroupOutWithHostCountAllOf.md#host_count) - -## Properties - -### host\_count - -• `Optional` **host\_count**: `number` - -The number of hosts associated with the group. - -**`Memberof`** - -GroupOutWithHostCountAllOf - -#### Defined in - -[api.ts:651](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L651) diff --git a/packages/host-inventory/doc/interfaces/GroupQueryOutput.md b/packages/host-inventory/doc/interfaces/GroupQueryOutput.md deleted file mode 100644 index 9d3cc1f6d..000000000 --- a/packages/host-inventory/doc/interfaces/GroupQueryOutput.md +++ /dev/null @@ -1,99 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / GroupQueryOutput - -# Interface: GroupQueryOutput - -A paginated group search query result with group entries and their Inventory metadata. - -**`Export`** - -GroupQueryOutput - -## Table of contents - -### Properties - -- [count](GroupQueryOutput.md#count) -- [page](GroupQueryOutput.md#page) -- [per\_page](GroupQueryOutput.md#per_page) -- [results](GroupQueryOutput.md#results) -- [total](GroupQueryOutput.md#total) - -## Properties - -### count - -• **count**: `number` - -The number of items on the current page - -**`Memberof`** - -GroupQueryOutput - -#### Defined in - -[api.ts:664](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L664) - -___ - -### page - -• **page**: `number` - -The page number - -**`Memberof`** - -GroupQueryOutput - -#### Defined in - -[api.ts:670](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L670) - -___ - -### per\_page - -• **per\_page**: `number` - -The number of items to return per page - -**`Memberof`** - -GroupQueryOutput - -#### Defined in - -[api.ts:676](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L676) - -___ - -### results - -• **results**: [`GroupOutWithHostCount`](GroupOutWithHostCount.md)[] - -Actual group search query result entries. - -**`Memberof`** - -GroupQueryOutput - -#### Defined in - -[api.ts:688](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L688) - -___ - -### total - -• **total**: `number` - -Total number of items - -**`Memberof`** - -GroupQueryOutput - -#### Defined in - -[api.ts:682](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L682) diff --git a/packages/host-inventory/doc/interfaces/GroupQueryOutputAllOf.md b/packages/host-inventory/doc/interfaces/GroupQueryOutputAllOf.md deleted file mode 100644 index c6ae83e19..000000000 --- a/packages/host-inventory/doc/interfaces/GroupQueryOutputAllOf.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / GroupQueryOutputAllOf - -# Interface: GroupQueryOutputAllOf - -**`Export`** - -GroupQueryOutputAllOf - -## Table of contents - -### Properties - -- [results](GroupQueryOutputAllOf.md#results) - -## Properties - -### results - -• **results**: [`GroupOutWithHostCount`](GroupOutWithHostCount.md)[] - -Actual group search query result entries. - -**`Memberof`** - -GroupQueryOutputAllOf - -#### Defined in - -[api.ts:701](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L701) diff --git a/packages/host-inventory/doc/interfaces/HostOut.md b/packages/host-inventory/doc/interfaces/HostOut.md deleted file mode 100644 index 6fecd53e0..000000000 --- a/packages/host-inventory/doc/interfaces/HostOut.md +++ /dev/null @@ -1,409 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / HostOut - -# Interface: HostOut - -Data of a single host belonging to an account. Represents the hosts without its Inventory metadata. - -**`Export`** - -HostOut - -## Table of contents - -### Properties - -- [account](HostOut.md#account) -- [ansible\_host](HostOut.md#ansible_host) -- [bios\_uuid](HostOut.md#bios_uuid) -- [created](HostOut.md#created) -- [culled\_timestamp](HostOut.md#culled_timestamp) -- [display\_name](HostOut.md#display_name) -- [facts](HostOut.md#facts) -- [fqdn](HostOut.md#fqdn) -- [groups](HostOut.md#groups) -- [id](HostOut.md#id) -- [insights\_id](HostOut.md#insights_id) -- [ip\_addresses](HostOut.md#ip_addresses) -- [mac\_addresses](HostOut.md#mac_addresses) -- [org\_id](HostOut.md#org_id) -- [per\_reporter\_staleness](HostOut.md#per_reporter_staleness) -- [provider\_id](HostOut.md#provider_id) -- [provider\_type](HostOut.md#provider_type) -- [reporter](HostOut.md#reporter) -- [satellite\_id](HostOut.md#satellite_id) -- [stale\_timestamp](HostOut.md#stale_timestamp) -- [stale\_warning\_timestamp](HostOut.md#stale_warning_timestamp) -- [subscription\_manager\_id](HostOut.md#subscription_manager_id) -- [updated](HostOut.md#updated) - -## Properties - -### account - -• `Optional` **account**: ``null`` \| `string` - -A Red Hat Account number that owns the host. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:780](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L780) - -___ - -### ansible\_host - -• `Optional` **ansible\_host**: ``null`` \| `string` - -The ansible host name for remediations - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:774](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L774) - -___ - -### bios\_uuid - -• `Optional` **bios\_uuid**: ``null`` \| `string` - -A UUID of the host machine BIOS. This field is considered to be a canonical fact. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:732](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L732) - -___ - -### created - -• `Optional` **created**: `string` - -A timestamp when the entry was created. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:798](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L798) - -___ - -### culled\_timestamp - -• `Optional` **culled\_timestamp**: ``null`` \| `string` - -Timestamp from which the host is considered deleted. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:828](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L828) - -___ - -### display\_name - -• `Optional` **display\_name**: ``null`` \| `string` - -A host’s human-readable display name, e.g. in a form of a domain name. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:768](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L768) - -___ - -### facts - -• `Optional` **facts**: [`FactSet`](FactSet.md)[] - -A set of facts belonging to the host. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:810](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L810) - -___ - -### fqdn - -• `Optional` **fqdn**: ``null`` \| `string` - -A host’s Fully Qualified Domain Name. This field is considered to be a canonical fact. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:744](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L744) - -___ - -### groups - -• `Optional` **groups**: [`GroupOut`](GroupOut.md)[] - -The groups that the host belongs to, if any. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:846](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L846) - -___ - -### id - -• `Optional` **id**: `string` - -A durable and reliable platform-wide host identifier. Applications should use this identifier to reference hosts. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:792](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L792) - -___ - -### insights\_id - -• `Optional` **insights\_id**: ``null`` \| `string` - -An ID defined in /etc/insights-client/machine-id. This field is considered a canonical fact. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:714](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L714) - -___ - -### ip\_addresses - -• `Optional` **ip\_addresses**: ``null`` \| `string`[] - -Host’s network IP addresses. This field is considered to be a canonical fact. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:738](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L738) - -___ - -### mac\_addresses - -• `Optional` **mac\_addresses**: ``null`` \| `string`[] - -Host’s network interfaces MAC addresses. This field is considered to be a canonical fact. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:750](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L750) - -___ - -### org\_id - -• **org\_id**: `string` - -The Org ID of the tenant that owns the host. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:786](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L786) - -___ - -### per\_reporter\_staleness - -• `Optional` **per\_reporter\_staleness**: `Object` - -Reporting source of the last checkin status, stale_timestamp, and last_check_in. - -**`Memberof`** - -HostOut - -#### Index signature - -▪ [key: `string`]: [`PerReporterStaleness`](PerReporterStaleness.md) - -#### Defined in - -[api.ts:840](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L840) - -___ - -### provider\_id - -• `Optional` **provider\_id**: ``null`` \| `string` - -Host’s reference in the external source e.g. Alibaba, AWS EC2, Azure, GCP, IBM etc. This field is one of the canonical facts and does not work without provider_type. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:756](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L756) - -___ - -### provider\_type - -• `Optional` **provider\_type**: ``null`` \| `string` - -Type of external source e.g. Alibaba, AWS EC2, Azure, GCP, IBM, etc. This field is one of the canonical facts and does not workout provider_id. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:762](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L762) - -___ - -### reporter - -• `Optional` **reporter**: ``null`` \| `string` - -Reporting source of the host. Used when updating the stale_timestamp. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:834](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L834) - -___ - -### satellite\_id - -• `Optional` **satellite\_id**: ``null`` \| `string` - -A Red Hat Satellite ID of a RHEL host. This field is considered to be a canonical fact. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:726](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L726) - -___ - -### stale\_timestamp - -• `Optional` **stale\_timestamp**: ``null`` \| `string` - -Timestamp from which the host is considered stale. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:816](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L816) - -___ - -### stale\_warning\_timestamp - -• `Optional` **stale\_warning\_timestamp**: ``null`` \| `string` - -Timestamp from which the host is considered too stale to be listed without an explicit toggle. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:822](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L822) - -___ - -### subscription\_manager\_id - -• `Optional` **subscription\_manager\_id**: ``null`` \| `string` - -A Red Hat Subcription Manager ID of a RHEL host. This field is considered to be a canonical fact. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:720](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L720) - -___ - -### updated - -• `Optional` **updated**: `string` - -A timestamp when the entry was last updated. - -**`Memberof`** - -HostOut - -#### Defined in - -[api.ts:804](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L804) diff --git a/packages/host-inventory/doc/interfaces/HostOutAllOf.md b/packages/host-inventory/doc/interfaces/HostOutAllOf.md deleted file mode 100644 index 9794fb8db..000000000 --- a/packages/host-inventory/doc/interfaces/HostOutAllOf.md +++ /dev/null @@ -1,254 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / HostOutAllOf - -# Interface: HostOutAllOf - -**`Export`** - -HostOutAllOf - -## Table of contents - -### Properties - -- [account](HostOutAllOf.md#account) -- [ansible\_host](HostOutAllOf.md#ansible_host) -- [created](HostOutAllOf.md#created) -- [culled\_timestamp](HostOutAllOf.md#culled_timestamp) -- [display\_name](HostOutAllOf.md#display_name) -- [facts](HostOutAllOf.md#facts) -- [groups](HostOutAllOf.md#groups) -- [id](HostOutAllOf.md#id) -- [org\_id](HostOutAllOf.md#org_id) -- [per\_reporter\_staleness](HostOutAllOf.md#per_reporter_staleness) -- [reporter](HostOutAllOf.md#reporter) -- [stale\_timestamp](HostOutAllOf.md#stale_timestamp) -- [stale\_warning\_timestamp](HostOutAllOf.md#stale_warning_timestamp) -- [updated](HostOutAllOf.md#updated) - -## Properties - -### account - -• `Optional` **account**: ``null`` \| `string` - -A Red Hat Account number that owns the host. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:871](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L871) - -___ - -### ansible\_host - -• `Optional` **ansible\_host**: ``null`` \| `string` - -The ansible host name for remediations - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:865](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L865) - -___ - -### created - -• `Optional` **created**: `string` - -A timestamp when the entry was created. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:889](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L889) - -___ - -### culled\_timestamp - -• `Optional` **culled\_timestamp**: ``null`` \| `string` - -Timestamp from which the host is considered deleted. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:919](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L919) - -___ - -### display\_name - -• `Optional` **display\_name**: ``null`` \| `string` - -A host’s human-readable display name, e.g. in a form of a domain name. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:859](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L859) - -___ - -### facts - -• `Optional` **facts**: [`FactSet`](FactSet.md)[] - -A set of facts belonging to the host. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:901](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L901) - -___ - -### groups - -• `Optional` **groups**: [`GroupOut`](GroupOut.md)[] - -The groups that the host belongs to, if any. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:937](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L937) - -___ - -### id - -• `Optional` **id**: `string` - -A durable and reliable platform-wide host identifier. Applications should use this identifier to reference hosts. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:883](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L883) - -___ - -### org\_id - -• **org\_id**: `string` - -The Org ID of the tenant that owns the host. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:877](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L877) - -___ - -### per\_reporter\_staleness - -• `Optional` **per\_reporter\_staleness**: `Object` - -Reporting source of the last checkin status, stale_timestamp, and last_check_in. - -**`Memberof`** - -HostOutAllOf - -#### Index signature - -▪ [key: `string`]: [`PerReporterStaleness`](PerReporterStaleness.md) - -#### Defined in - -[api.ts:931](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L931) - -___ - -### reporter - -• `Optional` **reporter**: ``null`` \| `string` - -Reporting source of the host. Used when updating the stale_timestamp. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:925](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L925) - -___ - -### stale\_timestamp - -• `Optional` **stale\_timestamp**: ``null`` \| `string` - -Timestamp from which the host is considered stale. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:907](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L907) - -___ - -### stale\_warning\_timestamp - -• `Optional` **stale\_warning\_timestamp**: ``null`` \| `string` - -Timestamp from which the host is considered too stale to be listed without an explicit toggle. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:913](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L913) - -___ - -### updated - -• `Optional` **updated**: `string` - -A timestamp when the entry was last updated. - -**`Memberof`** - -HostOutAllOf - -#### Defined in - -[api.ts:895](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L895) diff --git a/packages/host-inventory/doc/interfaces/HostQueryOutput.md b/packages/host-inventory/doc/interfaces/HostQueryOutput.md deleted file mode 100644 index 93ab71eda..000000000 --- a/packages/host-inventory/doc/interfaces/HostQueryOutput.md +++ /dev/null @@ -1,99 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / HostQueryOutput - -# Interface: HostQueryOutput - -A paginated host search query result with host entries and their Inventory metadata. - -**`Export`** - -HostQueryOutput - -## Table of contents - -### Properties - -- [count](HostQueryOutput.md#count) -- [page](HostQueryOutput.md#page) -- [per\_page](HostQueryOutput.md#per_page) -- [results](HostQueryOutput.md#results) -- [total](HostQueryOutput.md#total) - -## Properties - -### count - -• **count**: `number` - -The number of items on the current page - -**`Memberof`** - -HostQueryOutput - -#### Defined in - -[api.ts:950](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L950) - -___ - -### page - -• **page**: `number` - -The page number - -**`Memberof`** - -HostQueryOutput - -#### Defined in - -[api.ts:956](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L956) - -___ - -### per\_page - -• **per\_page**: `number` - -The number of items to return per page - -**`Memberof`** - -HostQueryOutput - -#### Defined in - -[api.ts:962](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L962) - -___ - -### results - -• **results**: [`HostOut`](HostOut.md)[] - -Actual host search query result entries. - -**`Memberof`** - -HostQueryOutput - -#### Defined in - -[api.ts:974](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L974) - -___ - -### total - -• **total**: `number` - -Total number of items - -**`Memberof`** - -HostQueryOutput - -#### Defined in - -[api.ts:968](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L968) diff --git a/packages/host-inventory/doc/interfaces/HostQueryOutputAllOf.md b/packages/host-inventory/doc/interfaces/HostQueryOutputAllOf.md deleted file mode 100644 index d9b9b760f..000000000 --- a/packages/host-inventory/doc/interfaces/HostQueryOutputAllOf.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / HostQueryOutputAllOf - -# Interface: HostQueryOutputAllOf - -**`Export`** - -HostQueryOutputAllOf - -## Table of contents - -### Properties - -- [results](HostQueryOutputAllOf.md#results) - -## Properties - -### results - -• **results**: [`HostOut`](HostOut.md)[] - -Actual host search query result entries. - -**`Memberof`** - -HostQueryOutputAllOf - -#### Defined in - -[api.ts:987](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L987) diff --git a/packages/host-inventory/doc/interfaces/HostSystemProfileOut.md b/packages/host-inventory/doc/interfaces/HostSystemProfileOut.md deleted file mode 100644 index 3d22092ab..000000000 --- a/packages/host-inventory/doc/interfaces/HostSystemProfileOut.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / HostSystemProfileOut - -# Interface: HostSystemProfileOut - -Individual host record that contains only the host id and system profile - -**`Export`** - -HostSystemProfileOut - -## Table of contents - -### Properties - -- [id](HostSystemProfileOut.md#id) -- [system\_profile](HostSystemProfileOut.md#system_profile) - -## Properties - -### id - -• `Optional` **id**: `string` - -**`Memberof`** - -HostSystemProfileOut - -#### Defined in - -[api.ts:1000](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1000) - -___ - -### system\_profile - -• `Optional` **system\_profile**: [`SystemProfile`](SystemProfile.md) - -**`Memberof`** - -HostSystemProfileOut - -#### Defined in - -[api.ts:1006](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1006) diff --git a/packages/host-inventory/doc/interfaces/InstalledProduct.md b/packages/host-inventory/doc/interfaces/InstalledProduct.md deleted file mode 100644 index d04cd7366..000000000 --- a/packages/host-inventory/doc/interfaces/InstalledProduct.md +++ /dev/null @@ -1,63 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / InstalledProduct - -# Interface: InstalledProduct - -Representation of one installed product - -**`Export`** - -InstalledProduct - -## Table of contents - -### Properties - -- [id](InstalledProduct.md#id) -- [name](InstalledProduct.md#name) -- [status](InstalledProduct.md#status) - -## Properties - -### id - -• `Optional` **id**: `string` - -The product ID - -**`Memberof`** - -InstalledProduct - -#### Defined in - -[api.ts:1025](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1025) - -___ - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -InstalledProduct - -#### Defined in - -[api.ts:1019](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1019) - -___ - -### status - -• `Optional` **status**: `string` - -Subscription status for product - -**`Memberof`** - -InstalledProduct - -#### Defined in - -[api.ts:1031](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1031) diff --git a/packages/host-inventory/doc/interfaces/InterSystemsRunningInstance.md b/packages/host-inventory/doc/interfaces/InterSystemsRunningInstance.md deleted file mode 100644 index 4d3ef437e..000000000 --- a/packages/host-inventory/doc/interfaces/InterSystemsRunningInstance.md +++ /dev/null @@ -1,65 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / InterSystemsRunningInstance - -# Interface: InterSystemsRunningInstance - -The info for an InterSystems instance running on the system - -**`Export`** - -InterSystemsRunningInstance - -## Table of contents - -### Properties - -- [instance\_name](InterSystemsRunningInstance.md#instance_name) -- [product](InterSystemsRunningInstance.md#product) -- [version](InterSystemsRunningInstance.md#version) - -## Properties - -### instance\_name - -• `Optional` **instance\_name**: `string` - -The name of the instance - -**`Memberof`** - -InterSystemsRunningInstance - -#### Defined in - -[api.ts:1044](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1044) - -___ - -### product - -• `Optional` **product**: `string` - -The product of the instance - -**`Memberof`** - -InterSystemsRunningInstance - -#### Defined in - -[api.ts:1050](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1050) - -___ - -### version - -• `Optional` **version**: `string` - -The version of the instance - -**`Memberof`** - -InterSystemsRunningInstance - -#### Defined in - -[api.ts:1056](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1056) diff --git a/packages/host-inventory/doc/interfaces/Links.md b/packages/host-inventory/doc/interfaces/Links.md deleted file mode 100644 index 4ced8422f..000000000 --- a/packages/host-inventory/doc/interfaces/Links.md +++ /dev/null @@ -1,82 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / Links - -# Interface: Links - -A collection of pagination links for resource-types endpoints - -**`Export`** - -Links - -## Table of contents - -### Properties - -- [first](Links.md#first) -- [last](Links.md#last) -- [next](Links.md#next) -- [previous](Links.md#previous) - -## Properties - -### first - -• **first**: `string` - -The URI path for the first page in the pagination - -**`Memberof`** - -Links - -#### Defined in - -[api.ts:1069](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1069) - -___ - -### last - -• **last**: `string` - -The URI path for the last page in the pagination - -**`Memberof`** - -Links - -#### Defined in - -[api.ts:1087](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1087) - -___ - -### next - -• **next**: ``null`` \| `string` - -The URI path for the next page in the pagination - -**`Memberof`** - -Links - -#### Defined in - -[api.ts:1081](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1081) - -___ - -### previous - -• **previous**: ``null`` \| `string` - -The URI path for the previous page in the pagination - -**`Memberof`** - -Links - -#### Defined in - -[api.ts:1075](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1075) diff --git a/packages/host-inventory/doc/interfaces/Meta.md b/packages/host-inventory/doc/interfaces/Meta.md deleted file mode 100644 index 99ccb685d..000000000 --- a/packages/host-inventory/doc/interfaces/Meta.md +++ /dev/null @@ -1,31 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / Meta - -# Interface: Meta - -The metadata for resource-types responses - -**`Export`** - -Meta - -## Table of contents - -### Properties - -- [count](Meta.md#count) - -## Properties - -### count - -• **count**: `number` - -The total number of objects returned by the query. - -**`Memberof`** - -Meta - -#### Defined in - -[api.ts:1100](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1100) diff --git a/packages/host-inventory/doc/interfaces/NetworkInterface.md b/packages/host-inventory/doc/interfaces/NetworkInterface.md deleted file mode 100644 index c5a6f4637..000000000 --- a/packages/host-inventory/doc/interfaces/NetworkInterface.md +++ /dev/null @@ -1,129 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / NetworkInterface - -# Interface: NetworkInterface - -Representation of one network interface - -**`Export`** - -NetworkInterface - -## Table of contents - -### Properties - -- [ipv4\_addresses](NetworkInterface.md#ipv4_addresses) -- [ipv6\_addresses](NetworkInterface.md#ipv6_addresses) -- [mac\_address](NetworkInterface.md#mac_address) -- [mtu](NetworkInterface.md#mtu) -- [name](NetworkInterface.md#name) -- [state](NetworkInterface.md#state) -- [type](NetworkInterface.md#type) - -## Properties - -### ipv4\_addresses - -• `Optional` **ipv4\_addresses**: `string`[] - -**`Memberof`** - -NetworkInterface - -#### Defined in - -[api.ts:1113](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1113) - -___ - -### ipv6\_addresses - -• `Optional` **ipv6\_addresses**: `string`[] - -**`Memberof`** - -NetworkInterface - -#### Defined in - -[api.ts:1119](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1119) - -___ - -### mac\_address - -• `Optional` **mac\_address**: `string` - -MAC address (with or without colons) - -**`Memberof`** - -NetworkInterface - -#### Defined in - -[api.ts:1131](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1131) - -___ - -### mtu - -• `Optional` **mtu**: `number` - -MTU (Maximum transmission unit) - -**`Memberof`** - -NetworkInterface - -#### Defined in - -[api.ts:1125](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1125) - -___ - -### name - -• `Optional` **name**: `string` - -Name of interface - -**`Memberof`** - -NetworkInterface - -#### Defined in - -[api.ts:1137](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1137) - -___ - -### state - -• `Optional` **state**: `string` - -Interface state (UP, DOWN, UNKNOWN) - -**`Memberof`** - -NetworkInterface - -#### Defined in - -[api.ts:1143](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1143) - -___ - -### type - -• `Optional` **type**: `string` - -Interface type (ether, loopback) - -**`Memberof`** - -NetworkInterface - -#### Defined in - -[api.ts:1149](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1149) diff --git a/packages/host-inventory/doc/interfaces/PaginationOut.md b/packages/host-inventory/doc/interfaces/PaginationOut.md deleted file mode 100644 index ee78d709e..000000000 --- a/packages/host-inventory/doc/interfaces/PaginationOut.md +++ /dev/null @@ -1,80 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / PaginationOut - -# Interface: PaginationOut - -**`Export`** - -PaginationOut - -## Table of contents - -### Properties - -- [count](PaginationOut.md#count) -- [page](PaginationOut.md#page) -- [per\_page](PaginationOut.md#per_page) -- [total](PaginationOut.md#total) - -## Properties - -### count - -• **count**: `number` - -The number of items on the current page - -**`Memberof`** - -PaginationOut - -#### Defined in - -[api.ts:1162](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1162) - -___ - -### page - -• **page**: `number` - -The page number - -**`Memberof`** - -PaginationOut - -#### Defined in - -[api.ts:1168](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1168) - -___ - -### per\_page - -• **per\_page**: `number` - -The number of items to return per page - -**`Memberof`** - -PaginationOut - -#### Defined in - -[api.ts:1174](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1174) - -___ - -### total - -• **total**: `number` - -Total number of items - -**`Memberof`** - -PaginationOut - -#### Defined in - -[api.ts:1180](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1180) diff --git a/packages/host-inventory/doc/interfaces/PatchHostIn.md b/packages/host-inventory/doc/interfaces/PatchHostIn.md deleted file mode 100644 index 4d277a4dd..000000000 --- a/packages/host-inventory/doc/interfaces/PatchHostIn.md +++ /dev/null @@ -1,48 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / PatchHostIn - -# Interface: PatchHostIn - -Data of a single host to be updated. - -**`Export`** - -PatchHostIn - -## Table of contents - -### Properties - -- [ansible\_host](PatchHostIn.md#ansible_host) -- [display\_name](PatchHostIn.md#display_name) - -## Properties - -### ansible\_host - -• `Optional` **ansible\_host**: `string` - -The ansible host name for remediations - -**`Memberof`** - -PatchHostIn - -#### Defined in - -[api.ts:1193](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1193) - -___ - -### display\_name - -• `Optional` **display\_name**: `string` - -A host’s human-readable display name, e.g. in a form of a domain name. - -**`Memberof`** - -PatchHostIn - -#### Defined in - -[api.ts:1199](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1199) diff --git a/packages/host-inventory/doc/interfaces/PerReporterStaleness.md b/packages/host-inventory/doc/interfaces/PerReporterStaleness.md deleted file mode 100644 index 1ca71384d..000000000 --- a/packages/host-inventory/doc/interfaces/PerReporterStaleness.md +++ /dev/null @@ -1,87 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / PerReporterStaleness - -# Interface: PerReporterStaleness - -**`Export`** - -PerReporterStaleness - -## Table of contents - -### Properties - -- [check\_in\_succeeded](PerReporterStaleness.md#check_in_succeeded) -- [culled\_timestamp](PerReporterStaleness.md#culled_timestamp) -- [last\_check\_in](PerReporterStaleness.md#last_check_in) -- [stale\_timestamp](PerReporterStaleness.md#stale_timestamp) -- [stale\_warning\_timestamp](PerReporterStaleness.md#stale_warning_timestamp) - -## Properties - -### check\_in\_succeeded - -• `Optional` **check\_in\_succeeded**: `boolean` - -**`Memberof`** - -PerReporterStaleness - -#### Defined in - -[api.ts:1236](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1236) - -___ - -### culled\_timestamp - -• `Optional` **culled\_timestamp**: `string` - -**`Memberof`** - -PerReporterStaleness - -#### Defined in - -[api.ts:1230](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1230) - -___ - -### last\_check\_in - -• `Optional` **last\_check\_in**: `string` - -**`Memberof`** - -PerReporterStaleness - -#### Defined in - -[api.ts:1212](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1212) - -___ - -### stale\_timestamp - -• `Optional` **stale\_timestamp**: `string` - -**`Memberof`** - -PerReporterStaleness - -#### Defined in - -[api.ts:1218](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1218) - -___ - -### stale\_warning\_timestamp - -• `Optional` **stale\_warning\_timestamp**: `string` - -**`Memberof`** - -PerReporterStaleness - -#### Defined in - -[api.ts:1224](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1224) diff --git a/packages/host-inventory/doc/interfaces/RPMOSTreeDeployment.md b/packages/host-inventory/doc/interfaces/RPMOSTreeDeployment.md deleted file mode 100644 index 2b7ad43e2..000000000 --- a/packages/host-inventory/doc/interfaces/RPMOSTreeDeployment.md +++ /dev/null @@ -1,133 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / RPMOSTreeDeployment - -# Interface: RPMOSTreeDeployment - -Limited deployment information from systems managed by rpm-ostree as reported by rpm-ostree status --json - -**`Export`** - -RPMOSTreeDeployment - -## Table of contents - -### Properties - -- [booted](RPMOSTreeDeployment.md#booted) -- [checksum](RPMOSTreeDeployment.md#checksum) -- [id](RPMOSTreeDeployment.md#id) -- [origin](RPMOSTreeDeployment.md#origin) -- [osname](RPMOSTreeDeployment.md#osname) -- [pinned](RPMOSTreeDeployment.md#pinned) -- [version](RPMOSTreeDeployment.md#version) - -## Properties - -### booted - -• **booted**: `boolean` - -Whether the deployment is currently booted - -**`Memberof`** - -RPMOSTreeDeployment - -#### Defined in - -[api.ts:1279](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1279) - -___ - -### checksum - -• **checksum**: `string` - -The checksum / commit of the deployment - -**`Memberof`** - -RPMOSTreeDeployment - -#### Defined in - -[api.ts:1255](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1255) - -___ - -### id - -• **id**: `string` - -ID of the deployment - -**`Memberof`** - -RPMOSTreeDeployment - -#### Defined in - -[api.ts:1249](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1249) - -___ - -### origin - -• **origin**: `string` - -The origin repo from which the commit was installed - -**`Memberof`** - -RPMOSTreeDeployment - -#### Defined in - -[api.ts:1261](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1261) - -___ - -### osname - -• **osname**: `string` - -The operating system name - -**`Memberof`** - -RPMOSTreeDeployment - -#### Defined in - -[api.ts:1267](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1267) - -___ - -### pinned - -• **pinned**: `boolean` - -Whether the deployment is currently pinned - -**`Memberof`** - -RPMOSTreeDeployment - -#### Defined in - -[api.ts:1285](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1285) - -___ - -### version - -• `Optional` **version**: `string` - -The version of the deployment - -**`Memberof`** - -RPMOSTreeDeployment - -#### Defined in - -[api.ts:1273](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1273) diff --git a/packages/host-inventory/doc/interfaces/ResourceTypesGroupsQueryOutput.md b/packages/host-inventory/doc/interfaces/ResourceTypesGroupsQueryOutput.md deleted file mode 100644 index 1727e75d7..000000000 --- a/packages/host-inventory/doc/interfaces/ResourceTypesGroupsQueryOutput.md +++ /dev/null @@ -1,61 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ResourceTypesGroupsQueryOutput - -# Interface: ResourceTypesGroupsQueryOutput - -A paginated group search query result with group entries and their Inventory metadata in paginated resource-types response format. - -**`Export`** - -ResourceTypesGroupsQueryOutput - -## Table of contents - -### Properties - -- [data](ResourceTypesGroupsQueryOutput.md#data) -- [links](ResourceTypesGroupsQueryOutput.md#links) -- [meta](ResourceTypesGroupsQueryOutput.md#meta) - -## Properties - -### data - -• **data**: [`GroupOutWithHostCount`](GroupOutWithHostCount.md)[] - -Actual group search query result entries. - -**`Memberof`** - -ResourceTypesGroupsQueryOutput - -#### Defined in - -[api.ts:1310](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1310) - -___ - -### links - -• **links**: [`Links`](Links.md) - -**`Memberof`** - -ResourceTypesGroupsQueryOutput - -#### Defined in - -[api.ts:1304](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1304) - -___ - -### meta - -• **meta**: [`Meta`](Meta.md) - -**`Memberof`** - -ResourceTypesGroupsQueryOutput - -#### Defined in - -[api.ts:1298](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1298) diff --git a/packages/host-inventory/doc/interfaces/ResourceTypesGroupsQueryOutputAllOf.md b/packages/host-inventory/doc/interfaces/ResourceTypesGroupsQueryOutputAllOf.md deleted file mode 100644 index 75a91e98d..000000000 --- a/packages/host-inventory/doc/interfaces/ResourceTypesGroupsQueryOutputAllOf.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ResourceTypesGroupsQueryOutputAllOf - -# Interface: ResourceTypesGroupsQueryOutputAllOf - -**`Export`** - -ResourceTypesGroupsQueryOutputAllOf - -## Table of contents - -### Properties - -- [data](ResourceTypesGroupsQueryOutputAllOf.md#data) - -## Properties - -### data - -• **data**: [`GroupOutWithHostCount`](GroupOutWithHostCount.md)[] - -Actual group search query result entries. - -**`Memberof`** - -ResourceTypesGroupsQueryOutputAllOf - -#### Defined in - -[api.ts:1323](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1323) diff --git a/packages/host-inventory/doc/interfaces/ResourceTypesOut.md b/packages/host-inventory/doc/interfaces/ResourceTypesOut.md deleted file mode 100644 index a5110be7a..000000000 --- a/packages/host-inventory/doc/interfaces/ResourceTypesOut.md +++ /dev/null @@ -1,63 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ResourceTypesOut - -# Interface: ResourceTypesOut - -Data describing a single resource-types RBAC object. - -**`Export`** - -ResourceTypesOut - -## Table of contents - -### Properties - -- [count](ResourceTypesOut.md#count) -- [path](ResourceTypesOut.md#path) -- [value](ResourceTypesOut.md#value) - -## Properties - -### count - -• `Optional` **count**: `number` - -**`Memberof`** - -ResourceTypesOut - -#### Defined in - -[api.ts:1348](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1348) - -___ - -### path - -• `Optional` **path**: `string` - -The path for the RBAC endpoint for the resource type - -**`Memberof`** - -ResourceTypesOut - -#### Defined in - -[api.ts:1342](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1342) - -___ - -### value - -• `Optional` **value**: `string` - -The name of the resource type - -**`Memberof`** - -ResourceTypesOut - -#### Defined in - -[api.ts:1336](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1336) diff --git a/packages/host-inventory/doc/interfaces/ResourceTypesPaginationOut.md b/packages/host-inventory/doc/interfaces/ResourceTypesPaginationOut.md deleted file mode 100644 index 3fb31a9b7..000000000 --- a/packages/host-inventory/doc/interfaces/ResourceTypesPaginationOut.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ResourceTypesPaginationOut - -# Interface: ResourceTypesPaginationOut - -**`Export`** - -ResourceTypesPaginationOut - -## Table of contents - -### Properties - -- [links](ResourceTypesPaginationOut.md#links) -- [meta](ResourceTypesPaginationOut.md#meta) - -## Properties - -### links - -• **links**: [`Links`](Links.md) - -**`Memberof`** - -ResourceTypesPaginationOut - -#### Defined in - -[api.ts:1367](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1367) - -___ - -### meta - -• **meta**: [`Meta`](Meta.md) - -**`Memberof`** - -ResourceTypesPaginationOut - -#### Defined in - -[api.ts:1361](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1361) diff --git a/packages/host-inventory/doc/interfaces/ResourceTypesQueryOutput.md b/packages/host-inventory/doc/interfaces/ResourceTypesQueryOutput.md deleted file mode 100644 index bc3653d4b..000000000 --- a/packages/host-inventory/doc/interfaces/ResourceTypesQueryOutput.md +++ /dev/null @@ -1,61 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ResourceTypesQueryOutput - -# Interface: ResourceTypesQueryOutput - -A paginated list of resource-types RBAC objects. - -**`Export`** - -ResourceTypesQueryOutput - -## Table of contents - -### Properties - -- [data](ResourceTypesQueryOutput.md#data) -- [links](ResourceTypesQueryOutput.md#links) -- [meta](ResourceTypesQueryOutput.md#meta) - -## Properties - -### data - -• **data**: [`ResourceTypesOut`](ResourceTypesOut.md)[] - -Actual resource-types object data. - -**`Memberof`** - -ResourceTypesQueryOutput - -#### Defined in - -[api.ts:1392](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1392) - -___ - -### links - -• **links**: [`Links`](Links.md) - -**`Memberof`** - -ResourceTypesQueryOutput - -#### Defined in - -[api.ts:1386](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1386) - -___ - -### meta - -• **meta**: [`Meta`](Meta.md) - -**`Memberof`** - -ResourceTypesQueryOutput - -#### Defined in - -[api.ts:1380](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1380) diff --git a/packages/host-inventory/doc/interfaces/ResourceTypesQueryOutputAllOf.md b/packages/host-inventory/doc/interfaces/ResourceTypesQueryOutputAllOf.md deleted file mode 100644 index 130a3e695..000000000 --- a/packages/host-inventory/doc/interfaces/ResourceTypesQueryOutputAllOf.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / ResourceTypesQueryOutputAllOf - -# Interface: ResourceTypesQueryOutputAllOf - -**`Export`** - -ResourceTypesQueryOutputAllOf - -## Table of contents - -### Properties - -- [data](ResourceTypesQueryOutputAllOf.md#data) - -## Properties - -### data - -• **data**: [`ResourceTypesOut`](ResourceTypesOut.md)[] - -Actual resource-types object data. - -**`Memberof`** - -ResourceTypesQueryOutputAllOf - -#### Defined in - -[api.ts:1405](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1405) diff --git a/packages/host-inventory/doc/interfaces/StalenessIn.md b/packages/host-inventory/doc/interfaces/StalenessIn.md deleted file mode 100644 index 728967fe4..000000000 --- a/packages/host-inventory/doc/interfaces/StalenessIn.md +++ /dev/null @@ -1,104 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / StalenessIn - -# Interface: StalenessIn - -Data of a single account staleness. - -**`Export`** - -StalenessIn - -## Table of contents - -### Properties - -- [conventional\_time\_to\_delete](StalenessIn.md#conventional_time_to_delete) -- [conventional\_time\_to\_stale](StalenessIn.md#conventional_time_to_stale) -- [conventional\_time\_to\_stale\_warning](StalenessIn.md#conventional_time_to_stale_warning) -- [immutable\_time\_to\_delete](StalenessIn.md#immutable_time_to_delete) -- [immutable\_time\_to\_stale](StalenessIn.md#immutable_time_to_stale) -- [immutable\_time\_to\_stale\_warning](StalenessIn.md#immutable_time_to_stale_warning) - -## Properties - -### conventional\_time\_to\_delete - -• `Optional` **conventional\_time\_to\_delete**: `number` - -**`Memberof`** - -StalenessIn - -#### Defined in - -[api.ts:1437](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1437) - -___ - -### conventional\_time\_to\_stale - -• `Optional` **conventional\_time\_to\_stale**: `number` - -**`Memberof`** - -StalenessIn - -#### Defined in - -[api.ts:1425](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1425) - -___ - -### conventional\_time\_to\_stale\_warning - -• `Optional` **conventional\_time\_to\_stale\_warning**: `number` - -**`Memberof`** - -StalenessIn - -#### Defined in - -[api.ts:1431](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1431) - -___ - -### immutable\_time\_to\_delete - -• `Optional` **immutable\_time\_to\_delete**: `number` - -**`Memberof`** - -StalenessIn - -#### Defined in - -[api.ts:1455](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1455) - -___ - -### immutable\_time\_to\_stale - -• `Optional` **immutable\_time\_to\_stale**: `number` - -**`Memberof`** - -StalenessIn - -#### Defined in - -[api.ts:1443](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1443) - -___ - -### immutable\_time\_to\_stale\_warning - -• `Optional` **immutable\_time\_to\_stale\_warning**: `number` - -**`Memberof`** - -StalenessIn - -#### Defined in - -[api.ts:1449](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1449) diff --git a/packages/host-inventory/doc/interfaces/StalenessOutput.md b/packages/host-inventory/doc/interfaces/StalenessOutput.md deleted file mode 100644 index 6725212fd..000000000 --- a/packages/host-inventory/doc/interfaces/StalenessOutput.md +++ /dev/null @@ -1,170 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / StalenessOutput - -# Interface: StalenessOutput - -Data of a account staleness. - -**`Export`** - -StalenessOutput - -## Table of contents - -### Properties - -- [conventional\_time\_to\_delete](StalenessOutput.md#conventional_time_to_delete) -- [conventional\_time\_to\_stale](StalenessOutput.md#conventional_time_to_stale) -- [conventional\_time\_to\_stale\_warning](StalenessOutput.md#conventional_time_to_stale_warning) -- [created](StalenessOutput.md#created) -- [id](StalenessOutput.md#id) -- [immutable\_time\_to\_delete](StalenessOutput.md#immutable_time_to_delete) -- [immutable\_time\_to\_stale](StalenessOutput.md#immutable_time_to_stale) -- [immutable\_time\_to\_stale\_warning](StalenessOutput.md#immutable_time_to_stale_warning) -- [org\_id](StalenessOutput.md#org_id) -- [updated](StalenessOutput.md#updated) - -## Properties - -### conventional\_time\_to\_delete - -• **conventional\_time\_to\_delete**: `number` - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1480](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1480) - -___ - -### conventional\_time\_to\_stale - -• **conventional\_time\_to\_stale**: `number` - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1468](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1468) - -___ - -### conventional\_time\_to\_stale\_warning - -• **conventional\_time\_to\_stale\_warning**: `number` - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1474](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1474) - -___ - -### created - -• **created**: ``null`` \| `string` - -A timestamp when the entry was created. - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1516](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1516) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1504](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1504) - -___ - -### immutable\_time\_to\_delete - -• **immutable\_time\_to\_delete**: `number` - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1498](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1498) - -___ - -### immutable\_time\_to\_stale - -• **immutable\_time\_to\_stale**: `number` - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1486](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1486) - -___ - -### immutable\_time\_to\_stale\_warning - -• **immutable\_time\_to\_stale\_warning**: `number` - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1492](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1492) - -___ - -### org\_id - -• **org\_id**: `string` - -The Org ID of the tenant that owns the host. - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1510](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1510) - -___ - -### updated - -• **updated**: ``null`` \| `string` - -A timestamp when the entry was last updated. - -**`Memberof`** - -StalenessOutput - -#### Defined in - -[api.ts:1522](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1522) diff --git a/packages/host-inventory/doc/interfaces/StalenessOutputAllOf.md b/packages/host-inventory/doc/interfaces/StalenessOutputAllOf.md deleted file mode 100644 index 58b3f3e23..000000000 --- a/packages/host-inventory/doc/interfaces/StalenessOutputAllOf.md +++ /dev/null @@ -1,78 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / StalenessOutputAllOf - -# Interface: StalenessOutputAllOf - -**`Export`** - -StalenessOutputAllOf - -## Table of contents - -### Properties - -- [created](StalenessOutputAllOf.md#created) -- [id](StalenessOutputAllOf.md#id) -- [org\_id](StalenessOutputAllOf.md#org_id) -- [updated](StalenessOutputAllOf.md#updated) - -## Properties - -### created - -• **created**: ``null`` \| `string` - -A timestamp when the entry was created. - -**`Memberof`** - -StalenessOutputAllOf - -#### Defined in - -[api.ts:1547](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1547) - -___ - -### id - -• **id**: `string` - -**`Memberof`** - -StalenessOutputAllOf - -#### Defined in - -[api.ts:1535](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1535) - -___ - -### org\_id - -• **org\_id**: `string` - -The Org ID of the tenant that owns the host. - -**`Memberof`** - -StalenessOutputAllOf - -#### Defined in - -[api.ts:1541](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1541) - -___ - -### updated - -• **updated**: ``null`` \| `string` - -A timestamp when the entry was last updated. - -**`Memberof`** - -StalenessOutputAllOf - -#### Defined in - -[api.ts:1553](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1553) diff --git a/packages/host-inventory/doc/interfaces/StructuredTag.md b/packages/host-inventory/doc/interfaces/StructuredTag.md deleted file mode 100644 index 73f3bf944..000000000 --- a/packages/host-inventory/doc/interfaces/StructuredTag.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / StructuredTag - -# Interface: StructuredTag - -**`Export`** - -StructuredTag - -## Table of contents - -### Properties - -- [key](StructuredTag.md#key) -- [namespace](StructuredTag.md#namespace) -- [value](StructuredTag.md#value) - -## Properties - -### key - -• `Optional` **key**: `string` - -**`Memberof`** - -StructuredTag - -#### Defined in - -[api.ts:1572](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1572) - -___ - -### namespace - -• `Optional` **namespace**: ``null`` \| `string` - -**`Memberof`** - -StructuredTag - -#### Defined in - -[api.ts:1566](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1566) - -___ - -### value - -• `Optional` **value**: ``null`` \| `string` - -**`Memberof`** - -StructuredTag - -#### Defined in - -[api.ts:1578](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1578) diff --git a/packages/host-inventory/doc/interfaces/SystemProfile.md b/packages/host-inventory/doc/interfaces/SystemProfile.md deleted file mode 100644 index 28005e140..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfile.md +++ /dev/null @@ -1,1078 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfile - -# Interface: SystemProfile - -Representation of the system profile fields - -**`Export`** - -SystemProfile - -## Table of contents - -### Properties - -- [ansible](SystemProfile.md#ansible) -- [arch](SystemProfile.md#arch) -- [basearch](SystemProfile.md#basearch) -- [bios\_release\_date](SystemProfile.md#bios_release_date) -- [bios\_vendor](SystemProfile.md#bios_vendor) -- [bios\_version](SystemProfile.md#bios_version) -- [bootc\_status](SystemProfile.md#bootc_status) -- [captured\_date](SystemProfile.md#captured_date) -- [cloud\_provider](SystemProfile.md#cloud_provider) -- [conversions](SystemProfile.md#conversions) -- [cores\_per\_socket](SystemProfile.md#cores_per_socket) -- [cpu\_flags](SystemProfile.md#cpu_flags) -- [cpu\_model](SystemProfile.md#cpu_model) -- [disk\_devices](SystemProfile.md#disk_devices) -- [dnf\_modules](SystemProfile.md#dnf_modules) -- [enabled\_services](SystemProfile.md#enabled_services) -- [gpg\_pubkeys](SystemProfile.md#gpg_pubkeys) -- [greenboot\_fallback\_detected](SystemProfile.md#greenboot_fallback_detected) -- [greenboot\_status](SystemProfile.md#greenboot_status) -- [host\_type](SystemProfile.md#host_type) -- [infrastructure\_type](SystemProfile.md#infrastructure_type) -- [infrastructure\_vendor](SystemProfile.md#infrastructure_vendor) -- [insights\_client\_version](SystemProfile.md#insights_client_version) -- [insights\_egg\_version](SystemProfile.md#insights_egg_version) -- [installed\_packages](SystemProfile.md#installed_packages) -- [installed\_packages\_delta](SystemProfile.md#installed_packages_delta) -- [installed\_products](SystemProfile.md#installed_products) -- [installed\_services](SystemProfile.md#installed_services) -- [intersystems](SystemProfile.md#intersystems) -- [is\_marketplace](SystemProfile.md#is_marketplace) -- [katello\_agent\_running](SystemProfile.md#katello_agent_running) -- [kernel\_modules](SystemProfile.md#kernel_modules) -- [last\_boot\_time](SystemProfile.md#last_boot_time) -- [mssql](SystemProfile.md#mssql) -- [network\_interfaces](SystemProfile.md#network_interfaces) -- [number\_of\_cpus](SystemProfile.md#number_of_cpus) -- [number\_of\_sockets](SystemProfile.md#number_of_sockets) -- [operating\_system](SystemProfile.md#operating_system) -- [os\_kernel\_version](SystemProfile.md#os_kernel_version) -- [os\_release](SystemProfile.md#os_release) -- [owner\_id](SystemProfile.md#owner_id) -- [public\_dns](SystemProfile.md#public_dns) -- [public\_ipv4\_addresses](SystemProfile.md#public_ipv4_addresses) -- [releasever](SystemProfile.md#releasever) -- [rhc\_client\_id](SystemProfile.md#rhc_client_id) -- [rhc\_config\_state](SystemProfile.md#rhc_config_state) -- [rhsm](SystemProfile.md#rhsm) -- [rpm\_ostree\_deployments](SystemProfile.md#rpm_ostree_deployments) -- [running\_processes](SystemProfile.md#running_processes) -- [sap](SystemProfile.md#sap) -- [sap\_instance\_number](SystemProfile.md#sap_instance_number) -- [sap\_sids](SystemProfile.md#sap_sids) -- [sap\_system](SystemProfile.md#sap_system) -- [sap\_version](SystemProfile.md#sap_version) -- [satellite\_managed](SystemProfile.md#satellite_managed) -- [selinux\_config\_file](SystemProfile.md#selinux_config_file) -- [selinux\_current\_mode](SystemProfile.md#selinux_current_mode) -- [subscription\_auto\_attach](SystemProfile.md#subscription_auto_attach) -- [subscription\_status](SystemProfile.md#subscription_status) -- [system\_memory\_bytes](SystemProfile.md#system_memory_bytes) -- [system\_purpose](SystemProfile.md#system_purpose) -- [system\_update\_method](SystemProfile.md#system_update_method) -- [systemd](SystemProfile.md#systemd) -- [third\_party\_services](SystemProfile.md#third_party_services) -- [threads\_per\_core](SystemProfile.md#threads_per_core) -- [tuned\_profile](SystemProfile.md#tuned_profile) -- [virtual\_host\_uuid](SystemProfile.md#virtual_host_uuid) -- [yum\_repos](SystemProfile.md#yum_repos) - -## Properties - -### ansible - -• `Optional` **ansible**: [`SystemProfileAnsible`](SystemProfileAnsible.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1960](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1960) - -___ - -### arch - -• `Optional` **arch**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1732](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1732) - -___ - -### basearch - -• `Optional` **basearch**: `string` - -The architecture family (from yum/dnf) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1738](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1738) - -___ - -### bios\_release\_date - -• `Optional` **bios\_release\_date**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1690](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1690) - -___ - -### bios\_vendor - -• `Optional` **bios\_vendor**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1678](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1678) - -___ - -### bios\_version - -• `Optional` **bios\_version**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1684](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1684) - -___ - -### bootc\_status - -• `Optional` **bootc\_status**: [`SystemProfileBootcStatus`](SystemProfileBootcStatus.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1990](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1990) - -___ - -### captured\_date - -• `Optional` **captured\_date**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1834](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1834) - -___ - -### cloud\_provider - -• `Optional` **cloud\_provider**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1786](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1786) - -___ - -### conversions - -• `Optional` **conversions**: [`SystemProfileConversions`](SystemProfileConversions.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1996](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1996) - -___ - -### cores\_per\_socket - -• `Optional` **cores\_per\_socket**: `number` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1636](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1636) - -___ - -### cpu\_flags - -• `Optional` **cpu\_flags**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1696](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1696) - -___ - -### cpu\_model - -• `Optional` **cpu\_model**: `string` - -The cpu model name - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1618](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1618) - -___ - -### disk\_devices - -• `Optional` **disk\_devices**: [`DiskDevice`](DiskDevice.md)[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1672](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1672) - -___ - -### dnf\_modules - -• `Optional` **dnf\_modules**: [`DnfModule`](DnfModule.md)[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1810](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1810) - -___ - -### enabled\_services - -• `Optional` **enabled\_services**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1864](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1864) - -___ - -### gpg\_pubkeys - -• `Optional` **gpg\_pubkeys**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1852](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1852) - -___ - -### greenboot\_fallback\_detected - -• `Optional` **greenboot\_fallback\_detected**: `boolean` - -Indicates whether greenboot detected a rolled back update on an edge device. - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1936](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1936) - -___ - -### greenboot\_status - -• `Optional` **greenboot\_status**: [`SystemProfileGreenbootStatusEnum`](../enums/SystemProfileGreenbootStatusEnum.md) - -Indicates the greenboot status of an edge device. - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1930](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1930) - -___ - -### host\_type - -• `Optional` **host\_type**: [`Edge`](../enums/SystemProfileHostTypeEnum.md#edge) - -Indicates the type of host. - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1924](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1924) - -___ - -### infrastructure\_type - -• `Optional` **infrastructure\_type**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1654](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1654) - -___ - -### infrastructure\_vendor - -• `Optional` **infrastructure\_vendor**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1660](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1660) - -___ - -### insights\_client\_version - -• `Optional` **insights\_client\_version**: `string` - -The version number of insights client. supports wildcards - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1822](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1822) - -___ - -### insights\_egg\_version - -• `Optional` **insights\_egg\_version**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1828](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1828) - -___ - -### installed\_packages - -• `Optional` **installed\_packages**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1840](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1840) - -___ - -### installed\_packages\_delta - -• `Optional` **installed\_packages\_delta**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1846](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1846) - -___ - -### installed\_products - -• `Optional` **installed\_products**: [`InstalledProduct`](InstalledProduct.md)[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1816](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1816) - -___ - -### installed\_services - -• `Optional` **installed\_services**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1858](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1858) - -___ - -### intersystems - -• `Optional` **intersystems**: [`SystemProfileIntersystems`](SystemProfileIntersystems.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1966](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1966) - -___ - -### is\_marketplace - -• `Optional` **is\_marketplace**: `boolean` - -Indicates whether the host is part of a marketplace install from AWS, Azure, etc. - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1918](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1918) - -___ - -### katello\_agent\_running - -• `Optional` **katello\_agent\_running**: `boolean` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1774](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1774) - -___ - -### kernel\_modules - -• `Optional` **kernel\_modules**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1744](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1744) - -___ - -### last\_boot\_time - -• `Optional` **last\_boot\_time**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1750](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1750) - -___ - -### mssql - -• `Optional` **mssql**: [`SystemProfileMssql`](SystemProfileMssql.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1972](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1972) - -___ - -### network\_interfaces - -• `Optional` **network\_interfaces**: [`NetworkInterface`](NetworkInterface.md)[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1666](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1666) - -___ - -### number\_of\_cpus - -• `Optional` **number\_of\_cpus**: `number` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1624](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1624) - -___ - -### number\_of\_sockets - -• `Optional` **number\_of\_sockets**: `number` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1630](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1630) - -___ - -### operating\_system - -• `Optional` **operating\_system**: [`SystemProfileOperatingSystem`](SystemProfileOperatingSystem.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1708](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1708) - -___ - -### os\_kernel\_version - -• `Optional` **os\_kernel\_version**: `string` - -The kernel version represented with a three, optionally four, number scheme. - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1720](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1720) - -___ - -### os\_release - -• `Optional` **os\_release**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1714](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1714) - -___ - -### owner\_id - -• `Optional` **owner\_id**: `string` - -A UUID associated with the host\'s RHSM certificate - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1600](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1600) - -___ - -### public\_dns - -• `Optional` **public\_dns**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1798](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1798) - -___ - -### public\_ipv4\_addresses - -• `Optional` **public\_ipv4\_addresses**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1792](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1792) - -___ - -### releasever - -• `Optional` **releasever**: `string` - -Release name of the system distribution (from yum/dnf) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1726](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1726) - -___ - -### rhc\_client\_id - -• `Optional` **rhc\_client\_id**: `string` - -A UUID associated with a cloud_connector - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1606](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1606) - -___ - -### rhc\_config\_state - -• `Optional` **rhc\_config\_state**: `string` - -A UUID associated with the config manager state - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1612](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1612) - -___ - -### rhsm - -• `Optional` **rhsm**: [`SystemProfileRhsm`](SystemProfileRhsm.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1948](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1948) - -___ - -### rpm\_ostree\_deployments - -• `Optional` **rpm\_ostree\_deployments**: [`RPMOSTreeDeployment`](RPMOSTreeDeployment.md)[] - -The list of deployments on the system as reported by rpm-ostree status --json - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1942](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1942) - -___ - -### running\_processes - -• `Optional` **running\_processes**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1756](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1756) - -___ - -### sap - -• `Optional` **sap**: [`SystemProfileSap`](SystemProfileSap.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1870](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1870) - -___ - -### sap\_instance\_number - -• `Optional` **sap\_instance\_number**: `string` - -The instance number of the SAP HANA system (a two-digit number between 00 and 99) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1888](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1888) - -___ - -### sap\_sids - -• `Optional` **sap\_sids**: `string`[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1882](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1882) - -___ - -### sap\_system - -• `Optional` **sap\_system**: `boolean` - -Indicates if SAP is installed on the system - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1876](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1876) - -___ - -### sap\_version - -• `Optional` **sap\_version**: `string` - -The version of the SAP HANA lifecycle management program - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1894](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1894) - -___ - -### satellite\_managed - -• `Optional` **satellite\_managed**: `boolean` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1780](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1780) - -___ - -### selinux\_config\_file - -• `Optional` **selinux\_config\_file**: `string` - -The SELinux mode provided in the config file - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1912](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1912) - -___ - -### selinux\_current\_mode - -• `Optional` **selinux\_current\_mode**: [`SystemProfileSelinuxCurrentModeEnum`](../enums/SystemProfileSelinuxCurrentModeEnum.md) - -The current SELinux mode, either enforcing, permissive, or disabled - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1906](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1906) - -___ - -### subscription\_auto\_attach - -• `Optional` **subscription\_auto\_attach**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1768](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1768) - -___ - -### subscription\_status - -• `Optional` **subscription\_status**: `string` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1762](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1762) - -___ - -### system\_memory\_bytes - -• `Optional` **system\_memory\_bytes**: `number` - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1648](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1648) - -___ - -### system\_purpose - -• `Optional` **system\_purpose**: [`SystemProfileSystemPurpose`](SystemProfileSystemPurpose.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1954](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1954) - -___ - -### system\_update\_method - -• `Optional` **system\_update\_method**: [`SystemProfileSystemUpdateMethodEnum`](../enums/SystemProfileSystemUpdateMethodEnum.md) - -System update method - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1978](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1978) - -___ - -### systemd - -• `Optional` **systemd**: [`SystemProfileSystemd`](SystemProfileSystemd.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1702](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1702) - -___ - -### third\_party\_services - -• `Optional` **third\_party\_services**: [`SystemProfileThirdPartyServices`](SystemProfileThirdPartyServices.md) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:2002](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2002) - -___ - -### 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:1642](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1642) - -___ - -### tuned\_profile - -• `Optional` **tuned\_profile**: `string` - -Current profile resulting from command tuned-adm active - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1900](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1900) - -___ - -### virtual\_host\_uuid - -• `Optional` **virtual\_host\_uuid**: `string` - -Hypervisor host identity (subscription manager id) - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1984](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1984) - -___ - -### yum\_repos - -• `Optional` **yum\_repos**: [`YumRepo`](YumRepo.md)[] - -**`Memberof`** - -SystemProfile - -#### Defined in - -[api.ts:1804](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1804) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileAnsible.md b/packages/host-inventory/doc/interfaces/SystemProfileAnsible.md deleted file mode 100644 index cff70a647..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileAnsible.md +++ /dev/null @@ -1,82 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileAnsible - -# Interface: SystemProfileAnsible - -Object containing data specific to Ansible Automation Platform - -**`Export`** - -SystemProfileAnsible - -## Table of contents - -### Properties - -- [catalog\_worker\_version](SystemProfileAnsible.md#catalog_worker_version) -- [controller\_version](SystemProfileAnsible.md#controller_version) -- [hub\_version](SystemProfileAnsible.md#hub_version) -- [sso\_version](SystemProfileAnsible.md#sso_version) - -## Properties - -### catalog\_worker\_version - -• `Optional` **catalog\_worker\_version**: `string` - -The catalog-worker version on the host - -**`Memberof`** - -SystemProfileAnsible - -#### Defined in - -[api.ts:2062](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2062) - -___ - -### controller\_version - -• `Optional` **controller\_version**: `string` - -The ansible-tower or automation-controller version on the host - -**`Memberof`** - -SystemProfileAnsible - -#### Defined in - -[api.ts:2050](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2050) - -___ - -### hub\_version - -• `Optional` **hub\_version**: `string` - -The automation-hub version on the host - -**`Memberof`** - -SystemProfileAnsible - -#### Defined in - -[api.ts:2056](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2056) - -___ - -### sso\_version - -• `Optional` **sso\_version**: `string` - -The SSO version on the host - -**`Memberof`** - -SystemProfileAnsible - -#### Defined in - -[api.ts:2068](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2068) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileBootcStatus.md b/packages/host-inventory/doc/interfaces/SystemProfileBootcStatus.md deleted file mode 100644 index a50f0160a..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileBootcStatus.md +++ /dev/null @@ -1,59 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileBootcStatus - -# Interface: SystemProfileBootcStatus - -Object containing image data from command bootc status - -**`Export`** - -SystemProfileBootcStatus - -## Table of contents - -### Properties - -- [booted](SystemProfileBootcStatus.md#booted) -- [rollback](SystemProfileBootcStatus.md#rollback) -- [staged](SystemProfileBootcStatus.md#staged) - -## Properties - -### booted - -• `Optional` **booted**: [`SystemProfileBootcStatusBooted`](SystemProfileBootcStatusBooted.md) - -**`Memberof`** - -SystemProfileBootcStatus - -#### Defined in - -[api.ts:2081](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2081) - -___ - -### rollback - -• `Optional` **rollback**: [`SystemProfileBootcStatusBooted`](SystemProfileBootcStatusBooted.md) - -**`Memberof`** - -SystemProfileBootcStatus - -#### Defined in - -[api.ts:2087](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2087) - -___ - -### staged - -• `Optional` **staged**: [`SystemProfileBootcStatusBooted`](SystemProfileBootcStatusBooted.md) - -**`Memberof`** - -SystemProfileBootcStatus - -#### Defined in - -[api.ts:2093](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2093) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileBootcStatusBooted.md b/packages/host-inventory/doc/interfaces/SystemProfileBootcStatusBooted.md deleted file mode 100644 index 8770b49b3..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileBootcStatusBooted.md +++ /dev/null @@ -1,80 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileBootcStatusBooted - -# Interface: SystemProfileBootcStatusBooted - -**`Export`** - -SystemProfileBootcStatusBooted - -## Table of contents - -### Properties - -- [cached\_image](SystemProfileBootcStatusBooted.md#cached_image) -- [cached\_image\_digest](SystemProfileBootcStatusBooted.md#cached_image_digest) -- [image](SystemProfileBootcStatusBooted.md#image) -- [image\_digest](SystemProfileBootcStatusBooted.md#image_digest) - -## Properties - -### cached\_image - -• `Optional` **cached\_image**: `string` - -Name of the image - -**`Memberof`** - -SystemProfileBootcStatusBooted - -#### Defined in - -[api.ts:2118](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2118) - -___ - -### cached\_image\_digest - -• `Optional` **cached\_image\_digest**: `string` - -Digest of the image - -**`Memberof`** - -SystemProfileBootcStatusBooted - -#### Defined in - -[api.ts:2124](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2124) - -___ - -### image - -• `Optional` **image**: `string` - -Name of the image - -**`Memberof`** - -SystemProfileBootcStatusBooted - -#### Defined in - -[api.ts:2106](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2106) - -___ - -### image\_digest - -• `Optional` **image\_digest**: `string` - -Digest of the image - -**`Memberof`** - -SystemProfileBootcStatusBooted - -#### Defined in - -[api.ts:2112](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2112) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileByHostOut.md b/packages/host-inventory/doc/interfaces/SystemProfileByHostOut.md deleted file mode 100644 index 04786a151..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileByHostOut.md +++ /dev/null @@ -1,99 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileByHostOut - -# Interface: SystemProfileByHostOut - -Structure of the output of the host system profile query - -**`Export`** - -SystemProfileByHostOut - -## Table of contents - -### Properties - -- [count](SystemProfileByHostOut.md#count) -- [page](SystemProfileByHostOut.md#page) -- [per\_page](SystemProfileByHostOut.md#per_page) -- [results](SystemProfileByHostOut.md#results) -- [total](SystemProfileByHostOut.md#total) - -## Properties - -### count - -• **count**: `number` - -The number of items on the current page - -**`Memberof`** - -SystemProfileByHostOut - -#### Defined in - -[api.ts:2137](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2137) - -___ - -### page - -• **page**: `number` - -The page number - -**`Memberof`** - -SystemProfileByHostOut - -#### Defined in - -[api.ts:2143](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2143) - -___ - -### per\_page - -• **per\_page**: `number` - -The number of items to return per page - -**`Memberof`** - -SystemProfileByHostOut - -#### Defined in - -[api.ts:2149](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2149) - -___ - -### results - -• **results**: [`HostSystemProfileOut`](HostSystemProfileOut.md)[] - -Actual host search query result entries. - -**`Memberof`** - -SystemProfileByHostOut - -#### Defined in - -[api.ts:2161](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2161) - -___ - -### total - -• **total**: `number` - -Total number of items - -**`Memberof`** - -SystemProfileByHostOut - -#### Defined in - -[api.ts:2155](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2155) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileByHostOutAllOf.md b/packages/host-inventory/doc/interfaces/SystemProfileByHostOutAllOf.md deleted file mode 100644 index 3fc49ff14..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileByHostOutAllOf.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileByHostOutAllOf - -# Interface: SystemProfileByHostOutAllOf - -**`Export`** - -SystemProfileByHostOutAllOf - -## Table of contents - -### Properties - -- [results](SystemProfileByHostOutAllOf.md#results) - -## Properties - -### results - -• **results**: [`HostSystemProfileOut`](HostSystemProfileOut.md)[] - -Actual host search query result entries. - -**`Memberof`** - -SystemProfileByHostOutAllOf - -#### Defined in - -[api.ts:2174](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2174) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileConversions.md b/packages/host-inventory/doc/interfaces/SystemProfileConversions.md deleted file mode 100644 index c1eaa02a6..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileConversions.md +++ /dev/null @@ -1,31 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileConversions - -# Interface: SystemProfileConversions - -Object containing information about 3rd party migration on instances - -**`Export`** - -SystemProfileConversions - -## Table of contents - -### Properties - -- [activity](SystemProfileConversions.md#activity) - -## Properties - -### activity - -• `Optional` **activity**: `boolean` - -Whether the conversion activity has been done or not - -**`Memberof`** - -SystemProfileConversions - -#### Defined in - -[api.ts:2187](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2187) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileDiskDevice.md b/packages/host-inventory/doc/interfaces/SystemProfileDiskDevice.md deleted file mode 100644 index 2ba84c553..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileDiskDevice.md +++ /dev/null @@ -1,101 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileDiskDevice - -# Interface: SystemProfileDiskDevice - -Representation of one mounted device - -**`Export`** - -SystemProfileDiskDevice - -## Table of contents - -### Properties - -- [device](SystemProfileDiskDevice.md#device) -- [label](SystemProfileDiskDevice.md#label) -- [mount\_point](SystemProfileDiskDevice.md#mount_point) -- [options](SystemProfileDiskDevice.md#options) -- [type](SystemProfileDiskDevice.md#type) - -## Properties - -### device - -• `Optional` **device**: `string` - -**`Memberof`** - -SystemProfileDiskDevice - -#### Defined in - -[api.ts:2200](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2200) - -___ - -### label - -• `Optional` **label**: `string` - -User-defined mount label - -**`Memberof`** - -SystemProfileDiskDevice - -#### Defined in - -[api.ts:2206](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2206) - -___ - -### mount\_point - -• `Optional` **mount\_point**: `string` - -The mount point - -**`Memberof`** - -SystemProfileDiskDevice - -#### Defined in - -[api.ts:2218](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2218) - -___ - -### options - -• `Optional` **options**: `Object` - -An arbitrary object that does not allow empty string keys. - -**`Memberof`** - -SystemProfileDiskDevice - -#### Index signature - -▪ [key: `string`]: `object` - -#### Defined in - -[api.ts:2212](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2212) - -___ - -### type - -• `Optional` **type**: `string` - -The mount type - -**`Memberof`** - -SystemProfileDiskDevice - -#### Defined in - -[api.ts:2224](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2224) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileDnfModule.md b/packages/host-inventory/doc/interfaces/SystemProfileDnfModule.md deleted file mode 100644 index bbfc64b84..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileDnfModule.md +++ /dev/null @@ -1,44 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileDnfModule - -# Interface: SystemProfileDnfModule - -Representation of one DNF module - -**`Export`** - -SystemProfileDnfModule - -## Table of contents - -### Properties - -- [name](SystemProfileDnfModule.md#name) -- [stream](SystemProfileDnfModule.md#stream) - -## Properties - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -SystemProfileDnfModule - -#### Defined in - -[api.ts:2237](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2237) - -___ - -### stream - -• `Optional` **stream**: `string` - -**`Memberof`** - -SystemProfileDnfModule - -#### Defined in - -[api.ts:2243](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2243) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileInstalledProduct.md b/packages/host-inventory/doc/interfaces/SystemProfileInstalledProduct.md deleted file mode 100644 index fca65aa74..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileInstalledProduct.md +++ /dev/null @@ -1,63 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileInstalledProduct - -# Interface: SystemProfileInstalledProduct - -Representation of one installed product - -**`Export`** - -SystemProfileInstalledProduct - -## Table of contents - -### Properties - -- [id](SystemProfileInstalledProduct.md#id) -- [name](SystemProfileInstalledProduct.md#name) -- [status](SystemProfileInstalledProduct.md#status) - -## Properties - -### id - -• `Optional` **id**: `string` - -The product ID - -**`Memberof`** - -SystemProfileInstalledProduct - -#### Defined in - -[api.ts:2262](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2262) - -___ - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -SystemProfileInstalledProduct - -#### Defined in - -[api.ts:2256](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2256) - -___ - -### status - -• `Optional` **status**: `string` - -Subscription status for product - -**`Memberof`** - -SystemProfileInstalledProduct - -#### Defined in - -[api.ts:2268](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2268) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileIntersystems.md b/packages/host-inventory/doc/interfaces/SystemProfileIntersystems.md deleted file mode 100644 index ea045b92e..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileIntersystems.md +++ /dev/null @@ -1,46 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileIntersystems - -# Interface: SystemProfileIntersystems - -Object containing data specific to InterSystems workload - -**`Export`** - -SystemProfileIntersystems - -## Table of contents - -### Properties - -- [is\_intersystems](SystemProfileIntersystems.md#is_intersystems) -- [running\_instances](SystemProfileIntersystems.md#running_instances) - -## Properties - -### is\_intersystems - -• `Optional` **is\_intersystems**: `boolean` - -Indicates if InterSystems is installed on the system - -**`Memberof`** - -SystemProfileIntersystems - -#### Defined in - -[api.ts:2281](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2281) - -___ - -### running\_instances - -• `Optional` **running\_instances**: [`InterSystemsRunningInstance`](InterSystemsRunningInstance.md)[] - -**`Memberof`** - -SystemProfileIntersystems - -#### Defined in - -[api.ts:2287](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2287) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileMssql.md b/packages/host-inventory/doc/interfaces/SystemProfileMssql.md deleted file mode 100644 index db83cb7f2..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileMssql.md +++ /dev/null @@ -1,31 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileMssql - -# Interface: SystemProfileMssql - -Object containing data specific to the MS SQL workload - -**`Export`** - -SystemProfileMssql - -## Table of contents - -### Properties - -- [version](SystemProfileMssql.md#version) - -## Properties - -### version - -• `Optional` **version**: `string` - -MSSQL version number - -**`Memberof`** - -SystemProfileMssql - -#### Defined in - -[api.ts:2300](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2300) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileNetworkInterface.md b/packages/host-inventory/doc/interfaces/SystemProfileNetworkInterface.md deleted file mode 100644 index 00f4ea99a..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileNetworkInterface.md +++ /dev/null @@ -1,129 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileNetworkInterface - -# Interface: SystemProfileNetworkInterface - -Representation of one network interface - -**`Export`** - -SystemProfileNetworkInterface - -## Table of contents - -### Properties - -- [ipv4\_addresses](SystemProfileNetworkInterface.md#ipv4_addresses) -- [ipv6\_addresses](SystemProfileNetworkInterface.md#ipv6_addresses) -- [mac\_address](SystemProfileNetworkInterface.md#mac_address) -- [mtu](SystemProfileNetworkInterface.md#mtu) -- [name](SystemProfileNetworkInterface.md#name) -- [state](SystemProfileNetworkInterface.md#state) -- [type](SystemProfileNetworkInterface.md#type) - -## Properties - -### ipv4\_addresses - -• `Optional` **ipv4\_addresses**: `string`[] - -**`Memberof`** - -SystemProfileNetworkInterface - -#### Defined in - -[api.ts:2313](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2313) - -___ - -### ipv6\_addresses - -• `Optional` **ipv6\_addresses**: `string`[] - -**`Memberof`** - -SystemProfileNetworkInterface - -#### Defined in - -[api.ts:2319](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2319) - -___ - -### mac\_address - -• `Optional` **mac\_address**: `string` - -MAC address (with or without colons) - -**`Memberof`** - -SystemProfileNetworkInterface - -#### Defined in - -[api.ts:2331](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2331) - -___ - -### mtu - -• `Optional` **mtu**: `number` - -MTU (Maximum transmission unit) - -**`Memberof`** - -SystemProfileNetworkInterface - -#### Defined in - -[api.ts:2325](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2325) - -___ - -### name - -• `Optional` **name**: `string` - -Name of interface - -**`Memberof`** - -SystemProfileNetworkInterface - -#### Defined in - -[api.ts:2337](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2337) - -___ - -### state - -• `Optional` **state**: `string` - -Interface state (UP, DOWN, UNKNOWN) - -**`Memberof`** - -SystemProfileNetworkInterface - -#### Defined in - -[api.ts:2343](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2343) - -___ - -### type - -• `Optional` **type**: `string` - -Interface type (ether, loopback) - -**`Memberof`** - -SystemProfileNetworkInterface - -#### Defined in - -[api.ts:2349](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2349) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystem.md b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystem.md deleted file mode 100644 index 322d6e6b6..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystem.md +++ /dev/null @@ -1,65 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileOperatingSystem - -# Interface: SystemProfileOperatingSystem - -Object for OS details. Supports range operations - -**`Export`** - -SystemProfileOperatingSystem - -## Table of contents - -### Properties - -- [major](SystemProfileOperatingSystem.md#major) -- [minor](SystemProfileOperatingSystem.md#minor) -- [name](SystemProfileOperatingSystem.md#name) - -## Properties - -### major - -• **major**: `number` - -Major release of OS (aka the x version) - -**`Memberof`** - -SystemProfileOperatingSystem - -#### Defined in - -[api.ts:2362](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2362) - -___ - -### minor - -• **minor**: `number` - -Minor release of OS (aka the y version) - -**`Memberof`** - -SystemProfileOperatingSystem - -#### Defined in - -[api.ts:2368](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2368) - -___ - -### name - -• **name**: [`SystemProfileOperatingSystemNameEnum`](../enums/SystemProfileOperatingSystemNameEnum.md) - -Name of the distro/os - -**`Memberof`** - -SystemProfileOperatingSystem - -#### Defined in - -[api.ts:2374](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2374) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOut.md b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOut.md deleted file mode 100644 index fa24b7436..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOut.md +++ /dev/null @@ -1,63 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileOperatingSystemOut - -# Interface: SystemProfileOperatingSystemOut - -**`Export`** - -SystemProfileOperatingSystemOut - -## Table of contents - -### Properties - -- [count](SystemProfileOperatingSystemOut.md#count) -- [results](SystemProfileOperatingSystemOut.md#results) -- [total](SystemProfileOperatingSystemOut.md#total) - -## Properties - -### count - -• `Optional` **count**: `number` - -The number of items on the current page - -**`Memberof`** - -SystemProfileOperatingSystemOut - -#### Defined in - -[api.ts:2404](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2404) - -___ - -### results - -• `Optional` **results**: [`SystemProfileOperatingSystemOutResults`](SystemProfileOperatingSystemOutResults.md)[] - -The list of operating_system values on the account - -**`Memberof`** - -SystemProfileOperatingSystemOut - -#### Defined in - -[api.ts:2410](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2410) - -___ - -### total - -• `Optional` **total**: `number` - -Total number of items - -**`Memberof`** - -SystemProfileOperatingSystemOut - -#### Defined in - -[api.ts:2398](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2398) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutResults.md b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutResults.md deleted file mode 100644 index 0b2e09d9a..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutResults.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileOperatingSystemOutResults - -# Interface: SystemProfileOperatingSystemOutResults - -**`Export`** - -SystemProfileOperatingSystemOutResults - -## Table of contents - -### Properties - -- [count](SystemProfileOperatingSystemOutResults.md#count) -- [value](SystemProfileOperatingSystemOutResults.md#value) - -## Properties - -### count - -• `Optional` **count**: `number` - -**`Memberof`** - -SystemProfileOperatingSystemOutResults - -#### Defined in - -[api.ts:2429](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2429) - -___ - -### value - -• `Optional` **value**: [`SystemProfileOperatingSystemOutValue`](SystemProfileOperatingSystemOutValue.md) - -**`Memberof`** - -SystemProfileOperatingSystemOutResults - -#### Defined in - -[api.ts:2423](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2423) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutValue.md b/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutValue.md deleted file mode 100644 index af3d77b38..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileOperatingSystemOutValue.md +++ /dev/null @@ -1,57 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileOperatingSystemOutValue - -# Interface: SystemProfileOperatingSystemOutValue - -**`Export`** - -SystemProfileOperatingSystemOutValue - -## Table of contents - -### Properties - -- [major](SystemProfileOperatingSystemOutValue.md#major) -- [minor](SystemProfileOperatingSystemOutValue.md#minor) -- [name](SystemProfileOperatingSystemOutValue.md#name) - -## Properties - -### major - -• `Optional` **major**: ``null`` \| `number` - -**`Memberof`** - -SystemProfileOperatingSystemOutValue - -#### Defined in - -[api.ts:2448](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2448) - -___ - -### minor - -• `Optional` **minor**: ``null`` \| `number` - -**`Memberof`** - -SystemProfileOperatingSystemOutValue - -#### Defined in - -[api.ts:2454](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2454) - -___ - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -SystemProfileOperatingSystemOutValue - -#### Defined in - -[api.ts:2442](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2442) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileRhsm.md b/packages/host-inventory/doc/interfaces/SystemProfileRhsm.md deleted file mode 100644 index 685b129d9..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileRhsm.md +++ /dev/null @@ -1,31 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileRhsm - -# Interface: SystemProfileRhsm - -Object for subscription-manager details - -**`Export`** - -SystemProfileRhsm - -## Table of contents - -### Properties - -- [version](SystemProfileRhsm.md#version) - -## Properties - -### version - -• `Optional` **version**: `string` - -System release set by subscription-manager - -**`Memberof`** - -SystemProfileRhsm - -#### Defined in - -[api.ts:2467](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2467) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSap.md b/packages/host-inventory/doc/interfaces/SystemProfileSap.md deleted file mode 100644 index 89d4ab74e..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileSap.md +++ /dev/null @@ -1,80 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSap - -# Interface: SystemProfileSap - -Object containing data specific to the SAP workload - -**`Export`** - -SystemProfileSap - -## Table of contents - -### Properties - -- [instance\_number](SystemProfileSap.md#instance_number) -- [sap\_system](SystemProfileSap.md#sap_system) -- [sids](SystemProfileSap.md#sids) -- [version](SystemProfileSap.md#version) - -## Properties - -### instance\_number - -• `Optional` **instance\_number**: `string` - -The instance number of the SAP HANA system (a two-digit number between 00 and 99) - -**`Memberof`** - -SystemProfileSap - -#### Defined in - -[api.ts:2492](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2492) - -___ - -### sap\_system - -• `Optional` **sap\_system**: `boolean` - -Indicates if SAP is installed on the system - -**`Memberof`** - -SystemProfileSap - -#### Defined in - -[api.ts:2480](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2480) - -___ - -### sids - -• `Optional` **sids**: `string`[] - -**`Memberof`** - -SystemProfileSap - -#### Defined in - -[api.ts:2486](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2486) - -___ - -### version - -• `Optional` **version**: `string` - -The version of the SAP HANA lifecycle management program - -**`Memberof`** - -SystemProfileSap - -#### Defined in - -[api.ts:2498](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2498) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOut.md b/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOut.md deleted file mode 100644 index cf23d2e85..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOut.md +++ /dev/null @@ -1,63 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSapSystemOut - -# Interface: SystemProfileSapSystemOut - -**`Export`** - -SystemProfileSapSystemOut - -## Table of contents - -### Properties - -- [count](SystemProfileSapSystemOut.md#count) -- [results](SystemProfileSapSystemOut.md#results) -- [total](SystemProfileSapSystemOut.md#total) - -## Properties - -### count - -• `Optional` **count**: `number` - -The number of items on the current page - -**`Memberof`** - -SystemProfileSapSystemOut - -#### Defined in - -[api.ts:2517](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2517) - -___ - -### results - -• `Optional` **results**: [`SystemProfileSapSystemOutResults`](SystemProfileSapSystemOutResults.md)[] - -The list of sap_system values on the account - -**`Memberof`** - -SystemProfileSapSystemOut - -#### Defined in - -[api.ts:2523](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2523) - -___ - -### total - -• `Optional` **total**: `number` - -Total number of items - -**`Memberof`** - -SystemProfileSapSystemOut - -#### Defined in - -[api.ts:2511](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2511) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOutResults.md b/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOutResults.md deleted file mode 100644 index 3b883c084..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileSapSystemOutResults.md +++ /dev/null @@ -1,42 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSapSystemOutResults - -# Interface: SystemProfileSapSystemOutResults - -**`Export`** - -SystemProfileSapSystemOutResults - -## Table of contents - -### Properties - -- [count](SystemProfileSapSystemOutResults.md#count) -- [value](SystemProfileSapSystemOutResults.md#value) - -## Properties - -### count - -• `Optional` **count**: `number` - -**`Memberof`** - -SystemProfileSapSystemOutResults - -#### Defined in - -[api.ts:2542](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2542) - -___ - -### value - -• `Optional` **value**: `string` \| `boolean` - -**`Memberof`** - -SystemProfileSapSystemOutResults - -#### Defined in - -[api.ts:2536](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2536) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSystemPurpose.md b/packages/host-inventory/doc/interfaces/SystemProfileSystemPurpose.md deleted file mode 100644 index 6f71d9fa0..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileSystemPurpose.md +++ /dev/null @@ -1,65 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSystemPurpose - -# Interface: SystemProfileSystemPurpose - -Object for system purpose information - -**`Export`** - -SystemProfileSystemPurpose - -## Table of contents - -### Properties - -- [role](SystemProfileSystemPurpose.md#role) -- [sla](SystemProfileSystemPurpose.md#sla) -- [usage](SystemProfileSystemPurpose.md#usage) - -## Properties - -### role - -• `Optional` **role**: [`SystemProfileSystemPurposeRoleEnum`](../enums/SystemProfileSystemPurposeRoleEnum.md) - -The intended role of the system - -**`Memberof`** - -SystemProfileSystemPurpose - -#### Defined in - -[api.ts:2561](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2561) - -___ - -### sla - -• `Optional` **sla**: [`SystemProfileSystemPurposeSlaEnum`](../enums/SystemProfileSystemPurposeSlaEnum.md) - -The intended SLA of the system - -**`Memberof`** - -SystemProfileSystemPurpose - -#### Defined in - -[api.ts:2567](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2567) - -___ - -### usage - -• `Optional` **usage**: [`SystemProfileSystemPurposeUsageEnum`](../enums/SystemProfileSystemPurposeUsageEnum.md) - -The intended usage of the system - -**`Memberof`** - -SystemProfileSystemPurpose - -#### Defined in - -[api.ts:2555](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2555) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileSystemd.md b/packages/host-inventory/doc/interfaces/SystemProfileSystemd.md deleted file mode 100644 index 414baa70b..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileSystemd.md +++ /dev/null @@ -1,82 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileSystemd - -# Interface: SystemProfileSystemd - -Object for whole system systemd state, as reported by systemctl status --all - -**`Export`** - -SystemProfileSystemd - -## Table of contents - -### Properties - -- [failed](SystemProfileSystemd.md#failed) -- [failed\_services](SystemProfileSystemd.md#failed_services) -- [jobs\_queued](SystemProfileSystemd.md#jobs_queued) -- [state](SystemProfileSystemd.md#state) - -## Properties - -### failed - -• **failed**: `number` - -The number of jobs failed - -**`Memberof`** - -SystemProfileSystemd - -#### Defined in - -[api.ts:2621](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2621) - -___ - -### failed\_services - -• `Optional` **failed\_services**: `string`[] - -List of all failed jobs. - -**`Memberof`** - -SystemProfileSystemd - -#### Defined in - -[api.ts:2627](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2627) - -___ - -### jobs\_queued - -• **jobs\_queued**: `number` - -The number of jobs jobs_queued - -**`Memberof`** - -SystemProfileSystemd - -#### Defined in - -[api.ts:2615](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2615) - -___ - -### state - -• **state**: [`SystemProfileSystemdStateEnum`](../enums/SystemProfileSystemdStateEnum.md) - -The state of the systemd subsystem - -**`Memberof`** - -SystemProfileSystemd - -#### Defined in - -[api.ts:2609](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2609) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileThirdPartyServices.md b/packages/host-inventory/doc/interfaces/SystemProfileThirdPartyServices.md deleted file mode 100644 index f49e0c6fb..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileThirdPartyServices.md +++ /dev/null @@ -1,29 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileThirdPartyServices - -# Interface: SystemProfileThirdPartyServices - -Object containing information about system facts of third party services - -**`Export`** - -SystemProfileThirdPartyServices - -## Table of contents - -### Properties - -- [crowdstrike](SystemProfileThirdPartyServices.md#crowdstrike) - -## Properties - -### crowdstrike - -• `Optional` **crowdstrike**: [`SystemProfileThirdPartyServicesCrowdstrike`](SystemProfileThirdPartyServicesCrowdstrike.md) - -**`Memberof`** - -SystemProfileThirdPartyServices - -#### Defined in - -[api.ts:2654](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2654) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileThirdPartyServicesCrowdstrike.md b/packages/host-inventory/doc/interfaces/SystemProfileThirdPartyServicesCrowdstrike.md deleted file mode 100644 index ba438411d..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileThirdPartyServicesCrowdstrike.md +++ /dev/null @@ -1,48 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileThirdPartyServicesCrowdstrike - -# Interface: SystemProfileThirdPartyServicesCrowdstrike - -Object containing information about CrowdStrike system facts - -**`Export`** - -SystemProfileThirdPartyServicesCrowdstrike - -## Table of contents - -### Properties - -- [falcon\_aid](SystemProfileThirdPartyServicesCrowdstrike.md#falcon_aid) -- [falcon\_backend](SystemProfileThirdPartyServicesCrowdstrike.md#falcon_backend) - -## Properties - -### falcon\_aid - -• `Optional` **falcon\_aid**: `string` - -CrowdStrike Falcon Agent ID - -**`Memberof`** - -SystemProfileThirdPartyServicesCrowdstrike - -#### Defined in - -[api.ts:2667](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2667) - -___ - -### falcon\_backend - -• `Optional` **falcon\_backend**: `string` - -CrowdStrike Falcon Sensor backend - -**`Memberof`** - -SystemProfileThirdPartyServicesCrowdstrike - -#### Defined in - -[api.ts:2673](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2673) diff --git a/packages/host-inventory/doc/interfaces/SystemProfileYumRepo.md b/packages/host-inventory/doc/interfaces/SystemProfileYumRepo.md deleted file mode 100644 index e140e2cc3..000000000 --- a/packages/host-inventory/doc/interfaces/SystemProfileYumRepo.md +++ /dev/null @@ -1,106 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / SystemProfileYumRepo - -# Interface: SystemProfileYumRepo - -Representation of one yum repository - -**`Export`** - -SystemProfileYumRepo - -## Table of contents - -### Properties - -- [base\_url](SystemProfileYumRepo.md#base_url) -- [enabled](SystemProfileYumRepo.md#enabled) -- [gpgcheck](SystemProfileYumRepo.md#gpgcheck) -- [id](SystemProfileYumRepo.md#id) -- [mirrorlist](SystemProfileYumRepo.md#mirrorlist) -- [name](SystemProfileYumRepo.md#name) - -## Properties - -### base\_url - -• `Optional` **base\_url**: `string` - -**`Memberof`** - -SystemProfileYumRepo - -#### Defined in - -[api.ts:2710](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2710) - -___ - -### enabled - -• `Optional` **enabled**: `boolean` - -**`Memberof`** - -SystemProfileYumRepo - -#### Defined in - -[api.ts:2704](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2704) - -___ - -### gpgcheck - -• `Optional` **gpgcheck**: `boolean` - -**`Memberof`** - -SystemProfileYumRepo - -#### Defined in - -[api.ts:2698](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2698) - -___ - -### id - -• `Optional` **id**: `string` - -**`Memberof`** - -SystemProfileYumRepo - -#### Defined in - -[api.ts:2686](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2686) - -___ - -### mirrorlist - -• `Optional` **mirrorlist**: `string` - -URL of a mirrorlist for the repository - -**`Memberof`** - -SystemProfileYumRepo - -#### Defined in - -[api.ts:2716](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2716) - -___ - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -SystemProfileYumRepo - -#### Defined in - -[api.ts:2692](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2692) diff --git a/packages/host-inventory/doc/interfaces/TagCountOut.md b/packages/host-inventory/doc/interfaces/TagCountOut.md deleted file mode 100644 index f732e0155..000000000 --- a/packages/host-inventory/doc/interfaces/TagCountOut.md +++ /dev/null @@ -1,101 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / TagCountOut - -# Interface: TagCountOut - -**`Export`** - -TagCountOut - -## Table of contents - -### Properties - -- [count](TagCountOut.md#count) -- [page](TagCountOut.md#page) -- [per\_page](TagCountOut.md#per_page) -- [results](TagCountOut.md#results) -- [total](TagCountOut.md#total) - -## Properties - -### count - -• **count**: `number` - -The number of items on the current page - -**`Memberof`** - -TagCountOut - -#### Defined in - -[api.ts:2729](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2729) - -___ - -### page - -• **page**: `number` - -The page number - -**`Memberof`** - -TagCountOut - -#### Defined in - -[api.ts:2735](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2735) - -___ - -### per\_page - -• **per\_page**: `number` - -The number of items to return per page - -**`Memberof`** - -TagCountOut - -#### Defined in - -[api.ts:2741](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2741) - -___ - -### results - -• `Optional` **results**: `Object` - -The list of tags on the systems - -**`Memberof`** - -TagCountOut - -#### Index signature - -▪ [key: `string`]: `number` - -#### Defined in - -[api.ts:2753](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2753) - -___ - -### total - -• **total**: `number` - -Total number of items - -**`Memberof`** - -TagCountOut - -#### Defined in - -[api.ts:2747](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2747) diff --git a/packages/host-inventory/doc/interfaces/TagCountOutAllOf.md b/packages/host-inventory/doc/interfaces/TagCountOutAllOf.md deleted file mode 100644 index 786d59c47..000000000 --- a/packages/host-inventory/doc/interfaces/TagCountOutAllOf.md +++ /dev/null @@ -1,33 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / TagCountOutAllOf - -# Interface: TagCountOutAllOf - -**`Export`** - -TagCountOutAllOf - -## Table of contents - -### Properties - -- [results](TagCountOutAllOf.md#results) - -## Properties - -### results - -• `Optional` **results**: `Object` - -The list of tags on the systems - -**`Memberof`** - -TagCountOutAllOf - -#### Index signature - -▪ [key: `string`]: `number` - -#### Defined in - -[api.ts:2766](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2766) diff --git a/packages/host-inventory/doc/interfaces/TagsOut.md b/packages/host-inventory/doc/interfaces/TagsOut.md deleted file mode 100644 index 823b4ded0..000000000 --- a/packages/host-inventory/doc/interfaces/TagsOut.md +++ /dev/null @@ -1,101 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / TagsOut - -# Interface: TagsOut - -**`Export`** - -TagsOut - -## Table of contents - -### Properties - -- [count](TagsOut.md#count) -- [page](TagsOut.md#page) -- [per\_page](TagsOut.md#per_page) -- [results](TagsOut.md#results) -- [total](TagsOut.md#total) - -## Properties - -### count - -• **count**: `number` - -The number of items on the current page - -**`Memberof`** - -TagsOut - -#### Defined in - -[api.ts:2779](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2779) - -___ - -### page - -• **page**: `number` - -The page number - -**`Memberof`** - -TagsOut - -#### Defined in - -[api.ts:2785](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2785) - -___ - -### per\_page - -• **per\_page**: `number` - -The number of items to return per page - -**`Memberof`** - -TagsOut - -#### Defined in - -[api.ts:2791](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2791) - -___ - -### results - -• `Optional` **results**: `Object` - -The list of tags on the systems - -**`Memberof`** - -TagsOut - -#### Index signature - -▪ [key: `string`]: [`StructuredTag`](StructuredTag.md)[] - -#### Defined in - -[api.ts:2803](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2803) - -___ - -### total - -• **total**: `number` - -Total number of items - -**`Memberof`** - -TagsOut - -#### Defined in - -[api.ts:2797](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2797) diff --git a/packages/host-inventory/doc/interfaces/TagsOutAllOf.md b/packages/host-inventory/doc/interfaces/TagsOutAllOf.md deleted file mode 100644 index 3f8a552dd..000000000 --- a/packages/host-inventory/doc/interfaces/TagsOutAllOf.md +++ /dev/null @@ -1,33 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / TagsOutAllOf - -# Interface: TagsOutAllOf - -**`Export`** - -TagsOutAllOf - -## Table of contents - -### Properties - -- [results](TagsOutAllOf.md#results) - -## Properties - -### results - -• `Optional` **results**: `Object` - -The list of tags on the systems - -**`Memberof`** - -TagsOutAllOf - -#### Index signature - -▪ [key: `string`]: [`StructuredTag`](StructuredTag.md)[] - -#### Defined in - -[api.ts:2816](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2816) diff --git a/packages/host-inventory/doc/interfaces/UnleashToggleOut.md b/packages/host-inventory/doc/interfaces/UnleashToggleOut.md deleted file mode 100644 index 4798b800c..000000000 --- a/packages/host-inventory/doc/interfaces/UnleashToggleOut.md +++ /dev/null @@ -1,46 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / UnleashToggleOut - -# Interface: UnleashToggleOut - -**`Export`** - -UnleashToggleOut - -## Table of contents - -### Properties - -- [flag\_value](UnleashToggleOut.md#flag_value) -- [using\_fallback\_value](UnleashToggleOut.md#using_fallback_value) - -## Properties - -### flag\_value - -• `Optional` **flag\_value**: `boolean` - -The value of the feature flag toggle - -**`Memberof`** - -UnleashToggleOut - -#### Defined in - -[api.ts:2829](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2829) - -___ - -### using\_fallback\_value - -• `Optional` **using\_fallback\_value**: `boolean` - -Whether the fallback value was used, if the Unleash server could not be accessed - -**`Memberof`** - -UnleashToggleOut - -#### Defined in - -[api.ts:2835](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2835) diff --git a/packages/host-inventory/doc/interfaces/YumRepo.md b/packages/host-inventory/doc/interfaces/YumRepo.md deleted file mode 100644 index a59fb4b45..000000000 --- a/packages/host-inventory/doc/interfaces/YumRepo.md +++ /dev/null @@ -1,106 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](../README.md) / [Exports](../modules.md) / YumRepo - -# Interface: YumRepo - -Representation of one yum repository - -**`Export`** - -YumRepo - -## Table of contents - -### Properties - -- [base\_url](YumRepo.md#base_url) -- [enabled](YumRepo.md#enabled) -- [gpgcheck](YumRepo.md#gpgcheck) -- [id](YumRepo.md#id) -- [mirrorlist](YumRepo.md#mirrorlist) -- [name](YumRepo.md#name) - -## Properties - -### base\_url - -• `Optional` **base\_url**: `string` - -**`Memberof`** - -YumRepo - -#### Defined in - -[api.ts:2872](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2872) - -___ - -### enabled - -• `Optional` **enabled**: `boolean` - -**`Memberof`** - -YumRepo - -#### Defined in - -[api.ts:2866](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2866) - -___ - -### gpgcheck - -• `Optional` **gpgcheck**: `boolean` - -**`Memberof`** - -YumRepo - -#### Defined in - -[api.ts:2860](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2860) - -___ - -### id - -• `Optional` **id**: `string` - -**`Memberof`** - -YumRepo - -#### Defined in - -[api.ts:2848](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2848) - -___ - -### mirrorlist - -• `Optional` **mirrorlist**: `string` - -URL of a mirrorlist for the repository - -**`Memberof`** - -YumRepo - -#### Defined in - -[api.ts:2878](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2878) - -___ - -### name - -• `Optional` **name**: `string` - -**`Memberof`** - -YumRepo - -#### Defined in - -[api.ts:2854](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2854) diff --git a/packages/host-inventory/doc/modules.md b/packages/host-inventory/doc/modules.md deleted file mode 100644 index 57ef6091e..000000000 --- a/packages/host-inventory/doc/modules.md +++ /dev/null @@ -1,749 +0,0 @@ -[@redhat-cloud-services/host-inventory-client](README.md) / Exports - -# @redhat-cloud-services/host-inventory-client - -## Table of contents - -### Enumerations - -- [SystemDefaultId](enums/SystemDefaultId.md) -- [SystemProfileGreenbootStatusEnum](enums/SystemProfileGreenbootStatusEnum.md) -- [SystemProfileHostTypeEnum](enums/SystemProfileHostTypeEnum.md) -- [SystemProfileOperatingSystemNameEnum](enums/SystemProfileOperatingSystemNameEnum.md) -- [SystemProfileSelinuxCurrentModeEnum](enums/SystemProfileSelinuxCurrentModeEnum.md) -- [SystemProfileSystemPurposeRoleEnum](enums/SystemProfileSystemPurposeRoleEnum.md) -- [SystemProfileSystemPurposeSlaEnum](enums/SystemProfileSystemPurposeSlaEnum.md) -- [SystemProfileSystemPurposeUsageEnum](enums/SystemProfileSystemPurposeUsageEnum.md) -- [SystemProfileSystemUpdateMethodEnum](enums/SystemProfileSystemUpdateMethodEnum.md) -- [SystemProfileSystemdStateEnum](enums/SystemProfileSystemdStateEnum.md) - -### Classes - -- [AccountsStalenessApi](classes/AccountsStalenessApi.md) -- [Configuration](classes/Configuration.md) -- [GroupsApi](classes/GroupsApi.md) -- [HostsApi](classes/HostsApi.md) -- [ResourceTypesApi](classes/ResourceTypesApi.md) -- [SystemProfileApi](classes/SystemProfileApi.md) -- [TagsApi](classes/TagsApi.md) - -### Interfaces - -- [ActiveTag](interfaces/ActiveTag.md) -- [ActiveTags](interfaces/ActiveTags.md) -- [ActiveTagsAllOf](interfaces/ActiveTagsAllOf.md) -- [AssignmentRuleIn](interfaces/AssignmentRuleIn.md) -- [AssignmentRuleOut](interfaces/AssignmentRuleOut.md) -- [AssignmentRuleQueryOutput](interfaces/AssignmentRuleQueryOutput.md) -- [AssignmentRuleQueryOutputAllOf](interfaces/AssignmentRuleQueryOutputAllOf.md) -- [CanonicalFactsIn](interfaces/CanonicalFactsIn.md) -- [CanonicalFactsInAllOf](interfaces/CanonicalFactsInAllOf.md) -- [CanonicalFactsOut](interfaces/CanonicalFactsOut.md) -- [ConfigurationParameters](interfaces/ConfigurationParameters.md) -- [CreateCheckIn](interfaces/CreateCheckIn.md) -- [CreateCheckInAllOf](interfaces/CreateCheckInAllOf.md) -- [DiskDevice](interfaces/DiskDevice.md) -- [DnfModule](interfaces/DnfModule.md) -- [FactSet](interfaces/FactSet.md) -- [GroupIn](interfaces/GroupIn.md) -- [GroupOut](interfaces/GroupOut.md) -- [GroupOutWithHostCount](interfaces/GroupOutWithHostCount.md) -- [GroupOutWithHostCountAllOf](interfaces/GroupOutWithHostCountAllOf.md) -- [GroupQueryOutput](interfaces/GroupQueryOutput.md) -- [GroupQueryOutputAllOf](interfaces/GroupQueryOutputAllOf.md) -- [HostOut](interfaces/HostOut.md) -- [HostOutAllOf](interfaces/HostOutAllOf.md) -- [HostQueryOutput](interfaces/HostQueryOutput.md) -- [HostQueryOutputAllOf](interfaces/HostQueryOutputAllOf.md) -- [HostSystemProfileOut](interfaces/HostSystemProfileOut.md) -- [InstalledProduct](interfaces/InstalledProduct.md) -- [InterSystemsRunningInstance](interfaces/InterSystemsRunningInstance.md) -- [Links](interfaces/Links.md) -- [Meta](interfaces/Meta.md) -- [NetworkInterface](interfaces/NetworkInterface.md) -- [PaginationOut](interfaces/PaginationOut.md) -- [PatchHostIn](interfaces/PatchHostIn.md) -- [PerReporterStaleness](interfaces/PerReporterStaleness.md) -- [RPMOSTreeDeployment](interfaces/RPMOSTreeDeployment.md) -- [ResourceTypesGroupsQueryOutput](interfaces/ResourceTypesGroupsQueryOutput.md) -- [ResourceTypesGroupsQueryOutputAllOf](interfaces/ResourceTypesGroupsQueryOutputAllOf.md) -- [ResourceTypesOut](interfaces/ResourceTypesOut.md) -- [ResourceTypesPaginationOut](interfaces/ResourceTypesPaginationOut.md) -- [ResourceTypesQueryOutput](interfaces/ResourceTypesQueryOutput.md) -- [ResourceTypesQueryOutputAllOf](interfaces/ResourceTypesQueryOutputAllOf.md) -- [StalenessIn](interfaces/StalenessIn.md) -- [StalenessOutput](interfaces/StalenessOutput.md) -- [StalenessOutputAllOf](interfaces/StalenessOutputAllOf.md) -- [StructuredTag](interfaces/StructuredTag.md) -- [SystemProfile](interfaces/SystemProfile.md) -- [SystemProfileAnsible](interfaces/SystemProfileAnsible.md) -- [SystemProfileBootcStatus](interfaces/SystemProfileBootcStatus.md) -- [SystemProfileBootcStatusBooted](interfaces/SystemProfileBootcStatusBooted.md) -- [SystemProfileByHostOut](interfaces/SystemProfileByHostOut.md) -- [SystemProfileByHostOutAllOf](interfaces/SystemProfileByHostOutAllOf.md) -- [SystemProfileConversions](interfaces/SystemProfileConversions.md) -- [SystemProfileDiskDevice](interfaces/SystemProfileDiskDevice.md) -- [SystemProfileDnfModule](interfaces/SystemProfileDnfModule.md) -- [SystemProfileInstalledProduct](interfaces/SystemProfileInstalledProduct.md) -- [SystemProfileIntersystems](interfaces/SystemProfileIntersystems.md) -- [SystemProfileMssql](interfaces/SystemProfileMssql.md) -- [SystemProfileNetworkInterface](interfaces/SystemProfileNetworkInterface.md) -- [SystemProfileOperatingSystem](interfaces/SystemProfileOperatingSystem.md) -- [SystemProfileOperatingSystemOut](interfaces/SystemProfileOperatingSystemOut.md) -- [SystemProfileOperatingSystemOutResults](interfaces/SystemProfileOperatingSystemOutResults.md) -- [SystemProfileOperatingSystemOutValue](interfaces/SystemProfileOperatingSystemOutValue.md) -- [SystemProfileRhsm](interfaces/SystemProfileRhsm.md) -- [SystemProfileSap](interfaces/SystemProfileSap.md) -- [SystemProfileSapSystemOut](interfaces/SystemProfileSapSystemOut.md) -- [SystemProfileSapSystemOutResults](interfaces/SystemProfileSapSystemOutResults.md) -- [SystemProfileSystemPurpose](interfaces/SystemProfileSystemPurpose.md) -- [SystemProfileSystemd](interfaces/SystemProfileSystemd.md) -- [SystemProfileThirdPartyServices](interfaces/SystemProfileThirdPartyServices.md) -- [SystemProfileThirdPartyServicesCrowdstrike](interfaces/SystemProfileThirdPartyServicesCrowdstrike.md) -- [SystemProfileYumRepo](interfaces/SystemProfileYumRepo.md) -- [TagCountOut](interfaces/TagCountOut.md) -- [TagCountOutAllOf](interfaces/TagCountOutAllOf.md) -- [TagsOut](interfaces/TagsOut.md) -- [TagsOutAllOf](interfaces/TagsOutAllOf.md) -- [UnleashToggleOut](interfaces/UnleashToggleOut.md) -- [YumRepo](interfaces/YumRepo.md) - -### Type Aliases - -- [StalenessId](modules.md#stalenessid) - -### Functions - -- [AccountsStalenessApiAxiosParamCreator](modules.md#accountsstalenessapiaxiosparamcreator) -- [AccountsStalenessApiFactory](modules.md#accountsstalenessapifactory) -- [AccountsStalenessApiFp](modules.md#accountsstalenessapifp) -- [GroupsApiAxiosParamCreator](modules.md#groupsapiaxiosparamcreator) -- [GroupsApiFactory](modules.md#groupsapifactory) -- [GroupsApiFp](modules.md#groupsapifp) -- [HostsApiAxiosParamCreator](modules.md#hostsapiaxiosparamcreator) -- [HostsApiFactory](modules.md#hostsapifactory) -- [HostsApiFp](modules.md#hostsapifp) -- [ResourceTypesApiAxiosParamCreator](modules.md#resourcetypesapiaxiosparamcreator) -- [ResourceTypesApiFactory](modules.md#resourcetypesapifactory) -- [ResourceTypesApiFp](modules.md#resourcetypesapifp) -- [SystemProfileApiAxiosParamCreator](modules.md#systemprofileapiaxiosparamcreator) -- [SystemProfileApiFactory](modules.md#systemprofileapifactory) -- [SystemProfileApiFp](modules.md#systemprofileapifp) -- [TagsApiAxiosParamCreator](modules.md#tagsapiaxiosparamcreator) -- [TagsApiFactory](modules.md#tagsapifactory) -- [TagsApiFp](modules.md#tagsapifp) - -## Type Aliases - -### StalenessId - -Ƭ **StalenessId**: [`SystemDefaultId`](enums/SystemDefaultId.md) \| `string` - -**`Export`** - -#### Defined in - -[api.ts:1412](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L1412) - -## Functions - -### AccountsStalenessApiAxiosParamCreator - -▸ **AccountsStalenessApiAxiosParamCreator**(`configuration?`): `Object` - -AccountsStalenessApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiStalenessCreateStaleness` | (`stalenessIn`: [`StalenessIn`](interfaces/StalenessIn.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `apiStalenessDeleteStaleness` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `apiStalenessGetDefaultStaleness` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `apiStalenessGetStaleness` | (`options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `apiStalenessUpdateStaleness` | (`stalenessIn`: [`StalenessIn`](interfaces/StalenessIn.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:2885](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L2885) - -___ - -### AccountsStalenessApiFactory - -▸ **AccountsStalenessApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -AccountsStalenessApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiStalenessCreateStaleness` | (`stalenessIn`: [`StalenessIn`](interfaces/StalenessIn.md), `options?`: `any`) => `AxiosPromise`\<[`StalenessOutput`](interfaces/StalenessOutput.md)\> | -| `apiStalenessDeleteStaleness` | (`options?`: `any`) => `AxiosPromise`\<`void`\> | -| `apiStalenessGetDefaultStaleness` | (`options?`: `any`) => `AxiosPromise`\<[`StalenessOutput`](interfaces/StalenessOutput.md)\> | -| `apiStalenessGetStaleness` | (`options?`: `any`) => `AxiosPromise`\<[`StalenessOutput`](interfaces/StalenessOutput.md)\> | -| `apiStalenessUpdateStaleness` | (`stalenessIn`: [`StalenessIn`](interfaces/StalenessIn.md), `options?`: `any`) => `AxiosPromise`\<[`StalenessOutput`](interfaces/StalenessOutput.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:3223](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L3223) - -___ - -### AccountsStalenessApiFp - -▸ **AccountsStalenessApiFp**(`configuration?`): `Object` - -AccountsStalenessApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiStalenessCreateStaleness` | (`stalenessIn`: [`StalenessIn`](interfaces/StalenessIn.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`StalenessOutput`](interfaces/StalenessOutput.md)\>\> | -| `apiStalenessDeleteStaleness` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | -| `apiStalenessGetDefaultStaleness` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`StalenessOutput`](interfaces/StalenessOutput.md)\>\> | -| `apiStalenessGetStaleness` | (`options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`StalenessOutput`](interfaces/StalenessOutput.md)\>\> | -| `apiStalenessUpdateStaleness` | (`stalenessIn`: [`StalenessIn`](interfaces/StalenessIn.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`StalenessOutput`](interfaces/StalenessOutput.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:3147](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L3147) - -___ - -### GroupsApiAxiosParamCreator - -▸ **GroupsApiAxiosParamCreator**(`configuration?`): `Object` - -GroupsApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiAssignmentRuleCreateAssignmentRule` | (`assignmentRuleIn`: [`AssignmentRuleIn`](interfaces/AssignmentRuleIn.md), `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `apiAssignmentRuleGetAssignmentRulesById` | (`assignmentRuleIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"group_id"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `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`\> | - | -| `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`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:3346](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L3346) - -___ - -### GroupsApiFactory - -▸ **GroupsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -GroupsApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiAssignmentRuleCreateAssignmentRule` | (`assignmentRuleIn`: [`AssignmentRuleIn`](interfaces/AssignmentRuleIn.md), `options?`: `any`) => `AxiosPromise`\<[`AssignmentRuleOut`](interfaces/AssignmentRuleOut.md)\> | -| `apiAssignmentRuleGetAssignmentRulesById` | (`assignmentRuleIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"group_id"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `AxiosPromise`\<[`AssignmentRuleQueryOutput`](interfaces/AssignmentRuleQueryOutput.md)\> | -| `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`\> | -| `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`\> | - -**`Export`** - -#### Defined in - -[api.ts:4147](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4147) - -___ - -### GroupsApiFp - -▸ **GroupsApiFp**(`configuration?`): `Object` - -GroupsApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiAssignmentRuleCreateAssignmentRule` | (`assignmentRuleIn`: [`AssignmentRuleIn`](interfaces/AssignmentRuleIn.md), `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`AssignmentRuleOut`](interfaces/AssignmentRuleOut.md)\>\> | -| `apiAssignmentRuleGetAssignmentRulesById` | (`assignmentRuleIdList`: `string`[], `perPage?`: `number`, `page?`: `number`, `orderBy?`: ``"name"`` \| ``"group_id"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`AssignmentRuleQueryOutput`](interfaces/AssignmentRuleQueryOutput.md)\>\> | -| `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`\>\> | -| `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`\>\> | - -**`Export`** - -#### Defined in - -[api.ts:3965](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L3965) - -___ - -### HostsApiAxiosParamCreator - -▸ **HostsApiAxiosParamCreator**(`configuration?`): `Object` - -HostsApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `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"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `tags?`: `string`[], `filter?`: \{ `[key: string]`: `object`; }, `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?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `tags?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!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`\> | - | -| `apiHostReplaceFacts` | (`hostIdList`: `string`[], `namespace`: `string`, `body`: `object`, `branchId?`: `string`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:4446](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L4446) - -___ - -### HostsApiFactory - -▸ **HostsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -HostsApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `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"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `tags?`: `string`[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`\<`void`\> | -| `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?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `tags?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!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`\> | -| `apiHostReplaceFacts` | (`hostIdList`: `string`[], `namespace`: `string`, `body`: `object`, `branchId?`: `string`, `options?`: `any`) => `AxiosPromise`\<`void`\> | - -**`Export`** - -#### Defined in - -[api.ts:5551](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5551) - -___ - -### HostsApiFp - -▸ **HostsApiFp**(`configuration?`): `Object` - -HostsApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `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"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `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?`: ``"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?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `tags?`: `string`[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!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`\>\> | -| `apiHostReplaceFacts` | (`hostIdList`: `string`[], `namespace`: `string`, `body`: `object`, `branchId?`: `string`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | - -**`Export`** - -#### Defined in - -[api.ts:5314](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5314) - -___ - -### ResourceTypesApiAxiosParamCreator - -▸ **ResourceTypesApiAxiosParamCreator**(`configuration?`): `Object` - -ResourceTypesApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiResourceTypeGetResourceTypeGroupsList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `apiResourceTypeGetResourceTypeList` | (`perPage?`: `number`, `page?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:5954](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L5954) - -___ - -### ResourceTypesApiFactory - -▸ **ResourceTypesApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -ResourceTypesApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiResourceTypeGetResourceTypeGroupsList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `options?`: `any`) => `AxiosPromise`\<[`ResourceTypesGroupsQueryOutput`](interfaces/ResourceTypesGroupsQueryOutput.md)\> | -| `apiResourceTypeGetResourceTypeList` | (`perPage?`: `number`, `page?`: `number`, `options?`: `any`) => `AxiosPromise`\<[`ResourceTypesQueryOutput`](interfaces/ResourceTypesQueryOutput.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:6104](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6104) - -___ - -### ResourceTypesApiFp - -▸ **ResourceTypesApiFp**(`configuration?`): `Object` - -ResourceTypesApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiResourceTypeGetResourceTypeGroupsList` | (`name?`: `string`, `perPage?`: `number`, `page?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`ResourceTypesGroupsQueryOutput`](interfaces/ResourceTypesGroupsQueryOutput.md)\>\> | -| `apiResourceTypeGetResourceTypeList` | (`perPage?`: `number`, `page?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`ResourceTypesQueryOutput`](interfaces/ResourceTypesQueryOutput.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:6064](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6064) - -___ - -### SystemProfileApiAxiosParamCreator - -▸ **SystemProfileApiAxiosParamCreator**(`configuration?`): `Object` - -SystemProfileApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiSystemProfileGetOperatingSystem` | (`tags?`: `string`[], `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `apiSystemProfileGetSapSids` | (`search?`: `string`, `tags?`: `string`[], `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `apiSystemProfileGetSapSystem` | (`tags?`: `string`[], `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | -| `apiSystemProfileValidateSchema` | (`repoBranch`: `string`, `repoFork?`: `string`, `days?`: `number`, `maxMessages?`: `number`, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:6173](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6173) - -___ - -### SystemProfileApiFactory - -▸ **SystemProfileApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -SystemProfileApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiSystemProfileGetOperatingSystem` | (`tags?`: `string`[], `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`\<[`SystemProfileOperatingSystemOut`](interfaces/SystemProfileOperatingSystemOut.md)\> | -| `apiSystemProfileGetSapSids` | (`search?`: `string`, `tags?`: `string`[], `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`\<[`SystemProfileSapSystemOut`](interfaces/SystemProfileSapSystemOut.md)\> | -| `apiSystemProfileGetSapSystem` | (`tags?`: `string`[], `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`\<[`SystemProfileSapSystemOut`](interfaces/SystemProfileSapSystemOut.md)\> | -| `apiSystemProfileValidateSchema` | (`repoBranch`: `string`, `repoFork?`: `string`, `days?`: `number`, `maxMessages?`: `number`, `options?`: `any`) => `AxiosPromise`\<`void`\> | - -**`Export`** - -#### Defined in - -[api.ts:6537](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6537) - -___ - -### SystemProfileApiFp - -▸ **SystemProfileApiFp**(`configuration?`): `Object` - -SystemProfileApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiSystemProfileGetOperatingSystem` | (`tags?`: `string`[], `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SystemProfileOperatingSystemOut`](interfaces/SystemProfileOperatingSystemOut.md)\>\> | -| `apiSystemProfileGetSapSids` | (`search?`: `string`, `tags?`: `string`[], `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SystemProfileSapSystemOut`](interfaces/SystemProfileSapSystemOut.md)\>\> | -| `apiSystemProfileGetSapSystem` | (`tags?`: `string`[], `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `registeredWith?`: (``"insights"`` \| ``"yupana"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`SystemProfileSapSystemOut`](interfaces/SystemProfileSapSystemOut.md)\>\> | -| `apiSystemProfileValidateSchema` | (`repoBranch`: `string`, `repoFork?`: `string`, `days?`: `number`, `maxMessages?`: `number`, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<`void`\>\> | - -**`Export`** - -#### Defined in - -[api.ts:6453](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6453) - -___ - -### TagsApiAxiosParamCreator - -▸ **TagsApiAxiosParamCreator**(`configuration?`): `Object` - -TagsApi - axios parameter creator - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | Description | -| :------ | :------ | :------ | -| `apiTagGetTags` | (`tags?`: `string`[], `orderBy?`: ``"tag"`` \| ``"count"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `search?`: `string`, `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"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `Promise`\<`RequestArgs`\> | - | - -**`Export`** - -#### Defined in - -[api.ts:6682](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6682) - -___ - -### TagsApiFactory - -▸ **TagsApiFactory**(`configuration?`, `basePath?`, `axios?`): `Object` - -TagsApi - factory interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | -| `basePath?` | `string` | -| `axios?` | `AxiosInstance` | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiTagGetTags` | (`tags?`: `string`[], `orderBy?`: ``"tag"`` \| ``"count"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `search?`: `string`, `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"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `AxiosPromise`\<[`ActiveTags`](interfaces/ActiveTags.md)\> | - -**`Export`** - -#### Defined in - -[api.ts:6863](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6863) - -___ - -### TagsApiFp - -▸ **TagsApiFp**(`configuration?`): `Object` - -TagsApi - functional programming interface - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `configuration?` | [`Configuration`](classes/Configuration.md) | - -#### Returns - -`Object` - -| Name | Type | -| :------ | :------ | -| `apiTagGetTags` | (`tags?`: `string`[], `orderBy?`: ``"tag"`` \| ``"count"``, `orderHow?`: ``"ASC"`` \| ``"DESC"``, `perPage?`: `number`, `page?`: `number`, `staleness?`: (``"fresh"`` \| ``"stale"`` \| ``"stale_warning"`` \| ``"unknown"``)[], `search?`: `string`, `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"`` \| ``"satellite"`` \| ``"discovery"`` \| ``"puptoo"`` \| ``"rhsm-conduit"`` \| ``"cloud-connector"`` \| ``"!yupana"`` \| ``"!satellite"`` \| ``"!discovery"`` \| ``"!puptoo"`` \| ``"!rhsm-conduit"`` \| ``"!cloud-connector"``)[], `filter?`: \{ `[key: string]`: `object`; }, `options?`: `any`) => `Promise`\<(`axios?`: `AxiosInstance`, `basePath?`: `string`) => `AxiosPromise`\<[`ActiveTags`](interfaces/ActiveTags.md)\>\> | - -**`Export`** - -#### Defined in - -[api.ts:6823](https://github.com/RedHatInsights/javascript-clients/blob/main/packages/host-inventory/api.ts#L6823) diff --git a/packages/host-inventory/jest.config.ts b/packages/host-inventory/jest.config.ts index 24b72fcbd..ca1368f89 100644 --- a/packages/host-inventory/jest.config.ts +++ b/packages/host-inventory/jest.config.ts @@ -7,4 +7,5 @@ export default { }, moduleFileExtensions: ['ts', 'js', 'html'], coverageDirectory: '../../coverage/packages/host-inventory', + testPathIgnorePatterns: ['/node_modules/','/tests/'], }; diff --git a/packages/host-inventory/package.json b/packages/host-inventory/package.json index 7442edffc..26599f14b 100644 --- a/packages/host-inventory/package.json +++ b/packages/host-inventory/package.json @@ -2,32 +2,32 @@ "name": "@redhat-cloud-services/host-inventory-client", "version": "4.1.7", "description": "", - "main": "./dist/index.js", - "typings": "./dist/index.d.ts", + "main": "./index.js", + "typings": "./index.d.ts", "exports": { ".": { - "types": "./dist/index.d.ts", - "import": "./dist/esm/index.js", - "default": "./dist/index.js" + "types": "./index.d.ts", + "import": "./esm/index.js", + "default": "./index.js" }, "./api": { - "types": "./dist/api.d.ts", - "import": "./dist/esm/api.js", - "default": "./dist/api.js" + "types": "./api.d.ts", + "import": "./esm/api.js", + "default": "./api.js" }, "./*": { - "types": "./dist/*/index.d.ts", - "import": "./dist/esm/*/index.js", - "default": "./dist/*/index.js" + "types": "./*/index.d.ts", + "import": "./esm/*/index.js", + "default": "./*/index.js" } }, "typesVersions": { "*": { "api": [ - "./dist/api.d.ts" + "./api.d.ts" ], "*": [ - "./dist/*/index.d.ts" + "./*/index.d.ts" ] } }, diff --git a/packages/host-inventory/project.json b/packages/host-inventory/project.json index a375149aa..5b0870a54 100644 --- a/packages/host-inventory/project.json +++ b/packages/host-inventory/project.json @@ -4,20 +4,30 @@ "sourceRoot": "packages/host-inventory", "projectType": "library", "targets": { + "clean-generate": { + "command": "rm -rf packages/host-inventory/src" + }, "generate": { + "dependsOn": ["clean-generate"], "executor": "@redhat-cloud-services/build-utils:client-generator", "options": { + "outputPath": "packages/host-inventory/src", "specs": { "default": "https://raw.githubusercontent.com/RedHatInsights/insights-host-inventory/master/swagger/openapi.json" }, "clientName": "HostInventoryClient" } }, + "clean-build": { + "command": "rm -rf packages/host-inventory/dist" + }, "build": { + "dependsOn": ["clean-build", "^build"], "executor": "@redhat-cloud-services/build-utils:builder", "options": { + "inputPath": "packages/host-inventory/src", "outputPath": "packages/host-inventory/dist", - "main": "packages/host-inventory/index.ts", + "main": "packages/host-inventory/src/index.ts", "esmTsConfig": "packages/host-inventory/tsconfig.esm.json", "cjsTsConfig": "packages/host-inventory/tsconfig.cjs.json" } diff --git a/packages/host-inventory/src/.gitignore b/packages/host-inventory/src/.gitignore new file mode 100644 index 000000000..149b57654 --- /dev/null +++ b/packages/host-inventory/src/.gitignore @@ -0,0 +1,4 @@ +wwwroot/*.js +node_modules +typings +dist diff --git a/packages/host-inventory/src/.npmignore b/packages/host-inventory/src/.npmignore new file mode 100644 index 000000000..6b112e4e7 --- /dev/null +++ b/packages/host-inventory/src/.npmignore @@ -0,0 +1,6 @@ +.openapi-generator +node_modules +.openapi-generator-ignore +package-lock.json +*.ts +!*.d.ts diff --git a/packages/host-inventory/src/.openapi-generator-ignore b/packages/host-inventory/src/.openapi-generator-ignore new file mode 100644 index 000000000..7484ee590 --- /dev/null +++ b/packages/host-inventory/src/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/packages/host-inventory/.openapi-generator/FILES b/packages/host-inventory/src/.openapi-generator/FILES similarity index 92% rename from packages/host-inventory/.openapi-generator/FILES rename to packages/host-inventory/src/.openapi-generator/FILES index 2d99ab66f..ed9dd6643 100644 --- a/packages/host-inventory/.openapi-generator/FILES +++ b/packages/host-inventory/src/.openapi-generator/FILES @@ -1,5 +1,6 @@ .gitignore .npmignore +.openapi-generator-ignore ApiGroupCreateGroup/index.ts ApiGroupDeleteGroups/index.ts ApiGroupDeleteHostsFromDifferentGroups/index.ts @@ -17,10 +18,12 @@ ApiHostGetHostTagCount/index.ts ApiHostGetHostTags/index.ts ApiHostGroupAddHostListToGroup/index.ts ApiHostGroupDeleteHostsFromGroup/index.ts +ApiHostGroupGetHostListByGroup/index.ts ApiHostHostCheckin/index.ts ApiHostMergeFacts/index.ts ApiHostPatchHostById/index.ts ApiHostReplaceFacts/index.ts +ApiHostViewsGetHostViews/index.ts ApiResourceTypeGetResourceTypeGroupsList/index.ts ApiResourceTypeGetResourceTypeList/index.ts ApiStalenessCreateStaleness/index.ts diff --git a/packages/host-inventory/.openapi-generator/VERSION b/packages/host-inventory/src/.openapi-generator/VERSION similarity index 100% rename from packages/host-inventory/.openapi-generator/VERSION rename to packages/host-inventory/src/.openapi-generator/VERSION diff --git a/packages/host-inventory/ApiGroupCreateGroup/index.ts b/packages/host-inventory/src/ApiGroupCreateGroup/index.ts similarity index 100% rename from packages/host-inventory/ApiGroupCreateGroup/index.ts rename to packages/host-inventory/src/ApiGroupCreateGroup/index.ts diff --git a/packages/host-inventory/ApiGroupDeleteGroups/index.ts b/packages/host-inventory/src/ApiGroupDeleteGroups/index.ts similarity index 100% rename from packages/host-inventory/ApiGroupDeleteGroups/index.ts rename to packages/host-inventory/src/ApiGroupDeleteGroups/index.ts diff --git a/packages/host-inventory/ApiGroupDeleteHostsFromDifferentGroups/index.ts b/packages/host-inventory/src/ApiGroupDeleteHostsFromDifferentGroups/index.ts similarity index 100% rename from packages/host-inventory/ApiGroupDeleteHostsFromDifferentGroups/index.ts rename to packages/host-inventory/src/ApiGroupDeleteHostsFromDifferentGroups/index.ts diff --git a/packages/host-inventory/ApiGroupGetGroupList/index.ts b/packages/host-inventory/src/ApiGroupGetGroupList/index.ts similarity index 100% rename from packages/host-inventory/ApiGroupGetGroupList/index.ts rename to packages/host-inventory/src/ApiGroupGetGroupList/index.ts diff --git a/packages/host-inventory/ApiGroupGetGroupsById/index.ts b/packages/host-inventory/src/ApiGroupGetGroupsById/index.ts similarity index 98% rename from packages/host-inventory/ApiGroupGetGroupsById/index.ts rename to packages/host-inventory/src/ApiGroupGetGroupsById/index.ts index 946205fc5..0af91ff56 100644 --- a/packages/host-inventory/ApiGroupGetGroupsById/index.ts +++ b/packages/host-inventory/src/ApiGroupGetGroupsById/index.ts @@ -8,7 +8,7 @@ import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/b import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; // @ts-ignore -import type { GroupQueryOutput } from '../types'; +import type { GroupQueryOutput, NotFoundErrorResponse } from '../types'; export type ApiGroupGetGroupsByIdParams = { diff --git a/packages/host-inventory/ApiGroupPatchGroupById/index.ts b/packages/host-inventory/src/ApiGroupPatchGroupById/index.ts similarity index 97% rename from packages/host-inventory/ApiGroupPatchGroupById/index.ts rename to packages/host-inventory/src/ApiGroupPatchGroupById/index.ts index aad835f2f..9c4705cf2 100644 --- a/packages/host-inventory/ApiGroupPatchGroupById/index.ts +++ b/packages/host-inventory/src/ApiGroupPatchGroupById/index.ts @@ -8,7 +8,7 @@ import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/b import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; // @ts-ignore -import type { GroupIn, GroupOutWithHostCount } from '../types'; +import type { GroupIn, GroupOutWithHostCount, NotFoundErrorResponse } from '../types'; export type ApiGroupPatchGroupByIdParams = { diff --git a/packages/host-inventory/ApiHostDeleteAllHosts/index.ts b/packages/host-inventory/src/ApiHostDeleteAllHosts/index.ts similarity index 100% rename from packages/host-inventory/ApiHostDeleteAllHosts/index.ts rename to packages/host-inventory/src/ApiHostDeleteAllHosts/index.ts diff --git a/packages/host-inventory/ApiHostDeleteHostById/index.ts b/packages/host-inventory/src/ApiHostDeleteHostById/index.ts similarity index 96% rename from packages/host-inventory/ApiHostDeleteHostById/index.ts rename to packages/host-inventory/src/ApiHostDeleteHostById/index.ts index cc8c767f4..cc3deceac 100644 --- a/packages/host-inventory/ApiHostDeleteHostById/index.ts +++ b/packages/host-inventory/src/ApiHostDeleteHostById/index.ts @@ -8,7 +8,7 @@ import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/b import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; // @ts-ignore -import type { } from '../types'; +import type { NotFoundErrorResponse } from '../types'; export type ApiHostDeleteHostByIdParams = { @@ -27,7 +27,7 @@ export type ApiHostDeleteHostByIdParams = { options?: AxiosRequestConfig } -export type ApiHostDeleteHostByIdReturnType = void; +export type ApiHostDeleteHostByIdReturnType = object; const isApiHostDeleteHostByIdObjectParams = (params: [ApiHostDeleteHostByIdParams] | unknown[]): params is [ApiHostDeleteHostByIdParams] => { const l = params.length === 1 diff --git a/packages/host-inventory/ApiHostDeleteHostsByFilter/index.ts b/packages/host-inventory/src/ApiHostDeleteHostsByFilter/index.ts similarity index 92% rename from packages/host-inventory/ApiHostDeleteHostsByFilter/index.ts rename to packages/host-inventory/src/ApiHostDeleteHostsByFilter/index.ts index 57d060a5a..398eac42f 100644 --- a/packages/host-inventory/ApiHostDeleteHostsByFilter/index.ts +++ b/packages/host-inventory/src/ApiHostDeleteHostsByFilter/index.ts @@ -79,6 +79,12 @@ export type ApiHostDeleteHostsByFilterParams = { */ groupName?: Array, /** + * Filter by group ID (UUID format) + * @type { Array } + * @memberof ApiHostDeleteHostsByFilterApi + */ + groupId?: Array, + /** * Filters out any host not registered by the specified reporters * @type { Array } * @memberof ApiHostDeleteHostsByFilterApi @@ -188,9 +194,9 @@ const isApiHostDeleteHostsByFilterObjectParams = (params: [ApiHostDeleteHostsByF * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const apiHostDeleteHostsByFilterParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiHostDeleteHostsByFilterParams] | [string, string, string, string, string, ApiHostDeleteHostsByFilterProviderTypeEnum, string, string, string, string, Array, Array, Array, Array, Array, { [key: string]: SystemProfileNestedObjectValue; }, string, AxiosRequestConfig])) => { - const params = isApiHostDeleteHostsByFilterObjectParams(config) ? config[0] : ['displayName', 'fqdn', 'hostnameOrId', 'insightsId', 'providerId', 'providerType', 'updatedStart', 'updatedEnd', 'lastCheckInStart', 'lastCheckInEnd', 'groupName', 'registeredWith', 'systemType', 'staleness', 'tags', 'filter', 'subscriptionManagerId', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiHostDeleteHostsByFilterParams; - const { displayName, fqdn, hostnameOrId, insightsId, providerId, providerType, updatedStart, updatedEnd, lastCheckInStart, lastCheckInEnd, groupName, registeredWith, systemType, staleness, tags, filter, subscriptionManagerId, options = {} } = params; +export const apiHostDeleteHostsByFilterParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiHostDeleteHostsByFilterParams] | [string, string, string, string, string, ApiHostDeleteHostsByFilterProviderTypeEnum, string, string, string, string, Array, Array, Array, Array, Array, Array, { [key: string]: SystemProfileNestedObjectValue; }, string, AxiosRequestConfig])) => { + const params = isApiHostDeleteHostsByFilterObjectParams(config) ? config[0] : ['displayName', 'fqdn', 'hostnameOrId', 'insightsId', 'providerId', 'providerType', 'updatedStart', 'updatedEnd', 'lastCheckInStart', 'lastCheckInEnd', 'groupName', 'groupId', 'registeredWith', 'systemType', 'staleness', 'tags', 'filter', 'subscriptionManagerId', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiHostDeleteHostsByFilterParams; + const { displayName, fqdn, hostnameOrId, insightsId, providerId, providerType, updatedStart, updatedEnd, lastCheckInStart, lastCheckInEnd, groupName, groupId, registeredWith, systemType, staleness, tags, filter, subscriptionManagerId, options = {} } = params; const localVarPath = `/hosts`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -250,6 +256,10 @@ export const apiHostDeleteHostsByFilterParamCreator = async (sendRequest: BaseAP localVarQueryParameter['group_name'] = groupName; } + if (groupId) { + localVarQueryParameter['group_id'] = groupId; + } + if (registeredWith) { localVarQueryParameter['registered_with'] = registeredWith; } diff --git a/packages/host-inventory/ApiHostGetHostById/index.ts b/packages/host-inventory/src/ApiHostGetHostById/index.ts similarity index 98% rename from packages/host-inventory/ApiHostGetHostById/index.ts rename to packages/host-inventory/src/ApiHostGetHostById/index.ts index 50f9684a5..f554d3fbd 100644 --- a/packages/host-inventory/ApiHostGetHostById/index.ts +++ b/packages/host-inventory/src/ApiHostGetHostById/index.ts @@ -8,7 +8,7 @@ import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/b import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; // @ts-ignore -import type { HostQueryOutput, SystemProfileNestedObjectValue } from '../types'; +import type { HostQueryOutput, NotFoundErrorResponse, SystemProfileNestedObjectValue } from '../types'; export type ApiHostGetHostByIdParams = { diff --git a/packages/host-inventory/ApiHostGetHostExists/index.ts b/packages/host-inventory/src/ApiHostGetHostExists/index.ts similarity index 100% rename from packages/host-inventory/ApiHostGetHostExists/index.ts rename to packages/host-inventory/src/ApiHostGetHostExists/index.ts diff --git a/packages/host-inventory/ApiHostGetHostList/index.ts b/packages/host-inventory/src/ApiHostGetHostList/index.ts similarity index 92% rename from packages/host-inventory/ApiHostGetHostList/index.ts rename to packages/host-inventory/src/ApiHostGetHostList/index.ts index f6a000923..250504188 100644 --- a/packages/host-inventory/ApiHostGetHostList/index.ts +++ b/packages/host-inventory/src/ApiHostGetHostList/index.ts @@ -85,6 +85,12 @@ export type ApiHostGetHostListParams = { */ groupName?: Array, /** + * Filter by group ID (UUID format) + * @type { Array } + * @memberof ApiHostGetHostListApi + */ + groupId?: Array, + /** * Filter by branch_id * @type { string } * @memberof ApiHostGetHostListApi @@ -236,9 +242,9 @@ const isApiHostGetHostListObjectParams = (params: [ApiHostGetHostListParams] | u * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const apiHostGetHostListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiHostGetHostListParams] | [string, string, string, string, string, string, ApiHostGetHostListProviderTypeEnum, string, string, string, string, Array, string, number, number, ApiHostGetHostListOrderByEnum, string, Array, Array, Array, Array, { [key: string]: SystemProfileNestedObjectValue; }, { [key: string]: SystemProfileNestedObjectValue; }, AxiosRequestConfig])) => { - const params = isApiHostGetHostListObjectParams(config) ? config[0] : ['displayName', 'fqdn', 'hostnameOrId', 'insightsId', 'subscriptionManagerId', 'providerId', 'providerType', 'updatedStart', 'updatedEnd', 'lastCheckInStart', 'lastCheckInEnd', 'groupName', 'branchId', 'perPage', 'page', 'orderBy', 'orderHow', 'staleness', 'tags', 'registeredWith', 'systemType', 'filter', 'fields', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiHostGetHostListParams; - const { displayName, fqdn, hostnameOrId, insightsId, subscriptionManagerId, providerId, providerType, updatedStart, updatedEnd, lastCheckInStart, lastCheckInEnd, groupName, branchId, perPage, page, orderBy, orderHow, staleness, tags, registeredWith, systemType, filter, fields, options = {} } = params; +export const apiHostGetHostListParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiHostGetHostListParams] | [string, string, string, string, string, string, ApiHostGetHostListProviderTypeEnum, string, string, string, string, Array, Array, string, number, number, ApiHostGetHostListOrderByEnum, string, Array, Array, Array, Array, { [key: string]: SystemProfileNestedObjectValue; }, { [key: string]: SystemProfileNestedObjectValue; }, AxiosRequestConfig])) => { + const params = isApiHostGetHostListObjectParams(config) ? config[0] : ['displayName', 'fqdn', 'hostnameOrId', 'insightsId', 'subscriptionManagerId', 'providerId', 'providerType', 'updatedStart', 'updatedEnd', 'lastCheckInStart', 'lastCheckInEnd', 'groupName', 'groupId', 'branchId', 'perPage', 'page', 'orderBy', 'orderHow', 'staleness', 'tags', 'registeredWith', 'systemType', 'filter', 'fields', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiHostGetHostListParams; + const { displayName, fqdn, hostnameOrId, insightsId, subscriptionManagerId, providerId, providerType, updatedStart, updatedEnd, lastCheckInStart, lastCheckInEnd, groupName, groupId, branchId, perPage, page, orderBy, orderHow, staleness, tags, registeredWith, systemType, filter, fields, options = {} } = params; const localVarPath = `/hosts`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -302,6 +308,10 @@ export const apiHostGetHostListParamCreator = async (sendRequest: BaseAPI["sendR localVarQueryParameter['group_name'] = groupName; } + if (groupId) { + localVarQueryParameter['group_id'] = groupId; + } + if (branchId !== undefined) { localVarQueryParameter['branch_id'] = branchId; } diff --git a/packages/host-inventory/ApiHostGetHostSystemProfileById/index.ts b/packages/host-inventory/src/ApiHostGetHostSystemProfileById/index.ts similarity index 98% rename from packages/host-inventory/ApiHostGetHostSystemProfileById/index.ts rename to packages/host-inventory/src/ApiHostGetHostSystemProfileById/index.ts index 643ceb9e1..cd05a0615 100644 --- a/packages/host-inventory/ApiHostGetHostSystemProfileById/index.ts +++ b/packages/host-inventory/src/ApiHostGetHostSystemProfileById/index.ts @@ -8,7 +8,7 @@ import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/b import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; // @ts-ignore -import type { SystemProfileByHostOut, SystemProfileNestedObjectValue } from '../types'; +import type { NotFoundErrorResponse, SystemProfileByHostOut, SystemProfileNestedObjectValue } from '../types'; export type ApiHostGetHostSystemProfileByIdParams = { diff --git a/packages/host-inventory/ApiHostGetHostTagCount/index.ts b/packages/host-inventory/src/ApiHostGetHostTagCount/index.ts similarity index 99% rename from packages/host-inventory/ApiHostGetHostTagCount/index.ts rename to packages/host-inventory/src/ApiHostGetHostTagCount/index.ts index 4985e5441..187b084f5 100644 --- a/packages/host-inventory/ApiHostGetHostTagCount/index.ts +++ b/packages/host-inventory/src/ApiHostGetHostTagCount/index.ts @@ -52,7 +52,6 @@ export const ApiHostGetHostTagCountOrderByEnum = { DisplayName: 'display_name', GroupName: 'group_name', Updated: 'updated', - OperatingSystem: 'operating_system', LastCheckIn: 'last_check_in' } as const; export type ApiHostGetHostTagCountOrderByEnum = typeof ApiHostGetHostTagCountOrderByEnum[keyof typeof ApiHostGetHostTagCountOrderByEnum]; diff --git a/packages/host-inventory/ApiHostGetHostTags/index.ts b/packages/host-inventory/src/ApiHostGetHostTags/index.ts similarity index 99% rename from packages/host-inventory/ApiHostGetHostTags/index.ts rename to packages/host-inventory/src/ApiHostGetHostTags/index.ts index 8c68442c0..7de005574 100644 --- a/packages/host-inventory/ApiHostGetHostTags/index.ts +++ b/packages/host-inventory/src/ApiHostGetHostTags/index.ts @@ -58,7 +58,6 @@ export const ApiHostGetHostTagsOrderByEnum = { DisplayName: 'display_name', GroupName: 'group_name', Updated: 'updated', - OperatingSystem: 'operating_system', LastCheckIn: 'last_check_in' } as const; export type ApiHostGetHostTagsOrderByEnum = typeof ApiHostGetHostTagsOrderByEnum[keyof typeof ApiHostGetHostTagsOrderByEnum]; diff --git a/packages/host-inventory/ApiHostGroupAddHostListToGroup/index.ts b/packages/host-inventory/src/ApiHostGroupAddHostListToGroup/index.ts similarity index 100% rename from packages/host-inventory/ApiHostGroupAddHostListToGroup/index.ts rename to packages/host-inventory/src/ApiHostGroupAddHostListToGroup/index.ts diff --git a/packages/host-inventory/ApiHostGroupDeleteHostsFromGroup/index.ts b/packages/host-inventory/src/ApiHostGroupDeleteHostsFromGroup/index.ts similarity index 100% rename from packages/host-inventory/ApiHostGroupDeleteHostsFromGroup/index.ts rename to packages/host-inventory/src/ApiHostGroupDeleteHostsFromGroup/index.ts diff --git a/packages/host-inventory/src/ApiHostGroupGetHostListByGroup/index.ts b/packages/host-inventory/src/ApiHostGroupGetHostListByGroup/index.ts new file mode 100644 index 000000000..550300dfe --- /dev/null +++ b/packages/host-inventory/src/ApiHostGroupGetHostListByGroup/index.ts @@ -0,0 +1,245 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { HostQueryOutput, SystemProfileNestedObjectValue } from '../types'; + + +export type ApiHostGroupGetHostListByGroupParams = { + /** + * Group ID. + * @type { string } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + groupId: string, + /** + * Filter by display_name (case-insensitive) + * @type { string } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + displayName?: string, + /** + * Filter by FQDN (case-insensitive) + * @type { string } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + fqdn?: string, + /** + * Filter by display_name, fqdn, id (case-insensitive) + * @type { string } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + hostnameOrId?: string, + /** + * Filter by insights_id + * @type { string } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + insightsId?: string, + /** + * A number of items to return per page. + * @type { number } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + perPage?: number, + /** + * A page number of the items to return. + * @type { number } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + page?: number, + /** + * Ordering field name + * @type { ApiHostGroupGetHostListByGroupOrderByEnum } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + orderBy?: ApiHostGroupGetHostListByGroupOrderByEnum, + /** + * Direction of the ordering (case-insensitive); defaults to ASC for display_name, and to DESC for updated and operating_system + * @type { string } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + orderHow?: string, + /** + * Culling states of the hosts. Default: fresh, stale and stale_warning + * @type { Array } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + staleness?: Array, + /** + * Filters systems by tag(s). Specify multiple tags as a comma-separated list (e.g. insights-client/security=strict,env/type=prod). + * @type { Array } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + tags?: Array, + /** + * Filters out any host not registered by the specified reporters + * @type { Array } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + registeredWith?: Array, + /** + * Filters hosts based on system_profile fields. For example:

    {\"system_profile\": {\"workloads\": {\"sap\": {\"sap_system\": {\"eq\": \"true\"}}}}}

which equates to the URL param:

    \"?filter[system_profile][sap_system][eq]=true\"

To get \"edge\" hosts, use this explicit filter:

    {\"system_profile\": {\"host_type\": {\"eq\": \"edge\"}}}

which equates to the URL param:

    \"?filter[system_profile][host_type][eq]=edge\"

To get hosts with an specific operating system, use this explicit filter:

    {\"system_profile\": {\"operating_system\": {\"name\": {\"eq\": \"rhel\"}}}}

which equates to the URL param:

    \"?filter[system_profile][name][eq]=rhel\" + * @type { { [key: string]: SystemProfileNestedObjectValue; } } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + filter?: { [key: string]: SystemProfileNestedObjectValue; }, + /** + * Fetches only mentioned system_profile fields. For example,

    {\"system_profile\": [\"arch\", \"host_type\"]}

which equates to the URL param:

    \"?fields[system_profile]=arch,host_type\" + * @type { { [key: string]: SystemProfileNestedObjectValue; } } + * @memberof ApiHostGroupGetHostListByGroupApi + */ + fields?: { [key: string]: SystemProfileNestedObjectValue; }, + options?: AxiosRequestConfig +} +/** + * @export + * @enum {string} + */ +export const ApiHostGroupGetHostListByGroupOrderByEnum = { + DisplayName: 'display_name', + GroupName: 'group_name', + Updated: 'updated', + OperatingSystem: 'operating_system', + LastCheckIn: 'last_check_in' +} as const; +export type ApiHostGroupGetHostListByGroupOrderByEnum = typeof ApiHostGroupGetHostListByGroupOrderByEnum[keyof typeof ApiHostGroupGetHostListByGroupOrderByEnum]; +/** + * @export + * @enum {string} + */ +export const ApiHostGroupGetHostListByGroupStalenessEnum = { + Fresh: 'fresh', + Stale: 'stale', + StaleWarning: 'stale_warning', + Unknown: 'unknown' +} as const; +export type ApiHostGroupGetHostListByGroupStalenessEnum = typeof ApiHostGroupGetHostListByGroupStalenessEnum[keyof typeof ApiHostGroupGetHostListByGroupStalenessEnum]; +/** + * @export + * @enum {string} + */ +export const ApiHostGroupGetHostListByGroupRegisteredWithEnum = { + Insights: 'insights', + Yupana: 'yupana', + Satellite: 'satellite', + Discovery: 'discovery', + Puptoo: 'puptoo', + RhsmConduit: 'rhsm-conduit', + CloudConnector: 'cloud-connector', + NotYupana: '!yupana', + NotSatellite: '!satellite', + NotDiscovery: '!discovery', + NotPuptoo: '!puptoo', + NotRhsmConduit: '!rhsm-conduit', + NotCloudConnector: '!cloud-connector' +} as const; +export type ApiHostGroupGetHostListByGroupRegisteredWithEnum = typeof ApiHostGroupGetHostListByGroupRegisteredWithEnum[keyof typeof ApiHostGroupGetHostListByGroupRegisteredWithEnum]; + +export type ApiHostGroupGetHostListByGroupReturnType = HostQueryOutput; + +const isApiHostGroupGetHostListByGroupObjectParams = (params: [ApiHostGroupGetHostListByGroupParams] | unknown[]): params is [ApiHostGroupGetHostListByGroupParams] => { + const l = params.length === 1 + if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { + return true && Object.prototype.hasOwnProperty.call(params[0], 'groupId') + } + return false +} +/** +* Read the list of all hosts in a specific group.

Required permissions: inventory:hosts:read +* @summary Read the list of hosts in a group +* @param {ApiHostGroupGetHostListByGroupParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const apiHostGroupGetHostListByGroupParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiHostGroupGetHostListByGroupParams] | [string, string, string, string, string, number, number, ApiHostGroupGetHostListByGroupOrderByEnum, string, Array, Array, Array, { [key: string]: SystemProfileNestedObjectValue; }, { [key: string]: SystemProfileNestedObjectValue; }, AxiosRequestConfig])) => { + const params = isApiHostGroupGetHostListByGroupObjectParams(config) ? config[0] : ['groupId', 'displayName', 'fqdn', 'hostnameOrId', 'insightsId', 'perPage', 'page', 'orderBy', 'orderHow', 'staleness', 'tags', 'registeredWith', 'filter', 'fields', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiHostGroupGetHostListByGroupParams; + const { groupId, displayName, fqdn, hostnameOrId, insightsId, perPage, page, orderBy, orderHow, staleness, tags, registeredWith, filter, fields, options = {} } = params; + const localVarPath = `/groups/{group_id}/hosts` + .replace(`{${"group_id"}}`, encodeURIComponent(String(groupId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'GET' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (displayName !== undefined) { + localVarQueryParameter['display_name'] = displayName; + } + + if (fqdn !== undefined) { + localVarQueryParameter['fqdn'] = fqdn; + } + + if (hostnameOrId !== undefined) { + localVarQueryParameter['hostname_or_id'] = hostnameOrId; + } + + if (insightsId !== undefined) { + localVarQueryParameter['insights_id'] = insightsId; + } + + if (perPage !== undefined) { + localVarQueryParameter['per_page'] = perPage; + } + + if (page !== undefined) { + localVarQueryParameter['page'] = page; + } + + if (orderBy !== undefined) { + localVarQueryParameter['order_by'] = orderBy; + } + + if (orderHow !== undefined) { + localVarQueryParameter['order_how'] = orderHow; + } + + if (staleness) { + localVarQueryParameter['staleness'] = staleness; + } + + if (tags) { + localVarQueryParameter['tags'] = tags; + } + + if (registeredWith) { + localVarQueryParameter['registered_with'] = registeredWith; + } + + if (filter !== undefined) { + localVarQueryParameter['filter'] = filter; + } + + if (fields !== undefined) { + localVarQueryParameter['fields'] = fields; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + const args = { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + auth:[ + { + // authentication ApiKeyAuth required + // in header with key required + authType: AuthTypeEnum.InHeader, + authKey: "x-rh-identity" + } + ] + }; + + return sendRequest(Promise.resolve(args)); +} + +export default apiHostGroupGetHostListByGroupParamCreator; diff --git a/packages/host-inventory/ApiHostHostCheckin/index.ts b/packages/host-inventory/src/ApiHostHostCheckin/index.ts similarity index 100% rename from packages/host-inventory/ApiHostHostCheckin/index.ts rename to packages/host-inventory/src/ApiHostHostCheckin/index.ts diff --git a/packages/host-inventory/ApiHostMergeFacts/index.ts b/packages/host-inventory/src/ApiHostMergeFacts/index.ts similarity index 100% rename from packages/host-inventory/ApiHostMergeFacts/index.ts rename to packages/host-inventory/src/ApiHostMergeFacts/index.ts diff --git a/packages/host-inventory/ApiHostPatchHostById/index.ts b/packages/host-inventory/src/ApiHostPatchHostById/index.ts similarity index 96% rename from packages/host-inventory/ApiHostPatchHostById/index.ts rename to packages/host-inventory/src/ApiHostPatchHostById/index.ts index d69467ff5..8db42eb58 100644 --- a/packages/host-inventory/ApiHostPatchHostById/index.ts +++ b/packages/host-inventory/src/ApiHostPatchHostById/index.ts @@ -8,7 +8,7 @@ import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/b import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; // @ts-ignore -import type { PatchHostIn } from '../types'; +import type { NotFoundErrorResponse, PatchHostIn } from '../types'; export type ApiHostPatchHostByIdParams = { @@ -33,7 +33,7 @@ export type ApiHostPatchHostByIdParams = { options?: AxiosRequestConfig } -export type ApiHostPatchHostByIdReturnType = void; +export type ApiHostPatchHostByIdReturnType = object; const isApiHostPatchHostByIdObjectParams = (params: [ApiHostPatchHostByIdParams] | unknown[]): params is [ApiHostPatchHostByIdParams] => { const l = params.length === 1 diff --git a/packages/host-inventory/ApiHostReplaceFacts/index.ts b/packages/host-inventory/src/ApiHostReplaceFacts/index.ts similarity index 100% rename from packages/host-inventory/ApiHostReplaceFacts/index.ts rename to packages/host-inventory/src/ApiHostReplaceFacts/index.ts diff --git a/packages/host-inventory/src/ApiHostViewsGetHostViews/index.ts b/packages/host-inventory/src/ApiHostViewsGetHostViews/index.ts new file mode 100644 index 000000000..9bf6fb31e --- /dev/null +++ b/packages/host-inventory/src/ApiHostViewsGetHostViews/index.ts @@ -0,0 +1,380 @@ +// @ts-ignore +import type { AxiosPromise, AxiosInstance, AxiosRequestConfig, Method } from 'axios'; +// @ts-ignore +import { COLLECTION_FORMATS, RequiredError, AuthTypeEnum, DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +import type { RequestArgs } from '@redhat-cloud-services/javascript-clients-shared/dist/common'; +// @ts-ignore +import { BaseAPI } from '@redhat-cloud-services/javascript-clients-shared/dist/base'; +import { Configuration } from '@redhat-cloud-services/javascript-clients-shared/dist/configuration'; + +// @ts-ignore +import type { HostViewFilterComparison, HostViewQueryOutput } from '../types'; + + +export type ApiHostViewsGetHostViewsParams = { + /** + * Filter by display_name (case-insensitive) + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + displayName?: string, + /** + * Filter by FQDN (case-insensitive) + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + fqdn?: string, + /** + * Filter by display_name, fqdn, id (case-insensitive) + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + hostnameOrId?: string, + /** + * Filter by insights_id + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + insightsId?: string, + /** + * Filter by subscription_manager_id + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + subscriptionManagerId?: string, + /** + * Filter by provider_id + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + providerId?: string, + /** + * Filter by provider_type + * @type { ApiHostViewsGetHostViewsProviderTypeEnum } + * @memberof ApiHostViewsGetHostViewsApi + */ + providerType?: ApiHostViewsGetHostViewsProviderTypeEnum, + /** + * Only show hosts last modified after the given date + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + updatedStart?: string, + /** + * Only show hosts last modified before the given date + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + updatedEnd?: string, + /** + * Only show hosts last checked in after the given date + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + lastCheckInStart?: string, + /** + * Only show hosts last checked in before the given date + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + lastCheckInEnd?: string, + /** + * Filter by group name + * @type { Array } + * @memberof ApiHostViewsGetHostViewsApi + */ + groupName?: Array, + /** + * Filter by branch_id + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + branchId?: string, + /** + * A number of items to return per page. + * @type { number } + * @memberof ApiHostViewsGetHostViewsApi + */ + perPage?: number, + /** + * A page number of the items to return. + * @type { number } + * @memberof ApiHostViewsGetHostViewsApi + */ + page?: number, + /** + * Ordering field for host views. Accepts standard host columns or application metrics using `app:field` format. Use together with `order_how`. **Host fields:** `display_name`, `group_name`, `updated`, `operating_system`, `last_check_in` **App fields:** See `AppSortableFields` schema for the full list of available application sort fields (e.g. `vulnerability:critical_cves`, `advisor:recommendations`). + * @type { ApiHostViewsGetHostViewsOrderByEnum } + * @memberof ApiHostViewsGetHostViewsApi + */ + orderBy?: ApiHostViewsGetHostViewsOrderByEnum, + /** + * Direction of the ordering (case-insensitive); defaults to ASC for display_name, and to DESC for updated and operating_system + * @type { string } + * @memberof ApiHostViewsGetHostViewsApi + */ + orderHow?: string, + /** + * Culling states of the hosts. Default: fresh, stale and stale_warning + * @type { Array } + * @memberof ApiHostViewsGetHostViewsApi + */ + staleness?: Array, + /** + * Filters systems by tag(s). Specify multiple tags as a comma-separated list (e.g. insights-client/security=strict,env/type=prod). + * @type { Array } + * @memberof ApiHostViewsGetHostViewsApi + */ + tags?: Array, + /** + * Filters out any host not registered by the specified reporters + * @type { Array } + * @memberof ApiHostViewsGetHostViewsApi + */ + registeredWith?: Array, + /** + * Filters systems by type + * @type { Array } + * @memberof ApiHostViewsGetHostViewsApi + */ + systemType?: Array, + /** + * Filters on aggregated application data using the syntax `filter[app_name][field_name][operator]=value`. Supported operators are `eq`, `ne`, `gte`, and `lte`. For example: `filter[vulnerability][critical_cves][gte]=1` or `filter[patch][template][eq]=production`. + * @type { { [key: string]: any; } } + * @memberof ApiHostViewsGetHostViewsApi + */ + filter?: { [key: string]: any; }, + /** + * Selects which application objects (or sub-fields) should be joined into the host view response. Use `fields[advisor]=recommendations` to request specific fields, or `fields[advisor]=recommendations&fields[vulnerability]=critical_cves` for multiple apps. When this parameter is omitted, all fields from all applications are returned by default (per JSON:API sparse fieldsets specification). + * @type { { [key: string]: { [key: string]: boolean; }; } } + * @memberof ApiHostViewsGetHostViewsApi + */ + fields?: { [key: string]: { [key: string]: boolean; }; }, + options?: AxiosRequestConfig +} +/** + * @export + * @enum {string} + */ +export const ApiHostViewsGetHostViewsProviderTypeEnum = { + Alibaba: 'alibaba', + Aws: 'aws', + Azure: 'azure', + Discovery: 'discovery', + Gcp: 'gcp', + Ibm: 'ibm' +} as const; +export type ApiHostViewsGetHostViewsProviderTypeEnum = typeof ApiHostViewsGetHostViewsProviderTypeEnum[keyof typeof ApiHostViewsGetHostViewsProviderTypeEnum]; +/** + * @export + * @enum {string} + */ +export const ApiHostViewsGetHostViewsOrderByEnum = { + DisplayName: 'display_name', + GroupName: 'group_name', + Updated: 'updated', + OperatingSystem: 'operating_system', + LastCheckIn: 'last_check_in', + Advisorrecommendations: 'advisor:recommendations', + Advisorincidents: 'advisor:incidents', + VulnerabilitytotalCves: 'vulnerability:total_cves', + VulnerabilitycriticalCves: 'vulnerability:critical_cves', + PatchadvisoriesRhsaInstallable: 'patch:advisories_rhsa_installable', + PatchpackagesInstallable: 'patch:packages_installable', + RemediationsremediationsPlans: 'remediations:remediations_plans', + CompliancelastScan: 'compliance:last_scan', + MalwarelastMatches: 'malware:last_matches', + MalwarelastScan: 'malware:last_scan' +} as const; +export type ApiHostViewsGetHostViewsOrderByEnum = typeof ApiHostViewsGetHostViewsOrderByEnum[keyof typeof ApiHostViewsGetHostViewsOrderByEnum]; +/** + * @export + * @enum {string} + */ +export const ApiHostViewsGetHostViewsStalenessEnum = { + Fresh: 'fresh', + Stale: 'stale', + StaleWarning: 'stale_warning', + Unknown: 'unknown' +} as const; +export type ApiHostViewsGetHostViewsStalenessEnum = typeof ApiHostViewsGetHostViewsStalenessEnum[keyof typeof ApiHostViewsGetHostViewsStalenessEnum]; +/** + * @export + * @enum {string} + */ +export const ApiHostViewsGetHostViewsRegisteredWithEnum = { + Insights: 'insights', + Yupana: 'yupana', + Satellite: 'satellite', + Discovery: 'discovery', + Puptoo: 'puptoo', + RhsmConduit: 'rhsm-conduit', + CloudConnector: 'cloud-connector', + NotYupana: '!yupana', + NotSatellite: '!satellite', + NotDiscovery: '!discovery', + NotPuptoo: '!puptoo', + NotRhsmConduit: '!rhsm-conduit', + NotCloudConnector: '!cloud-connector' +} as const; +export type ApiHostViewsGetHostViewsRegisteredWithEnum = typeof ApiHostViewsGetHostViewsRegisteredWithEnum[keyof typeof ApiHostViewsGetHostViewsRegisteredWithEnum]; +/** + * @export + * @enum {string} + */ +export const ApiHostViewsGetHostViewsSystemTypeEnum = { + Conventional: 'conventional', + Bootc: 'bootc', + Edge: 'edge', + Cluster: 'cluster' +} as const; +export type ApiHostViewsGetHostViewsSystemTypeEnum = typeof ApiHostViewsGetHostViewsSystemTypeEnum[keyof typeof ApiHostViewsGetHostViewsSystemTypeEnum]; + +export type ApiHostViewsGetHostViewsReturnType = HostViewQueryOutput; + +const isApiHostViewsGetHostViewsObjectParams = (params: [ApiHostViewsGetHostViewsParams] | unknown[]): params is [ApiHostViewsGetHostViewsParams] => { + const l = params.length === 1 + if(l && typeof params[0] === 'object' && !Array.isArray(params[0])) { + return true + } + return false +} +/** +* **[Work In Progress]** This endpoint is under active development and currently returns HTTP 501 (Not Implemented).

Read a combined view of hosts with optional application data such as Advisor, Vulnerability, Compliance, Patch, and others. Application joins are opt-in and controlled through the fields parameter.

Required permissions: inventory:hosts:read +* @summary [WIP] Read aggregated host and application data +* @param {ApiHostViewsGetHostViewsParams} config with all available params. +* @param {*} [options] Override http request option. +* @throws {RequiredError} +*/ +export const apiHostViewsGetHostViewsParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiHostViewsGetHostViewsParams] | [string, string, string, string, string, string, ApiHostViewsGetHostViewsProviderTypeEnum, string, string, string, string, Array, string, number, number, ApiHostViewsGetHostViewsOrderByEnum, string, Array, Array, Array, Array, { [key: string]: any; }, { [key: string]: { [key: string]: boolean; }; }, AxiosRequestConfig])) => { + const params = isApiHostViewsGetHostViewsObjectParams(config) ? config[0] : ['displayName', 'fqdn', 'hostnameOrId', 'insightsId', 'subscriptionManagerId', 'providerId', 'providerType', 'updatedStart', 'updatedEnd', 'lastCheckInStart', 'lastCheckInEnd', 'groupName', 'branchId', 'perPage', 'page', 'orderBy', 'orderHow', 'staleness', 'tags', 'registeredWith', 'systemType', 'filter', 'fields', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiHostViewsGetHostViewsParams; + const { displayName, fqdn, hostnameOrId, insightsId, subscriptionManagerId, providerId, providerType, updatedStart, updatedEnd, lastCheckInStart, lastCheckInEnd, groupName, branchId, perPage, page, orderBy, orderHow, staleness, tags, registeredWith, systemType, filter, fields, options = {} } = params; + const localVarPath = `/beta/hosts-view`; + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + const localVarRequestOptions = { method: 'GET' as Method, ...options}; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (displayName !== undefined) { + localVarQueryParameter['display_name'] = displayName; + } + + if (fqdn !== undefined) { + localVarQueryParameter['fqdn'] = fqdn; + } + + if (hostnameOrId !== undefined) { + localVarQueryParameter['hostname_or_id'] = hostnameOrId; + } + + if (insightsId !== undefined) { + localVarQueryParameter['insights_id'] = insightsId; + } + + if (subscriptionManagerId !== undefined) { + localVarQueryParameter['subscription_manager_id'] = subscriptionManagerId; + } + + if (providerId !== undefined) { + localVarQueryParameter['provider_id'] = providerId; + } + + if (providerType !== undefined) { + localVarQueryParameter['provider_type'] = providerType; + } + + if (updatedStart !== undefined) { + localVarQueryParameter['updated_start'] = (updatedStart as any instanceof Date) ? + (updatedStart as any).toISOString() : + updatedStart; + } + + if (updatedEnd !== undefined) { + localVarQueryParameter['updated_end'] = (updatedEnd as any instanceof Date) ? + (updatedEnd as any).toISOString() : + updatedEnd; + } + + if (lastCheckInStart !== undefined) { + localVarQueryParameter['last_check_in_start'] = (lastCheckInStart as any instanceof Date) ? + (lastCheckInStart as any).toISOString() : + lastCheckInStart; + } + + if (lastCheckInEnd !== undefined) { + localVarQueryParameter['last_check_in_end'] = (lastCheckInEnd as any instanceof Date) ? + (lastCheckInEnd as any).toISOString() : + lastCheckInEnd; + } + + if (groupName) { + localVarQueryParameter['group_name'] = groupName; + } + + if (branchId !== undefined) { + localVarQueryParameter['branch_id'] = branchId; + } + + if (perPage !== undefined) { + localVarQueryParameter['per_page'] = perPage; + } + + if (page !== undefined) { + localVarQueryParameter['page'] = page; + } + + if (orderBy !== undefined) { + localVarQueryParameter['order_by'] = orderBy; + } + + if (orderHow !== undefined) { + localVarQueryParameter['order_how'] = orderHow; + } + + if (staleness) { + localVarQueryParameter['staleness'] = staleness; + } + + if (tags) { + localVarQueryParameter['tags'] = tags; + } + + if (registeredWith) { + localVarQueryParameter['registered_with'] = registeredWith; + } + + if (systemType) { + localVarQueryParameter['system_type'] = systemType; + } + + if (filter !== undefined) { + localVarQueryParameter['filter'] = filter; + } + + if (fields !== undefined) { + localVarQueryParameter['fields'] = fields; + } + + + + setSearchParams(localVarUrlObj, localVarQueryParameter); + localVarRequestOptions.headers = {...localVarHeaderParameter, ...options.headers}; + + const args = { + urlObj: localVarUrlObj, + options: localVarRequestOptions, + auth:[ + { + // authentication ApiKeyAuth required + // in header with key required + authType: AuthTypeEnum.InHeader, + authKey: "x-rh-identity" + } + ] + }; + + return sendRequest(Promise.resolve(args)); +} + +export default apiHostViewsGetHostViewsParamCreator; diff --git a/packages/host-inventory/ApiResourceTypeGetResourceTypeGroupsList/index.ts b/packages/host-inventory/src/ApiResourceTypeGetResourceTypeGroupsList/index.ts similarity index 100% rename from packages/host-inventory/ApiResourceTypeGetResourceTypeGroupsList/index.ts rename to packages/host-inventory/src/ApiResourceTypeGetResourceTypeGroupsList/index.ts diff --git a/packages/host-inventory/ApiResourceTypeGetResourceTypeList/index.ts b/packages/host-inventory/src/ApiResourceTypeGetResourceTypeList/index.ts similarity index 100% rename from packages/host-inventory/ApiResourceTypeGetResourceTypeList/index.ts rename to packages/host-inventory/src/ApiResourceTypeGetResourceTypeList/index.ts diff --git a/packages/host-inventory/ApiStalenessCreateStaleness/index.ts b/packages/host-inventory/src/ApiStalenessCreateStaleness/index.ts similarity index 100% rename from packages/host-inventory/ApiStalenessCreateStaleness/index.ts rename to packages/host-inventory/src/ApiStalenessCreateStaleness/index.ts diff --git a/packages/host-inventory/ApiStalenessDeleteStaleness/index.ts b/packages/host-inventory/src/ApiStalenessDeleteStaleness/index.ts similarity index 100% rename from packages/host-inventory/ApiStalenessDeleteStaleness/index.ts rename to packages/host-inventory/src/ApiStalenessDeleteStaleness/index.ts diff --git a/packages/host-inventory/ApiStalenessGetDefaultStaleness/index.ts b/packages/host-inventory/src/ApiStalenessGetDefaultStaleness/index.ts similarity index 100% rename from packages/host-inventory/ApiStalenessGetDefaultStaleness/index.ts rename to packages/host-inventory/src/ApiStalenessGetDefaultStaleness/index.ts diff --git a/packages/host-inventory/ApiStalenessGetStaleness/index.ts b/packages/host-inventory/src/ApiStalenessGetStaleness/index.ts similarity index 100% rename from packages/host-inventory/ApiStalenessGetStaleness/index.ts rename to packages/host-inventory/src/ApiStalenessGetStaleness/index.ts diff --git a/packages/host-inventory/ApiStalenessUpdateStaleness/index.ts b/packages/host-inventory/src/ApiStalenessUpdateStaleness/index.ts similarity index 100% rename from packages/host-inventory/ApiStalenessUpdateStaleness/index.ts rename to packages/host-inventory/src/ApiStalenessUpdateStaleness/index.ts diff --git a/packages/host-inventory/ApiSystemProfileGetOperatingSystem/index.ts b/packages/host-inventory/src/ApiSystemProfileGetOperatingSystem/index.ts similarity index 100% rename from packages/host-inventory/ApiSystemProfileGetOperatingSystem/index.ts rename to packages/host-inventory/src/ApiSystemProfileGetOperatingSystem/index.ts diff --git a/packages/host-inventory/ApiSystemProfileGetSapSids/index.ts b/packages/host-inventory/src/ApiSystemProfileGetSapSids/index.ts similarity index 100% rename from packages/host-inventory/ApiSystemProfileGetSapSids/index.ts rename to packages/host-inventory/src/ApiSystemProfileGetSapSids/index.ts diff --git a/packages/host-inventory/ApiSystemProfileGetSapSystem/index.ts b/packages/host-inventory/src/ApiSystemProfileGetSapSystem/index.ts similarity index 100% rename from packages/host-inventory/ApiSystemProfileGetSapSystem/index.ts rename to packages/host-inventory/src/ApiSystemProfileGetSapSystem/index.ts diff --git a/packages/host-inventory/ApiSystemProfileValidateSchema/index.ts b/packages/host-inventory/src/ApiSystemProfileValidateSchema/index.ts similarity index 100% rename from packages/host-inventory/ApiSystemProfileValidateSchema/index.ts rename to packages/host-inventory/src/ApiSystemProfileValidateSchema/index.ts diff --git a/packages/host-inventory/ApiTagGetTags/index.ts b/packages/host-inventory/src/ApiTagGetTags/index.ts similarity index 94% rename from packages/host-inventory/ApiTagGetTags/index.ts rename to packages/host-inventory/src/ApiTagGetTags/index.ts index e3e33c8dc..e446d85aa 100644 --- a/packages/host-inventory/ApiTagGetTags/index.ts +++ b/packages/host-inventory/src/ApiTagGetTags/index.ts @@ -121,6 +121,12 @@ export type ApiTagGetTagsParams = { */ groupName?: Array, /** + * Filter by group ID (UUID format) + * @type { Array } + * @memberof ApiTagGetTagsApi + */ + groupId?: Array, + /** * Filters out any host not registered by the specified reporters * @type { Array } * @memberof ApiTagGetTagsApi @@ -221,9 +227,9 @@ const isApiTagGetTagsObjectParams = (params: [ApiTagGetTagsParams] | unknown[]): * @param {*} [options] Override http request option. * @throws {RequiredError} */ -export const apiTagGetTagsParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiTagGetTagsParams] | [Array, ApiTagGetTagsOrderByEnum, string, number, number, Array, string, string, string, string, string, string, ApiTagGetTagsProviderTypeEnum, string, string, string, string, Array, Array, Array, { [key: string]: SystemProfileNestedObjectValue; }, AxiosRequestConfig])) => { - const params = isApiTagGetTagsObjectParams(config) ? config[0] : ['tags', 'orderBy', 'orderHow', 'perPage', 'page', 'staleness', 'search', 'displayName', 'fqdn', 'hostnameOrId', 'insightsId', 'providerId', 'providerType', 'updatedStart', 'updatedEnd', 'lastCheckInStart', 'lastCheckInEnd', 'groupName', 'registeredWith', 'systemType', 'filter', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiTagGetTagsParams; - const { tags, orderBy, orderHow, perPage, page, staleness, search, displayName, fqdn, hostnameOrId, insightsId, providerId, providerType, updatedStart, updatedEnd, lastCheckInStart, lastCheckInEnd, groupName, registeredWith, systemType, filter, options = {} } = params; +export const apiTagGetTagsParamCreator = async (sendRequest: BaseAPI["sendRequest"], ...config: ([ApiTagGetTagsParams] | [Array, ApiTagGetTagsOrderByEnum, string, number, number, Array, string, string, string, string, string, string, ApiTagGetTagsProviderTypeEnum, string, string, string, string, Array, Array, Array, Array, { [key: string]: SystemProfileNestedObjectValue; }, AxiosRequestConfig])) => { + const params = isApiTagGetTagsObjectParams(config) ? config[0] : ['tags', 'orderBy', 'orderHow', 'perPage', 'page', 'staleness', 'search', 'displayName', 'fqdn', 'hostnameOrId', 'insightsId', 'providerId', 'providerType', 'updatedStart', 'updatedEnd', 'lastCheckInStart', 'lastCheckInEnd', 'groupName', 'groupId', 'registeredWith', 'systemType', 'filter', 'options'].reduce((acc, curr, index) => ({ ...acc, [curr]: config[index] }), {}) as ApiTagGetTagsParams; + const { tags, orderBy, orderHow, perPage, page, staleness, search, displayName, fqdn, hostnameOrId, insightsId, providerId, providerType, updatedStart, updatedEnd, lastCheckInStart, lastCheckInEnd, groupName, groupId, registeredWith, systemType, filter, options = {} } = params; const localVarPath = `/tags`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -311,6 +317,10 @@ export const apiTagGetTagsParamCreator = async (sendRequest: BaseAPI["sendReques localVarQueryParameter['group_name'] = groupName; } + if (groupId) { + localVarQueryParameter['group_id'] = groupId; + } + if (registeredWith) { localVarQueryParameter['registered_with'] = registeredWith; } diff --git a/packages/host-inventory/api.ts b/packages/host-inventory/src/api.ts similarity index 94% rename from packages/host-inventory/api.ts rename to packages/host-inventory/src/api.ts index 813a2afa0..992601a5f 100644 --- a/packages/host-inventory/api.ts +++ b/packages/host-inventory/src/api.ts @@ -20,10 +20,12 @@ import { apiHostGetHostTags, apiHostGroupAddHostListToGroup, apiHostGroupDeleteHostsFromGroup, + apiHostGroupGetHostListByGroup, apiHostHostCheckin, apiHostMergeFacts, apiHostPatchHostById, apiHostReplaceFacts, + apiHostViewsGetHostViews, apiResourceTypeGetResourceTypeGroupsList, apiResourceTypeGetResourceTypeList, apiStalenessCreateStaleness, @@ -57,10 +59,12 @@ const endpointList = { apiHostGetHostTags, apiHostGroupAddHostListToGroup, apiHostGroupDeleteHostsFromGroup, + apiHostGroupGetHostListByGroup, apiHostHostCheckin, apiHostMergeFacts, apiHostPatchHostById, apiHostReplaceFacts, + apiHostViewsGetHostViews, apiResourceTypeGetResourceTypeGroupsList, apiResourceTypeGetResourceTypeList, apiStalenessCreateStaleness, diff --git a/packages/host-inventory/index.ts b/packages/host-inventory/src/index.ts similarity index 94% rename from packages/host-inventory/index.ts rename to packages/host-inventory/src/index.ts index 0d7be7c60..3f5cd4cd7 100644 --- a/packages/host-inventory/index.ts +++ b/packages/host-inventory/src/index.ts @@ -32,6 +32,8 @@ export { default as apiHostGroupAddHostListToGroup, type ApiHostGroupAddHostList export { default as apiHostGroupDeleteHostsFromGroup, type ApiHostGroupDeleteHostsFromGroupReturnType } from './ApiHostGroupDeleteHostsFromGroup' +export { default as apiHostGroupGetHostListByGroup, type ApiHostGroupGetHostListByGroupReturnType } from './ApiHostGroupGetHostListByGroup' + export { default as apiHostHostCheckin, type ApiHostHostCheckinReturnType } from './ApiHostHostCheckin' export { default as apiHostMergeFacts, type ApiHostMergeFactsReturnType } from './ApiHostMergeFacts' @@ -40,6 +42,8 @@ export { default as apiHostPatchHostById, type ApiHostPatchHostByIdReturnType } export { default as apiHostReplaceFacts, type ApiHostReplaceFactsReturnType } from './ApiHostReplaceFacts' +export { default as apiHostViewsGetHostViews, type ApiHostViewsGetHostViewsReturnType } from './ApiHostViewsGetHostViews' + export { default as apiResourceTypeGetResourceTypeGroupsList, type ApiResourceTypeGetResourceTypeGroupsListReturnType } from './ApiResourceTypeGetResourceTypeGroupsList' export { default as apiResourceTypeGetResourceTypeList, type ApiResourceTypeGetResourceTypeListReturnType } from './ApiResourceTypeGetResourceTypeList' @@ -66,5 +70,3 @@ export { default as apiTagGetTags, type ApiTagGetTagsReturnType } from './ApiTag export * from './types' - -// Trigger release - updated to regenerate clients diff --git a/packages/host-inventory/types/index.ts b/packages/host-inventory/src/types/index.ts similarity index 80% rename from packages/host-inventory/types/index.ts rename to packages/host-inventory/src/types/index.ts index 0f5d9af42..9b8bb9938 100644 --- a/packages/host-inventory/types/index.ts +++ b/packages/host-inventory/src/types/index.ts @@ -54,6 +54,47 @@ export interface ActiveTags { */ 'results': Array; } +/** + * + * @export + * @interface AdvisorAppData + */ +export interface AdvisorAppData { + /** + * + * @type {number} + * @memberof AdvisorAppData + */ + 'recommendations'?: number | null; + /** + * + * @type {number} + * @memberof AdvisorAppData + */ + 'incidents'?: number | null; +} +/** + * Application data fields available for sorting in the /hosts-view endpoint. Use format `app_name:field_name` with the `order_by` parameter. **Advisor** - `advisor:recommendations` - Number of Advisor recommendations - `advisor:incidents` - Number of Advisor incidents **Vulnerability** - `vulnerability:total_cves` - Total CVE count - `vulnerability:critical_cves` - Critical severity CVEs **Patch** - `patch:advisories_rhsa_installable` - Number of RHSA installable advisories - `patch:packages_installable` - Number of installable packages **Remediations** - `remediations:remediations_plans` - Active remediation plans count **Compliance** - `compliance:last_scan` - Last compliance scan timestamp **Malware** - `malware:last_matches` - Malware matches count - `malware:last_scan` - Last malware scan timestamp + * @export + * @enum {string} + */ + +export const AppSortableFields = { + Advisorrecommendations: 'advisor:recommendations', + Advisorincidents: 'advisor:incidents', + VulnerabilitytotalCves: 'vulnerability:total_cves', + VulnerabilitycriticalCves: 'vulnerability:critical_cves', + PatchadvisoriesRhsaInstallable: 'patch:advisories_rhsa_installable', + PatchpackagesInstallable: 'patch:packages_installable', + RemediationsremediationsPlans: 'remediations:remediations_plans', + CompliancelastScan: 'compliance:last_scan', + MalwarelastMatches: 'malware:last_matches', + MalwarelastScan: 'malware:last_scan' +} as const; + +export type AppSortableFields = typeof AppSortableFields[keyof typeof AppSortableFields]; + + /** * * @export @@ -176,6 +217,68 @@ export interface CanonicalFactsOut { */ 'provider_type'?: string | null; } +/** + * + * @export + * @interface ComplianceAppData + */ +export interface ComplianceAppData { + /** + * + * @type {number} + * @memberof ComplianceAppData + */ + 'policies'?: number | null; + /** + * + * @type {string} + * @memberof ComplianceAppData + */ + 'last_scan'?: string | null; +} +/** + * Application-specific metrics and metadata associated with a host. + * @export + * @interface ConsumerApplicationsData + */ +export interface ConsumerApplicationsData { + /** + * + * @type {AdvisorAppData} + * @memberof ConsumerApplicationsData + */ + 'advisor'?: AdvisorAppData; + /** + * + * @type {VulnerabilityAppData} + * @memberof ConsumerApplicationsData + */ + 'vulnerability'?: VulnerabilityAppData; + /** + * + * @type {PatchAppData} + * @memberof ConsumerApplicationsData + */ + 'patch'?: PatchAppData; + /** + * + * @type {RemediationsAppData} + * @memberof ConsumerApplicationsData + */ + 'remediations'?: RemediationsAppData; + /** + * + * @type {ComplianceAppData} + * @memberof ConsumerApplicationsData + */ + 'compliance'?: ComplianceAppData; + /** + * + * @type {MalwareAppData} + * @memberof ConsumerApplicationsData + */ + 'malware'?: MalwareAppData; +} /** * Data required to create a check-in record for a host. * @export @@ -594,6 +697,12 @@ export interface HostOut { * @memberof HostOut */ 'last_check_in'?: string; + /** + * The OpenShift cluster ID that the host belongs to, if any. + * @type {string} + * @memberof HostOut + */ + 'openshift_cluster_id'?: string | null; } /** * A paginated host search query result with host entries and their Inventory metadata. @@ -651,6 +760,330 @@ export interface HostSystemProfileOut { */ 'system_profile'?: SystemProfile; } +/** + * Supported comparison operators for application metrics filtering. **Value comparisons:** - `eq` - Equal to - `ne` - Not equal to - `gt` - Greater than - `lt` - Less than - `gte` - Greater than or equal to - `lte` - Less than or equal to **null checks:** - `nil` - Field is null/missing - `not_nil` - Field is not null/exists + * @export + * @interface HostViewFilterComparison + */ +export interface HostViewFilterComparison { + /** + * + * @type {string} + * @memberof HostViewFilterComparison + */ + 'eq'?: string; + /** + * + * @type {string} + * @memberof HostViewFilterComparison + */ + 'ne'?: string; + /** + * + * @type {string} + * @memberof HostViewFilterComparison + */ + 'gt'?: string; + /** + * + * @type {string} + * @memberof HostViewFilterComparison + */ + 'lt'?: string; + /** + * + * @type {string} + * @memberof HostViewFilterComparison + */ + 'gte'?: string; + /** + * + * @type {string} + * @memberof HostViewFilterComparison + */ + 'lte'?: string; + /** + * When true, matches hosts where this field is null/missing. + * @type {boolean} + * @memberof HostViewFilterComparison + */ + 'nil'?: boolean; + /** + * When true, matches hosts where this field exists and is not null. + * @type {boolean} + * @memberof HostViewFilterComparison + */ + 'not_nil'?: boolean; +} +/** + * + * @export + * @interface HostViewHost + */ +export interface HostViewHost { + /** + * An ID defined in /etc/insights-client/machine-id. This field is considered a canonical fact. + * @type {string} + * @memberof HostViewHost + */ + 'insights_id'?: string | null; + /** + * A Red Hat Subcription Manager ID of a RHEL host. This field is considered to be a canonical fact. + * @type {string} + * @memberof HostViewHost + */ + 'subscription_manager_id'?: string | null; + /** + * A Red Hat Satellite ID of a RHEL host. This field is considered to be a canonical fact. + * @type {string} + * @memberof HostViewHost + */ + 'satellite_id'?: string | null; + /** + * A UUID of the host machine BIOS. This field is considered to be a canonical fact. + * @type {string} + * @memberof HostViewHost + */ + 'bios_uuid'?: string | null; + /** + * Host’s network IP addresses. This field is considered to be a canonical fact. + * @type {Array} + * @memberof HostViewHost + */ + 'ip_addresses'?: Array | null; + /** + * A host’s Fully Qualified Domain Name. This field is considered to be a canonical fact. + * @type {string} + * @memberof HostViewHost + */ + 'fqdn'?: string | null; + /** + * Host’s network interfaces MAC addresses. This field is considered to be a canonical fact. + * @type {Array} + * @memberof HostViewHost + */ + 'mac_addresses'?: Array | null; + /** + * Host’s reference in the external source e.g. Alibaba, AWS EC2, Azure, GCP, IBM etc. This field is one of the canonical facts and does not work without provider_type. + * @type {string} + * @memberof HostViewHost + */ + 'provider_id'?: string | null; + /** + * Type of external source e.g. Alibaba, AWS EC2, Azure, GCP, IBM, etc. This field is one of the canonical facts and does not workout provider_id. + * @type {string} + * @memberof HostViewHost + */ + 'provider_type'?: string | null; + /** + * A host’s human-readable display name, e.g. in a form of a domain name. + * @type {string} + * @memberof HostViewHost + */ + 'display_name'?: string | null; + /** + * The ansible host name for remediations + * @type {string} + * @memberof HostViewHost + */ + 'ansible_host'?: string | null; + /** + * A Red Hat Account number that owns the host. + * @type {string} + * @memberof HostViewHost + * @deprecated + */ + 'account'?: string | null; + /** + * The Org ID of the tenant that owns the host. + * @type {string} + * @memberof HostViewHost + */ + 'org_id': string; + /** + * A durable and reliable platform-wide host identifier. Applications should use this identifier to reference hosts. + * @type {string} + * @memberof HostViewHost + */ + 'id'?: string; + /** + * A timestamp when the entry was created. + * @type {string} + * @memberof HostViewHost + */ + 'created'?: string; + /** + * A timestamp when the entry was last updated. + * @type {string} + * @memberof HostViewHost + */ + 'updated'?: string; + /** + * A set of facts belonging to the host. + * @type {Array} + * @memberof HostViewHost + */ + 'facts'?: Array; + /** + * Timestamp from which the host is considered stale. + * @type {string} + * @memberof HostViewHost + */ + 'stale_timestamp'?: string | null; + /** + * Timestamp from which the host is considered too stale to be listed without an explicit toggle. + * @type {string} + * @memberof HostViewHost + */ + 'stale_warning_timestamp'?: string | null; + /** + * Timestamp from which the host is considered deleted. + * @type {string} + * @memberof HostViewHost + */ + 'culled_timestamp'?: string | null; + /** + * Reporting source of the host. Used when updating the stale_timestamp. + * @type {string} + * @memberof HostViewHost + */ + 'reporter'?: string | null; + /** + * Reporting source of the last checkin status, stale_timestamp, and last_check_in. + * @type {{ [key: string]: PerReporterStaleness; }} + * @memberof HostViewHost + */ + 'per_reporter_staleness'?: { [key: string]: PerReporterStaleness; }; + /** + * The groups that the host belongs to, if any. + * @type {Array} + * @memberof HostViewHost + */ + 'groups'?: Array; + /** + * + * @type {SystemProfile} + * @memberof HostViewHost + */ + 'system_profile'?: SystemProfile; + /** + * + * @type {string} + * @memberof HostViewHost + */ + 'last_check_in'?: string; + /** + * The OpenShift cluster ID that the host belongs to, if any. + * @type {string} + * @memberof HostViewHost + */ + 'openshift_cluster_id'?: string | null; + /** + * + * @type {ConsumerApplicationsData} + * @memberof HostViewHost + */ + 'app_data'?: ConsumerApplicationsData; +} +/** + * A paginated host view that optionally includes application data joins. + * @export + * @interface HostViewQueryOutput + */ +export interface HostViewQueryOutput { + /** + * The number of items on the current page + * @type {number} + * @memberof HostViewQueryOutput + */ + 'count': number; + /** + * The page number + * @type {number} + * @memberof HostViewQueryOutput + */ + 'page': number; + /** + * The number of items to return per page + * @type {number} + * @memberof HostViewQueryOutput + */ + 'per_page': number; + /** + * Total number of items + * @type {number} + * @memberof HostViewQueryOutput + */ + 'total': number; + /** + * Combined host and application entries. + * @type {Array} + * @memberof HostViewQueryOutput + */ + 'results': Array; +} +/** + * + * @export + * @interface MalwareAppData + */ +export interface MalwareAppData { + /** + * + * @type {string} + * @memberof MalwareAppData + */ + 'last_status'?: string | null; + /** + * + * @type {number} + * @memberof MalwareAppData + */ + 'last_matches'?: number | null; + /** + * + * @type {string} + * @memberof MalwareAppData + */ + 'last_scan'?: string | null; +} +/** + * Error response returned when one or more requested resources are not found. + * @export + * @interface NotFoundErrorResponse + */ +export interface NotFoundErrorResponse { + /** + * The HTTP status code. + * @type {number} + * @memberof NotFoundErrorResponse + */ + 'status': number; + /** + * A short summary of the error. + * @type {string} + * @memberof NotFoundErrorResponse + */ + 'title': string; + /** + * A human-readable description of the error. + * @type {string} + * @memberof NotFoundErrorResponse + */ + 'detail': string; + /** + * A list of IDs that were requested but not found. This field is included when specific IDs can be identified as missing. + * @type {Array} + * @memberof NotFoundErrorResponse + */ + 'not_found_ids'?: Array; + /** + * The type of the error. + * @type {string} + * @memberof NotFoundErrorResponse + */ + 'type'?: string; +} /** * * @export @@ -682,6 +1115,91 @@ export interface PaginationOut { */ 'total': number; } +/** + * + * @export + * @interface PatchAppData + */ +export interface PatchAppData { + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'advisories_rhsa_applicable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'advisories_rhba_applicable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'advisories_rhea_applicable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'advisories_other_applicable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'advisories_rhsa_installable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'advisories_rhba_installable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'advisories_rhea_installable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'advisories_other_installable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'packages_applicable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'packages_installable'?: number | null; + /** + * + * @type {number} + * @memberof PatchAppData + */ + 'packages_installed'?: number | null; + /** + * + * @type {string} + * @memberof PatchAppData + */ + 'template_name'?: string | null; + /** + * + * @type {string} + * @memberof PatchAppData + */ + 'template_uuid'?: string | null; +} /** * Data of a single host to be updated. * @export @@ -738,6 +1256,19 @@ export interface PerReporterStaleness { */ 'check_in_succeeded'?: boolean; } +/** + * + * @export + * @interface RemediationsAppData + */ +export interface RemediationsAppData { + /** + * + * @type {number} + * @memberof RemediationsAppData + */ + 'remediations_plans'?: number | null; +} /** * A paginated group search query result with group entries and their Inventory metadata in paginated resource-types response format. * @export @@ -2518,3 +3049,40 @@ export interface TagsOut { */ 'results'?: { [key: string]: Array; }; } +/** + * + * @export + * @interface VulnerabilityAppData + */ +export interface VulnerabilityAppData { + /** + * + * @type {number} + * @memberof VulnerabilityAppData + */ + 'total_cves'?: number | null; + /** + * + * @type {number} + * @memberof VulnerabilityAppData + */ + 'critical_cves'?: number | null; + /** + * + * @type {number} + * @memberof VulnerabilityAppData + */ + 'high_severity_cves'?: number | null; + /** + * + * @type {number} + * @memberof VulnerabilityAppData + */ + 'cves_with_security_rules'?: number | null; + /** + * + * @type {number} + * @memberof VulnerabilityAppData + */ + 'cves_with_known_exploits'?: number | null; +} diff --git a/packages/host-inventory/tsconfig.cjs.json b/packages/host-inventory/tsconfig.cjs.json index d29a1ef4a..34a67d692 100644 --- a/packages/host-inventory/tsconfig.cjs.json +++ b/packages/host-inventory/tsconfig.cjs.json @@ -1,6 +1,21 @@ { "extends": "./tsconfig.esm.json", "compilerOptions": { - "module": "CommonJS", + "declaration": true, + "target": "es5", + "module": "commonjs", + "noImplicitAny": true, + "outDir": ".", + "rootDir": ".", + "lib": [ + "es2017", + "dom" + ] }, + "exclude": [ + "dist", + "node_modules", + "*.d.ts", + "jest.config.ts" + ] } diff --git a/packages/host-inventory/tsconfig.esm.json b/packages/host-inventory/tsconfig.esm.json index 28ffe1d28..d3bf25a51 100644 --- a/packages/host-inventory/tsconfig.esm.json +++ b/packages/host-inventory/tsconfig.esm.json @@ -1,13 +1,24 @@ { "extends": "./tsconfig.json", "compilerOptions": { - "outDir": "../../dist/out-tsc", + "target": "es2021", + "module": "esnext", + "moduleResolution": "node", "declaration": true, - "types": ["node"], - "module": "ES2015", - "target": "ES5", - "rootDir": "./", + "declarationMap": true, + "noImplicitAny": true, + "outDir": "esm", + "rootDir": ".", + "lib": [ + "es2017", + "dom" + ] }, - "include": ["*.ts", "**/*.ts"], - "exclude": ["jest.config.ts", "dist"] + "include": ["src/**/*.ts"], + "exclude": [ + "dist", + "node_modules", + "*.d.ts", + "jest.config.ts" + ] } diff --git a/tsconfig.base.json b/tsconfig.base.json index ac97398c7..d2a005ed3 100644 --- a/tsconfig.base.json +++ b/tsconfig.base.json @@ -19,7 +19,7 @@ "@redhat-cloud-services/compliance-client": ["packages/compliance/index.ts"], "@redhat-cloud-services/config-manager-client": ["packages/config-manager/src/index.ts"], "@redhat-cloud-services/entitlements-client": ["packages/entitlements/src/index.ts"], - "@redhat-cloud-services/host-inventory-client": ["packages/host-inventory/index.ts"], + "@redhat-cloud-services/host-inventory-client": ["packages/host-inventory/src/index.ts"], "@redhat-cloud-services/insights-client": ["packages/insights/index.ts"], "@redhat-cloud-services/integrations-client": ["packages/integrations/src/index.ts"], "@redhat-cloud-services/notifications-client": ["packages/notifications/src/index.ts"],