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

package/dist/response/SdPlatformResponseOrganization.d.ts

@@ -1,134 +1,134 @@
-import { SdPlatformChargebeeAddon, SdPlatformChargebeeCustomer, SdPlatformChargebeePlan, SdPlatformChargebeeSubscription } from "../commons/SdPlatformChargebee";
-import { SdPlatformPolicyCommonAliasesOrganization, SdPlatformPolicyPermissionsOrganization } from "../commons/SdPlatformPolicyCommons";
-import { SdPlatformOrganizationVisibility } from "../commons/SdPlatformVisibility";
-import { SdPlatformResponseBackendSystem } from "./SdPlatformResponseBackendSystem";
-import { SdPlatformResponseDomain } from "./SdPlatformResponseDomain";
-import { SdPlatformResponseFeatures } from "./SdPlatformResponseFeatures";
-import { SdPlatformResponsePolicyPermissions } from "./SdPlatformResponsePolicy";
-import { SdPlatformResponseUserOrganization } from "./SdPlatformResponseUser";
-/**
- * Organization - public access level
- */
-export interface SdPlatformResponseOrganizationPublic extends SdPlatformResponsePolicyPermissions<SdPlatformPolicyCommonAliasesOrganization, SdPlatformPolicyPermissionsOrganization> {
-    /**
-     * Unique id of the organization.
-     */
-    readonly id: string;
-    /**
-     * Name of the organization.
-     */
-    readonly name: string;
-    /**
-     * URL-compatible short name of the organization. Used for links to the organizations's profile on the ShapeDiver Platform.
-     */
-    readonly slug: string;
-    /**
-     * URL to the organization's avatar.
-     */
-    readonly avatar_url?: string;
-    /**
-     * Website of organization.
-     */
-    readonly website?: string;
-    /**
-     * Description of organization.
-     */
-    readonly description?: string;
-    /**
-     * Features which the organization has access to.
-     */
-    readonly features?: SdPlatformResponseFeatures;
-}
-/**
- * Organization - organization member access level.
- */
-export interface SdPlatformResponseOrganizationMember extends SdPlatformResponseOrganizationPublic {
-    /**
-     * Accessdomains of the organization.
-     */
-    readonly accessdomains?: Array<SdPlatformResponseDomain>;
-    /**
-     *  Members of the organization.
-     */
-    readonly members: Array<SdPlatformResponseUserOrganization>;
-    /**
-     * Visibility of the organization. This limits the visibility of organization members and their models.
-     */
-    readonly visibility: SdPlatformOrganizationVisibility;
-    /**
-     * Should sharing be allowed for organization members?
-     */
-    readonly allow_sharing: boolean;
-    /**
-     * Should private link sharing be allowed for organization members?
-     */
-    readonly allow_link_sharing: boolean;
-    /**
-     * Should organization members be allowed to expose their email address?
-     */
-    readonly allow_expose_email: boolean;
-    /**
-     * Geometry backend system of the organization.
-     */
-    readonly backend_system?: SdPlatformResponseBackendSystem;
-    /**
-     *  Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the organization?
-     */
-    readonly force_require_token: boolean;
-    /**
-     * Should credit consumption be limited once the monthly quota has been reached?
-     */
-    readonly limit_credit_consumption: boolean;
-    /**
-     * OpenID provider linked with the organization
-     */
-    readonly openid_provider?: string;
-}
-/**
- * Organization - organization administrator access level.
- */
-export interface SdPlatformResponseOrganizationAdministrator extends SdPlatformResponseOrganizationMember {
-    /**
-     * Features which the organization has access to
-     */
-    readonly created_at: number;
-    /**
-     * Features which the organization has access to.
-     */
-    readonly updated_at: number;
-}
-/**
- * Organization - organization owner access level.
- */
-export interface SdPlatformResponseOrganizationOwner extends SdPlatformResponseOrganizationAdministrator {
-    /**
-     * Status of the organization, one of "created" or "confirmed"
-     */
-    readonly status?: string;
-    readonly chargebee_customer?: SdPlatformChargebeeCustomer;
-    readonly chargebee_plan?: SdPlatformChargebeePlan;
-    readonly chargebee_subscription?: SdPlatformChargebeeSubscription;
-    readonly chargbee_addons?: Array<SdPlatformChargebeeAddon>;
-}
-/**
- *  Organization - admin access level.
- */
-export interface SdPlatformResponseOrganizationAdmin extends SdPlatformResponseOrganizationOwner {
-    /**
-     * Epoch timestamp of deletion.
-     */
-    readonly deleted_at?: number;
-    /**
-     * Id of backend system {@link SdPlatformRequestBackendSystemToken}
-     */
-    readonly backend_system_id?: string;
-    /**
-     * Chargebee customer id.
-     */
-    readonly chargebee_customer_id?: string;
-}
-/**
- * Organization - any access level
- */
-export declare type SdPlatformResponseOrganizationAny = SdPlatformResponseOrganizationAdmin | SdPlatformResponseOrganizationOwner | SdPlatformResponseOrganizationAdministrator | SdPlatformResponseOrganizationMember | SdPlatformResponseOrganizationPublic;
+import { SdPlatformChargebeeAddon, SdPlatformChargebeeCustomer, SdPlatformChargebeePlan, SdPlatformChargebeeSubscription } from "../commons/SdPlatformChargebee";
+import { SdPlatformPolicyCommonAliasesOrganization, SdPlatformPolicyPermissionsOrganization } from "../commons/SdPlatformPolicyCommons";
+import { SdPlatformOrganizationVisibility } from "../commons/SdPlatformVisibility";
+import { SdPlatformResponseBackendSystem } from "./SdPlatformResponseBackendSystem";
+import { SdPlatformResponseDomain } from "./SdPlatformResponseDomain";
+import { SdPlatformResponseFeatures } from "./SdPlatformResponseFeatures";
+import { SdPlatformResponsePolicyPermissions } from "./SdPlatformResponsePolicy";
+import { SdPlatformResponseUserOrganization } from "./SdPlatformResponseUser";
+/**
+ * Organization - public access level
+ */
+export interface SdPlatformResponseOrganizationPublic extends SdPlatformResponsePolicyPermissions<SdPlatformPolicyCommonAliasesOrganization, SdPlatformPolicyPermissionsOrganization> {
+    /**
+     * Unique id of the organization.
+     */
+    readonly id: string;
+    /**
+     * Name of the organization.
+     */
+    readonly name: string;
+    /**
+     * URL-compatible short name of the organization. Used for links to the organizations's profile on the ShapeDiver Platform.
+     */
+    readonly slug: string;
+    /**
+     * URL to the organization's avatar.
+     */
+    readonly avatar_url?: string;
+    /**
+     * Website of organization.
+     */
+    readonly website?: string;
+    /**
+     * Description of organization.
+     */
+    readonly description?: string;
+    /**
+     * Features which the organization has access to.
+     */
+    readonly features?: SdPlatformResponseFeatures;
+}
+/**
+ * Organization - organization member access level.
+ */
+export interface SdPlatformResponseOrganizationMember extends SdPlatformResponseOrganizationPublic {
+    /**
+     * Accessdomains of the organization.
+     */
+    readonly accessdomains?: Array<SdPlatformResponseDomain>;
+    /**
+     *  Members of the organization.
+     */
+    readonly members: Array<SdPlatformResponseUserOrganization>;
+    /**
+     * Visibility of the organization. This limits the visibility of organization members and their models.
+     */
+    readonly visibility: SdPlatformOrganizationVisibility;
+    /**
+     * Should sharing be allowed for organization members?
+     */
+    readonly allow_sharing: boolean;
+    /**
+     * Should private link sharing be allowed for organization members?
+     */
+    readonly allow_link_sharing: boolean;
+    /**
+     * Should organization members be allowed to expose their email address?
+     */
+    readonly allow_expose_email: boolean;
+    /**
+     * Geometry backend system of the organization.
+     */
+    readonly backend_system?: SdPlatformResponseBackendSystem;
+    /**
+     *  Should {@link SdPlatformResponseModelOwner.require_token} be forced to true for all models of the organization?
+     */
+    readonly force_require_token: boolean;
+    /**
+     * Should credit consumption be limited once the monthly quota has been reached?
+     */
+    readonly limit_credit_consumption: boolean;
+    /**
+     * OpenID provider linked with the organization
+     */
+    readonly openid_provider?: string;
+}
+/**
+ * Organization - organization administrator access level.
+ */
+export interface SdPlatformResponseOrganizationAdministrator extends SdPlatformResponseOrganizationMember {
+    /**
+     * Features which the organization has access to
+     */
+    readonly created_at: number;
+    /**
+     * Features which the organization has access to.
+     */
+    readonly updated_at: number;
+}
+/**
+ * Organization - organization owner access level.
+ */
+export interface SdPlatformResponseOrganizationOwner extends SdPlatformResponseOrganizationAdministrator {
+    /**
+     * Status of the organization, one of "created" or "confirmed"
+     */
+    readonly status?: string;
+    readonly chargebee_customer?: SdPlatformChargebeeCustomer;
+    readonly chargebee_plan?: SdPlatformChargebeePlan;
+    readonly chargebee_subscription?: SdPlatformChargebeeSubscription;
+    readonly chargbee_addons?: Array<SdPlatformChargebeeAddon>;
+}
+/**
+ *  Organization - admin access level.
+ */
+export interface SdPlatformResponseOrganizationAdmin extends SdPlatformResponseOrganizationOwner {
+    /**
+     * Epoch timestamp of deletion.
+     */
+    readonly deleted_at?: number;
+    /**
+     * Id of backend system {@link SdPlatformRequestBackendSystemToken}
+     */
+    readonly backend_system_id?: string;
+    /**
+     * Chargebee customer id.
+     */
+    readonly chargebee_customer_id?: string;
+}
+/**
+ * Organization - any access level
+ */
+export declare type SdPlatformResponseOrganizationAny = SdPlatformResponseOrganizationAdmin | SdPlatformResponseOrganizationOwner | SdPlatformResponseOrganizationAdministrator | SdPlatformResponseOrganizationMember | SdPlatformResponseOrganizationPublic;
 //# sourceMappingURL=SdPlatformResponseOrganization.d.ts.map

package/dist/response/SdPlatformResponseOrganization.js

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

package/dist/response/SdPlatformResponsePolicy.d.ts

@@ -1,58 +1,58 @@
-import { SdPlatformPolicyPermissionsStatusType, SdPlatformPolicyPermissionsType, SdPlatformPolicyRequiredFeatures, SdPlatformPolicyType } from "../commons/SdPlatformPolicyCommons";
-/**
- * A policy
- */
-export interface SdPlatformResponsePolicy {
-    /** id of the policy */
-    readonly id: string;
-    /** type of policy */
-    readonly type: SdPlatformPolicyType;
-    /** policy alias, used to identify policy in evaluators */
-    readonly alias: string;
-    /** description of the policy */
-    readonly description: string;
-    /** role required to be granted this policy */
-    readonly required_role?: string;
-    /** permission status */
-    readonly permissions: SdPlatformPolicyPermissionsStatusType;
-    /** granted permissions */
-    readonly allowed_permissions: SdPlatformPolicyPermissionsType;
-    /** explicitely denied permissions */
-    readonly denied_permissions: SdPlatformPolicyPermissionsType;
-    /** features required by the receiver of the policy */
-    readonly features_receiver: SdPlatformPolicyRequiredFeatures;
-    /** features required by the provider of the policy */
-    readonly features_provider: SdPlatformPolicyRequiredFeatures;
-}
-export interface SdPlatformResponsePoliciesDeniedContext {
-    /**
-     * The features that provider is missing.
-     */
-    readonly provider_missing_features: Array<string>;
-    /**
-     * The features that receiver is missing.
-     */
-    readonly receiver_missing_features: Array<string>;
-}
-/**
- * Permissions and policies available to the requesting user
- */
-export interface SdPlatformResponsePolicyPermissions<Tpolicy extends string, Tpermission> {
-    /**
-     * Aliases of granted policies.
-     */
-    readonly policies_granted: Array<Tpolicy>;
-    /**
-     * Aliases of denied policies
-     */
-    readonly policies_denied: Array<Tpolicy>;
-    /**
-     * Granted permissions
-     */
-    readonly permissions: Array<Tpermission>;
-    /**
-     * The policies denied context.
-     */
-    readonly policies_denied_context: Record<Tpolicy, SdPlatformResponsePoliciesDeniedContext>;
-}
+import { SdPlatformPolicyPermissionsStatusType, SdPlatformPolicyPermissionsType, SdPlatformPolicyRequiredFeatures, SdPlatformPolicyType } from "../commons/SdPlatformPolicyCommons";
+/**
+ * A policy
+ */
+export interface SdPlatformResponsePolicy {
+    /** id of the policy */
+    readonly id: string;
+    /** type of policy */
+    readonly type: SdPlatformPolicyType;
+    /** policy alias, used to identify policy in evaluators */
+    readonly alias: string;
+    /** description of the policy */
+    readonly description: string;
+    /** role required to be granted this policy */
+    readonly required_role?: string;
+    /** permission status */
+    readonly permissions: SdPlatformPolicyPermissionsStatusType;
+    /** granted permissions */
+    readonly allowed_permissions: SdPlatformPolicyPermissionsType;
+    /** explicitely denied permissions */
+    readonly denied_permissions: SdPlatformPolicyPermissionsType;
+    /** features required by the receiver of the policy */
+    readonly features_receiver: SdPlatformPolicyRequiredFeatures;
+    /** features required by the provider of the policy */
+    readonly features_provider: SdPlatformPolicyRequiredFeatures;
+}
+export interface SdPlatformResponsePoliciesDeniedContext {
+    /**
+     * The features that provider is missing.
+     */
+    readonly provider_missing_features: Array<string>;
+    /**
+     * The features that receiver is missing.
+     */
+    readonly receiver_missing_features: Array<string>;
+}
+/**
+ * Permissions and policies available to the requesting user
+ */
+export interface SdPlatformResponsePolicyPermissions<Tpolicy extends string, Tpermission> {
+    /**
+     * Aliases of granted policies.
+     */
+    readonly policies_granted: Array<Tpolicy>;
+    /**
+     * Aliases of denied policies
+     */
+    readonly policies_denied: Array<Tpolicy>;
+    /**
+     * Granted permissions
+     */
+    readonly permissions: Array<Tpermission>;
+    /**
+     * The policies denied context.
+     */
+    readonly policies_denied_context: Record<Tpolicy, SdPlatformResponsePoliciesDeniedContext>;
+}
 //# sourceMappingURL=SdPlatformResponsePolicy.d.ts.map

package/dist/response/SdPlatformResponsePolicy.js

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

package/dist/response/SdPlatformResponseSavedState.d.ts

@@ -1,108 +1,108 @@
-import { SdPlatformPolicyCommonAliasesSavedState, SdPlatformPolicyPermissionsSavedState } from "../commons/SdPlatformPolicyCommons";
-import { SdPlatformSavedStateVisibility } from "../commons/SdPlatformVisibility";
-import { SdPlatformResponseModelPublic } from "./SdPlatformResponseModel";
-import { SdPlatformResponseOrganizationPublic } from "./SdPlatformResponseOrganization";
-import { SdPlatformResponsePolicyPermissions } from "./SdPlatformResponsePolicy";
-import { SdPlatformResponseUserMinimal } from "./SdPlatformResponseUser";
-import { SdPlatformResponseImagePublic } from './SdPlatformResponseImage';
-/**
- * Saved state - minimal information
- */
-export interface SdPlatformResponseSavedStateMinimal extends SdPlatformResponsePolicyPermissions<SdPlatformPolicyCommonAliasesSavedState, SdPlatformPolicyPermissionsSavedState> {
-    /**
-     * The saved state id.
-     */
-    readonly id: string;
-    /**
-     * Name of the saved state.
-     */
-    readonly name: string;
-    /**
-     * Id of the model of the saved state.
-     */
-    readonly model_id: string;
-    /**
-     * Model of the saved state.
-     */
-    readonly model?: SdPlatformResponseModelPublic;
-    /**
-     * Image of the saved state.
-     */
-    readonly image?: SdPlatformResponseImagePublic;
-    /**
-     * Id of the image of the saved state.
-     */
-    readonly image_id?: string;
-}
-/**
- * The saved state settings.
- */
-export interface SdPlatformResponseSavedStateSettings {
-    /**
-     * The version of settings.
-     */
-    readonly version?: string;
-    /**
-     * The Viewer Settings.
-     */
-    readonly viewer_settings?: any;
-}
-/**
- * Saved state - public access level
- */
-export interface SdPlatformResponseSavedStatePublic extends SdPlatformResponseSavedStateMinimal {
-    /**
-     * Description of the saved state.
-     */
-    readonly description: string;
-    /**
-     * Id of the owner of the saved state (may be different from the owner of the model).
-     */
-    readonly owner_id: string;
-    /**
-     * Owner of the saved state.
-     */
-    readonly owner?: SdPlatformResponseUserMinimal;
-    /**
-     * The parameter values of the model for this saved state. Map from parameter id to parameter string value.
-     */
-    readonly parameters: {
-        [id: string]: string;
-    };
-    /**
-     * Organization of the owner of the saved state, if the owner is member of an organization.
-     */
-    readonly organization?: SdPlatformResponseOrganizationPublic;
-    /**
-     * Epoch timestamp of creation.
-     */
-    readonly created_at: number;
-    /**
-     * Epoch timestamp of update.
-     */
-    readonly updated_at: number;
-    readonly settings: SdPlatformResponseSavedStateSettings;
-}
-/**
- * Saved state - owner access level
- */
-export interface SdPlatformResponseSavedStateOwner extends SdPlatformResponseSavedStatePublic {
-    /**
-     * Visibility of the saved state. Might be limited by the visibility of the model, the owner, or an organization.
-     */
-    readonly visibility: SdPlatformSavedStateVisibility;
-    /**
-     * Nominal visibility of the saved state as specified by the saved state owner.
-     */
-    readonly visibility_nominal: SdPlatformSavedStateVisibility;
-}
-/**
- * Saved state - admin access level
- */
-export interface SdPlatformResponseSavedStateAdmin extends SdPlatformResponseSavedStateOwner {
-}
-/**
- * Saved state - any access level
- */
-export declare type SdPlatformResponseSavedStateAny = SdPlatformResponseSavedStateAdmin | SdPlatformResponseSavedStateOwner | SdPlatformResponseSavedStatePublic | SdPlatformResponseSavedStateMinimal;
+import { SdPlatformPolicyCommonAliasesSavedState, SdPlatformPolicyPermissionsSavedState } from "../commons/SdPlatformPolicyCommons";
+import { SdPlatformSavedStateVisibility } from "../commons/SdPlatformVisibility";
+import { SdPlatformResponseModelPublic } from "./SdPlatformResponseModel";
+import { SdPlatformResponseOrganizationPublic } from "./SdPlatformResponseOrganization";
+import { SdPlatformResponsePolicyPermissions } from "./SdPlatformResponsePolicy";
+import { SdPlatformResponseUserMinimal } from "./SdPlatformResponseUser";
+import { SdPlatformResponseImagePublic } from './SdPlatformResponseImage';
+/**
+ * Saved state - minimal information
+ */
+export interface SdPlatformResponseSavedStateMinimal extends SdPlatformResponsePolicyPermissions<SdPlatformPolicyCommonAliasesSavedState, SdPlatformPolicyPermissionsSavedState> {
+    /**
+     * The saved state id.
+     */
+    readonly id: string;
+    /**
+     * Name of the saved state.
+     */
+    readonly name: string;
+    /**
+     * Id of the model of the saved state.
+     */
+    readonly model_id: string;
+    /**
+     * Model of the saved state.
+     */
+    readonly model?: SdPlatformResponseModelPublic;
+    /**
+     * Image of the saved state.
+     */
+    readonly image?: SdPlatformResponseImagePublic;
+    /**
+     * Id of the image of the saved state.
+     */
+    readonly image_id?: string;
+}
+/**
+ * The saved state settings.
+ */
+export interface SdPlatformResponseSavedStateSettings {
+    /**
+     * The version of settings.
+     */
+    readonly version?: string;
+    /**
+     * The Viewer Settings.
+     */
+    readonly viewer_settings?: any;
+}
+/**
+ * Saved state - public access level
+ */
+export interface SdPlatformResponseSavedStatePublic extends SdPlatformResponseSavedStateMinimal {
+    /**
+     * Description of the saved state.
+     */
+    readonly description: string;
+    /**
+     * Id of the owner of the saved state (may be different from the owner of the model).
+     */
+    readonly owner_id: string;
+    /**
+     * Owner of the saved state.
+     */
+    readonly owner?: SdPlatformResponseUserMinimal;
+    /**
+     * The parameter values of the model for this saved state. Map from parameter id to parameter string value.
+     */
+    readonly parameters: {
+        [id: string]: string;
+    };
+    /**
+     * Organization of the owner of the saved state, if the owner is member of an organization.
+     */
+    readonly organization?: SdPlatformResponseOrganizationPublic;
+    /**
+     * Epoch timestamp of creation.
+     */
+    readonly created_at: number;
+    /**
+     * Epoch timestamp of update.
+     */
+    readonly updated_at: number;
+    readonly settings: SdPlatformResponseSavedStateSettings;
+}
+/**
+ * Saved state - owner access level
+ */
+export interface SdPlatformResponseSavedStateOwner extends SdPlatformResponseSavedStatePublic {
+    /**
+     * Visibility of the saved state. Might be limited by the visibility of the model, the owner, or an organization.
+     */
+    readonly visibility: SdPlatformSavedStateVisibility;
+    /**
+     * Nominal visibility of the saved state as specified by the saved state owner.
+     */
+    readonly visibility_nominal: SdPlatformSavedStateVisibility;
+}
+/**
+ * Saved state - admin access level
+ */
+export interface SdPlatformResponseSavedStateAdmin extends SdPlatformResponseSavedStateOwner {
+}
+/**
+ * Saved state - any access level
+ */
+export declare type SdPlatformResponseSavedStateAny = SdPlatformResponseSavedStateAdmin | SdPlatformResponseSavedStateOwner | SdPlatformResponseSavedStatePublic | SdPlatformResponseSavedStateMinimal;
 //# sourceMappingURL=SdPlatformResponseSavedState.d.ts.map

package/dist/response/SdPlatformResponseSavedState.js

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