import { NonNullablePaths } from '@wix/sdk-types'; /** * A package is group of instances of Wix services that a reseller offers to a * customer as part of a single transaction. */ interface EmptyEntity { } interface PublishSiteRequest { } interface PublishSiteResponse { } interface DeployStandalonePagesRequest { } interface DeployStandalonePagesResponse { } interface DuplicateSiteRequest { /** * ID of the site to duplicated. * @format GUID */ sourceSiteId: string; /** * Display name for the new site. * @minLength 1 * @maxLength 40 */ siteDisplayName: string; } interface DuplicateSiteResponse { /** * ID of the new site. * @format GUID */ newSiteId?: string; } interface BulkDeleteSiteRequest { /** * Site IDs. * * Min: 1 site ID
* Max: 20 site IDs * @format GUID * @minSize 1 * @maxSize 20 */ ids: string[]; } interface BulkDeleteSiteResponse { /** List of deletion results. */ results?: BulkSiteResult[]; /** Summary of deletion data. */ bulkActionMetadata?: BulkActionMetadata; } interface BulkSiteResult { /** Result of deletion request per site describing the success or failure of each deletion. */ itemMetadata?: ItemMetadata; } interface ItemMetadata { /** Site ID. */ _id?: string | null; /** Index of the site in the request array. Allows for correlation between request and response. */ originalIndex?: number; /** Whether the requested action was successful for the site. When `false`, the action failed and an `error` object is populated. */ success?: boolean; /** Details about the error. */ error?: ApplicationError; } interface ApplicationError { /** Error code. */ code?: string; /** Description of error. */ description?: string; } interface BulkActionMetadata { /** Number of sites that were deleted successfully. */ totalSuccesses?: number; /** Number of sites that were not deleted successfully. */ totalFailures?: number; } interface RenameSiteRequest { /** * @minLength 1 * @maxLength 40 */ siteNewName?: string; } interface RenameSiteResponse { } interface ValidateSiteNameRequest { /** * @minLength 1 * @maxLength 40 */ siteName?: string; } interface ValidateSiteNameResponse { /** Indicates whether the site name is valid. */ valid?: boolean; } interface UnpublishSiteRequest { } interface UnpublishSiteResponse { } interface MoveSiteToTrashRequest { } interface MoveSiteToTrashResponse { } interface RestoreSiteFromTrashRequest { /** @format GUID */ siteId?: string; } interface RestoreSiteFromTrashResponse { } interface DeleteSiteFromTrashRequest { /** @format GUID */ siteId?: string; } interface DeleteSiteFromTrashResponse { } interface CreateAndAttachChildRequest { /** @format GUID */ templateId?: string; /** * @minLength 1 * @maxLength 40 */ name?: string; } interface CreateAndAttachChildResponse { /** @format GUID */ childMetaSiteId?: string; } /** @docsIgnore */ type PublishSiteApplicationErrors = { code?: 'SITE_IS_NOT_DEFINED_AS_PUBLISHABLE'; description?: string; data?: Record; }; /** @docsIgnore */ type DeployStandalonePagesApplicationErrors = { code?: 'SITE_IS_NOT_HEADLESS'; description?: string; data?: Record; }; /** * Publishes a site. * * Publishing a site makes any changes previously saved on the site available on the internet. * After publishing, changes to your site appear in the [site's history](https://support.wix.com/en/article/viewing-and-managing-your-site-history). * * When using an API key for authentication, include a `wix-site-id` header with the ID of the site you want to publish. * @public * @permissionId METASITE.UPDATE * @applicableIdentity APP * @fqn wix.site.v1.SitePublisher.PublishSite */ declare function publishSite(): Promise; /** * Publishes a headless site. * * Publishing only the headless pages of the site. * * When using an API key for authentication, include a `wix-site-id` header with the ID of the site you want to publish. * @public * @permissionId METASITE.UPDATE * @applicableIdentity APP * @fqn wix.site.v1.SitePublisher.DeployStandalonePages */ declare function deployStandalonePages(): Promise; /** * Duplicates a site with a new site name. * * > **Note:** When you duplicate a site, some business-related content such as store orders, contacts, invoices, and 3rd-party app settings are not be included. * > The duplicated site won’t have a domain or any Premium capabilities. * * Any installed apps that can be used only on sites with a Premium Plan, will be copied to the duplicated site and * will appear unactivated. Once the site is upgraded, the app will be available for use. * * > **Important:** This call requires an account level API key. * @param sourceSiteId - ID of the site to duplicated. * @public * @requiredField options * @requiredField options.siteDisplayName * @requiredField sourceSiteId * @permissionId my-account.duplicate-site * @fqn com.wix.site.actions.SiteActionsService.DuplicateSite */ declare function duplicateSite(sourceSiteId: string, options: NonNullablePaths): Promise>; interface DuplicateSiteOptions { /** * Display name for the new site. * @minLength 1 * @maxLength 40 */ siteDisplayName: string; } /** * This endpoint enables you to delete multiple sites. * * This is not a permanent delete. Sites are moved to the trash bin and can be restored through site collaborators. * * Learn more about [deleting multiple sites](https://support.wix.com/en/article/moving-a-site-to-trash). * * > **Important:** This call requires an account level API key. * @param ids - Site IDs. * * Min: 1 site ID
* Max: 20 site IDs * @public * @requiredField ids * @permissionId my-account.delete-site * @fqn com.wix.site.actions.SiteActionsService.BulkDeleteSite */ declare function bulkDeleteSite(ids: string[]): Promise>; export { type ApplicationError, type BulkActionMetadata, type BulkDeleteSiteRequest, type BulkDeleteSiteResponse, type BulkSiteResult, type CreateAndAttachChildRequest, type CreateAndAttachChildResponse, type DeleteSiteFromTrashRequest, type DeleteSiteFromTrashResponse, type DeployStandalonePagesApplicationErrors, type DeployStandalonePagesRequest, type DeployStandalonePagesResponse, type DuplicateSiteOptions, type DuplicateSiteRequest, type DuplicateSiteResponse, type EmptyEntity, type ItemMetadata, type MoveSiteToTrashRequest, type MoveSiteToTrashResponse, type PublishSiteApplicationErrors, type PublishSiteRequest, type PublishSiteResponse, type RenameSiteRequest, type RenameSiteResponse, type RestoreSiteFromTrashRequest, type RestoreSiteFromTrashResponse, type UnpublishSiteRequest, type UnpublishSiteResponse, type ValidateSiteNameRequest, type ValidateSiteNameResponse, bulkDeleteSite, deployStandalonePages, duplicateSite, publishSite };