@shapediver/sdk.geometry-api-sdk-v2 2.2.0 → 2.4.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 = "2.2.0";
+    protected readonly sdkVersion = "2.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 = '2.2.0';
+        this.sdkVersion = '2.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": "2.2.0",
+    "version": "2.4.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: 1.6.1
+ * The version of the OpenAPI document: 1.8.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -21,7 +21,7 @@ import globalAxios from 'axios';
 import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
 import type { RequestArgs } from './base';
 // @ts-ignore
-import { BASE_PATH, COLLECTION_FORMATS, RequiredError, operationServerMap } from './base';
+import { BASE_PATH, COLLECTION_FORMATS,  RequiredError, operationServerMap } from './base';
 import { BaseAPI } from '../base';
 
 /**
@@ -98,6 +98,25 @@ export interface CommonsGroup {
      */
     'name': string;
 }
+/**
+ * Reasons why the model may be blocked.
+ * @export
+ * @interface CommonsModelBlockingReasons
+ */
+export interface CommonsModelBlockingReasons {
+    /**
+     * The model owner\'s credit limit has been exceeded.
+     * @type {boolean}
+     * @memberof CommonsModelBlockingReasons
+     */
+    'creditLimit'?: boolean;
+    /**
+     * The model has been blocked explicitly by its owner.
+     * @type {boolean}
+     * @memberof CommonsModelBlockingReasons
+     */
+    'owner'?: boolean;
+}
 /**
  * Status of a model.
  * @export
@@ -360,6 +379,13 @@ export interface ReqAuthorizationGroup {
      */
     'organizations'?: Array<string>;
 }
+/**
+ * @type ReqBasicParameter
+ * Definition of a basic ShapeDiver parameter.
+ * @export
+ */
+export type ReqBasicParameter = boolean | number | string;
+
 /**
  * Body of an export or output cache request. A directory of export-/output-IDs and version-IDs.
  * @export
@@ -423,7 +449,7 @@ export interface ReqCreditMetrics {
     'parameters': Array<ReqCreditMetric>;
 }
 /**
- * A directory of parameter keys and values.  Supported parameter keys are as follows, whereby the parameter resolution is done in the same order as the keys are listed: * `id` * `name` * `displayname`  Supported parameter values are: * Basic parameter (`CommonsBasicParameter`) * S-type parameter (`CommonsStypeParameter`)
+ * A directory of parameter keys and values.  Supported parameter keys are as follows, whereby the parameter resolution is done in the same order as the keys are listed: * `id` * `name` * `displayname`  Supported parameter values are: * Basic parameter (`ReqBasicParameter`) * S-type parameter (`ReqStypeParameter`)
  * @export
  * @interface ReqCustomization
  */
@@ -570,7 +596,7 @@ export interface ReqFileUpload {
 
 }
 /**
- * Group information.
+ * Group of a parameter, export or output.
  * @export
  * @interface ReqGroup
  */
@@ -654,6 +680,12 @@ export interface ReqModel {
      * @memberof ReqModel
      */
     'backendaccess'?: boolean;
+    /**
+     * 
+     * @type {ReqModelBlockingReasons}
+     * @memberof ReqModel
+     */
+    'blockingReasons'?: ReqModelBlockingReasons;
     /**
      * Original name of the model\'s grasshopper file.
      * @type {string}
@@ -761,7 +793,7 @@ export interface ReqModel {
      * @type {boolean}
      * @memberof ReqModel
      */
-    'pub': boolean;
+    'pub'?: boolean;
     /**
      * Enforces iframe embedding instead of direct embedding.
      * @type {boolean}
@@ -819,6 +851,25 @@ export interface ReqModel {
 }
 
 
+/**
+ * Reasons why the model may be blocked.
+ * @export
+ * @interface ReqModelBlockingReasons
+ */
+export interface ReqModelBlockingReasons {
+    /**
+     * The model owner\'s credit limit has been exceeded.
+     * @type {boolean}
+     * @memberof ReqModelBlockingReasons
+     */
+    'creditLimit'?: boolean;
+    /**
+     * The model has been blocked explicitly by its owner.
+     * @type {boolean}
+     * @memberof ReqModelBlockingReasons
+     */
+    'owner'?: boolean;
+}
 /**
  * Model metrics
  * @export
@@ -1120,7 +1171,7 @@ export interface ReqParameterDefinitions {
  * The value of a single model parameter.
  * @export
  */
-export type ReqParameterValue = CommonsBasicParameter | CommonsStypeParameter;
+export type ReqParameterValue = ReqBasicParameter | ReqStypeParameter;
 
 /**
  * Data for a single sdTF parameter.
@@ -1168,6 +1219,25 @@ export const ReqSdtfType = {
 export type ReqSdtfType = typeof ReqSdtfType[keyof typeof ReqSdtfType];
 
 
+/**
+ * Definition of the value to use for s-type parameters.
+ * @export
+ * @interface ReqStypeParameter
+ */
+export interface ReqStypeParameter {
+    /**
+     * Optional embedded value. If this is set the asset is ignored.
+     * @type {string}
+     * @memberof ReqStypeParameter
+     */
+    'value'?: string;
+    /**
+     * 
+     * @type {CommmonsParameterAsset}
+     * @memberof ReqStypeParameter
+     */
+    'asset'?: CommmonsParameterAsset;
+}
 /**
  * System-wide metrics
  * @export
@@ -1787,6 +1857,13 @@ export interface ResBaseSystem {
      */
     'system'?: ResSystem;
 }
+/**
+ * @type ResBasicParameter
+ * Definition of a basic ShapeDiver parameter.
+ * @export
+ */
+export type ResBasicParameter = boolean | number | string;
+
 /**
  * 
  * @export
@@ -4433,6 +4510,31 @@ export interface ResModel {
 }
 
 
+/**
+ * 
+ * @export
+ * @interface ResModelBlockingReasons
+ */
+export interface ResModelBlockingReasons {
+    /**
+     * The model owner\'s credit limit has been exceeded.
+     * @type {boolean}
+     * @memberof ResModelBlockingReasons
+     */
+    'creditLimit': boolean;
+    /**
+     * The model has been blocked explicitly by its owner.
+     * @type {boolean}
+     * @memberof ResModelBlockingReasons
+     */
+    'owner': boolean;
+    /**
+     * The model uses a Grasshopper plugin that is not allowed for the owner.
+     * @type {boolean}
+     * @memberof ResModelBlockingReasons
+     */
+    'pluginPermission': boolean;
+}
 /**
  * Information about a model cleanup process.
  * @export
@@ -4578,6 +4680,12 @@ export interface ResModelComputation {
      * @memberof ResModelComputation
      */
     'limit'?: ResComputationLimits;
+    /**
+     * The number of credits that are charged for this computation.
+     * @type {number}
+     * @memberof ResModelComputation
+     */
+    'credits'?: number;
 }
 
 
@@ -4929,6 +5037,12 @@ export interface ResModelSettings {
      * @memberof ResModelSettings
      */
     'cdn_supported'?: boolean;
+    /**
+     * 
+     * @type {ResModelBlockingReasons}
+     * @memberof ResModelSettings
+     */
+    'blockingReasons'?: ResModelBlockingReasons;
 }
 /**
  * Definition of a Model-State.
@@ -6043,10 +6157,10 @@ export type ResParameterType = typeof ResParameterType[keyof typeof ResParameter
 
 /**
  * @type ResParameterValue
- * The value of a single model parameter. Supported parameter values are: * Basic parameter (`CommonsBasicParameter`) * S-type parameter (`CommonsStypeParameter`)
+ * The value of a single model parameter. Supported parameter values are: * Basic parameter (`ResBasicParameter`) * S-type parameter (`ResStypeParameter`)
  * @export
  */
-export type ResParameterValue = CommonsBasicParameter | CommonsStypeParameter;
+export type ResParameterValue = ResBasicParameter | ResStypeParameter;
 
 /**
  * 
@@ -6731,6 +6845,25 @@ export const ResStructureType = {
 export type ResStructureType = typeof ResStructureType[keyof typeof ResStructureType];
 
 
+/**
+ * Definition of the value to use for s-type parameters.
+ * @export
+ * @interface ResStypeParameter
+ */
+export interface ResStypeParameter {
+    /**
+     * Optional embedded value. If this is set the asset is ignored.
+     * @type {string}
+     * @memberof ResStypeParameter
+     */
+    'value'?: string;
+    /**
+     * 
+     * @type {CommmonsParameterAsset}
+     * @memberof ResStypeParameter
+     */
+    'asset'?: CommmonsParameterAsset;
+}
 /**
  * ShapeDiver API response of system-request.
  * @export

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: 1.6.1
+ * The version of the OpenAPI document: 1.8.2
  * 
  *
  * 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: 1.6.1
+ * The version of the OpenAPI document: 1.8.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/client/configuration.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: 1.6.1
+ * The version of the OpenAPI document: 1.8.2
  * 
  *
  * 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: 1.6.1
+ * The version of the OpenAPI document: 1.8.2
  * 
  *
  * 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 = '2.2.0'; // WARNING: This value is updated automatically!
+    protected readonly sdkVersion = '2.3.0'; // WARNING: This value is updated automatically!
 
     public readonly useCustomAxios: boolean;
     public readonly maxRetries: number;