diff --git a/packages/approval/doc/classes/requirederror.md b/packages/approval/doc/classes/requirederror.md index ec22e7b3b..ef2f72e76 100644 --- a/packages/approval/doc/classes/requirederror.md +++ b/packages/approval/doc/classes/requirederror.md @@ -70,7 +70,7 @@ ___ *Inherited from Error.message* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:964* ___ @@ -94,7 +94,7 @@ ___ *Overrides Error.stack* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:965* ___ @@ -103,7 +103,7 @@ ___ **● Error**: *`ErrorConstructor`* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:974* ___ diff --git a/packages/catalog/doc/classes/requirederror.md b/packages/catalog/doc/classes/requirederror.md index a021cbd9b..0fb514a1d 100644 --- a/packages/catalog/doc/classes/requirederror.md +++ b/packages/catalog/doc/classes/requirederror.md @@ -70,7 +70,7 @@ ___ *Inherited from Error.message* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:964* ___ @@ -94,7 +94,7 @@ ___ *Overrides Error.stack* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:965* ___ @@ -103,7 +103,7 @@ ___ **● Error**: *`ErrorConstructor`* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:974* ___ diff --git a/packages/entitlements/doc/classes/requirederror.md b/packages/entitlements/doc/classes/requirederror.md index 20004bb00..0a694744b 100644 --- a/packages/entitlements/doc/classes/requirederror.md +++ b/packages/entitlements/doc/classes/requirederror.md @@ -70,7 +70,7 @@ ___ *Inherited from Error.message* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:964* ___ @@ -94,7 +94,7 @@ ___ *Overrides Error.stack* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:965* ___ @@ -103,7 +103,7 @@ ___ **● Error**: *`ErrorConstructor`* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:974* ___ diff --git a/packages/host-inventory/api.ts b/packages/host-inventory/api.ts index 33fe03e7d..d8d17c9e3 100644 --- a/packages/host-inventory/api.ts +++ b/packages/host-inventory/api.ts @@ -974,6 +974,47 @@ export const HostsApiAxiosParamCreator = function (configuration?: Configuration options: localVarRequestOptions, }; }, + /** + * Delete hosts by IDs + * @summary Delete hosts by IDs + * @param {Array} hostIdList A comma separated list of host IDs. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiHostDeleteById(hostIdList: Array, options: any = {}): RequestArgs { + // verify required parameter 'hostIdList' is not null or undefined + if (hostIdList === null || hostIdList === undefined) { + throw new RequiredError('hostIdList','Required parameter hostIdList was null or undefined when calling apiHostDeleteById.'); + } + const localVarPath = `/hosts/{host_id_list}` + .replace(`{${"host_id_list"}}`, encodeURIComponent(String(hostIdList))); + const localVarUrlObj = url.parse(localVarPath, true); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = Object.assign({ method: 'DELETE' }, baseOptions, options); + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + // authentication ApiKeyAuth required + if (configuration && configuration.apiKey) { + const localVarApiKeyValue = typeof configuration.apiKey === 'function' + ? configuration.apiKey("x-rh-identity") + : configuration.apiKey; + localVarHeaderParameter["x-rh-identity"] = localVarApiKeyValue; + } + + localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query); + // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943 + delete localVarUrlObj.search; + localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers); + + return { + url: url.format(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * Find one or more hosts by their ID. * @summary Find hosts by their IDs @@ -1341,6 +1382,20 @@ export const HostsApiFp = function(configuration?: Configuration) { return axios.request(axiosRequestArgs); }; }, + /** + * Delete hosts by IDs + * @summary Delete hosts by IDs + * @param {Array} hostIdList A comma separated list of host IDs. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiHostDeleteById(hostIdList: Array, options?: any): (axios?: AxiosInstance, basePath?: string) => AxiosPromise { + const localVarAxiosArgs = HostsApiAxiosParamCreator(configuration).apiHostDeleteById(hostIdList, options); + return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + const axiosRequestArgs = Object.assign(localVarAxiosArgs.options, {url: basePath + localVarAxiosArgs.url}) + return axios.request(axiosRequestArgs); + }; + }, /** * Find one or more hosts by their ID. * @summary Find hosts by their IDs @@ -1461,6 +1516,16 @@ export const HostsApiFactory = function (configuration?: Configuration, basePath apiHostAddHostList(createHostIn: Array, options?: any) { return HostsApiFp(configuration).apiHostAddHostList(createHostIn, options)(axios, basePath); }, + /** + * Delete hosts by IDs + * @summary Delete hosts by IDs + * @param {Array} hostIdList A comma separated list of host IDs. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + apiHostDeleteById(hostIdList: Array, options?: any) { + return HostsApiFp(configuration).apiHostDeleteById(hostIdList, options)(axios, basePath); + }, /** * Find one or more hosts by their ID. * @summary Find hosts by their IDs @@ -1560,6 +1625,18 @@ export class HostsApi extends BaseAPI { return HostsApiFp(this.configuration).apiHostAddHostList(createHostIn, options)(this.axios, this.basePath); } + /** + * Delete hosts by IDs + * @summary Delete hosts by IDs + * @param {Array} hostIdList A comma separated list of host IDs. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof HostsApi + */ + public apiHostDeleteById(hostIdList: Array, options?: any) { + return HostsApiFp(this.configuration).apiHostDeleteById(hostIdList, options)(this.axios, this.basePath); + } + /** * Find one or more hosts by their ID. * @summary Find hosts by their IDs diff --git a/packages/host-inventory/doc/README.md b/packages/host-inventory/doc/README.md index 14225e9e0..7e05d9a37 100644 --- a/packages/host-inventory/doc/README.md +++ b/packages/host-inventory/doc/README.md @@ -154,7 +154,7 @@ ___ ▸ **HostsApiFactory**(configuration?: *[Configuration](classes/configuration.md)*, basePath?: *`string`*, axios?: *`AxiosInstance`*): `object` -*Defined in [api.ts:1452](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1452)* +*Defined in [api.ts:1507](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1507)* HostsApi - factory interface @@ -175,7 +175,7 @@ ___ ▸ **HostsApiFp**(configuration?: *[Configuration](classes/configuration.md)*): `object` -*Defined in [api.ts:1328](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1328)* +*Defined in [api.ts:1369](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1369)* HostsApi - functional programming interface diff --git a/packages/host-inventory/doc/classes/hostsapi.md b/packages/host-inventory/doc/classes/hostsapi.md index 2f9b9f62d..8db2845fc 100644 --- a/packages/host-inventory/doc/classes/hostsapi.md +++ b/packages/host-inventory/doc/classes/hostsapi.md @@ -31,6 +31,7 @@ HostsApi - object-oriented interface ### Methods * [apiHostAddHostList](hostsapi.md#apihostaddhostlist) +* [apiHostDeleteById](hostsapi.md#apihostdeletebyid) * [apiHostGetHostById](hostsapi.md#apihostgethostbyid) * [apiHostGetHostList](hostsapi.md#apihostgethostlist) * [apiHostGetHostSystemProfileById](hostsapi.md#apihostgethostsystemprofilebyid) @@ -108,7 +109,7 @@ ___ ▸ **apiHostAddHostList**(createHostIn: *`Array`<[CreateHostIn](../interfaces/createhostin.md)>*, options?: *`any`*): `AxiosPromise`<[BulkHostOut](../interfaces/bulkhostout.md)> -*Defined in [api.ts:1559](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1559)* +*Defined in [api.ts:1624](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1624)* Create a new host and add it to the host list or update an existing hosts. A host is updated if there is already one with the same canonicals facts and belonging to the same account. @@ -127,6 +128,32 @@ Create a new host and add it to the host list or update an existing hosts. A hos **Returns:** `AxiosPromise`<[BulkHostOut](../interfaces/bulkhostout.md)> +___ + + +### apiHostDeleteById + +▸ **apiHostDeleteById**(hostIdList: *`Array`<`string`>*, options?: *`any`*): `AxiosPromise`<`Response`> + +*Defined in [api.ts:1636](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1636)* + +Delete hosts by IDs + +*__summary__*: Delete hosts by IDs + +*__throws__*: {RequiredError} + +*__memberof__*: HostsApi + +**Parameters:** + +| Name | Type | Description | +| ------ | ------ | ------ | +| hostIdList | `Array`<`string`> | A comma separated list of host IDs. | +| `Optional` options | `any` | + +**Returns:** `AxiosPromise`<`Response`> + ___ @@ -134,7 +161,7 @@ ___ ▸ **apiHostGetHostById**(hostIdList: *`Array`<`string`>*, branchId?: *`string`*, perPage?: *`number`*, page?: *`number`*, options?: *`any`*): `AxiosPromise`<[HostQueryOutput](../interfaces/hostqueryoutput.md)> -*Defined in [api.ts:1574](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1574)* +*Defined in [api.ts:1651](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1651)* Find one or more hosts by their ID. @@ -163,7 +190,7 @@ ___ ▸ **apiHostGetHostList**(displayName?: *`string`*, fqdn?: *`string`*, hostnameOrId?: *`string`*, insightsId?: *`string`*, branchId?: *`string`*, perPage?: *`number`*, page?: *`number`*, options?: *`any`*): `AxiosPromise`<[HostQueryOutput](../interfaces/hostqueryoutput.md)> -*Defined in [api.ts:1592](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1592)* +*Defined in [api.ts:1669](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1669)* Read the entire list of all hosts available to the account. @@ -195,7 +222,7 @@ ___ ▸ **apiHostGetHostSystemProfileById**(hostIdList: *`Array`<`string`>*, perPage?: *`number`*, page?: *`number`*, options?: *`any`*): `AxiosPromise`<[SystemProfileByHostOut](../interfaces/systemprofilebyhostout.md)> -*Defined in [api.ts:1606](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1606)* +*Defined in [api.ts:1683](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1683)* Find one or more hosts by their ID and return the id and system profile @@ -223,7 +250,7 @@ ___ ▸ **apiHostMergeFacts**(hostIdList: *`Array`<`string`>*, namespace: *`string`*, body: *`any`*, options?: *`any`*): `AxiosPromise`<`Response`> -*Defined in [api.ts:1620](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1620)* +*Defined in [api.ts:1697](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1697)* Merge one or multiple hosts facts under a namespace. @@ -251,7 +278,7 @@ ___ ▸ **apiHostPatchById**(hostIdList: *`Array`<`string`>*, patchHostIn: *[PatchHostIn](../interfaces/patchhostin.md)*, branchId?: *`string`*, options?: *`any`*): `AxiosPromise`<`Response`> -*Defined in [api.ts:1634](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1634)* +*Defined in [api.ts:1711](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1711)* Update a host @@ -279,7 +306,7 @@ ___ ▸ **apiHostReplaceFacts**(hostIdList: *`Array`<`string`>*, namespace: *`string`*, body: *`any`*, options?: *`any`*): `AxiosPromise`<`Response`> -*Defined in [api.ts:1648](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1648)* +*Defined in [api.ts:1725](https://github.com/RedHatInsights/javascript-clients/blob/master/packages/host-inventory/api.ts#L1725)* Replace facts under a namespace diff --git a/packages/host-inventory/doc/classes/requirederror.md b/packages/host-inventory/doc/classes/requirederror.md index 00a385a09..9c116aae4 100644 --- a/packages/host-inventory/doc/classes/requirederror.md +++ b/packages/host-inventory/doc/classes/requirederror.md @@ -70,7 +70,7 @@ ___ *Inherited from Error.message* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:964* ___ @@ -94,7 +94,7 @@ ___ *Overrides Error.stack* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:965* ___ @@ -103,7 +103,7 @@ ___ **● Error**: *`ErrorConstructor`* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:974* ___ diff --git a/packages/rbac/doc/classes/requirederror.md b/packages/rbac/doc/classes/requirederror.md index 9ca87da5c..2d8fd5a83 100644 --- a/packages/rbac/doc/classes/requirederror.md +++ b/packages/rbac/doc/classes/requirederror.md @@ -70,7 +70,7 @@ ___ *Inherited from Error.message* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:964* ___ @@ -94,7 +94,7 @@ ___ *Overrides Error.stack* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:965* ___ @@ -103,7 +103,7 @@ ___ **● Error**: *`ErrorConstructor`* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:974* ___ diff --git a/packages/sources/doc/classes/requirederror.md b/packages/sources/doc/classes/requirederror.md index d9f42645b..32f43ef9e 100644 --- a/packages/sources/doc/classes/requirederror.md +++ b/packages/sources/doc/classes/requirederror.md @@ -70,7 +70,7 @@ ___ *Inherited from Error.message* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:964* ___ @@ -94,7 +94,7 @@ ___ *Overrides Error.stack* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:965* ___ @@ -103,7 +103,7 @@ ___ **● Error**: *`ErrorConstructor`* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:974* ___ diff --git a/packages/topological-inventory/doc/classes/requirederror.md b/packages/topological-inventory/doc/classes/requirederror.md index 709c624f4..e05add7a1 100644 --- a/packages/topological-inventory/doc/classes/requirederror.md +++ b/packages/topological-inventory/doc/classes/requirederror.md @@ -70,7 +70,7 @@ ___ *Inherited from Error.message* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:964* ___ @@ -94,7 +94,7 @@ ___ *Overrides Error.stack* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:965* ___ @@ -103,7 +103,7 @@ ___ **● Error**: *`ErrorConstructor`* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:974* ___ diff --git a/packages/vulnerabilities/doc/classes/requirederror.md b/packages/vulnerabilities/doc/classes/requirederror.md index 78398fa96..7c27f133f 100644 --- a/packages/vulnerabilities/doc/classes/requirederror.md +++ b/packages/vulnerabilities/doc/classes/requirederror.md @@ -70,7 +70,7 @@ ___ *Inherited from Error.message* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:964* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:964* ___ @@ -94,7 +94,7 @@ ___ *Overrides Error.stack* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:965* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:965* ___ @@ -103,7 +103,7 @@ ___ **● Error**: *`ErrorConstructor`* -*Defined in /home/mmarosi/insights/javascript-clients/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:974* +*Defined in node_modules/typescript/lib/lib.es5.d.ts:974* ___