@shapediver/sdk.geometry-api-sdk-v2 3.1.0 → 3.3.0

package/dist/configuration.d.ts

@@ -6,7 +6,7 @@ export interface ConfigurationParameters extends Pick<ClientConfigParams, 'acces
     maxRetries?: number;
 }
 export declare class Configuration extends ClientConfig {
-    protected readonly sdkVersion = "3.1.0";
+    protected readonly sdkVersion = "3.3.0";
     readonly useCustomAxios: boolean;
     readonly maxRetries: number;
     constructor(param?: ConfigurationParameters);

package/dist/configuration.js

@@ -6,7 +6,7 @@ class Configuration extends configuration_1.Configuration {
     constructor(param = {}) {
         var _a, _b, _c, _d;
         super(param);
-        this.sdkVersion = '3.1.0';
+        this.sdkVersion = '3.3.0';
         this.useCustomAxios = (_a = param.useCustomAxios) !== null && _a !== void 0 ? _a : true;
         this.maxRetries = (_b = param.maxRetries) !== null && _b !== void 0 ? _b : 5;
         this.baseOptions = (_c = this.baseOptions) !== null && _c !== void 0 ? _c : {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@shapediver/sdk.geometry-api-sdk-v2",
-    "version": "3.1.0",
+    "version": "3.3.0",
     "description": "SDK to communicate with the Geometry API version 2",
     "keywords": [
         "shapediver",

package/src/client/api.ts

@@ -4,7 +4,7 @@
  * Geometry Backend API v2
  * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.3.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -86,6 +86,10 @@ export interface CommonsModelBlockingReasons {
      * The model has been blocked explicitly by its owner.
      */
     'owner'?: boolean;
+    /**
+     * The model owner has been restricted from accessing this backend system
+     */
+    'backendPermission'?: boolean;
 }
 /**
  * Status of a model.
@@ -612,6 +616,10 @@ export interface ReqModelBlockingReasons {
      * The model has been blocked explicitly by its owner.
      */
     'owner'?: boolean;
+    /**
+     * The model owner has been restricted from accessing this backend system
+     */
+    'backendPermission'?: boolean;
 }
 /**
  * Model metrics
@@ -1889,6 +1897,14 @@ export interface ResExport {
      * Controls whether the parameter should be hidden in the UI.
      */
     'hidden': boolean;
+    /**
+     * Type-specific ID of the export. In case of exports defined by a single component, this corresponds to the component’s uuid.
+     */
+    'typeId'?: string;
+    /**
+     * Type-specific name of the export. In case of exports defined by a single component, this corresponds to the component’s name (NOT its nickname).
+     */
+    'typeName'?: string;
     /**
      * Requested version of the export.
      */
@@ -1986,6 +2002,14 @@ export interface ResExportDefinition {
      * Controls whether the parameter should be hidden in the UI.
      */
     'hidden': boolean;
+    /**
+     * Type-specific ID of the export. In case of exports defined by a single component, this corresponds to the component’s uuid.
+     */
+    'typeId'?: string;
+    /**
+     * Type-specific name of the export. In case of exports defined by a single component, this corresponds to the component’s name (NOT its nickname).
+     */
+    'typeName'?: string;
     /**
      * This property is never set.
      * @deprecated
@@ -2785,6 +2809,10 @@ export interface ResModelBlockingReasons {
      * The model has been blocked explicitly by its owner.
      */
     'owner': boolean;
+    /**
+     * The model owner has been restricted from accessing this backend system
+     */
+    'backendPermission': boolean;
     /**
      * The model uses a Grasshopper plugin that is not allowed for the owner.
      */
@@ -3457,6 +3485,14 @@ export interface ResOutput {
      * Controls whether the parameter should be hidden in the UI.
      */
     'hidden': boolean;
+    /**
+     * Type-specific ID of the output. In case of outputs defined by a single component, this corresponds to the component’s uuid.
+     */
+    'typeId'?: string;
+    /**
+     * Type-specific name of the output. In case of outputs defined by a single component, this corresponds to the component’s name (NOT its nickname).
+     */
+    'typeName'?: string;
     /**
      * A unique identifier for the particular version of the output. This is a hash code which is based on the parameter values that were used to compute the resulting data. The hash code only depends on the values of the parameters which may theoretically influence the results of the output. As an example, parameters which are in no way connected to the output component in Grasshopper are not considered.
      */
@@ -3606,6 +3642,14 @@ export interface ResOutputDefinition {
      * Controls whether the parameter should be hidden in the UI.
      */
     'hidden': boolean;
+    /**
+     * Type-specific ID of the output. In case of outputs defined by a single component, this corresponds to the component’s uuid.
+     */
+    'typeId'?: string;
+    /**
+     * Type-specific name of the output. In case of outputs defined by a single component, this corresponds to the component’s name (NOT its nickname).
+     */
+    'typeName'?: string;
     /**
      * This property is never set.
      * @deprecated
@@ -7676,10 +7720,13 @@ export const ModelApiAxiosParamCreator = function (configuration?: Configuration
          * Permissions: * `setting.viewer.get.*` - __required__.
          * @summary Get model config.
          * @param {string} modelId Model ID.
+         * @param {boolean} [xShapediverNoconvert] When set to `true`, the config object is returned as stored, without any version conversion applied. [Priority: 1]
+         * @param {string} [xShapediverUseconfigversion] When set to `true`, the returned config version will be of the same version as when the config object has been created. In case the version number cannot be extracted from the config object, this header is ignored. [Priority: 2]
+         * @param {string} [xShapediverBuildversion] When specified, converts the requested config object to the provided target version. Otherwise, the config object is converted into the default version instead. [Priority: 3]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getModelConfig: async (modelId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getModelConfig: async (modelId: string, xShapediverNoconvert?: boolean, xShapediverUseconfigversion?: string, xShapediverBuildversion?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'modelId' is not null or undefined
             assertParamExists('getModelConfig', 'modelId', modelId)
             const localVarPath = `/api/v2/model/{modelId}/config`
@@ -7701,6 +7748,17 @@ export const ModelApiAxiosParamCreator = function (configuration?: Configuration
 
             localVarHeaderParameter['Accept'] = 'application/json';
 
+            if (xShapediverNoconvert != null) {
+                localVarHeaderParameter['x-shapediver-noconvert'] = typeof xShapediverNoconvert === 'string'
+                    ? xShapediverNoconvert
+                    : JSON.stringify(xShapediverNoconvert);
+            }
+            if (xShapediverUseconfigversion != null) {
+                localVarHeaderParameter['x-shapediver-useconfigversion'] = String(xShapediverUseconfigversion);
+            }
+            if (xShapediverBuildversion != null) {
+                localVarHeaderParameter['x-shapediver-buildversion'] = String(xShapediverBuildversion);
+            }
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -8124,11 +8182,14 @@ export const ModelApiFp = function(configuration?: Configuration) {
          * Permissions: * `setting.viewer.get.*` - __required__.
          * @summary Get model config.
          * @param {string} modelId Model ID.
+         * @param {boolean} [xShapediverNoconvert] When set to &#x60;true&#x60;, the config object is returned as stored, without any version conversion applied. [Priority: 1]
+         * @param {string} [xShapediverUseconfigversion] When set to &#x60;true&#x60;, the returned config version will be of the same version as when the config object has been created. In case the version number cannot be extracted from the config object, this header is ignored. [Priority: 2]
+         * @param {string} [xShapediverBuildversion] When specified, converts the requested config object to the provided target version. Otherwise, the config object is converted into the default version instead. [Priority: 3]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getModelConfig(modelId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResGetModelConfig>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getModelConfig(modelId, options);
+        async getModelConfig(modelId: string, xShapediverNoconvert?: boolean, xShapediverUseconfigversion?: string, xShapediverBuildversion?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResGetModelConfig>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getModelConfig(modelId, xShapediverNoconvert, xShapediverUseconfigversion, xShapediverBuildversion, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ModelApi.getModelConfig']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -8342,11 +8403,14 @@ export const ModelApiFactory = function (configuration?: Configuration, basePath
          * Permissions: * `setting.viewer.get.*` - __required__.
          * @summary Get model config.
          * @param {string} modelId Model ID.
+         * @param {boolean} [xShapediverNoconvert] When set to &#x60;true&#x60;, the config object is returned as stored, without any version conversion applied. [Priority: 1]
+         * @param {string} [xShapediverUseconfigversion] When set to &#x60;true&#x60;, the returned config version will be of the same version as when the config object has been created. In case the version number cannot be extracted from the config object, this header is ignored. [Priority: 2]
+         * @param {string} [xShapediverBuildversion] When specified, converts the requested config object to the provided target version. Otherwise, the config object is converted into the default version instead. [Priority: 3]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getModelConfig(modelId: string, options?: RawAxiosRequestConfig): AxiosPromise<ResGetModelConfig> {
-            return localVarFp.getModelConfig(modelId, options).then((request) => request(axios, basePath));
+        getModelConfig(modelId: string, xShapediverNoconvert?: boolean, xShapediverUseconfigversion?: string, xShapediverBuildversion?: string, options?: RawAxiosRequestConfig): AxiosPromise<ResGetModelConfig> {
+            return localVarFp.getModelConfig(modelId, xShapediverNoconvert, xShapediverUseconfigversion, xShapediverBuildversion, options).then((request) => request(axios, basePath));
         },
         /**
          * Subject-Restriction: __backend__.
@@ -8547,11 +8611,14 @@ export class ModelApi extends BaseAPI {
      * Permissions: * `setting.viewer.get.*` - __required__.
      * @summary Get model config.
      * @param {string} modelId Model ID.
+     * @param {boolean} [xShapediverNoconvert] When set to &#x60;true&#x60;, the config object is returned as stored, without any version conversion applied. [Priority: 1]
+     * @param {string} [xShapediverUseconfigversion] When set to &#x60;true&#x60;, the returned config version will be of the same version as when the config object has been created. In case the version number cannot be extracted from the config object, this header is ignored. [Priority: 2]
+     * @param {string} [xShapediverBuildversion] When specified, converts the requested config object to the provided target version. Otherwise, the config object is converted into the default version instead. [Priority: 3]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    public getModelConfig(modelId: string, options?: RawAxiosRequestConfig) {
-        return ModelApiFp(this.configuration).getModelConfig(modelId, options).then((request) => request(this.axios, this.basePath));
+    public getModelConfig(modelId: string, xShapediverNoconvert?: boolean, xShapediverUseconfigversion?: string, xShapediverBuildversion?: string, options?: RawAxiosRequestConfig) {
+        return ModelApiFp(this.configuration).getModelConfig(modelId, xShapediverNoconvert, xShapediverUseconfigversion, xShapediverBuildversion, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/src/client/base.ts

@@ -4,7 +4,7 @@
  * Geometry Backend API v2
  * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.3.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/client/common.ts

@@ -4,7 +4,7 @@
  * Geometry Backend API v2
  * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.3.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/client/configuration.ts

@@ -3,7 +3,7 @@
  * Geometry Backend API v2
  * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.3.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/client/index.ts

@@ -4,7 +4,7 @@
  * Geometry Backend API v2
  * The ShapeDiver Geometry Backend system is used to: * host Grasshopper models in a secure, reliable, scalable, and performant way, * run computations of Grasshopper models, * and cache and output the results of computations and exports.
  *
- * The version of the OpenAPI document: 2.0.0
+ * The version of the OpenAPI document: 2.3.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/configuration.ts

@@ -34,7 +34,7 @@ export interface ConfigurationParameters
 }
 
 export class Configuration extends ClientConfig {
-    protected readonly sdkVersion = '3.1.0'; // WARNING: This value is updated automatically!
+    protected readonly sdkVersion = '3.3.0'; // WARNING: This value is updated automatically!
 
     public readonly useCustomAxios: boolean;
     public readonly maxRetries: number;