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

package/dist/request/SdPlatformRequestOrganization.d.ts

@@ -1,58 +1,58 @@
-import { SdPlatformOrganizationVisibility } from "../commons/SdPlatformVisibility";
-/**
- * DTO for creating an organization
- */
-export interface SdPlatformRequestOrganizationCreate {
-    name: string;
-    /**
-     * avatar image base64 encoded, maximum 1MB
-     */
-    avatar?: string;
-    visibility?: SdPlatformOrganizationVisibility;
-    allow_sharing?: boolean;
-    allow_link_sharing?: boolean;
-    allow_expose_email?: boolean;
-    website?: string;
-    description?: string;
-}
-/**
- * DTO for patching an organization - organization administrator access level
- */
-export interface SdPlatformRequestOrganizationPatchAdministrator {
-    visibility?: SdPlatformOrganizationVisibility;
-    allow_sharing?: boolean;
-    allow_link_sharing?: boolean;
-    allow_expose_email?: boolean;
-    website?: string;
-    description?: string;
-    accessdomains?: Array<string>;
-    force_require_token?: boolean;
-    limit_credit_consumption?: boolean;
-    /**
-     * updates the default backend system for the organization based on the given backend system alias,
-     */
-    backend_system_alias?: string;
-}
-/**
- * DTO for patching an organization - organization owner access level
- */
-export interface SdPlatformRequestOrganizationPatchOwner extends SdPlatformRequestOrganizationPatchAdministrator {
-    name?: string;
-    /**
-     * avatar image base64 encoded, maximum 1MB
-     */
-    avatar?: string;
-    slug?: string;
-}
-/**
- * DTO for patching an organization - admin access level
- */
-export interface SdPlatformRequestOrganizationPatchAdmin extends SdPlatformRequestOrganizationPatchOwner {
-    backend_system_id?: string;
-    chargebee_customer_id?: string;
-}
-/**
- * DTO for patching an organization - admin access level
- */
-export declare type SdPlatformRequestOrganizationPatchAny = SdPlatformRequestOrganizationPatchAdmin | SdPlatformRequestOrganizationPatchOwner | SdPlatformRequestOrganizationPatchAdministrator;
+import { SdPlatformOrganizationVisibility } from "../commons/SdPlatformVisibility";
+/**
+ * DTO for creating an organization
+ */
+export interface SdPlatformRequestOrganizationCreate {
+    name: string;
+    /**
+     * avatar image base64 encoded, maximum 1MB
+     */
+    avatar?: string;
+    visibility?: SdPlatformOrganizationVisibility;
+    allow_sharing?: boolean;
+    allow_link_sharing?: boolean;
+    allow_expose_email?: boolean;
+    website?: string;
+    description?: string;
+}
+/**
+ * DTO for patching an organization - organization administrator access level
+ */
+export interface SdPlatformRequestOrganizationPatchAdministrator {
+    visibility?: SdPlatformOrganizationVisibility;
+    allow_sharing?: boolean;
+    allow_link_sharing?: boolean;
+    allow_expose_email?: boolean;
+    website?: string;
+    description?: string;
+    accessdomains?: Array<string>;
+    force_require_token?: boolean;
+    limit_credit_consumption?: boolean;
+    /**
+     * updates the default backend system for the organization based on the given backend system alias,
+     */
+    backend_system_alias?: string;
+}
+/**
+ * DTO for patching an organization - organization owner access level
+ */
+export interface SdPlatformRequestOrganizationPatchOwner extends SdPlatformRequestOrganizationPatchAdministrator {
+    name?: string;
+    /**
+     * avatar image base64 encoded, maximum 1MB
+     */
+    avatar?: string;
+    slug?: string;
+}
+/**
+ * DTO for patching an organization - admin access level
+ */
+export interface SdPlatformRequestOrganizationPatchAdmin extends SdPlatformRequestOrganizationPatchOwner {
+    backend_system_id?: string;
+    chargebee_customer_id?: string;
+}
+/**
+ * DTO for patching an organization - admin access level
+ */
+export declare type SdPlatformRequestOrganizationPatchAny = SdPlatformRequestOrganizationPatchAdmin | SdPlatformRequestOrganizationPatchOwner | SdPlatformRequestOrganizationPatchAdministrator;
 //# sourceMappingURL=SdPlatformRequestOrganization.d.ts.map

package/dist/request/SdPlatformRequestOrganization.js

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

package/dist/request/SdPlatformRequestPolicy.d.ts

@@ -1,40 +1,40 @@
-import { SdPlatformPolicyCommonAliases, SdPlatformPolicyPermissionsType, SdPlatformPolicyRequiredFeatures, SdPlatformPolicyType } from "../commons/SdPlatformPolicyCommons";
-/**
- * DTO for creating a policy
- */
-export interface SdPlatformRequestPolicyCreate {
-    /** type of policy */
-    type: SdPlatformPolicyType;
-    /** policy alias, used to identify policy in evaluators */
-    alias: SdPlatformPolicyCommonAliases | string;
-    /** description of policy */
-    description?: string;
-    /** role required to be granted this policy */
-    required_role?: string;
-    /** granted permissions */
-    allowed_permissions?: SdPlatformPolicyPermissionsType;
-    /** explicitely denied permissions */
-    denied_permissions?: SdPlatformPolicyPermissionsType;
-    /** features required by the receiver of the policy */
-    features_receiver?: SdPlatformPolicyRequiredFeatures;
-    /** features required by the provider of the policy */
-    features_provider?: SdPlatformPolicyRequiredFeatures;
-}
-/**
- * DTO for patching a policy
- */
-export interface SdPlatformRequestPolicyPatch {
-    /** description of policy */
-    description?: string;
-    /** role required to be granted this policy */
-    required_role?: string;
-    /** granted permissions */
-    allowed_permissions?: SdPlatformPolicyPermissionsType;
-    /** explicitely denied permissions */
-    denied_permissions?: SdPlatformPolicyPermissionsType;
-    /** features required by the receiver of the policy */
-    features_receiver?: SdPlatformPolicyRequiredFeatures;
-    /** features required by the provider of the policy */
-    features_provider?: SdPlatformPolicyRequiredFeatures;
-}
+import { SdPlatformPolicyCommonAliases, SdPlatformPolicyPermissionsType, SdPlatformPolicyRequiredFeatures, SdPlatformPolicyType } from "../commons/SdPlatformPolicyCommons";
+/**
+ * DTO for creating a policy
+ */
+export interface SdPlatformRequestPolicyCreate {
+    /** type of policy */
+    type: SdPlatformPolicyType;
+    /** policy alias, used to identify policy in evaluators */
+    alias: SdPlatformPolicyCommonAliases | string;
+    /** description of policy */
+    description?: string;
+    /** role required to be granted this policy */
+    required_role?: string;
+    /** granted permissions */
+    allowed_permissions?: SdPlatformPolicyPermissionsType;
+    /** explicitely denied permissions */
+    denied_permissions?: SdPlatformPolicyPermissionsType;
+    /** features required by the receiver of the policy */
+    features_receiver?: SdPlatformPolicyRequiredFeatures;
+    /** features required by the provider of the policy */
+    features_provider?: SdPlatformPolicyRequiredFeatures;
+}
+/**
+ * DTO for patching a policy
+ */
+export interface SdPlatformRequestPolicyPatch {
+    /** description of policy */
+    description?: string;
+    /** role required to be granted this policy */
+    required_role?: string;
+    /** granted permissions */
+    allowed_permissions?: SdPlatformPolicyPermissionsType;
+    /** explicitely denied permissions */
+    denied_permissions?: SdPlatformPolicyPermissionsType;
+    /** features required by the receiver of the policy */
+    features_receiver?: SdPlatformPolicyRequiredFeatures;
+    /** features required by the provider of the policy */
+    features_provider?: SdPlatformPolicyRequiredFeatures;
+}
 //# sourceMappingURL=SdPlatformRequestPolicy.d.ts.map

package/dist/request/SdPlatformRequestPolicy.js

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

package/dist/request/SdPlatformRequestSavedState.d.ts

@@ -1,36 +1,36 @@
-import { SdPlatformSavedStateVisibility } from "../commons/SdPlatformVisibility";
-/**
- * The saved state settings.
- */
-export interface SdPlatformRequestSavedStateSettings {
-    version: string;
-    viewer_settings: any;
-}
-/**
- * DTO for creating a saved state
- */
-export interface SdPlatformRequestSavedStateCreate {
-    name: string;
-    description: string;
-    model_id: string;
-    image_id?: string;
-    parameters: {
-        [id: string]: string;
-    };
-    visibility: SdPlatformSavedStateVisibility;
-    settings?: SdPlatformRequestSavedStateSettings;
-}
-/**
- * DTO for patching a saved state
- */
-export interface SdPlatformRequestSavedStatePatch {
-    name?: string;
-    description?: string;
-    image_id?: string;
-    parameters?: {
-        [id: string]: string;
-    };
-    visibility?: SdPlatformSavedStateVisibility;
-    settings?: SdPlatformRequestSavedStateSettings;
-}
+import { SdPlatformSavedStateVisibility } from "../commons/SdPlatformVisibility";
+/**
+ * The saved state settings.
+ */
+export interface SdPlatformRequestSavedStateSettings {
+    version: string;
+    viewer_settings: any;
+}
+/**
+ * DTO for creating a saved state
+ */
+export interface SdPlatformRequestSavedStateCreate {
+    name: string;
+    description: string;
+    model_id: string;
+    image_id?: string;
+    parameters: {
+        [id: string]: string;
+    };
+    visibility: SdPlatformSavedStateVisibility;
+    settings?: SdPlatformRequestSavedStateSettings;
+}
+/**
+ * DTO for patching a saved state
+ */
+export interface SdPlatformRequestSavedStatePatch {
+    name?: string;
+    description?: string;
+    image_id?: string;
+    parameters?: {
+        [id: string]: string;
+    };
+    visibility?: SdPlatformSavedStateVisibility;
+    settings?: SdPlatformRequestSavedStateSettings;
+}
 //# sourceMappingURL=SdPlatformRequestSavedState.d.ts.map

package/dist/request/SdPlatformRequestSavedState.js

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

package/dist/request/SdPlatformRequestSavedStateSharing.d.ts

@@ -1,35 +1,35 @@
-/**
- * DTO for creating a saved state sharing relationship, which shares a policy for accessing a saved state with a receiving user.
- */
-export interface SdPlatformResponseSavedStateSharingCreate {
-    /**
-     * Id of the receiving user.
-     */
-    user_id: string;
-    /**
-     * Id of the saved state being shared.
-     */
-    saved_state_id: string;
-    /**
-     * Alias of the policy being shared.
-     */
-    policy_alias: string;
-}
-/**
- * DTO for creating a saved state sharing relationships, which shares policies for accessing a saved state with a receiving user.
- */
-export interface SdPlatformRequestSavedStateSharingCreateMultiple {
-    /**
-     * Id of the receiving user.
-     */
-    user_id: string;
-    /**
-     * Id of the saved state being shared.
-     */
-    saved_state_id: string;
-    /**
-     * Aliases of policies being shared.
-     */
-    policy_aliases: Array<string>;
-}
+/**
+ * DTO for creating a saved state sharing relationship, which shares a policy for accessing a saved state with a receiving user.
+ */
+export interface SdPlatformResponseSavedStateSharingCreate {
+    /**
+     * Id of the receiving user.
+     */
+    user_id: string;
+    /**
+     * Id of the saved state being shared.
+     */
+    saved_state_id: string;
+    /**
+     * Alias of the policy being shared.
+     */
+    policy_alias: string;
+}
+/**
+ * DTO for creating a saved state sharing relationships, which shares policies for accessing a saved state with a receiving user.
+ */
+export interface SdPlatformRequestSavedStateSharingCreateMultiple {
+    /**
+     * Id of the receiving user.
+     */
+    user_id: string;
+    /**
+     * Id of the saved state being shared.
+     */
+    saved_state_id: string;
+    /**
+     * Aliases of policies being shared.
+     */
+    policy_aliases: Array<string>;
+}
 //# sourceMappingURL=SdPlatformRequestSavedStateSharing.d.ts.map

package/dist/request/SdPlatformRequestSavedStateSharing.js

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

package/dist/request/SdPlatformRequestUser.d.ts

@@ -1,90 +1,90 @@
-import { SdPlatformOrganizationMemberRole } from "../commons/SdPlatformOrganizationCommons";
-import { SdPlatformUserVisibility } from "../commons/SdPlatformVisibility";
-/**
- * DTO for confirming a password reset request
- */
-export interface SdPlatformRequestUserPasswordResetConfirm {
-    token: string;
-    password?: string;
-    password_confirmation?: string;
-}
-/**
- * DTO for registering a new user
- */
-export interface SdPlatformRequestUserRegister {
-    email: string;
-    password: string;
-    password_confirmation: string;
-    captcha_token: string;
-}
-/**
- * DTO for patching a user
- */
-export interface SdPlatformRequestUserPatch {
-    username?: string;
-    /**
-     * avatar image base64 encoded, maximum 1MB
-     */
-    avatar?: string;
-    location?: string;
-    website?: string;
-    facebook_id?: string;
-    instagram_id?: string;
-    mcneel_id?: string;
-    linkedin_id?: string;
-    twitter_id?: string;
-    bio?: string;
-    global_accessdomains?: Array<string>;
-    newsletter_subscribed?: boolean;
-    first_name?: string;
-    last_name?: string;
-    country?: string;
-    company_name?: string;
-    using_reason?: string;
-    know_source?: string;
-    grasshopper_knowhow?: string;
-    industry?: string;
-    expose_email?: boolean;
-    old_password?: string;
-    new_password?: string;
-    new_password_confirmation?: string;
-    visibility?: SdPlatformUserVisibility;
-    allow_sharing?: boolean;
-    allow_link_sharing?: boolean;
-    slug?: string;
-    /**
-     *  updates the default backend system for the user, requires permission "update_default_backend_system"
-     */
-    backend_system_id?: string;
-    /**
-     * updates the default backend system for the user based on the given backend system alias,
-     * requires that the user has access to the backend system
-     */
-    backend_system_alias?: string;
-    force_require_token?: boolean;
-    mailing?: {
-        [id: string]: boolean;
-    };
-    limit_credit_consumption?: boolean;
-    transfers_accept_any?: boolean;
-    transfers_clear_sharing?: boolean;
-    transfers_accept_shareback?: boolean;
-}
-/**
- * DTO for patching a user - admin access level
- */
-export interface SdPlatformRequestUserPatchAdmin extends SdPlatformRequestUserPatch {
-    /** manually activate / deactivate user */
-    active?: boolean;
-    /** admin roles of the user */
-    roles?: Array<string>;
-    /** id of chargebee customer */
-    chargebee_customer_id?: string;
-    /** set this to null to un-delete */
-    deleted_at?: null;
-    /** manually assign user to an organization */
-    organization_id?: string;
-    /** role of user in organization */
-    organization_role?: SdPlatformOrganizationMemberRole;
-}
+import { SdPlatformOrganizationMemberRole } from "../commons/SdPlatformOrganizationCommons";
+import { SdPlatformUserVisibility } from "../commons/SdPlatformVisibility";
+/**
+ * DTO for confirming a password reset request
+ */
+export interface SdPlatformRequestUserPasswordResetConfirm {
+    token: string;
+    password?: string;
+    password_confirmation?: string;
+}
+/**
+ * DTO for registering a new user
+ */
+export interface SdPlatformRequestUserRegister {
+    email: string;
+    password: string;
+    password_confirmation: string;
+    captcha_token: string;
+}
+/**
+ * DTO for patching a user
+ */
+export interface SdPlatformRequestUserPatch {
+    username?: string;
+    /**
+     * avatar image base64 encoded, maximum 1MB
+     */
+    avatar?: string;
+    location?: string;
+    website?: string;
+    facebook_id?: string;
+    instagram_id?: string;
+    mcneel_id?: string;
+    linkedin_id?: string;
+    twitter_id?: string;
+    bio?: string;
+    global_accessdomains?: Array<string>;
+    newsletter_subscribed?: boolean;
+    first_name?: string;
+    last_name?: string;
+    country?: string;
+    company_name?: string;
+    using_reason?: string;
+    know_source?: string;
+    grasshopper_knowhow?: string;
+    industry?: string;
+    expose_email?: boolean;
+    old_password?: string;
+    new_password?: string;
+    new_password_confirmation?: string;
+    visibility?: SdPlatformUserVisibility;
+    allow_sharing?: boolean;
+    allow_link_sharing?: boolean;
+    slug?: string;
+    /**
+     *  updates the default backend system for the user, requires permission "update_default_backend_system"
+     */
+    backend_system_id?: string;
+    /**
+     * updates the default backend system for the user based on the given backend system alias,
+     * requires that the user has access to the backend system
+     */
+    backend_system_alias?: string;
+    force_require_token?: boolean;
+    mailing?: {
+        [id: string]: boolean;
+    };
+    limit_credit_consumption?: boolean;
+    transfers_accept_any?: boolean;
+    transfers_clear_sharing?: boolean;
+    transfers_accept_shareback?: boolean;
+}
+/**
+ * DTO for patching a user - admin access level
+ */
+export interface SdPlatformRequestUserPatchAdmin extends SdPlatformRequestUserPatch {
+    /** manually activate / deactivate user */
+    active?: boolean;
+    /** admin roles of the user */
+    roles?: Array<string>;
+    /** id of chargebee customer */
+    chargebee_customer_id?: string;
+    /** set this to null to un-delete */
+    deleted_at?: null;
+    /** manually assign user to an organization */
+    organization_id?: string;
+    /** role of user in organization */
+    organization_role?: SdPlatformOrganizationMemberRole;
+}
 //# sourceMappingURL=SdPlatformRequestUser.d.ts.map

package/dist/request/SdPlatformRequestUser.js

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

package/dist/request/SdPlatformRequestWebhook.d.ts

@@ -1,40 +1,40 @@
-import { SdPlatformNotificationLevel, SdPlatformNotificationType } from "../commons/SdPlatformNotificationCommons";
-/**
- * DTO for Chargebee webhook call
- * Please see https://apidocs.chargebee.com/docs/api/v1/events
- */
-export interface SdPlatformRequestWebhookChargebeeEvent {
-    /** event id */
-    id: string;
-    /** event type */
-    event_type: string;
-}
-/**
- * DTO for model message webhook call
- * Send a message to the owner of a model.
- */
-export interface SdPlatformRequestWebhookModelMessage {
-    /** geometry backend model id (guid) */
-    modelid: string;
-    /** subject of message */
-    subject: string;
-    /** message */
-    msg: string;
-}
-/**
- * DTO for notification webhook call
- * Create a notification related to a model.
- */
-export interface SdPlatformRequestWebhookNotification {
-    /** geometry backend model id (guid) */
-    guid: string;
-    /** description of the notification */
-    description?: string;
-    /** optional epoch timestamp until which the notification should be valid */
-    valid_until?: number;
-    /** level of notification */
-    level: SdPlatformNotificationLevel;
-    /** type of notification */
-    type: SdPlatformNotificationType;
-}
+import { SdPlatformNotificationLevel, SdPlatformNotificationType } from "../commons/SdPlatformNotificationCommons";
+/**
+ * DTO for Chargebee webhook call
+ * Please see https://apidocs.chargebee.com/docs/api/v1/events
+ */
+export interface SdPlatformRequestWebhookChargebeeEvent {
+    /** event id */
+    id: string;
+    /** event type */
+    event_type: string;
+}
+/**
+ * DTO for model message webhook call
+ * Send a message to the owner of a model.
+ */
+export interface SdPlatformRequestWebhookModelMessage {
+    /** geometry backend model id (guid) */
+    modelid: string;
+    /** subject of message */
+    subject: string;
+    /** message */
+    msg: string;
+}
+/**
+ * DTO for notification webhook call
+ * Create a notification related to a model.
+ */
+export interface SdPlatformRequestWebhookNotification {
+    /** geometry backend model id (guid) */
+    guid: string;
+    /** description of the notification */
+    description?: string;
+    /** optional epoch timestamp until which the notification should be valid */
+    valid_until?: number;
+    /** level of notification */
+    level: SdPlatformNotificationLevel;
+    /** type of notification */
+    type: SdPlatformNotificationType;
+}
 //# sourceMappingURL=SdPlatformRequestWebhook.d.ts.map

package/dist/request/SdPlatformRequestWebhook.js

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