system-initiative-api-client 1.6.0 → 1.6.2

package/dist/cjs/api.d.ts

@@ -2376,6 +2376,12 @@ export interface SchemaVariantFunc {
      * @memberof SchemaVariantFunc
      */
     'id': string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SchemaVariantFunc
+     */
+    'isOverlay': boolean;
 }
 /**
  * @type SchemaVariantFuncKind
@@ -3056,6 +3062,12 @@ export interface Workspace {
      * @memberof Workspace
      */
     'displayName': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    'externalId'?: string | null;
     /**
      *
      * @type {string}
@@ -5840,6 +5852,16 @@ export declare const SchemasApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getVariant: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} schemaId Schema identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installSchema: (workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary List all schemas (paginated endpoint)
@@ -6061,6 +6083,16 @@ export declare const SchemasApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getVariant(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaVariantV1Response>>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} schemaId Schema identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installSchema(workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaV1Response>>;
     /**
      *
      * @summary List all schemas (paginated endpoint)
@@ -6230,6 +6262,14 @@ export declare const SchemasApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getVariant(requestParameters: SchemasApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installSchema(requestParameters: SchemasApiInstallSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
     /**
      *
      * @summary List all schemas (paginated endpoint)
@@ -6404,6 +6444,15 @@ export interface SchemasApiInterface {
      * @memberof SchemasApiInterface
      */
     getVariant(requestParameters: SchemasApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SchemasApiInterface
+     */
+    installSchema(requestParameters: SchemasApiInstallSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
     /**
      *
      * @summary List all schemas (paginated endpoint)
@@ -6948,6 +6997,31 @@ export interface SchemasApiGetVariantRequest {
      */
     readonly schemaVariantId: string;
 }
+/**
+ * Request parameters for installSchema operation in SchemasApi.
+ * @export
+ * @interface SchemasApiInstallSchemaRequest
+ */
+export interface SchemasApiInstallSchemaRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof SchemasApiInstallSchema
+     */
+    readonly workspaceId: string;
+    /**
+     * Change Set identifier
+     * @type {string}
+     * @memberof SchemasApiInstallSchema
+     */
+    readonly changeSetId: string;
+    /**
+     * Schema identifier
+     * @type {string}
+     * @memberof SchemasApiInstallSchema
+     */
+    readonly schemaId: string;
+}
 /**
  * Request parameters for listSchemas operation in SchemasApi.
  * @export
@@ -7208,6 +7282,15 @@ export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
      * @memberof SchemasApi
      */
     getVariant(requestParameters: SchemasApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaVariantV1Response, any, {}>>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SchemasApi
+     */
+    installSchema(requestParameters: SchemasApiInstallSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaV1Response, any, {}>>;
     /**
      *
      * @summary List all schemas (paginated endpoint)

package/dist/cjs/api.js

@@ -3393,6 +3393,43 @@ const SchemasApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {string} schemaId Schema identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        installSchema: async (workspaceId, changeSetId, schemaId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            (0, common_1.assertParamExists)('installSchema', 'workspaceId', workspaceId);
+            // verify required parameter 'changeSetId' is not null or undefined
+            (0, common_1.assertParamExists)('installSchema', 'changeSetId', changeSetId);
+            // verify required parameter 'schemaId' is not null or undefined
+            (0, common_1.assertParamExists)('installSchema', 'schemaId', schemaId);
+            const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/schemas/{schema_id}/install`
+                .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
+                .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
+                .replace(`{${"schema_id"}}`, encodeURIComponent(String(schemaId)));
+            // 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 List all schemas (paginated endpoint)
@@ -3812,6 +3849,21 @@ const SchemasApiFp = function (configuration) {
             const localVarOperationServerBasePath = base_1.operationServerMap['SchemasApi.getVariant']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         *
+         * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {string} schemaId Schema identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async installSchema(workspaceId, changeSetId, schemaId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.installSchema(workspaceId, changeSetId, schemaId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = base_1.operationServerMap['SchemasApi.installSchema']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary List all schemas (paginated endpoint)
@@ -4035,6 +4087,16 @@ const SchemasApiFactory = function (configuration, basePath, axios) {
         getVariant(requestParameters, options) {
             return localVarFp.getVariant(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, requestParameters.schemaVariantId, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+         * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        installSchema(requestParameters, options) {
+            return localVarFp.installSchema(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary List all schemas (paginated endpoint)
@@ -4250,6 +4312,17 @@ class SchemasApi extends base_1.BaseAPI {
     getVariant(requestParameters, options) {
         return (0, exports.SchemasApiFp)(this.configuration).getVariant(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, requestParameters.schemaVariantId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SchemasApi
+     */
+    installSchema(requestParameters, options) {
+        return (0, exports.SchemasApiFp)(this.configuration).installSchema(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary List all schemas (paginated endpoint)

package/dist/esm/api.d.ts

@@ -2376,6 +2376,12 @@ export interface SchemaVariantFunc {
      * @memberof SchemaVariantFunc
      */
     'id': string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SchemaVariantFunc
+     */
+    'isOverlay': boolean;
 }
 /**
  * @type SchemaVariantFuncKind
@@ -3056,6 +3062,12 @@ export interface Workspace {
      * @memberof Workspace
      */
     'displayName': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Workspace
+     */
+    'externalId'?: string | null;
     /**
      *
      * @type {string}
@@ -5840,6 +5852,16 @@ export declare const SchemasApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getVariant: (workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} schemaId Schema identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installSchema: (workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary List all schemas (paginated endpoint)
@@ -6061,6 +6083,16 @@ export declare const SchemasApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getVariant(workspaceId: string, changeSetId: string, schemaId: string, schemaVariantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaVariantV1Response>>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {string} workspaceId Workspace identifier
+     * @param {string} changeSetId Change Set identifier
+     * @param {string} schemaId Schema identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installSchema(workspaceId: string, changeSetId: string, schemaId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSchemaV1Response>>;
     /**
      *
      * @summary List all schemas (paginated endpoint)
@@ -6230,6 +6262,14 @@ export declare const SchemasApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getVariant(requestParameters: SchemasApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    installSchema(requestParameters: SchemasApiInstallSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
     /**
      *
      * @summary List all schemas (paginated endpoint)
@@ -6404,6 +6444,15 @@ export interface SchemasApiInterface {
      * @memberof SchemasApiInterface
      */
     getVariant(requestParameters: SchemasApiGetVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaVariantV1Response>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SchemasApiInterface
+     */
+    installSchema(requestParameters: SchemasApiInstallSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSchemaV1Response>;
     /**
      *
      * @summary List all schemas (paginated endpoint)
@@ -6948,6 +6997,31 @@ export interface SchemasApiGetVariantRequest {
      */
     readonly schemaVariantId: string;
 }
+/**
+ * Request parameters for installSchema operation in SchemasApi.
+ * @export
+ * @interface SchemasApiInstallSchemaRequest
+ */
+export interface SchemasApiInstallSchemaRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof SchemasApiInstallSchema
+     */
+    readonly workspaceId: string;
+    /**
+     * Change Set identifier
+     * @type {string}
+     * @memberof SchemasApiInstallSchema
+     */
+    readonly changeSetId: string;
+    /**
+     * Schema identifier
+     * @type {string}
+     * @memberof SchemasApiInstallSchema
+     */
+    readonly schemaId: string;
+}
 /**
  * Request parameters for listSchemas operation in SchemasApi.
  * @export
@@ -7208,6 +7282,15 @@ export declare class SchemasApi extends BaseAPI implements SchemasApiInterface {
      * @memberof SchemasApi
      */
     getVariant(requestParameters: SchemasApiGetVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaVariantV1Response, any, {}>>;
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SchemasApi
+     */
+    installSchema(requestParameters: SchemasApiInstallSchemaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSchemaV1Response, any, {}>>;
     /**
      *
      * @summary List all schemas (paginated endpoint)

package/dist/esm/api.js

@@ -3363,6 +3363,43 @@ export const SchemasApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {string} schemaId Schema identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        installSchema: async (workspaceId, changeSetId, schemaId, options = {}) => {
+            // verify required parameter 'workspaceId' is not null or undefined
+            assertParamExists('installSchema', 'workspaceId', workspaceId);
+            // verify required parameter 'changeSetId' is not null or undefined
+            assertParamExists('installSchema', 'changeSetId', changeSetId);
+            // verify required parameter 'schemaId' is not null or undefined
+            assertParamExists('installSchema', 'schemaId', schemaId);
+            const localVarPath = `/v1/w/{workspace_id}/change-sets/{change_set_id}/schemas/{schema_id}/install`
+                .replace(`{${"workspace_id"}}`, encodeURIComponent(String(workspaceId)))
+                .replace(`{${"change_set_id"}}`, encodeURIComponent(String(changeSetId)))
+                .replace(`{${"schema_id"}}`, encodeURIComponent(String(schemaId)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          *
          * @summary List all schemas (paginated endpoint)
@@ -3781,6 +3818,21 @@ export const SchemasApiFp = function (configuration) {
             const localVarOperationServerBasePath = operationServerMap['SchemasApi.getVariant']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         *
+         * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+         * @param {string} workspaceId Workspace identifier
+         * @param {string} changeSetId Change Set identifier
+         * @param {string} schemaId Schema identifier
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async installSchema(workspaceId, changeSetId, schemaId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.installSchema(workspaceId, changeSetId, schemaId, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SchemasApi.installSchema']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          *
          * @summary List all schemas (paginated endpoint)
@@ -4003,6 +4055,16 @@ export const SchemasApiFactory = function (configuration, basePath, axios) {
         getVariant(requestParameters, options) {
             return localVarFp.getVariant(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, requestParameters.schemaVariantId, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+         * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        installSchema(requestParameters, options) {
+            return localVarFp.installSchema(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, options).then((request) => request(axios, basePath));
+        },
         /**
          *
          * @summary List all schemas (paginated endpoint)
@@ -4217,6 +4279,17 @@ export class SchemasApi extends BaseAPI {
     getVariant(requestParameters, options) {
         return SchemasApiFp(this.configuration).getVariant(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, requestParameters.schemaVariantId, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Installs a schema - if there\'s an installed schema, it will return that schema detail
+     * @param {SchemasApiInstallSchemaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SchemasApi
+     */
+    installSchema(requestParameters, options) {
+        return SchemasApiFp(this.configuration).installSchema(requestParameters.workspaceId, requestParameters.changeSetId, requestParameters.schemaId, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      *
      * @summary List all schemas (paginated endpoint)

package/package.json

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