import { NonNullablePaths } from '@wix/sdk-types';

/** Deployment is the main entity of Deployments. */
interface Deployment extends DeploymentDescriptionOneOf, DeploymentCreationPublishTypeOneOf {
    /** Deployment description */
    editorRevision?: EditorRevision;
    /** No publish */
    noPublish?: CreationPublishTypeNone;
    /** Publish Site */
    sitePublish?: CreationPublishTypeSite;
    /** Publish Site's RC */
    rcPublish?: CreationPublishTypeRC;
    /**
     * Deployment ID
     * @format GUID
     */
    _id?: string;
    /** Deployment type */
    deploymentType?: DeploymentTypeWithLiterals;
    /**
     * The label of the deployment.
     * @maxLength 250
     */
    label?: string | null;
    /**
     * Represents the time this Deployment was last modified
     * @readonly
     */
    _updatedDate?: Date | null;
    /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision */
    revision?: string | null;
    /**
     * All pipelines that implement DeploymentPipelineProvider interface
     * @maxSize 30
     */
    pipelines?: PipelineResult[];
    /** The pipelines status of the deployment */
    deploymentPipelinesStatus?: DeploymentPipelinesStatusWithLiterals;
    /**
     * Represents the time this Deployment was created
     * @readonly
     */
    _createdDate?: Date | null;
    /** The editor session that created the deployment */
    editorSession?: EditorSession;
    /** Data Extensions */
    extendedFields?: ExtendedFields;
}
/** @oneof */
interface DeploymentDescriptionOneOf {
    /** Deployment description */
    editorRevision?: EditorRevision;
}
/** @oneof */
interface DeploymentCreationPublishTypeOneOf {
    /** No publish */
    noPublish?: CreationPublishTypeNone;
    /** Publish Site */
    sitePublish?: CreationPublishTypeSite;
    /** Publish Site's RC */
    rcPublish?: CreationPublishTypeRC;
}
declare enum DeploymentType {
    UNKNOWN = "UNKNOWN",
    EDITOR_REVISION = "EDITOR_REVISION"
}
/** @enumType */
type DeploymentTypeWithLiterals = DeploymentType | 'UNKNOWN' | 'EDITOR_REVISION';
interface EditorRevision {
    /**
     * Branch's Id
     * @format GUID
     */
    branchId?: string | null;
    /** Revision's Id */
    siteRevision?: string;
}
interface PipelineResult {
    /**
     * The deployment pipeline implementer id as appears in the SPI Config
     * @format GUID
     */
    deploymentPipelineId?: string;
    /** Pipeline status */
    pipelineStatus?: PipelineStatusWithLiterals;
    /**
     * The deployment pipeline task results
     * @maxSize 20
     */
    tasksResults?: TaskResult[];
}
declare enum PipelineStatus {
    UNDEFINED = "UNDEFINED",
    IN_PROGRESS = "IN_PROGRESS",
    SUCCESS = "SUCCESS",
    ERROR = "ERROR",
    INVOKE_ERROR = "INVOKE_ERROR",
    TIMEOUT = "TIMEOUT",
    SKIPPED = "SKIPPED"
}
/** @enumType */
type PipelineStatusWithLiterals = PipelineStatus | 'UNDEFINED' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR' | 'INVOKE_ERROR' | 'TIMEOUT' | 'SKIPPED';
interface TaskResult {
    /**
     * Name of the task for internal references. For example: "user code bundling".
     * @minLength 1
     * @maxLength 250
     */
    taskName?: string;
    /** The execution status of the pipeline for the given deployment creation process */
    status?: TaskStatusWithLiterals;
}
declare enum TaskStatus {
    UNDEFINED = "UNDEFINED",
    SUCCESS = "SUCCESS",
    ERROR = "ERROR",
    RUNNING = "RUNNING",
    ABORTED = "ABORTED"
}
/** @enumType */
type TaskStatusWithLiterals = TaskStatus | 'UNDEFINED' | 'SUCCESS' | 'ERROR' | 'RUNNING' | 'ABORTED';
declare enum DeploymentPipelinesStatus {
    UNDEFINED = "UNDEFINED",
    /** No pipelines are defined for this deployment */
    NONE = "NONE",
    /** Pipelines are invoked and in progress */
    IN_PROGRESS = "IN_PROGRESS",
    /** Pipelines completed successfully */
    SUCCESS = "SUCCESS",
    /** Pipelines completed with errors */
    ERROR = "ERROR"
}
/** @enumType */
type DeploymentPipelinesStatusWithLiterals = DeploymentPipelinesStatus | 'UNDEFINED' | 'NONE' | 'IN_PROGRESS' | 'SUCCESS' | 'ERROR';
interface EditorSession {
    /**
     * Editor Session Id
     * @format GUID
     */
    esi?: string | null;
    /**
     * Document services Origin
     * @maxLength 50
     */
    dsOrigin?: string | null;
}
interface ExtendedFields {
    /**
     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
     * The value of each key is structured according to the schema defined when the extended fields were configured.
     *
     * You can only access fields for which you have the appropriate permissions.
     *
     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
     */
    namespaces?: Record<string, Record<string, any>>;
}
interface CreationPublishTypeNone {
}
interface CreationPublishTypeSite {
}
interface CreationPublishTypeRC {
    /** The RC label provided on the deployment creation */
    rcLabel?: RCLabelWithLiterals;
    /** If true, during publishing the RC there will be a validation that there is at most 1 RC with the same label for this site's branch, and if such RC exists it will replace it with the new RC. */
    useUniqueLabel?: boolean;
    /**
     * number of minutes the RC will be published
     * @max 129600
     * @min 1
     */
    ttlMinutes?: number | null;
}
declare enum RCLabel {
    /** Illegal default value, exception will be thrown if used */
    UNKNOWN = "UNKNOWN",
    RELEASE_MANAGER = "RELEASE_MANAGER",
    BLOCKS = "BLOCKS",
    WIX_CLI = "WIX_CLI",
    MOBILE_APP_BUILDER = "MOBILE_APP_BUILDER",
    SEO = "SEO",
    FEEDBACK = "FEEDBACK",
    ACCESSIBILITY = "ACCESSIBILITY",
    ENTERPRISE_APPROVALS = "ENTERPRISE_APPROVALS"
}
/** @enumType */
type RCLabelWithLiterals = RCLabel | 'UNKNOWN' | 'RELEASE_MANAGER' | 'BLOCKS' | 'WIX_CLI' | 'MOBILE_APP_BUILDER' | 'SEO' | 'FEEDBACK' | 'ACCESSIBILITY' | 'ENTERPRISE_APPROVALS';
interface DeploymentPipelineUpdatedMessage {
    /**
     * The deployment id
     * @format GUID
     */
    deploymentId?: string;
}
interface CreateDeploymentRequest extends CreateDeploymentRequestBasedOnOneOf, CreateDeploymentRequestPublishMethodOneOf {
    /** Based on a specific Editor Revision. */
    specificVersion?: EditorRevision;
    /** Based on the latest state of a branch. */
    latestFromBranch?: LatestFromBranch;
    /** Publish RC */
    publishSiteRcMethod?: PublishSiteRCMethod;
    /**
     * Deployment's label.
     * @maxLength 250
     */
    label?: string;
    /**
     * Deployments attributes.
     * @maxSize 1
     */
    deploymentAttributes?: DeploymentAttribute[];
    /** Supporting publish on the creation flow. Please specify the publish type and leave empty in case you don't want to publish */
    publishType?: PublishTypeWithLiterals;
    /** Session info */
    sessionInfo?: SessionInfo;
}
/** @oneof */
interface CreateDeploymentRequestBasedOnOneOf {
    /** Based on a specific Editor Revision. */
    specificVersion?: EditorRevision;
    /** Based on the latest state of a branch. */
    latestFromBranch?: LatestFromBranch;
}
/** @oneof */
interface CreateDeploymentRequestPublishMethodOneOf {
    /** Publish RC */
    publishSiteRcMethod?: PublishSiteRCMethod;
}
interface DeploymentAttribute extends DeploymentAttributeAttributeOneOf {
    /** GridAppId attribute. */
    gridAppIdAttribute?: GridAppIdAttribute;
}
/** @oneof */
interface DeploymentAttributeAttributeOneOf {
    /** GridAppId attribute. */
    gridAppIdAttribute?: GridAppIdAttribute;
}
interface GridAppIdAttribute {
    /**
     * The gridAppId attribute would like to override/append.
     * @maxLength 100
     */
    gridAppId?: string;
}
declare enum PublishType {
    /** No publish */
    NONE = "NONE",
    /** Publish Site */
    SITE = "SITE",
    /** Publish Site's RC - Notice that PublishSiteRCMethod should be provided as well. */
    RC = "RC"
}
/** @enumType */
type PublishTypeWithLiterals = PublishType | 'NONE' | 'SITE' | 'RC';
interface SessionInfo {
    /**
     * Editor session id
     * @format GUID
     */
    esi?: string | null;
    /**
     * Ds origin
     * @maxLength 50
     */
    dsOrigin?: string | null;
}
interface LatestFromBranch {
    /**
     * Branch to get the latest state from.
     * @format GUID
     */
    branchId?: string | null;
}
interface PublishSiteRCMethod {
    /** The label of this RC */
    rcLabel?: RCLabelWithLiterals;
    /** If true, during publishing the RC there will be a validation that there is at most 1 RC with the same label for this site's branch, and if such RC exists it will replace it with the new RC. */
    useUniqueLabel?: boolean;
    /**
     * number of minutes the RC will be published
     * @max 129600
     * @min 1
     */
    ttlMinutes?: number | null;
}
interface CreateDeploymentResponse {
    /** The created Deployment */
    deployment?: Deployment;
}
interface GetDeploymentRequest {
    /**
     * Id of the Deployment to retrieve
     * @format GUID
     */
    deploymentId: string;
}
interface GetDeploymentResponse {
    /** The retrieved Deployment */
    deployment?: Deployment;
}
interface PublishDeploymentRequest {
    /**
     * Id of the Deployment to publish
     * @format GUID
     */
    deploymentId: string;
    /** If provided - will publish even if deployment's pipeline is not successfully completed */
    skipPipelineCheck?: boolean | null;
}
interface PublishDeploymentResponse {
    /** The published Deployment */
    deployment?: Deployment;
}
interface PublishRCDeploymentRequest {
    /**
     * Id of the Deployment to publish
     * @format GUID
     */
    deploymentId: string;
    /** The label of this RC */
    rcLabel?: RCLabelWithLiterals;
    /** If provided - will publish even if deployment's pipeline is not successfully completed */
    skipPipelineCheck?: boolean | null;
    /** If true, during publishing the RC there will be a validation that there is at most 1 RC with the same label for this site's branch, and if such RC exists it will replace it with the new RC. */
    useUniqueLabel?: boolean;
    /**
     * number of minutes the RC will be published
     * @max 129600
     * @min 1
     */
    ttlMinutes?: number | null;
}
interface PublishRCDeploymentResponse {
    /** The published Deployment */
    deployment?: Deployment;
}
interface ListDeploymentsRequest {
}
interface ListDeploymentsResponse {
    /** The retrieved Deployments */
    deployments?: Deployment[];
}
interface QueryDeploymentsRequest {
    /** Cursor query message. */
    query: CursorQuery;
}
interface CursorQuery extends CursorQueryPagingMethodOneOf {
    /**
     * Cursor paging options.
     *
     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
     */
    cursorPaging?: CursorPaging;
    /**
     * Filter object.
     *
     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
     */
    filter?: Record<string, any> | null;
    /**
     * Sort object.
     *
     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
     * @maxSize 5
     */
    sort?: Sorting[];
}
/** @oneof */
interface CursorQueryPagingMethodOneOf {
    /**
     * Cursor paging options.
     *
     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
     */
    cursorPaging?: CursorPaging;
}
interface Sorting {
    /**
     * Name of the field to sort by.
     * @maxLength 512
     */
    fieldName?: string;
    /** Sort order. */
    order?: SortOrderWithLiterals;
}
declare enum SortOrder {
    ASC = "ASC",
    DESC = "DESC"
}
/** @enumType */
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
interface CursorPaging {
    /**
     * Maximum number of items to return in the results.
     * @max 100
     */
    limit?: number | null;
    /**
     * Pointer to the next or previous page in the list of results.
     *
     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
     * Not relevant for the first request.
     * @maxLength 16000
     */
    cursor?: string | null;
}
interface QueryDeploymentsResponse {
    /** Results from query. */
    deployments?: Deployment[];
    /** Paging metadata */
    pagingMetadata?: CursorPagingMetadata;
}
interface CursorPagingMetadata {
    /** Number of items returned in current page. */
    count?: number | null;
    /** Cursor strings that point to the next page, previous page, or both. */
    cursors?: Cursors;
    /**
     * Whether there are more pages to retrieve following the current page.
     *
     * + `true`: Another page of results can be retrieved.
     * + `false`: This is the last page.
     */
    hasNext?: boolean | null;
}
interface Cursors {
    /**
     * Cursor string pointing to the next page in the list of results.
     * @maxLength 16000
     */
    next?: string | null;
    /**
     * Cursor pointing to the previous page in the list of results.
     * @maxLength 16000
     */
    prev?: string | null;
}
interface ReportDeploymentPipelineResultRequest {
    /**
     * The deployment creation process id, should match the id that was passed in the invoke() call by the SPI Host
     * @format GUID
     */
    deploymentId: string;
    /**
     * The deployment pipeline implementer id as appears in the SPI Config
     * @format GUID
     */
    deploymentPipelineId: string;
    /**
     * The deployment pipeline task results
     * @maxSize 20
     */
    tasksResults?: TaskResult[];
}
interface ReportDeploymentPipelineResultResponse {
}
interface GetDeploymentPipelineDescriptionRequest {
    /**
     * The deployment id
     * @format GUID
     */
    deploymentId: string;
    /**
     * The deployment pipelines implementers ids as appears in the SPI Config to be called for getting descriptions.
     * @format GUID
     * @minSize 1
     * @maxSize 30
     */
    deploymentPipelinesIds: string[];
}
interface GetDeploymentPipelineDescriptionResponse {
    /**
     * Full description on the tasks each provider done on the specific deployment_id (description per task).
     * @minSize 30
     */
    pipelinesDescription?: PipelineDescription[];
}
interface PipelineDescription {
    /**
     * The deployment pipeline id (spi implementers).
     * @format GUID
     */
    deploymentPipelineId?: string;
    /**
     * description per task
     * @maxSize 20
     */
    tasksDescriptions?: TaskDescription[];
}
interface TaskDescription {
    /**
     * Name of the task for internal references. For example: "user code bundling".
     * @minLength 1
     * @maxLength 250
     */
    taskName?: string;
    /**
     * Description about the tasks results.
     * @maxLength 10000
     */
    description?: string | null;
    /** Task status */
    status?: TaskStatusWithLiterals;
}
interface Empty {
}
interface UpdateExtendedFieldsRequest {
    /** ID of the entity to update. */
    _id: string;
    /** Identifier for the app whose extended fields are being updated. */
    namespace: string;
    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
    namespaceData: Record<string, any> | null;
}
interface UpdateExtendedFieldsResponse {
    /** Updated Deployment. */
    deployment?: Deployment;
}
interface DomainEvent extends DomainEventBodyOneOf {
    createdEvent?: EntityCreatedEvent;
    updatedEvent?: EntityUpdatedEvent;
    deletedEvent?: EntityDeletedEvent;
    actionEvent?: ActionEvent;
    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
    _id?: string;
    /**
     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
     */
    entityFqdn?: string;
    /**
     * Event action name, placed at the top level to make it easier for users to dispatch messages.
     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
     */
    slug?: string;
    /** ID of the entity associated with the event. */
    entityId?: string;
    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
    eventTime?: Date | null;
    /**
     * Whether the event was triggered as a result of a privacy regulation application
     * (for example, GDPR).
     */
    triggeredByAnonymizeRequest?: boolean | null;
    /** If present, indicates the action that triggered the event. */
    originatedFrom?: string | null;
    /**
     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
     */
    entityEventSequence?: string | null;
}
/** @oneof */
interface DomainEventBodyOneOf {
    createdEvent?: EntityCreatedEvent;
    updatedEvent?: EntityUpdatedEvent;
    deletedEvent?: EntityDeletedEvent;
    actionEvent?: ActionEvent;
}
interface EntityCreatedEvent {
    entity?: string;
}
interface RestoreInfo {
    deletedDate?: Date | null;
}
interface EntityUpdatedEvent {
    /**
     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
     */
    currentEntity?: string;
}
interface EntityDeletedEvent {
    /** Entity that was deleted. */
    deletedEntity?: string | null;
}
interface ActionEvent {
    body?: string;
}
interface MessageEnvelope {
    /**
     * App instance ID.
     * @format GUID
     */
    instanceId?: string | null;
    /**
     * Event type.
     * @maxLength 150
     */
    eventType?: string;
    /** The identification type and identity data. */
    identity?: IdentificationData;
    /** Stringify payload. */
    data?: string;
}
interface IdentificationData extends IdentificationDataIdOneOf {
    /**
     * ID of a site visitor that has not logged in to the site.
     * @format GUID
     */
    anonymousVisitorId?: string;
    /**
     * ID of a site visitor that has logged in to the site.
     * @format GUID
     */
    memberId?: string;
    /**
     * ID of a Wix user (site owner, contributor, etc.).
     * @format GUID
     */
    wixUserId?: string;
    /**
     * ID of an app.
     * @format GUID
     */
    appId?: string;
    /** @readonly */
    identityType?: WebhookIdentityTypeWithLiterals;
}
/** @oneof */
interface IdentificationDataIdOneOf {
    /**
     * ID of a site visitor that has not logged in to the site.
     * @format GUID
     */
    anonymousVisitorId?: string;
    /**
     * ID of a site visitor that has logged in to the site.
     * @format GUID
     */
    memberId?: string;
    /**
     * ID of a Wix user (site owner, contributor, etc.).
     * @format GUID
     */
    wixUserId?: string;
    /**
     * ID of an app.
     * @format GUID
     */
    appId?: string;
}
declare enum WebhookIdentityType {
    UNKNOWN = "UNKNOWN",
    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
    MEMBER = "MEMBER",
    WIX_USER = "WIX_USER",
    APP = "APP"
}
/** @enumType */
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
/** @docsIgnore */
type CreateDeploymentApplicationErrors = {
    code?: 'UNSUPPORTED_EDITOR';
    description?: string;
    data?: Record<string, any>;
};
/** @docsIgnore */
type PublishDeploymentApplicationErrors = {
    code?: 'PUBLISH_NOT_ALLOWED';
    description?: string;
    data?: Record<string, any>;
};
/** @docsIgnore */
type PublishRcDeploymentApplicationErrors = {
    code?: 'PUBLISH_NOT_ALLOWED';
    description?: string;
    data?: Record<string, any>;
};
/** @docsIgnore */
type ReportDeploymentPipelineResultApplicationErrors = {
    code?: 'NO_PIPELINE_IN_PROGRESS';
    description?: string;
    data?: Record<string, any>;
};
/** @docsIgnore */
type GetDeploymentPipelineDescriptionApplicationErrors = {
    code?: 'PIPELINE_NOT_COMPLETED';
    description?: string;
    data?: Record<string, any>;
};
/**
 * Creates a new Deployment
 * @public
 * @documentationMaturity preview
 * @requiredField options.basedOn
 * @permissionId EDITOR.DEPLOYMENT_CREATE
 * @returns The created Deployment
 * @fqn wix.editor.deployments.v1.DeploymentsService.CreateDeployment
 */
declare function createDeployment(options?: CreateDeploymentOptions): Promise<NonNullablePaths<Deployment, `editorRevision.siteRevision` | `rcPublish.rcLabel` | `rcPublish.useUniqueLabel` | `_id` | `deploymentType` | `pipelines` | `pipelines.${number}.deploymentPipelineId` | `pipelines.${number}.pipelineStatus` | `deploymentPipelinesStatus`, 4> & {
    __applicationErrorsType?: CreateDeploymentApplicationErrors;
}>;
interface CreateDeploymentOptions extends CreateDeploymentOptionsBasedOnOneOf, CreateDeploymentOptionsPublishMethodOneOf {
    /**
     * Deployment's label.
     * @maxLength 250
     */
    label?: string;
    /**
     * Deployments attributes.
     * @maxSize 1
     */
    deploymentAttributes?: DeploymentAttribute[];
    /** Supporting publish on the creation flow. Please specify the publish type and leave empty in case you don't want to publish */
    publishType?: PublishTypeWithLiterals;
    /** Session info */
    sessionInfo?: SessionInfo;
    /** Based on a specific Editor Revision. */
    specificVersion?: EditorRevision;
    /** Based on the latest state of a branch. */
    latestFromBranch?: LatestFromBranch;
    /** Publish RC */
    publishSiteRcMethod?: PublishSiteRCMethod;
}
/** @oneof */
interface CreateDeploymentOptionsBasedOnOneOf {
    /** Based on a specific Editor Revision. */
    specificVersion?: EditorRevision;
    /** Based on the latest state of a branch. */
    latestFromBranch?: LatestFromBranch;
}
/** @oneof */
interface CreateDeploymentOptionsPublishMethodOneOf {
    /** Publish RC */
    publishSiteRcMethod?: PublishSiteRCMethod;
}
/**
 * Get a Deployment by id
 * @param deploymentId - Id of the Deployment to retrieve
 * @public
 * @documentationMaturity preview
 * @requiredField deploymentId
 * @permissionId EDITOR.DEPLOYMENT_READ
 * @returns The retrieved Deployment
 * @fqn wix.editor.deployments.v1.DeploymentsService.GetDeployment
 */
declare function getDeployment(deploymentId: string): Promise<NonNullablePaths<Deployment, `editorRevision.siteRevision` | `rcPublish.rcLabel` | `rcPublish.useUniqueLabel` | `_id` | `deploymentType` | `pipelines` | `pipelines.${number}.deploymentPipelineId` | `pipelines.${number}.pipelineStatus` | `deploymentPipelinesStatus`, 4>>;
/**
 * Publish a Deployment
 * @param deploymentId - Id of the Deployment to publish
 * @public
 * @documentationMaturity preview
 * @requiredField deploymentId
 * @permissionId EDITOR.DEPLOYMENT_PUBLISH
 * @fqn wix.editor.deployments.v1.DeploymentsService.PublishDeployment
 */
declare function publishDeployment(deploymentId: string, options?: PublishDeploymentOptions): Promise<NonNullablePaths<PublishDeploymentResponse, `deployment.editorRevision.siteRevision` | `deployment.rcPublish.rcLabel` | `deployment.rcPublish.useUniqueLabel` | `deployment._id` | `deployment.deploymentType` | `deployment.pipelines` | `deployment.pipelines.${number}.deploymentPipelineId` | `deployment.pipelines.${number}.pipelineStatus` | `deployment.deploymentPipelinesStatus`, 5> & {
    __applicationErrorsType?: PublishDeploymentApplicationErrors;
}>;
interface PublishDeploymentOptions {
    /** If provided - will publish even if deployment's pipeline is not successfully completed */
    skipPipelineCheck?: boolean | null;
}
/**
 * Publish an RC Deployment
 * @param deploymentId - Id of the Deployment to publish
 * @public
 * @documentationMaturity preview
 * @requiredField deploymentId
 * @permissionId EDITOR.DEPLOYMENT_PUBLISH
 * @fqn wix.editor.deployments.v1.DeploymentsService.PublishRCDeployment
 */
declare function publishRcDeployment(deploymentId: string, options?: PublishRcDeploymentOptions): Promise<NonNullablePaths<PublishRCDeploymentResponse, `deployment.editorRevision.siteRevision` | `deployment.rcPublish.rcLabel` | `deployment.rcPublish.useUniqueLabel` | `deployment._id` | `deployment.deploymentType` | `deployment.pipelines` | `deployment.pipelines.${number}.deploymentPipelineId` | `deployment.pipelines.${number}.pipelineStatus` | `deployment.deploymentPipelinesStatus`, 5> & {
    __applicationErrorsType?: PublishRcDeploymentApplicationErrors;
}>;
interface PublishRcDeploymentOptions {
    /** The label of this RC */
    rcLabel?: RCLabelWithLiterals;
    /** If provided - will publish even if deployment's pipeline is not successfully completed */
    skipPipelineCheck?: boolean | null;
    /** If true, during publishing the RC there will be a validation that there is at most 1 RC with the same label for this site's branch, and if such RC exists it will replace it with the new RC. */
    useUniqueLabel?: boolean;
    /**
     * number of minutes the RC will be published
     * @max 129600
     * @min 1
     */
    ttlMinutes?: number | null;
}
/**
 * List Deployments
 * @public
 * @documentationMaturity preview
 * @permissionId EDITOR.DEPLOYMENT_READ
 * @fqn wix.editor.deployments.v1.DeploymentsService.ListDeployments
 */
declare function listDeployments(): Promise<NonNullablePaths<ListDeploymentsResponse, `deployments` | `deployments.${number}.editorRevision.siteRevision` | `deployments.${number}.rcPublish.rcLabel` | `deployments.${number}.rcPublish.useUniqueLabel` | `deployments.${number}._id` | `deployments.${number}.deploymentType` | `deployments.${number}.deploymentPipelinesStatus`, 5>>;
/**
 * Query Deployments
 * @public
 * @documentationMaturity preview
 * @permissionId EDITOR.DEPLOYMENT_READ
 * @fqn wix.editor.deployments.v1.DeploymentsService.QueryDeployments
 */
declare function queryDeployments(): DeploymentsQueryBuilder;
interface QueryCursorResult {
    cursors: Cursors;
    hasNext: () => boolean;
    hasPrev: () => boolean;
    length: number;
    pageSize: number;
}
interface DeploymentsQueryResult extends QueryCursorResult {
    items: Deployment[];
    query: DeploymentsQueryBuilder;
    next: () => Promise<DeploymentsQueryResult>;
    prev: () => Promise<DeploymentsQueryResult>;
}
interface DeploymentsQueryBuilder {
    /** @param propertyName - Property whose value is compared with `value`.
     * @param value - Value to compare against.
     * @documentationMaturity preview
     */
    eq: (propertyName: 'deploymentType' | 'label' | '_updatedDate' | 'pipelines.deploymentPipelineId' | 'pipelines.pipelineStatus' | 'pipelines.tasksResults.taskName' | 'pipelines.tasksResults.status' | 'deploymentPipelinesStatus' | '_createdDate', value: any) => DeploymentsQueryBuilder;
    /** @param propertyName - Property whose value is compared with `value`.
     * @param value - Value to compare against.
     * @documentationMaturity preview
     */
    ne: (propertyName: '_updatedDate' | '_createdDate', value: any) => DeploymentsQueryBuilder;
    /** @param propertyName - Property whose value is compared with `value`.
     * @param value - Value to compare against.
     * @documentationMaturity preview
     */
    ge: (propertyName: '_updatedDate' | '_createdDate', value: any) => DeploymentsQueryBuilder;
    /** @param propertyName - Property whose value is compared with `value`.
     * @param value - Value to compare against.
     * @documentationMaturity preview
     */
    gt: (propertyName: '_updatedDate' | '_createdDate', value: any) => DeploymentsQueryBuilder;
    /** @param propertyName - Property whose value is compared with `value`.
     * @param value - Value to compare against.
     * @documentationMaturity preview
     */
    le: (propertyName: '_updatedDate' | '_createdDate', value: any) => DeploymentsQueryBuilder;
    /** @param propertyName - Property whose value is compared with `value`.
     * @param value - Value to compare against.
     * @documentationMaturity preview
     */
    lt: (propertyName: '_updatedDate' | '_createdDate', value: any) => DeploymentsQueryBuilder;
    /** @param propertyName - Property whose value is compared with `values`.
     * @param values - List of values to compare against.
     * @documentationMaturity preview
     */
    hasSome: (propertyName: '_updatedDate' | '_createdDate', value: any[]) => DeploymentsQueryBuilder;
    /** @documentationMaturity preview */
    in: (propertyName: '_updatedDate' | '_createdDate', value: any) => DeploymentsQueryBuilder;
    /** @documentationMaturity preview */
    exists: (propertyName: '_updatedDate' | '_createdDate', value: boolean) => DeploymentsQueryBuilder;
    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
     * @documentationMaturity preview
     */
    ascending: (...propertyNames: Array<'deploymentType' | 'label' | '_updatedDate' | 'deploymentPipelinesStatus' | '_createdDate'>) => DeploymentsQueryBuilder;
    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
     * @documentationMaturity preview
     */
    descending: (...propertyNames: Array<'deploymentType' | 'label' | '_updatedDate' | 'deploymentPipelinesStatus' | '_createdDate'>) => DeploymentsQueryBuilder;
    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
     * @documentationMaturity preview
     */
    limit: (limit: number) => DeploymentsQueryBuilder;
    /** @param cursor - A pointer to specific record
     * @documentationMaturity preview
     */
    skipTo: (cursor: string) => DeploymentsQueryBuilder;
    /** @documentationMaturity preview */
    find: () => Promise<DeploymentsQueryResult>;
}
/**
 * The pipeline provider has to send this event when its execution has ended.
 * @param deploymentId - The deployment creation process id, should match the id that was passed in the invoke() call by the SPI Host
 * @param deploymentPipelineId - The deployment pipeline implementer id as appears in the SPI Config
 * @public
 * @documentationMaturity preview
 * @requiredField deploymentId
 * @requiredField deploymentPipelineId
 * @permissionId EDITOR.DEPLOYMENT_UPDATE
 * @fqn wix.editor.deployments.v1.DeploymentsService.ReportDeploymentPipelineResult
 */
declare function reportDeploymentPipelineResult(deploymentId: string, deploymentPipelineId: string, options?: ReportDeploymentPipelineResultOptions): Promise<void & {
    __applicationErrorsType?: ReportDeploymentPipelineResultApplicationErrors;
}>;
interface ReportDeploymentPipelineResultOptions {
    /**
     * The deployment pipeline task results
     * @maxSize 20
     */
    tasksResults?: TaskResult[];
}
/**
 * Get Deployment Pipeline Description
 * @param deploymentId - The deployment id
 * @param deploymentPipelinesIds - The deployment pipelines implementers ids as appears in the SPI Config to be called for getting descriptions.
 * @public
 * @documentationMaturity preview
 * @requiredField deploymentId
 * @requiredField deploymentPipelinesIds
 * @permissionId EDITOR.DEPLOYMENT_READ
 * @fqn wix.editor.deployments.v1.DeploymentsService.GetDeploymentPipelineDescription
 */
declare function getDeploymentPipelineDescription(deploymentId: string, deploymentPipelinesIds: string[]): Promise<NonNullablePaths<GetDeploymentPipelineDescriptionResponse, `pipelinesDescription` | `pipelinesDescription.${number}.deploymentPipelineId`, 4> & {
    __applicationErrorsType?: GetDeploymentPipelineDescriptionApplicationErrors;
}>;
/**
 * Updates extended fields of a Deployment without incrementing revision
 * @param _id - ID of the entity to update.
 * @param namespace - Identifier for the app whose extended fields are being updated.
 * @public
 * @documentationMaturity preview
 * @requiredField _id
 * @requiredField namespace
 * @requiredField options
 * @requiredField options.namespaceData
 * @permissionId EDITOR.DEPLOYMENT_UPDATE
 * @fqn wix.editor.deployments.v1.DeploymentsService.UpdateExtendedFields
 */
declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`, 2>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, `deployment.editorRevision.siteRevision` | `deployment.rcPublish.rcLabel` | `deployment.rcPublish.useUniqueLabel` | `deployment._id` | `deployment.deploymentType` | `deployment.pipelines` | `deployment.pipelines.${number}.deploymentPipelineId` | `deployment.pipelines.${number}.pipelineStatus` | `deployment.deploymentPipelinesStatus`, 5>>;
interface UpdateExtendedFieldsOptions {
    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
    namespaceData: Record<string, any> | null;
}

export { type ActionEvent, type CreateDeploymentApplicationErrors, type CreateDeploymentOptions, type CreateDeploymentOptionsBasedOnOneOf, type CreateDeploymentOptionsPublishMethodOneOf, type CreateDeploymentRequest, type CreateDeploymentRequestBasedOnOneOf, type CreateDeploymentRequestPublishMethodOneOf, type CreateDeploymentResponse, type CreationPublishTypeNone, type CreationPublishTypeRC, type CreationPublishTypeSite, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type Deployment, type DeploymentAttribute, type DeploymentAttributeAttributeOneOf, type DeploymentCreationPublishTypeOneOf, type DeploymentDescriptionOneOf, type DeploymentPipelineUpdatedMessage, DeploymentPipelinesStatus, type DeploymentPipelinesStatusWithLiterals, DeploymentType, type DeploymentTypeWithLiterals, type DeploymentsQueryBuilder, type DeploymentsQueryResult, type DomainEvent, type DomainEventBodyOneOf, type EditorRevision, type EditorSession, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetDeploymentPipelineDescriptionApplicationErrors, type GetDeploymentPipelineDescriptionRequest, type GetDeploymentPipelineDescriptionResponse, type GetDeploymentRequest, type GetDeploymentResponse, type GridAppIdAttribute, type IdentificationData, type IdentificationDataIdOneOf, type LatestFromBranch, type ListDeploymentsRequest, type ListDeploymentsResponse, type MessageEnvelope, type PipelineDescription, type PipelineResult, PipelineStatus, type PipelineStatusWithLiterals, type PublishDeploymentApplicationErrors, type PublishDeploymentOptions, type PublishDeploymentRequest, type PublishDeploymentResponse, type PublishRCDeploymentRequest, type PublishRCDeploymentResponse, type PublishRcDeploymentApplicationErrors, type PublishRcDeploymentOptions, type PublishSiteRCMethod, PublishType, type PublishTypeWithLiterals, type QueryDeploymentsRequest, type QueryDeploymentsResponse, RCLabel, type RCLabelWithLiterals, type ReportDeploymentPipelineResultApplicationErrors, type ReportDeploymentPipelineResultOptions, type ReportDeploymentPipelineResultRequest, type ReportDeploymentPipelineResultResponse, type RestoreInfo, type SessionInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type TaskDescription, type TaskResult, TaskStatus, type TaskStatusWithLiterals, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createDeployment, getDeployment, getDeploymentPipelineDescription, listDeployments, publishDeployment, publishRcDeployment, queryDeployments, reportDeploymentPipelineResult, updateExtendedFields };