system-initiative-api-client 1.0.6 → 1.0.8

package/dist/cjs/api.d.ts

@@ -803,6 +803,19 @@ export interface DuplicateComponentsV1Response {
      */
     'components': Array<Array<string>>;
 }
+/**
+ *
+ * @export
+ * @interface EraseComponentV1Response
+ */
+export interface EraseComponentV1Response {
+    /**
+     *
+     * @type {boolean}
+     * @memberof EraseComponentV1Response
+     */
+    'status': boolean;
+}
 /**
  *
  * @export
@@ -1946,6 +1959,19 @@ export interface RequestApprovalChangeSetV1Response {
      */
     'success': boolean;
 }
+/**
+ *
+ * @export
+ * @interface RestoreComponentV1Response
+ */
+export interface RestoreComponentV1Response {
+    /**
+     *
+     * @type {boolean}
+     * @memberof RestoreComponentV1Response
+     */
+    'status': boolean;
+}
 /**
  *
  * @export
@@ -2211,12 +2237,6 @@ export interface Subscription {
      * @memberof Subscription
      */
     'function'?: string;
-    /**
-     *
-     * @type {boolean}
-     * @memberof Subscription
-     */
-    'keepExistingSubscriptions'?: boolean | null;
     /**
      *
      * @type {string}
@@ -3307,6 +3327,16 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     duplicateComponents: (workspaceId: string, changeSetId: string, duplicateComponentsV1Request: DuplicateComponentsV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Erase a component without queuing a delete action
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} componentId Component identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    eraseComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Execute a component\'s management function
@@ -3371,6 +3401,16 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     manageComponent: (workspaceId: string, changeSetId: string, componentId: string, manageComponentV1Request: ManageComponentV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Restore a component that is marked for deletion
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} componentId Component identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Complex search for components
@@ -3449,6 +3489,16 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     duplicateComponents(workspaceId: string, changeSetId: string, duplicateComponentsV1Request: DuplicateComponentsV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DuplicateComponentsV1Response>>;
+    /**
+     *
+     * @summary Erase a component without queuing a delete action
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} componentId Component identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    eraseComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EraseComponentV1Response>>;
     /**
      *
      * @summary Execute a component\'s management function
@@ -3513,6 +3563,16 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     manageComponent(workspaceId: string, changeSetId: string, componentId: string, manageComponentV1Request: ManageComponentV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManageComponentV1Response>>;
+    /**
+     *
+     * @summary Restore a component that is marked for deletion
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} componentId Component identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestoreComponentV1Response>>;
     /**
      *
      * @summary Complex search for components
@@ -3582,6 +3642,14 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     duplicateComponents(requestParameters: ComponentsApiDuplicateComponentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DuplicateComponentsV1Response>;
+    /**
+     *
+     * @summary Erase a component without queuing a delete action
+     * @param {ComponentsApiEraseComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    eraseComponent(requestParameters: ComponentsApiEraseComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<EraseComponentV1Response>;
     /**
      *
      * @summary Execute a component\'s management function
@@ -3630,6 +3698,14 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     manageComponent(requestParameters: ComponentsApiManageComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ManageComponentV1Response>;
+    /**
+     *
+     * @summary Restore a component that is marked for deletion
+     * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    restoreComponent(requestParameters: ComponentsApiRestoreComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<RestoreComponentV1Response>;
     /**
      *
      * @summary Complex search for components
@@ -3697,6 +3773,15 @@ export interface ComponentsApiInterface {
      * @memberof ComponentsApiInterface
      */
     duplicateComponents(requestParameters: ComponentsApiDuplicateComponentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<DuplicateComponentsV1Response>;
+    /**
+     *
+     * @summary Erase a component without queuing a delete action
+     * @param {ComponentsApiEraseComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    eraseComponent(requestParameters: ComponentsApiEraseComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<EraseComponentV1Response>;
     /**
      *
      * @summary Execute a component\'s management function
@@ -3751,6 +3836,15 @@ export interface ComponentsApiInterface {
      * @memberof ComponentsApiInterface
      */
     manageComponent(requestParameters: ComponentsApiManageComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<ManageComponentV1Response>;
+    /**
+     *
+     * @summary Restore a component that is marked for deletion
+     * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    restoreComponent(requestParameters: ComponentsApiRestoreComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<RestoreComponentV1Response>;
     /**
      *
      * @summary Complex search for components
@@ -3885,6 +3979,31 @@ export interface ComponentsApiDuplicateComponentsRequest {
      */
     readonly duplicateComponentsV1Request: DuplicateComponentsV1Request;
 }
+/**
+ * Request parameters for eraseComponent operation in ComponentsApi.
+ * @export
+ * @interface ComponentsApiEraseComponentRequest
+ */
+export interface ComponentsApiEraseComponentRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ComponentsApiEraseComponent
+     */
+    readonly workspaceId: string;
+    /**
+     * Change Set identifier
+     * @type {string}
+     * @memberof ComponentsApiEraseComponent
+     */
+    readonly changeSetId: string;
+    /**
+     * Component identifier
+     * @type {string}
+     * @memberof ComponentsApiEraseComponent
+     */
+    readonly componentId: string;
+}
 /**
  * Request parameters for executeManagementFunction operation in ComponentsApi.
  * @export
@@ -4059,6 +4178,31 @@ export interface ComponentsApiManageComponentRequest {
      */
     readonly manageComponentV1Request: ManageComponentV1Request;
 }
+/**
+ * Request parameters for restoreComponent operation in ComponentsApi.
+ * @export
+ * @interface ComponentsApiRestoreComponentRequest
+ */
+export interface ComponentsApiRestoreComponentRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ComponentsApiRestoreComponent
+     */
+    readonly workspaceId: string;
+    /**
+     * Change Set identifier
+     * @type {string}
+     * @memberof ComponentsApiRestoreComponent
+     */
+    readonly changeSetId: string;
+    /**
+     * Component identifier
+     * @type {string}
+     * @memberof ComponentsApiRestoreComponent
+     */
+    readonly componentId: string;
+}
 /**
  * Request parameters for searchComponents operation in ComponentsApi.
  * @export
@@ -4183,6 +4327,15 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
      * @memberof ComponentsApi
      */
     duplicateComponents(requestParameters: ComponentsApiDuplicateComponentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DuplicateComponentsV1Response, any>>;
+    /**
+     *
+     * @summary Erase a component without queuing a delete action
+     * @param {ComponentsApiEraseComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApi
+     */
+    eraseComponent(requestParameters: ComponentsApiEraseComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EraseComponentV1Response, any>>;
     /**
      *
      * @summary Execute a component\'s management function
@@ -4237,6 +4390,15 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
      * @memberof ComponentsApi
      */
     manageComponent(requestParameters: ComponentsApiManageComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ManageComponentV1Response, any>>;
+    /**
+     *
+     * @summary Restore a component that is marked for deletion
+     * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApi
+     */
+    restoreComponent(requestParameters: ComponentsApiRestoreComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RestoreComponentV1Response, any>>;
     /**
      *
      * @summary Complex search for components

package/dist/cjs/api.js

@@ -1092,6 +1092,43 @@ const ComponentsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Erase a component without queuing a delete action
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {string} componentId Component identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        eraseComponent: async (workspaceId, changeSetId, componentId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            (0, common_1.assertParamExists)('eraseComponent', 'workspaceId', workspaceId);
+            // verify required parameter 'changeSetId' is not null or undefined
+            (0, common_1.assertParamExists)('eraseComponent', 'changeSetId', changeSetId);
+            // verify required parameter 'componentId' is not null or undefined
+            (0, common_1.assertParamExists)('eraseComponent', 'componentId', componentId);
+            const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/components/{component_id}/erase`
+                .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
+                .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
+                .replace(`{${"component_id"}}`, encodeURIComponent(String(componentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary Execute a component\'s management function
@@ -1333,6 +1370,43 @@ const ComponentsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Restore a component that is marked for deletion
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {string} componentId Component identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restoreComponent: async (workspaceId, changeSetId, componentId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            (0, common_1.assertParamExists)('restoreComponent', 'workspaceId', workspaceId);
+            // verify required parameter 'changeSetId' is not null or undefined
+            (0, common_1.assertParamExists)('restoreComponent', 'changeSetId', changeSetId);
+            // verify required parameter 'componentId' is not null or undefined
+            (0, common_1.assertParamExists)('restoreComponent', 'componentId', componentId);
+            const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/components/{component_id}/restore`
+                .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
+                .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
+                .replace(`{${"component_id"}}`, encodeURIComponent(String(componentId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary Complex search for components
@@ -1521,6 +1595,21 @@ const ComponentsApiFp = function (configuration) {
             const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.duplicateComponents']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         *
+         * @summary Erase a component without queuing a delete action
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {string} componentId Component identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async eraseComponent(workspaceId, changeSetId, componentId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.eraseComponent(workspaceId, changeSetId, componentId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.eraseComponent']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary Execute a component\'s management function
@@ -1615,6 +1704,21 @@ const ComponentsApiFp = function (configuration) {
             const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.manageComponent']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         *
+         * @summary Restore a component that is marked for deletion
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {string} componentId Component identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async restoreComponent(workspaceId, changeSetId, componentId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.restoreComponent(workspaceId, changeSetId, componentId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.restoreComponent']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary Complex search for components
@@ -1711,6 +1815,16 @@ const ComponentsApiFactory = function (configuration, basePath, axios) {
         duplicateComponents(requestParameters, options) {
             return localVarFp.duplicateComponents(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.duplicateComponentsV1Request, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Erase a component without queuing a delete action
+         * @param {ComponentsApiEraseComponentRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        eraseComponent(requestParameters, options) {
+            return localVarFp.eraseComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Execute a component\'s management function
@@ -1771,6 +1885,16 @@ const ComponentsApiFactory = function (configuration, basePath, axios) {
         manageComponent(requestParameters, options) {
             return localVarFp.manageComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, requestParameters.manageComponentV1Request, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Restore a component that is marked for deletion
+         * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        restoreComponent(requestParameters, options) {
+            return localVarFp.restoreComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Complex search for components
@@ -1855,6 +1979,17 @@ class ComponentsApi extends base_1.BaseAPI {
     duplicateComponents(requestParameters, options) {
         return (0, exports.ComponentsApiFp)(this.configuration).duplicateComponents(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.duplicateComponentsV1Request, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Erase a component without queuing a delete action
+     * @param {ComponentsApiEraseComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApi
+     */
+    eraseComponent(requestParameters, options) {
+        return (0, exports.ComponentsApiFp)(this.configuration).eraseComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Execute a component\'s management function
@@ -1921,6 +2056,17 @@ class ComponentsApi extends base_1.BaseAPI {
     manageComponent(requestParameters, options) {
         return (0, exports.ComponentsApiFp)(this.configuration).manageComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, requestParameters.manageComponentV1Request, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Restore a component that is marked for deletion
+     * @param {ComponentsApiRestoreComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApi
+     */
+    restoreComponent(requestParameters, options) {
+        return (0, exports.ComponentsApiFp)(this.configuration).restoreComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Complex search for components

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "system-initiative-api-client",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "TypeScript/JavaScript SDK for the System Initiative Public API",
   "author": "System Initiative <support@systeminit.com>",
   "repository": {