@shapediver/api.platform-api-dto-v1 2.12.7 → 2.12.8

package/dist/request/SdPlatformBaseRequestTypes.d.ts

@@ -1,46 +1,46 @@
-/**
- * Pagination parameters for query requests.
- */
-interface SdPlatformPaginationParameters {
-    /** Maximum number of items to fetch */
-    limit?: number | null;
-    /** If set to true the limit will be attained if possible (if there are enough items left) */
-    strict_limit?: boolean | null;
-    /**
-     * Offset is used to fetch next set of results.
-     */
-    offset?: string | null;
-}
-export declare enum SdPlatformSortingOrder {
-    Asc = "asc",
-    Desc = "desc"
-}
-export declare type SdPlatformFilterValue = string | number | boolean | null | Array<SdPlatformFilterValue>;
-/**
- * Filtering parameters for query calls.
- */
-interface SdPlatformFilterParameters {
-    filters?: {
-        [filter_expression: string]: SdPlatformFilterValue;
-    };
-}
-/**
- * Sorting parameters for query calls.
- */
-interface SdPlatformSorterParameters {
-    sorters?: {
-        [column: string]: SdPlatformSortingOrder;
-    };
-}
-/**
- * Embedding parameters.
- */
-interface SdPlatformEmbedParameters<TEmbeddableResource> {
-    embed?: Array<TEmbeddableResource>;
-}
-/**
- * Parameters for querying resources.
- */
-export declare type SdPlatformQueryParameters<TEmbeddableResource> = SdPlatformPaginationParameters & SdPlatformFilterParameters & SdPlatformSorterParameters & SdPlatformEmbedParameters<TEmbeddableResource>;
-export {};
+/**
+ * Pagination parameters for query requests.
+ */
+interface SdPlatformPaginationParameters {
+    /** Maximum number of items to fetch */
+    limit?: number | null;
+    /** If set to true the limit will be attained if possible (if there are enough items left) */
+    strict_limit?: boolean | null;
+    /**
+     * Offset is used to fetch next set of results.
+     */
+    offset?: string | null;
+}
+export declare enum SdPlatformSortingOrder {
+    Asc = "asc",
+    Desc = "desc"
+}
+export declare type SdPlatformFilterValue = string | number | boolean | null | Array<SdPlatformFilterValue>;
+/**
+ * Filtering parameters for query calls.
+ */
+interface SdPlatformFilterParameters {
+    filters?: {
+        [filter_expression: string]: SdPlatformFilterValue;
+    };
+}
+/**
+ * Sorting parameters for query calls.
+ */
+interface SdPlatformSorterParameters {
+    sorters?: {
+        [column: string]: SdPlatformSortingOrder;
+    };
+}
+/**
+ * Embedding parameters.
+ */
+interface SdPlatformEmbedParameters<TEmbeddableResource> {
+    embed?: Array<TEmbeddableResource>;
+}
+/**
+ * Parameters for querying resources.
+ */
+export declare type SdPlatformQueryParameters<TEmbeddableResource> = SdPlatformPaginationParameters & SdPlatformFilterParameters & SdPlatformSorterParameters & SdPlatformEmbedParameters<TEmbeddableResource>;
+export {};
 //# sourceMappingURL=SdPlatformBaseRequestTypes.d.ts.map

package/dist/request/SdPlatformBaseRequestTypes.js

@@ -1,9 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SdPlatformSortingOrder = void 0;
-var SdPlatformSortingOrder;
-(function (SdPlatformSortingOrder) {
-    SdPlatformSortingOrder["Asc"] = "asc";
-    SdPlatformSortingOrder["Desc"] = "desc";
-})(SdPlatformSortingOrder = exports.SdPlatformSortingOrder || (exports.SdPlatformSortingOrder = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SdPlatformSortingOrder = void 0;
+var SdPlatformSortingOrder;
+(function (SdPlatformSortingOrder) {
+    SdPlatformSortingOrder["Asc"] = "asc";
+    SdPlatformSortingOrder["Desc"] = "desc";
+})(SdPlatformSortingOrder = exports.SdPlatformSortingOrder || (exports.SdPlatformSortingOrder = {}));
 //# sourceMappingURL=SdPlatformBaseRequestTypes.js.map

package/dist/request/SdPlatformRequestApiClients.d.ts

@@ -1,21 +1,21 @@
-export interface SdPlatformRequestApiClientCreate {
-    client_name: string;
-    client_secret?: string;
-    refresh_token?: boolean;
-    allowed_origins?: Array<string>;
-    access_token_lifetime?: number;
-    refresh_token_lifetime?: number;
-    refresh_token_limit?: number;
-    required_feature: string;
-}
-export interface SdPlatformRequestApiClientPatch {
-    client_name?: string;
-    client_secret?: string;
-    refresh_token?: boolean;
-    allowed_origins?: Array<string>;
-    access_token_lifetime?: number;
-    refresh_token_lifetime?: number;
-    refresh_token_limit?: number;
-    required_feature: string;
-}
+export interface SdPlatformRequestApiClientCreate {
+    client_name: string;
+    client_secret?: string;
+    refresh_token?: boolean;
+    allowed_origins?: Array<string>;
+    access_token_lifetime?: number;
+    refresh_token_lifetime?: number;
+    refresh_token_limit?: number;
+    required_feature: string;
+}
+export interface SdPlatformRequestApiClientPatch {
+    client_name?: string;
+    client_secret?: string;
+    refresh_token?: boolean;
+    allowed_origins?: Array<string>;
+    access_token_lifetime?: number;
+    refresh_token_lifetime?: number;
+    refresh_token_limit?: number;
+    required_feature: string;
+}
 //# sourceMappingURL=SdPlatformRequestApiClients.d.ts.map

package/dist/request/SdPlatformRequestApiClients.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SdPlatformRequestApiClients.js.map

package/dist/request/SdPlatformRequestApiToken.d.ts

@@ -1,24 +1,24 @@
-import { SdPlatformApiTokenScopes } from "../commons/SdPlatformApiTokenScopes";
-/**
- * DTO for creating an API token
- */
-export interface SdPlatformRequestApiTokenCreate {
-    /** mandatory description of the API token */
-    description: string;
-    /** scopes which the API token shall be limited to */
-    scope: Array<SdPlatformApiTokenScopes>;
-    /** epoch timestamp until which the API token shall be valid */
-    valid_until?: number;
-}
-/**
- * DTO for patching an API token
- */
-export interface SdPlatformRequestApiTokenPatch {
-    /** description of the API token */
-    description?: string;
-    /** epoch timestamp until which the API token shall be valid */
-    valid_until?: number | null;
-    /** activate or deactivate the API token */
-    active?: boolean;
-}
+import { SdPlatformApiTokenScopes } from "../commons/SdPlatformApiTokenScopes";
+/**
+ * DTO for creating an API token
+ */
+export interface SdPlatformRequestApiTokenCreate {
+    /** mandatory description of the API token */
+    description: string;
+    /** scopes which the API token shall be limited to */
+    scope: Array<SdPlatformApiTokenScopes>;
+    /** epoch timestamp until which the API token shall be valid */
+    valid_until?: number;
+}
+/**
+ * DTO for patching an API token
+ */
+export interface SdPlatformRequestApiTokenPatch {
+    /** description of the API token */
+    description?: string;
+    /** epoch timestamp until which the API token shall be valid */
+    valid_until?: number | null;
+    /** activate or deactivate the API token */
+    active?: boolean;
+}
 //# sourceMappingURL=SdPlatformRequestApiToken.d.ts.map

package/dist/request/SdPlatformRequestApiToken.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SdPlatformRequestApiToken.js.map

package/dist/request/SdPlatformRequestBackendSystem.d.ts

@@ -1,70 +1,70 @@
-/**
- * DTO for creating a ShapeDiver Geometry Backend System
- */
-export interface SdPlatformRequestBackendSystemCreate {
-    /** The endpoint of the ShapeDiver Geometry Backend System */
-    model_view_url: string;
-    /** obsolete, will be phased out */
-    model_view_user?: string;
-    /** obsolete, will be phased out */
-    model_view_pass?: string;
-    /** The endpoint of the ShapeDiver Geometry Backend System. Obsolete, will be phased out */
-    model_mgmt_url: string;
-    /** obsolete, will be phased out */
-    model_mgmt_user?: string;
-    /** obsolete, will be phased out */
-    model_mgmt_pass?: string;
-    /** Shall this backend system be used by default? */
-    use_by_default?: boolean;
-    /** Is this a productive backend system? */
-    is_production?: boolean;
-    /** Maximum allowed value of max_comp_time for models on this system */
-    max_max_comp_time?: number;
-    /** Maximum allowed value of num_loaded_max for models on this system */
-    max_num_loaded_max?: number;
-    /** Unique alias of backend system */
-    alias: string;
-    /** Description of backend system */
-    description?: string;
-}
-/**
- * DTO for patching a ShapeDiver Geometry Backend System
- */
-export interface SdPlatformRequestBackendSystemPatch {
-    /** The endpoint of the ShapeDiver Geometry Backend System */
-    model_view_url?: string;
-    /** obsolete, will be phased out */
-    model_view_user?: string;
-    /** obsolete, will be phased out */
-    model_view_pass?: string;
-    /** The endpoint of the ShapeDiver Geometry Backend System. Obsolete, will be phased out */
-    model_mgmt_url?: string;
-    /** obsolete, will be phased out */
-    model_mgmt_user?: string;
-    /** obsolete, will be phased out */
-    model_mgmt_pass?: string;
-    /** Shall this backend system be used by default? */
-    use_by_default?: boolean;
-    /** Is this a productive backend system? */
-    is_production?: boolean;
-    /** Maximum allowed value of max_comp_time for models on this system */
-    max_max_comp_time?: number;
-    /** Maximum allowed value of num_loaded_max for models on this system */
-    max_num_loaded_max?: number;
-    /** Unique alias of backend system */
-    alias?: string;
-    /** Description of backend system */
-    description?: string;
-}
-/**
- * DTO for creating a token for accessing a ShapeDiver Geometry Backend System
- */
-export interface SdPlatformRequestBackendSystemToken {
-    /** Id of the ShapeDiver Geometry Backend System */
-    id: string;
-    /** Scopes to create the token for */
-    scopes: Array<string>;
-    /** The lifetime of a token in seconds, which is only set if lifetime is less then minimum lifetime for a client. */
-    lifetime?: number;
-}
+/**
+ * DTO for creating a ShapeDiver Geometry Backend System
+ */
+export interface SdPlatformRequestBackendSystemCreate {
+    /** The endpoint of the ShapeDiver Geometry Backend System */
+    model_view_url: string;
+    /** obsolete, will be phased out */
+    model_view_user?: string;
+    /** obsolete, will be phased out */
+    model_view_pass?: string;
+    /** The endpoint of the ShapeDiver Geometry Backend System. Obsolete, will be phased out */
+    model_mgmt_url: string;
+    /** obsolete, will be phased out */
+    model_mgmt_user?: string;
+    /** obsolete, will be phased out */
+    model_mgmt_pass?: string;
+    /** Shall this backend system be used by default? */
+    use_by_default?: boolean;
+    /** Is this a productive backend system? */
+    is_production?: boolean;
+    /** Maximum allowed value of max_comp_time for models on this system */
+    max_max_comp_time?: number;
+    /** Maximum allowed value of num_loaded_max for models on this system */
+    max_num_loaded_max?: number;
+    /** Unique alias of backend system */
+    alias: string;
+    /** Description of backend system */
+    description?: string;
+}
+/**
+ * DTO for patching a ShapeDiver Geometry Backend System
+ */
+export interface SdPlatformRequestBackendSystemPatch {
+    /** The endpoint of the ShapeDiver Geometry Backend System */
+    model_view_url?: string;
+    /** obsolete, will be phased out */
+    model_view_user?: string;
+    /** obsolete, will be phased out */
+    model_view_pass?: string;
+    /** The endpoint of the ShapeDiver Geometry Backend System. Obsolete, will be phased out */
+    model_mgmt_url?: string;
+    /** obsolete, will be phased out */
+    model_mgmt_user?: string;
+    /** obsolete, will be phased out */
+    model_mgmt_pass?: string;
+    /** Shall this backend system be used by default? */
+    use_by_default?: boolean;
+    /** Is this a productive backend system? */
+    is_production?: boolean;
+    /** Maximum allowed value of max_comp_time for models on this system */
+    max_max_comp_time?: number;
+    /** Maximum allowed value of num_loaded_max for models on this system */
+    max_num_loaded_max?: number;
+    /** Unique alias of backend system */
+    alias?: string;
+    /** Description of backend system */
+    description?: string;
+}
+/**
+ * DTO for creating a token for accessing a ShapeDiver Geometry Backend System
+ */
+export interface SdPlatformRequestBackendSystemToken {
+    /** Id of the ShapeDiver Geometry Backend System */
+    id: string;
+    /** Scopes to create the token for */
+    scopes: Array<string>;
+    /** The lifetime of a token in seconds, which is only set if lifetime is less then minimum lifetime for a client. */
+    lifetime?: number;
+}
 //# sourceMappingURL=SdPlatformRequestBackendSystem.d.ts.map

package/dist/request/SdPlatformRequestBackendSystem.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SdPlatformRequestBackendSystem.js.map

package/dist/request/SdPlatformRequestBookmark.d.ts

@@ -1,8 +1,8 @@
-/**
- * DTO for creating a bookmark for a model
- */
-export interface SdPlatformRequestBookmarkCreate {
-    /** The id of the model to bookmark */
-    model_id: string;
-}
+/**
+ * DTO for creating a bookmark for a model
+ */
+export interface SdPlatformRequestBookmarkCreate {
+    /** The id of the model to bookmark */
+    model_id: string;
+}
 //# sourceMappingURL=SdPlatformRequestBookmark.d.ts.map

package/dist/request/SdPlatformRequestBookmark.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SdPlatformRequestBookmark.js.map

package/dist/request/SdPlatformRequestChargebee.d.ts

@@ -1,12 +1,12 @@
-export interface SdPlatformRequestChargebeeHostedPage {
-    plan_id: string;
-    customer_id?: string;
-}
-export interface SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod {
-    customer_id: string;
-}
-export interface SdPlatformRequestChargebeePortalSession {
-    customer_id: string;
-    redirect_url: string;
-}
+export interface SdPlatformRequestChargebeeHostedPage {
+    plan_id: string;
+    customer_id?: string;
+}
+export interface SdPlatformRequestChargebeeHostedPageUpdatePaymentMethod {
+    customer_id: string;
+}
+export interface SdPlatformRequestChargebeePortalSession {
+    customer_id: string;
+    redirect_url: string;
+}
 //# sourceMappingURL=SdPlatformRequestChargebee.d.ts.map

package/dist/request/SdPlatformRequestChargebee.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SdPlatformRequestChargebee.js.map

package/dist/request/SdPlatformRequestDocument.d.ts

@@ -1,47 +1,47 @@
-export interface SdPlatformRequestDocumentCreate {
-    /**
-      * An identifier for the type of document, freely choosable string, e.g.
-      * - customer_terms
-      * - user_terms
-      * - data_processing_agreement
-      * - privacy_policy_supplement
-      */
-    type: string;
-    /**
-     * Description of the document.
-     */
-    description: string;
-    /**
-     * Timestamp from which the document will be valid.
-     */
-    valid_from: number;
-    /**
-     * If true the document must be accepted, otherwise it’s just for information.
-     */
-    requires_acceptance: boolean;
-    /**
-     * If true this document applies to account owners, if false it applies to users who are not account owners.
-     */
-    account_owner: boolean;
-    /**
-     * The actual document (the contents of the file), base64 encoded.
-     */
-    document: string;
-    /**
-     * Content-Type of the document to be used when downloading it.
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type
-     */
-    content_type: string;
-    /**
-     * Filename of the document, to be used when downloading it. This will be used for the Content-Disposition header.
-     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
-     */
-    filename: string;
-}
-export interface SdPlatformRequestDocumentAccept {
-    /**
-     * Recaptcha token.
-     */
-    recaptcha_token: string;
-}
+export interface SdPlatformRequestDocumentCreate {
+    /**
+      * An identifier for the type of document, freely choosable string, e.g.
+      * - customer_terms
+      * - user_terms
+      * - data_processing_agreement
+      * - privacy_policy_supplement
+      */
+    type: string;
+    /**
+     * Description of the document.
+     */
+    description: string;
+    /**
+     * Timestamp from which the document will be valid.
+     */
+    valid_from: number;
+    /**
+     * If true the document must be accepted, otherwise it’s just for information.
+     */
+    requires_acceptance: boolean;
+    /**
+     * If true this document applies to account owners, if false it applies to users who are not account owners.
+     */
+    account_owner: boolean;
+    /**
+     * The actual document (the contents of the file), base64 encoded.
+     */
+    document: string;
+    /**
+     * Content-Type of the document to be used when downloading it.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type
+     */
+    content_type: string;
+    /**
+     * Filename of the document, to be used when downloading it. This will be used for the Content-Disposition header.
+     * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition
+     */
+    filename: string;
+}
+export interface SdPlatformRequestDocumentAccept {
+    /**
+     * Recaptcha token.
+     */
+    recaptcha_token: string;
+}
 //# sourceMappingURL=SdPlatformRequestDocument.d.ts.map

package/dist/request/SdPlatformRequestDocument.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SdPlatformRequestDocument.js.map

package/dist/request/SdPlatformRequestDomain.d.ts

@@ -1,19 +1,19 @@
-/**
- * DTO for creating an image
- */
-export interface SdPlatformRequestDomainCreate {
-    /** name of the domain, e.g. www.shapediver.com or 127.0.0.1:8080 */
-    name: string;
-    /** uuids of models the domain should be attached to */
-    models?: Array<string>;
-}
-/**
- * DTO for patching an image
- */
-export interface SdPlatformRequestDomainPatch {
-    /** name of the domain, e.g. www.shapediver.com or 127.0.0.1:8080 */
-    name?: string;
-    /** uuids of models the domain should be attached to */
-    models?: Array<string>;
-}
+/**
+ * DTO for creating an image
+ */
+export interface SdPlatformRequestDomainCreate {
+    /** name of the domain, e.g. www.shapediver.com or 127.0.0.1:8080 */
+    name: string;
+    /** uuids of models the domain should be attached to */
+    models?: Array<string>;
+}
+/**
+ * DTO for patching an image
+ */
+export interface SdPlatformRequestDomainPatch {
+    /** name of the domain, e.g. www.shapediver.com or 127.0.0.1:8080 */
+    name?: string;
+    /** uuids of models the domain should be attached to */
+    models?: Array<string>;
+}
 //# sourceMappingURL=SdPlatformRequestDomain.d.ts.map

package/dist/request/SdPlatformRequestDomain.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SdPlatformRequestDomain.js.map

package/dist/request/SdPlatformRequestImage.d.ts

@@ -1,17 +1,17 @@
-/**
- * DTO for creating an image
- */
-export interface SdPlatformRequestImageCreate {
-    /** The image alt description */
-    alt?: string;
-    /** An optional alias to use for the image */
-    alias?: string;
-    /**
-     * base 64 encoded representation of image
-     * Examples:
-     *   * "data:image/png;base64,ACTUAL_BASE64_ENCODED_IMAGE"
-     *   * "ACTUAL_BASE64_ENCODED_IMAGE"
-     */
-    imageData: string;
-}
+/**
+ * DTO for creating an image
+ */
+export interface SdPlatformRequestImageCreate {
+    /** The image alt description */
+    alt?: string;
+    /** An optional alias to use for the image */
+    alias?: string;
+    /**
+     * base 64 encoded representation of image
+     * Examples:
+     *   * "data:image/png;base64,ACTUAL_BASE64_ENCODED_IMAGE"
+     *   * "ACTUAL_BASE64_ENCODED_IMAGE"
+     */
+    imageData: string;
+}
 //# sourceMappingURL=SdPlatformRequestImage.d.ts.map

package/dist/request/SdPlatformRequestImage.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=SdPlatformRequestImage.js.map