@shapediver/api.platform-api-dto-v1 2.14.2 → 2.14.5

package/dist/request/SdPlatformAuthRequest.d.ts

@@ -1,78 +1,78 @@
-/**
- * OAuth 2.0 grant type
- */
-export declare enum SdPlatformAuthGrantType {
-    Password = "password",
-    RefreshToken = "refresh_token",
-    Code = "authorization_code"
-}
-/**
- * DTO for ShapeDiver Platform Authentication API (OAuth 2.0)
- */
-export interface SdPlatformAuthRequest {
-    /**
-     * The grant type.
-     */
-    grant_type: SdPlatformAuthGrantType;
-    /**
-     * The client id.
-     */
-    client_id?: string | null;
-    /**
-     * The client secret.
-     */
-    client_secret?: string | null;
-    /**
-     * The refresh token.
-     */
-    refresh_token?: string | null;
-    /**
-     * The username.
-     */
-    username?: string | null;
-    /**
-     * The password.
-     */
-    password?: string | null;
-    /**
-     * The code.
-     */
-    code?: string | null;
-    /**
-     * The state.
-     */
-    state?: string | null;
-}
-export declare enum SdPlatformRequestAuthorizationCodeResponseType {
-    Code = "code"
-}
-export declare enum SdPlatformRequestAuthorizationCodeCodeChallengeMethod {
-    S256 = "S256"
-}
-export interface SdPlatformRequestAuthorizationCode {
-    /**
-     * The uri to be verified.
-     */
-    redirect_uri: string;
-    /**
-     * Must be present.
-     */
-    state: string;
-    /**
-     * Must be present and must be 'code'.
-     */
-    response_type: SdPlatformRequestAuthorizationCodeResponseType;
-    /**
-     * Must be present.
-     */
-    code_challenge: string;
-    /**
-     * Must be 'S256'.
-     */
-    code_challenge_method: SdPlatformRequestAuthorizationCodeCodeChallengeMethod;
-    /**
-     * Must be present.
-     */
-    client_id: string;
-}
+/**
+ * OAuth 2.0 grant type
+ */
+export declare enum SdPlatformAuthGrantType {
+    Password = "password",
+    RefreshToken = "refresh_token",
+    Code = "authorization_code"
+}
+/**
+ * DTO for ShapeDiver Platform Authentication API (OAuth 2.0)
+ */
+export interface SdPlatformAuthRequest {
+    /**
+     * The grant type.
+     */
+    grant_type: SdPlatformAuthGrantType;
+    /**
+     * The client id.
+     */
+    client_id?: string | null;
+    /**
+     * The client secret.
+     */
+    client_secret?: string | null;
+    /**
+     * The refresh token.
+     */
+    refresh_token?: string | null;
+    /**
+     * The username.
+     */
+    username?: string | null;
+    /**
+     * The password.
+     */
+    password?: string | null;
+    /**
+     * The code.
+     */
+    code?: string | null;
+    /**
+     * The state.
+     */
+    state?: string | null;
+}
+export declare enum SdPlatformRequestAuthorizationCodeResponseType {
+    Code = "code"
+}
+export declare enum SdPlatformRequestAuthorizationCodeCodeChallengeMethod {
+    S256 = "S256"
+}
+export interface SdPlatformRequestAuthorizationCode {
+    /**
+     * The uri to be verified.
+     */
+    redirect_uri: string;
+    /**
+     * Must be present.
+     */
+    state: string;
+    /**
+     * Must be present and must be 'code'.
+     */
+    response_type: SdPlatformRequestAuthorizationCodeResponseType;
+    /**
+     * Must be present.
+     */
+    code_challenge: string;
+    /**
+     * Must be 'S256'.
+     */
+    code_challenge_method: SdPlatformRequestAuthorizationCodeCodeChallengeMethod;
+    /**
+     * Must be present.
+     */
+    client_id: string;
+}
 //# sourceMappingURL=SdPlatformAuthRequest.d.ts.map

package/dist/request/SdPlatformAuthRequest.js

@@ -1,21 +1,21 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SdPlatformRequestAuthorizationCodeCodeChallengeMethod = exports.SdPlatformRequestAuthorizationCodeResponseType = exports.SdPlatformAuthGrantType = void 0;
-/**
- * OAuth 2.0 grant type
- */
-var SdPlatformAuthGrantType;
-(function (SdPlatformAuthGrantType) {
-    SdPlatformAuthGrantType["Password"] = "password";
-    SdPlatformAuthGrantType["RefreshToken"] = "refresh_token";
-    SdPlatformAuthGrantType["Code"] = "authorization_code";
-})(SdPlatformAuthGrantType = exports.SdPlatformAuthGrantType || (exports.SdPlatformAuthGrantType = {}));
-var SdPlatformRequestAuthorizationCodeResponseType;
-(function (SdPlatformRequestAuthorizationCodeResponseType) {
-    SdPlatformRequestAuthorizationCodeResponseType["Code"] = "code";
-})(SdPlatformRequestAuthorizationCodeResponseType = exports.SdPlatformRequestAuthorizationCodeResponseType || (exports.SdPlatformRequestAuthorizationCodeResponseType = {}));
-var SdPlatformRequestAuthorizationCodeCodeChallengeMethod;
-(function (SdPlatformRequestAuthorizationCodeCodeChallengeMethod) {
-    SdPlatformRequestAuthorizationCodeCodeChallengeMethod["S256"] = "S256";
-})(SdPlatformRequestAuthorizationCodeCodeChallengeMethod = exports.SdPlatformRequestAuthorizationCodeCodeChallengeMethod || (exports.SdPlatformRequestAuthorizationCodeCodeChallengeMethod = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SdPlatformRequestAuthorizationCodeCodeChallengeMethod = exports.SdPlatformRequestAuthorizationCodeResponseType = exports.SdPlatformAuthGrantType = void 0;
+/**
+ * OAuth 2.0 grant type
+ */
+var SdPlatformAuthGrantType;
+(function (SdPlatformAuthGrantType) {
+    SdPlatformAuthGrantType["Password"] = "password";
+    SdPlatformAuthGrantType["RefreshToken"] = "refresh_token";
+    SdPlatformAuthGrantType["Code"] = "authorization_code";
+})(SdPlatformAuthGrantType = exports.SdPlatformAuthGrantType || (exports.SdPlatformAuthGrantType = {}));
+var SdPlatformRequestAuthorizationCodeResponseType;
+(function (SdPlatformRequestAuthorizationCodeResponseType) {
+    SdPlatformRequestAuthorizationCodeResponseType["Code"] = "code";
+})(SdPlatformRequestAuthorizationCodeResponseType = exports.SdPlatformRequestAuthorizationCodeResponseType || (exports.SdPlatformRequestAuthorizationCodeResponseType = {}));
+var SdPlatformRequestAuthorizationCodeCodeChallengeMethod;
+(function (SdPlatformRequestAuthorizationCodeCodeChallengeMethod) {
+    SdPlatformRequestAuthorizationCodeCodeChallengeMethod["S256"] = "S256";
+})(SdPlatformRequestAuthorizationCodeCodeChallengeMethod = exports.SdPlatformRequestAuthorizationCodeCodeChallengeMethod || (exports.SdPlatformRequestAuthorizationCodeCodeChallengeMethod = {}));
 //# sourceMappingURL=SdPlatformAuthRequest.js.map

package/dist/request/SdPlatformBaseRequestTypes.d.ts

@@ -1,66 +1,66 @@
-/**
- * Pagination parameters for query requests.
- */
-interface SdPlatformPaginationParameters {
-    /**
-     * Limit, or number of items to fetch.
-     */
-    limit?: number | null;
-    /**
-     * Strict limit. If set to true, the query will fetch the exact number of items unless there is no more items to query.
-     * If set to false, query will request 10 items, but might actually return less depending on the user's permissions.
-     */
-    strict_limit?: boolean | null;
-    /**
-     * Offset, is used like page number. If offset from response is not null, it can be used to query results further in next request.
-     */
-    offset?: string | null;
-}
-export declare enum SdPlatformSortingOrder {
-    /**
-     * Sort in ascending order.
-     */
-    Asc = "asc",
-    /**
-     * Sort in descending order.
-     */
-    Desc = "desc"
-}
-export declare type SdPlatformFilterValue = string | number | boolean | null | Array<SdPlatformFilterValue>;
-/**
- * Filtering parameters for query calls.
- */
-interface SdPlatformFilterParameters {
-    /**
-     * The query filters.
-     */
-    filters?: {
-        [filter_expression: string]: SdPlatformFilterValue;
-    };
-}
-/**
- * Sorting parameters for query calls.
- */
-interface SdPlatformSorterParameters {
-    /**
-     * Sorting criteria for request.
-     */
-    sorters?: {
-        [column: string]: SdPlatformSortingOrder;
-    };
-}
-/**
- * Embedding parameters.
- */
-interface SdPlatformEmbedParameters<TEmbeddableResource> {
-    /**
-     * Which fields to embed.
-     */
-    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 {
+    /**
+     * Limit, or number of items to fetch.
+     */
+    limit?: number | null;
+    /**
+     * Strict limit. If set to true, the query will fetch the exact number of items unless there is no more items to query.
+     * If set to false, query will request 10 items, but might actually return less depending on the user's permissions.
+     */
+    strict_limit?: boolean | null;
+    /**
+     * Offset, is used like page number. If offset from response is not null, it can be used to query results further in next request.
+     */
+    offset?: string | null;
+}
+export declare enum SdPlatformSortingOrder {
+    /**
+     * Sort in ascending order.
+     */
+    Asc = "asc",
+    /**
+     * Sort in descending order.
+     */
+    Desc = "desc"
+}
+export declare type SdPlatformFilterValue = string | number | boolean | null | Array<SdPlatformFilterValue>;
+/**
+ * Filtering parameters for query calls.
+ */
+interface SdPlatformFilterParameters {
+    /**
+     * The query filters.
+     */
+    filters?: {
+        [filter_expression: string]: SdPlatformFilterValue;
+    };
+}
+/**
+ * Sorting parameters for query calls.
+ */
+interface SdPlatformSorterParameters {
+    /**
+     * Sorting criteria for request.
+     */
+    sorters?: {
+        [column: string]: SdPlatformSortingOrder;
+    };
+}
+/**
+ * Embedding parameters.
+ */
+interface SdPlatformEmbedParameters<TEmbeddableResource> {
+    /**
+     * Which fields to embed.
+     */
+    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,15 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SdPlatformSortingOrder = void 0;
-var SdPlatformSortingOrder;
-(function (SdPlatformSortingOrder) {
-    /**
-     * Sort in ascending order.
-     */
-    SdPlatformSortingOrder["Asc"] = "asc";
-    /**
-     * Sort in descending order.
-     */
-    SdPlatformSortingOrder["Desc"] = "desc";
-})(SdPlatformSortingOrder = exports.SdPlatformSortingOrder || (exports.SdPlatformSortingOrder = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SdPlatformSortingOrder = void 0;
+var SdPlatformSortingOrder;
+(function (SdPlatformSortingOrder) {
+    /**
+     * Sort in ascending order.
+     */
+    SdPlatformSortingOrder["Asc"] = "asc";
+    /**
+     * Sort in descending order.
+     */
+    SdPlatformSortingOrder["Desc"] = "desc";
+})(SdPlatformSortingOrder = exports.SdPlatformSortingOrder || (exports.SdPlatformSortingOrder = {}));
 //# sourceMappingURL=SdPlatformBaseRequestTypes.js.map

package/dist/request/SdPlatformRequestApiClients.d.ts

@@ -1,69 +1,69 @@
-export interface SdPlatformRequestApiClientCreate {
-    /**
-     * Client application name
-     */
-    client_name: string;
-    /**
-     * Client application secret (typically unused)
-     */
-    client_secret?: string;
-    /**
-     * Should refresh tokens be used?
-     */
-    refresh_token?: boolean;
-    /**
-     *  Origins (domains) which the client application may connect from.
-     */
-    allowed_origins?: Array<string>;
-    /**
-     * Lifetime of access tokens issued to this client application in seconds.
-     */
-    access_token_lifetime?: number;
-    /**
-     * Lifetime of refresh tokens issued to this client application in seconds.
-     */
-    refresh_token_lifetime?: number;
-    /**
-     * The refresh token limit (how often can refresh tokens be used?)
-     */
-    refresh_token_limit?: number;
-    /**
-     *  The required feature. If this is set, the user must have this feature enabled in order to be allowed to sign in from this client. {@link SdPlatformResponseFeatureValues}
-     */
-    required_feature: string;
-}
-export interface SdPlatformRequestApiClientPatch {
-    /**
-    * Client application name
-    */
-    client_name?: string;
-    /**
-     * Client application secret (typically unused)
-     */
-    client_secret?: string;
-    /**
-    * Should refresh tokens be used?
-    */
-    refresh_token?: boolean;
-    /**
-    *  Origins (domains) which the client application may connect from.
-    */
-    allowed_origins?: Array<string>;
-    /**
-     * Lifetime of access tokens issued to this client application in seconds.
-     */
-    access_token_lifetime?: number;
-    /**
-    * Lifetime of refresh tokens issued to this client application in seconds.
-    */
-    refresh_token_lifetime?: number;
-    /**
-     * The refresh token limit (how often can refresh tokens be used?)
-     */
-    refresh_token_limit?: number;
-    /**
-     *  The required feature. If this is set, the user must have this feature enabled in order to be allowed to sign in from this client. {@link SdPlatformResponseFeatureValues}
-     */
-    required_feature: string;
-}
+export interface SdPlatformRequestApiClientCreate {
+    /**
+     * Client application name
+     */
+    client_name: string;
+    /**
+     * Client application secret (typically unused)
+     */
+    client_secret?: string;
+    /**
+     * Should refresh tokens be used?
+     */
+    refresh_token?: boolean;
+    /**
+     *  Origins (domains) which the client application may connect from.
+     */
+    allowed_origins?: Array<string>;
+    /**
+     * Lifetime of access tokens issued to this client application in seconds.
+     */
+    access_token_lifetime?: number;
+    /**
+     * Lifetime of refresh tokens issued to this client application in seconds.
+     */
+    refresh_token_lifetime?: number;
+    /**
+     * The refresh token limit (how often can refresh tokens be used?)
+     */
+    refresh_token_limit?: number;
+    /**
+     *  The required feature. If this is set, the user must have this feature enabled in order to be allowed to sign in from this client. {@link SdPlatformResponseFeatureValues}
+     */
+    required_feature: string;
+}
+export interface SdPlatformRequestApiClientPatch {
+    /**
+    * Client application name
+    */
+    client_name?: string;
+    /**
+     * Client application secret (typically unused)
+     */
+    client_secret?: string;
+    /**
+    * Should refresh tokens be used?
+    */
+    refresh_token?: boolean;
+    /**
+    *  Origins (domains) which the client application may connect from.
+    */
+    allowed_origins?: Array<string>;
+    /**
+     * Lifetime of access tokens issued to this client application in seconds.
+     */
+    access_token_lifetime?: number;
+    /**
+    * Lifetime of refresh tokens issued to this client application in seconds.
+    */
+    refresh_token_lifetime?: number;
+    /**
+     * The refresh token limit (how often can refresh tokens be used?)
+     */
+    refresh_token_limit?: number;
+    /**
+     *  The required feature. If this is set, the user must have this feature enabled in order to be allowed to sign in from this client. {@link SdPlatformResponseFeatureValues}
+     */
+    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