system-initiative-api-client 1.0.4 → 1.0.6

package/dist/cjs/api.d.ts

@@ -1193,6 +1193,56 @@ export interface FuncRunViewV1 {
      */
     'updatedAt': string;
 }
+/**
+ *
+ * @export
+ * @interface GenerateTemplateV1Request
+ */
+export interface GenerateTemplateV1Request {
+    /**
+     *
+     * @type {string}
+     * @memberof GenerateTemplateV1Request
+     */
+    'assetName': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GenerateTemplateV1Request
+     */
+    'category'?: string | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof GenerateTemplateV1Request
+     */
+    'componentIds': Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof GenerateTemplateV1Request
+     */
+    'funcName': string;
+}
+/**
+ *
+ * @export
+ * @interface GenerateTemplateV1Response
+ */
+export interface GenerateTemplateV1Response {
+    /**
+     *
+     * @type {string}
+     * @memberof GenerateTemplateV1Response
+     */
+    'funcId': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GenerateTemplateV1Response
+     */
+    'schemaVariantId': string;
+}
 /**
  *
  * @export
@@ -2312,6 +2362,19 @@ export interface UpdateSecretV1Response {
      */
     'secret': SecretV1;
 }
+/**
+ *
+ * @export
+ * @interface UpgradeComponentV1Response
+ */
+export interface UpgradeComponentV1Response {
+    /**
+     *
+     * @type {ComponentViewV1}
+     * @memberof UpgradeComponentV1Response
+     */
+    'component': ComponentViewV1;
+}
 /**
  *
  * @export
@@ -3266,6 +3329,16 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     findComponent: (workspaceId: string, changeSetId: string, component?: string | null, componentId?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Generate a template
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {GenerateTemplateV1Request} generateTemplateV1Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateTemplate: (workspaceId: string, changeSetId: string, generateTemplateV1Request: GenerateTemplateV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Get a component by component Id
@@ -3319,6 +3392,16 @@ export declare const ComponentsApiAxiosParamCreator: (configuration?: Configurat
      * @throws {RequiredError}
      */
     updateComponent: (workspaceId: string, changeSetId: string, componentId: string, updateComponentV1Request: UpdateComponentV1Request, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Upgrade a component to the latest schema variant
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} componentId Component identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upgradeComponent: (workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ComponentsApi - functional programming interface
@@ -3388,6 +3471,16 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     findComponent(workspaceId: string, changeSetId: string, component?: string | null, componentId?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetComponentV1Response>>;
+    /**
+     *
+     * @summary Generate a template
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {GenerateTemplateV1Request} generateTemplateV1Request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateTemplate(workspaceId: string, changeSetId: string, generateTemplateV1Request: GenerateTemplateV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateTemplateV1Response>>;
     /**
      *
      * @summary Get a component by component Id
@@ -3441,6 +3534,16 @@ export declare const ComponentsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     updateComponent(workspaceId: string, changeSetId: string, componentId: string, updateComponentV1Request: UpdateComponentV1Request, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateComponentV1Response>>;
+    /**
+     *
+     * @summary Upgrade a component to the latest schema variant
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} componentId Component identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upgradeComponent(workspaceId: string, changeSetId: string, componentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpgradeComponentV1Response>>;
 };
 /**
  * ComponentsApi - factory interface
@@ -3495,6 +3598,14 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
+    /**
+     *
+     * @summary Generate a template
+     * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    generateTemplate(requestParameters: ComponentsApiGenerateTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateTemplateV1Response>;
     /**
      *
      * @summary Get a component by component Id
@@ -3535,6 +3646,14 @@ export declare const ComponentsApiFactory: (configuration?: Configuration, baseP
      * @throws {RequiredError}
      */
     updateComponent(requestParameters: ComponentsApiUpdateComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateComponentV1Response>;
+    /**
+     *
+     * @summary Upgrade a component to the latest schema variant
+     * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpgradeComponentV1Response>;
 };
 /**
  * ComponentsApi - interface
@@ -3596,6 +3715,15 @@ export interface ComponentsApiInterface {
      * @memberof ComponentsApiInterface
      */
     findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetComponentV1Response>;
+    /**
+     *
+     * @summary Generate a template
+     * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    generateTemplate(requestParameters: ComponentsApiGenerateTemplateRequest, options?: RawAxiosRequestConfig): AxiosPromise<GenerateTemplateV1Response>;
     /**
      *
      * @summary Get a component by component Id
@@ -3641,6 +3769,15 @@ export interface ComponentsApiInterface {
      * @memberof ComponentsApiInterface
      */
     updateComponent(requestParameters: ComponentsApiUpdateComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateComponentV1Response>;
+    /**
+     *
+     * @summary Upgrade a component to the latest schema variant
+     * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApiInterface
+     */
+    upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpgradeComponentV1Response>;
 }
 /**
  * Request parameters for addAction operation in ComponentsApi.
@@ -3810,6 +3947,31 @@ export interface ComponentsApiFindComponentRequest {
      */
     readonly componentId?: string | null;
 }
+/**
+ * Request parameters for generateTemplate operation in ComponentsApi.
+ * @export
+ * @interface ComponentsApiGenerateTemplateRequest
+ */
+export interface ComponentsApiGenerateTemplateRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ComponentsApiGenerateTemplate
+     */
+    readonly workspaceId: string;
+    /**
+     * Change Set identifier
+     * @type {string}
+     * @memberof ComponentsApiGenerateTemplate
+     */
+    readonly changeSetId: string;
+    /**
+     *
+     * @type {GenerateTemplateV1Request}
+     * @memberof ComponentsApiGenerateTemplate
+     */
+    readonly generateTemplateV1Request: GenerateTemplateV1Request;
+}
 /**
  * Request parameters for getComponent operation in ComponentsApi.
  * @export
@@ -3953,6 +4115,31 @@ export interface ComponentsApiUpdateComponentRequest {
      */
     readonly updateComponentV1Request: UpdateComponentV1Request;
 }
+/**
+ * Request parameters for upgradeComponent operation in ComponentsApi.
+ * @export
+ * @interface ComponentsApiUpgradeComponentRequest
+ */
+export interface ComponentsApiUpgradeComponentRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ComponentsApiUpgradeComponent
+     */
+    readonly workspaceId: string;
+    /**
+     * Change Set identifier
+     * @type {string}
+     * @memberof ComponentsApiUpgradeComponent
+     */
+    readonly changeSetId: string;
+    /**
+     * Component identifier
+     * @type {string}
+     * @memberof ComponentsApiUpgradeComponent
+     */
+    readonly componentId: string;
+}
 /**
  * ComponentsApi - object-oriented interface
  * @export
@@ -4014,6 +4201,15 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
      * @memberof ComponentsApi
      */
     findComponent(requestParameters: ComponentsApiFindComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetComponentV1Response, any>>;
+    /**
+     *
+     * @summary Generate a template
+     * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApi
+     */
+    generateTemplate(requestParameters: ComponentsApiGenerateTemplateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateTemplateV1Response, any>>;
     /**
      *
      * @summary Get a component by component Id
@@ -4059,6 +4255,15 @@ export declare class ComponentsApi extends BaseAPI implements ComponentsApiInter
      * @memberof ComponentsApi
      */
     updateComponent(requestParameters: ComponentsApiUpdateComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateComponentV1Response, any>>;
+    /**
+     *
+     * @summary Upgrade a component to the latest schema variant
+     * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApi
+     */
+    upgradeComponent(requestParameters: ComponentsApiUpgradeComponentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpgradeComponentV1Response, any>>;
 }
 /**
  * FuncsApi - axios parameter creator

package/dist/cjs/api.js

@@ -1175,6 +1175,44 @@ const ComponentsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Generate a template
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {GenerateTemplateV1Request} generateTemplateV1Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateTemplate: async (workspaceId, changeSetId, generateTemplateV1Request, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            (0, common_1.assertParamExists)('generateTemplate', 'workspaceId', workspaceId);
+            // verify required parameter 'changeSetId' is not null or undefined
+            (0, common_1.assertParamExists)('generateTemplate', 'changeSetId', changeSetId);
+            // verify required parameter 'generateTemplateV1Request' is not null or undefined
+            (0, common_1.assertParamExists)('generateTemplate', 'generateTemplateV1Request', generateTemplateV1Request);
+            const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/components/generate_template`
+                .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
+                .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)));
+            // 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 = {};
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(generateTemplateV1Request, localVarRequestOptions, configuration);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary Get a component by component Id
@@ -1375,6 +1413,43 @@ const ComponentsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Upgrade a component to the latest schema variant
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {string} componentId Component identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upgradeComponent: async (workspaceId, changeSetId, componentId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            (0, common_1.assertParamExists)('upgradeComponent', 'workspaceId', workspaceId);
+            // verify required parameter 'changeSetId' is not null or undefined
+            (0, common_1.assertParamExists)('upgradeComponent', 'changeSetId', changeSetId);
+            // verify required parameter 'componentId' is not null or undefined
+            (0, common_1.assertParamExists)('upgradeComponent', 'componentId', componentId);
+            const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/components/{component_id}/upgrade`
+                .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,
+            };
+        },
     };
 };
 exports.ComponentsApiAxiosParamCreator = ComponentsApiAxiosParamCreator;
@@ -1478,6 +1553,21 @@ const ComponentsApiFp = function (configuration) {
             const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.findComponent']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         *
+         * @summary Generate a template
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {GenerateTemplateV1Request} generateTemplateV1Request
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async generateTemplate(workspaceId, changeSetId, generateTemplateV1Request, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.generateTemplate(workspaceId, changeSetId, generateTemplateV1Request, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.generateTemplate']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary Get a component by component Id
@@ -1556,6 +1646,21 @@ const ComponentsApiFp = function (configuration) {
             const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.updateComponent']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         *
+         * @summary Upgrade a component to the latest schema variant
+         * @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 upgradeComponent(workspaceId, changeSetId, componentId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.upgradeComponent(workspaceId, changeSetId, componentId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['ComponentsApi.upgradeComponent']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     };
 };
 exports.ComponentsApiFp = ComponentsApiFp;
@@ -1626,6 +1731,16 @@ const ComponentsApiFactory = function (configuration, basePath, axios) {
         findComponent(requestParameters, options) {
             return localVarFp.findComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.component, requestParameters.componentId, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Generate a template
+         * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        generateTemplate(requestParameters, options) {
+            return localVarFp.generateTemplate(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.generateTemplateV1Request, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary Get a component by component Id
@@ -1676,6 +1791,16 @@ const ComponentsApiFactory = function (configuration, basePath, axios) {
         updateComponent(requestParameters, options) {
             return localVarFp.updateComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, requestParameters.updateComponentV1Request, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Upgrade a component to the latest schema variant
+         * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upgradeComponent(requestParameters, options) {
+            return localVarFp.upgradeComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(axios, basePath));
+        },
     };
 };
 exports.ComponentsApiFactory = ComponentsApiFactory;
@@ -1752,6 +1877,17 @@ class ComponentsApi extends base_1.BaseAPI {
     findComponent(requestParameters, options) {
         return (0, exports.ComponentsApiFp)(this.configuration).findComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.component, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Generate a template
+     * @param {ComponentsApiGenerateTemplateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApi
+     */
+    generateTemplate(requestParameters, options) {
+        return (0, exports.ComponentsApiFp)(this.configuration).generateTemplate(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.generateTemplateV1Request, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary Get a component by component Id
@@ -1807,6 +1943,17 @@ class ComponentsApi extends base_1.BaseAPI {
     updateComponent(requestParameters, options) {
         return (0, exports.ComponentsApiFp)(this.configuration).updateComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, requestParameters.updateComponentV1Request, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Upgrade a component to the latest schema variant
+     * @param {ComponentsApiUpgradeComponentRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ComponentsApi
+     */
+    upgradeComponent(requestParameters, options) {
+        return (0, exports.ComponentsApiFp)(this.configuration).upgradeComponent(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.componentId, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.ComponentsApi = ComponentsApi;
 /**

package/package.json

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