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

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;
 }
 

package/src/client/apis/SdtfApi.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,25 +23,58 @@ import type {
 } from '../models/index';
 
 export interface DeleteSdtfRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * Namespace of the sdTF asset.
+     */
     namespace: string;
+    /**
+     * ID of the sdTF asset.
+     */
     sdtfId: string;
 }
 
 export interface DownloadSdtfRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * Namespace of the sdTF asset.
+     */
     namespace: string;
+    /**
+     * ID of the sdTF asset.
+     */
     sdtfId: string;
 }
 
 export interface ListSdtfsRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * Namespace of the sdTF asset.
+     */
     namespace: string;
+    /**
+     * Continuation token for pagination.
+     */
     offset?: string;
 }
 
 export interface UploadSdtfRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * 
+     */
     reqSdtfDefinition: Array<ReqSdtfDefinition>;
 }
 

package/src/client/apis/SessionApi.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).
@@ -27,35 +27,94 @@ import type {
 } from '../models/index';
 
 export interface CloseSessionRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
 }
 
 export interface CreateSessionByModelRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * ID of the Model-State to apply.
+     */
     modelStateId?: string;
+    /**
+     * Allow relaxed validation of parameter identifiers for customization and export requests.
+     * When set to `true`, unknown parameter IDs will be ignored instead of causing an error.
+     * 
+     * Defaults to `false`.
+     */
     ignoreUnknownParams?: boolean;
+    /**
+     * When set to `false`, any Model-State parameter that cannot be applied to the model -
+     * either because the parameter ID is unknown or the parameter value is invalid - will be
+     * ignored. When set to `true`, any validation error will result in an error response.
+     * 
+     * Defaults to `false`.
+     */
     strictModelStateValidation?: boolean;
+    /**
+     * 
+     */
     reqCustomizationOrExport?: ReqCustomizationOrExport;
 }
 
 export interface CreateSessionByTicketRequest {
+    /**
+     * Encrypted ticket.
+     */
     ticketId: string;
+    /**
+     * ID of the Model-State to apply.
+     */
     modelStateId?: string;
+    /**
+     * Allow relaxed validation of parameter identifiers for customization and export requests.
+     * When set to `true`, unknown parameter IDs will be ignored instead of causing an error.
+     * 
+     * Defaults to `false`.
+     */
     ignoreUnknownParams?: boolean;
+    /**
+     * When set to `false`, any Model-State parameter that cannot be applied to the model -
+     * either because the parameter ID is unknown or the parameter value is invalid - will be
+     * ignored. When set to `true`, any validation error will result in an error response.
+     * 
+     * Defaults to `false`.
+     */
     strictModelStateValidation?: boolean;
+    /**
+     * 
+     */
     reqCustomizationOrExport?: ReqCustomizationOrExport;
 }
 
 export interface CreateTicketRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
+    /**
+     * 
+     */
     reqTicket: ReqTicket;
 }
 
 export interface DecryptTicketRequest {
+    /**
+     * Encrypted ShapeDiver ticket.
+     */
     ticketEncrypted: string;
 }
 
 export interface GetSessionDefaultsRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
 }
 

package/src/client/apis/SystemApi.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,11 +23,20 @@ import type {
 } from '../models/index';
 
 export interface CreateSignedUrlRequest {
+    /**
+     * CDN endpoint.
+     */
     endpoint: string;
+    /**
+     * Base64 encoded target URI.
+     */
     encodedUri: string;
 }
 
 export interface EraseModelRequest {
+    /**
+     * Model ID.
+     */
     modelId: string;
 }
 

package/src/client/apis/TextureApi.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).
@@ -20,7 +20,13 @@ import type {
 } from '../models/index';
 
 export interface ListTexturesRequest {
+    /**
+     * Session ID.
+     */
     sessionId: string;
+    /**
+     * Continuation token for pagination.
+     */
     offset?: string;
 }