import { SdPlatformModelFileType } from "../commons/SdPlatformModelCommons"; import { SdPlatformModelVisibility } from "../commons/SdPlatformVisibility"; export declare enum SdPlatformRequestModelStatus { /** The model has been configured and shall be published. */ Done = "done", /** An error happened uploading the model. */ ErrorUpload = "error_upload" } export interface SdPlatformRequestModelSettings { parameters_commit?: boolean; parameters_disable?: boolean; hide_data_outputs?: boolean; hide_data_outputs_iframe?: boolean; hide_exports?: boolean; hide_exports_iframe?: boolean; hide_saved_states?: boolean; hide_saved_states_iframe?: boolean; hide_attribute_visualization?: boolean; hide_attribute_visualization_iframe?: boolean; hide_desktop_clients?: boolean; hide_json_menu?: boolean; hide_json_menu_iframe?: boolean; } /** * Organization-specific model settings. */ export interface SdPlatformRequestModelOrganizationSettings { /** Organization-specific confirmation flag, can be used by organization-specific App Builder implementations */ confirmed?: boolean; } /** * DTO for patching a model */ export interface SdPlatformRequestModelPatch { /** Title of the model. Min 5 characters, max 50 characters. */ title?: string; /** Filename of the model. */ filename?: string; /** Description of the model */ description?: string; /** Comment on the model. */ comment?: string; /** Tags of the model. */ tags?: Array; /** List of decoration image ids to attach to the model. */ decoration?: Array; /** List of host names (optionally including port) to set as allowed domains for embedding. */ accessdomains?: Array; /** Set to true if the per-account access domains shall be used. */ use_global_accessdomains?: boolean; /** Set to true to allow backend access. */ backendaccess?: boolean; /** Allowed values for patching: done, error_upload */ status?: SdPlatformRequestModelStatus; /** Nominal visibility of the model. */ visibility?: SdPlatformModelVisibility; /** Should link sharing be enabled? If so, link_sharing_slug will be created for the model. */ link_sharing?: boolean; /** URL-compatible short name of the model, minimum 5 characters. Used for links to the model on the ShapeDiver Platform. */ slug?: string; /** Set to true if accessing this model on the geometry backend should require an access token (JWT) to be present in addition to a ticket. */ require_token?: boolean; /** Should model allow to be used as part of webhook? */ allow_webhook?: boolean; /** Settings of the model. */ settings?: SdPlatformRequestModelSettings; /** Organization settings of the model. */ organization_settings?: SdPlatformRequestModelOrganizationSettings; /** Allow direct embedding */ allow_direct_embedding?: boolean; } /** * DTO for patching a model - admin access level */ export interface SdPlatformRequestModelPatchAdmin extends SdPlatformRequestModelPatch { /** * Update the model owner without a transfer request. */ user_id?: string; /** * The id of a backend system that model should belong to. */ backend_system_id?: string; /** * Is this a featured model? */ featured?: boolean; deleted_at?: null; } /** * DTO for creating a model. */ export interface SdPlatformRequestModelCreate { /** * Title of the model. Min 5 characters, max 50 characters. Either title or {@link SdPlatformRequestModelCreate.filename} needs to be specified. */ title?: string; /** * Filename of the model. Either {@link SdPlatformRequestModelCreate.title} or needs to be specified. */ filename?: string; /** * File type of the model. */ ftype?: SdPlatformModelFileType; /** * Description of the model. */ description?: string; /** Comment on the model. */ comment?: string; /** * Tags of the model. */ tags?: Array; /** * Accessdomains to allow embedding from. */ accessdomains?: Array; /** * Set to true if the per-account access domains shall be used. */ use_global_accessdomains?: boolean; /** * Set to true to allow backend access. */ backendaccess?: boolean; /** * Nominal visibility of the model */ visibility?: SdPlatformModelVisibility; /** * Should token be required. */ require_token?: boolean; /** * The previous model id */ prev_id?: string; /** * Alias of the geometry backend system on which to create the model. * When omitted, the user's default backend system is used. * Requires that the user has access to the backend system. */ backend_system_alias?: string; } /** * DTO for swapping slugs between two models. */ export interface SdPlatformRequestModelSwapSlug { /** UUID, GUID or slug of model B. */ other: string; /** Optional new slug to use for model B. */ other_slug?: string; } //# sourceMappingURL=SdPlatformRequestModel.d.ts.map