@shapediver/sdk.geometry-api-sdk-v2 4.2.2 → 4.3.0

package/src/client/apis/FileApi.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.5.0
+ * The version of the OpenAPI document: 2.6.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,31 +23,73 @@ import type {
 } from '../models/index';
 
 export interface DeleteFileRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * Parameter ID of the file asset.
+     */
     paramId: string;
+    /**
+     * ID of the file asset.
+     */
     fileId: string;
 }
 
 export interface DownloadFileRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * Parameter ID of the file asset.
+     */
     paramId: string;
+    /**
+     * ID of the file asset.
+     */
     fileId: string;
 }
 
 export interface GetFileMetadataRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * Parameter ID of the file asset.
+     */
     paramId: string;
+    /**
+     * ID of the file asset.
+     */
     fileId: string;
 }
 
 export interface ListFilesRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * Parameter ID of the file asset.
+     */
     paramId: string;
+    /**
+     * Continuation token for pagination.
+     */
     offset?: string;
 }
 
 export interface UploadFileRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * 
+     */
     reqFileUpload: ReqFileUpload;
 }
 

package/src/client/apis/GltfApi.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.5.0
+ * The version of the OpenAPI document: 2.6.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,8 +21,17 @@ import type {
 } from '../models/index';
 
 export interface UploadGltfRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * 
+     */
     body: Blob;
+    /**
+     * Specify to convert the uploaded glTF.
+     */
     conversion?: QueryGltfConversion;
 }
 

package/src/client/apis/LogApi.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.5.0
+ * The version of the OpenAPI document: 2.6.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,7 +21,13 @@ import type {
 } from '../models/index';
 
 export interface LogMessageRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * 
+     */
     reqLogMessage: ReqLogMessage;
 }
 

package/src/client/apis/ModelApi.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.5.0
+ * The version of the OpenAPI document: 2.6.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -34,6 +34,7 @@ import type {
     ResGetModel,
     ResGetModelComputations,
     ResGetModelConfig,
+    ResGetModelSessionsAnalytics,
     ResListModels,
     ResUpdateModel,
     ResUpdateModelConfig,
@@ -42,91 +43,257 @@ import type {
 } from '../models/index';
 
 export interface CleanupExportsRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * Delete all components that have been used last at or before this timestamp.
+     */
     untilLastSeen: string;
 }
 
 export interface CleanupOutputsRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * Delete all components that have been used last at or before this timestamp.
+     */
     untilLastSeen: string;
 }
 
 export interface CleanupTexturesRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * Delete all components that have been used last at or before this timestamp.
+     */
     untilLastSeen: string;
 }
 
 export interface CreateModelRequest {
+    /**
+     * 
+     */
     reqModel: ReqModel;
 }
 
 export interface CreateModelConfigRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * 
+     */
     reqConfigure: ReqConfigure;
 }
 
 export interface DeleteModelRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
 }
 
 export interface DownloadModelFileRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
 }
 
 export interface GetCleanupStatusRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
 }
 
 export interface GetModelRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
 }
 
 export interface GetModelComputationsRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * Order in which to query computation stats items.
+     * 
+     * _Default:_ `desc`
+     */
     order?: QueryOrder;
+    /**
+     * Timestamp to query from.
+     * 
+     * _Default:_ `0`
+     */
     timestampFrom?: string;
+    /**
+     * Timestamp to query to.
+     * 
+     * _Default:_ `infinity`
+     */
     timestampTo?: string;
+    /**
+     * Filter computations by the result status.
+     * 
+     * _Default:_ `*`
+     */
     status?: QueryComputationStatisticsStatus;
+    /**
+     * Filter computations by type.
+     * 
+     * _Default:_ `*`
+     */
     type?: QueryComputationType;
+    /**
+     * How many items to return at most.
+     * 
+     * _Default:_ `100`
+     */
     limit?: number;
+    /**
+     * Whether the limit shall be attained (if there are enough items).
+     * 
+     * _Default:_ `false`
+     */
     strictLimit?: boolean;
+    /**
+     * Continuation token for pagination.
+     */
     offset?: string;
 }
 
 export interface GetModelConfigRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * When set to `true`, the config object is returned as stored, without any version conversion applied. [Priority: 1]
+     */
     xShapediverNoconvert?: boolean;
+    /**
+     * 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]
+     */
     xShapediverUseconfigversion?: string;
+    /**
+     * 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]
+     */
     xShapediverBuildversion?: string;
 }
 
+export interface GetModelSessionsAnalyticsRequest {
+    /**
+     * Model ID.
+     */
+    modelId: string;
+    /**
+     * Order in which to query session analytics items.
+     * 
+     * _Default:_ `desc`
+     */
+    order?: QueryOrder;
+    /**
+     * Open timestamp to query from.
+     * 
+     * _Default:_ `0`
+     */
+    timestampFrom?: string;
+    /**
+     * Open timestamp to query to.
+     * 
+     * _Default:_ `infinity`
+     */
+    timestampTo?: string;
+    /**
+     * How many items to return at most.
+     * 
+     * _Default:_ `100`
+     */
+    limit?: number;
+    /**
+     * Continuation token for pagination.
+     */
+    offset?: string;
+}
+
 export interface ListModelsRequest {
+    /**
+     * Filter models by `stat`.
+     */
     modelStatus?: QueryModelStatus;
+    /**
+     * Continuation token for pagination.
+     */
     offset?: string;
 }
 
 export interface RestoreModelRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
 }
 
 export interface UpdateModelRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * 
+     */
     reqModel: ReqModel;
 }
 
 export interface UpdateModelConfigRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * 
+     */
     reqConfigure: ReqConfigure;
 }
 
 export interface UpdateParameterDefaultValuesRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * 
+     */
     reqCustomization: ReqCustomization;
+    /**
+     * Allow relaxed validation of parameter identifiers. When set to `true`, unrecognized
+     * parameters will be ignored rather than causing an error.
+     * 
+     * Defaults to `false`.
+     */
     ignoreUnknownParams?: boolean;
 }
 
 export interface UpdateParameterDefinitionsRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * 
+     */
     reqParameterDefinitions: ReqParameterDefinitions;
 }
 
@@ -829,6 +996,81 @@ export class ModelApi extends BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getModelSessionsAnalytics without sending the request
+     */
+    async getModelSessionsAnalyticsRequestOpts(requestParameters: GetModelSessionsAnalyticsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['modelId'] == null) {
+            throw new runtime.RequiredError(
+                'modelId',
+                'Required parameter "modelId" was null or undefined when calling getModelSessionsAnalytics().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['order'] != null) {
+            queryParameters['order'] = requestParameters['order'];
+        }
+
+        if (requestParameters['timestampFrom'] != null) {
+            queryParameters['timestamp_from'] = requestParameters['timestampFrom'];
+        }
+
+        if (requestParameters['timestampTo'] != null) {
+            queryParameters['timestamp_to'] = requestParameters['timestampTo'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['offset'] != null) {
+            queryParameters['offset'] = requestParameters['offset'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("JwtAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v2/model/{modelId}/sessions`;
+        urlPath = urlPath.replace('{modelId}', encodeURIComponent(String(requestParameters['modelId'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Returns session analytics whose **open** timestamp falls in the requested time range. `statistics` is omitted until the session has been finalized.  Permissions: * `analytics.model.get.*` - __required__.
+     * Get model session analytics in a time range.
+     */
+    async getModelSessionsAnalyticsRaw(requestParameters: GetModelSessionsAnalyticsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ResGetModelSessionsAnalytics>> {
+        const requestOptions = await this.getModelSessionsAnalyticsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response);
+    }
+
+    /**
+     * Returns session analytics whose **open** timestamp falls in the requested time range. `statistics` is omitted until the session has been finalized.  Permissions: * `analytics.model.get.*` - __required__.
+     * Get model session analytics in a time range.
+     */
+    async getModelSessionsAnalytics(modelId: string, order?: QueryOrder, timestampFrom?: string, timestampTo?: string, limit?: number, offset?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ResGetModelSessionsAnalytics> {
+        const response = await this.getModelSessionsAnalyticsRaw({ modelId: modelId, order: order, timestampFrom: timestampFrom, timestampTo: timestampTo, limit: limit, offset: offset }, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for listModels without sending the request
      */

package/src/client/apis/ModelStateApi.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.5.0
+ * The version of the OpenAPI document: 2.6.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -25,37 +25,73 @@ import type {
 } from '../models/index';
 
 export interface CreateModelStateRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * 
+     */
     reqModelState: ReqModelState;
+    /**
+     * Allow relaxed validation of parameter identifiers. When set to `true`, unrecognized
+     * parameters will be ignored rather than causing an error.
+     * 
+     * Defaults to `false`.
+     */
     ignoreUnknownParams?: boolean;
 }
 
 export interface DeleteModelStateRequest {
+    /**
+     * Model-State ID.
+     */
     modelStateId: string;
 }
 
 export interface DownloadModelStateImageRequest {
+    /**
+     * Model-State ID.
+     */
     modelStateId: string;
 }
 
 export interface GetModelStateRequest {
+    /**
+     * Model-State ID.
+     */
     modelStateId: string;
 }
 
 export interface GetModelStateDataRequest {
+    /**
+     * Model-State ID.
+     */
     modelStateId: string;
 }
 
 export interface GetModelStateImageMetadataRequest {
+    /**
+     * Model-State ID.
+     */
     modelStateId: string;
 }
 
 export interface GetModelStateMetadataRequest {
+    /**
+     * Model-State ID.
+     */
     modelStateId: string;
 }
 
 export interface ListModelStatesRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * Continuation token for pagination.
+     */
     offset?: string;
 }
 

package/src/client/apis/OutputApi.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.5.0
+ * The version of the OpenAPI document: 2.6.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,26 +28,65 @@ import type {
 } from '../models/index';
 
 export interface ComputeOutputsRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * 
+     */
     reqCustomization: ReqCustomization;
+    /**
+     * Allow relaxed validation of parameter identifiers. When set to `true`, unrecognized
+     * parameters will be ignored rather than causing an error.
+     * 
+     * Defaults to `false`.
+     */
     ignoreUnknownParams?: boolean;
 }
 
 export interface GetCachedOutputsRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * 
+     */
     reqCacheReqCustomization: ReqCache | ReqCustomization | null;
 }
 
 export interface ListOutputVersionsRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * Output ID.
+     */
     outputId: string;
+    /**
+     * Filter output versions by `status_computation`.
+     */
     statusComputation?: QueryComputationStatus;
+    /**
+     * Filter output versions by `status_collect`.
+     */
     statusCollect?: QueryComputationStatus;
+    /**
+     * Continuation token for pagination.
+     */
     offset?: string;
 }
 
 export interface UpdateOutputDefinitionsRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * 
+     */
     reqOutputDefinitions: ReqOutputDefinitions;
 }
 

package/src/client/apis/ScriptApi.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.5.0
+ * The version of the OpenAPI document: 2.6.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -19,10 +19,16 @@ import type {
 } from '../models/index';
 
 export interface ConfirmScriptRequest {
+    /**
+     * Script ID.
+     */
     scriptId: string;
 }
 
 export interface DenyScriptRequest {
+    /**
+     * Script ID.
+     */
     scriptId: string;
 }