import { CreateDeploymentRequest as CreateDeploymentRequest$1, CreateDeploymentResponse as CreateDeploymentResponse$1, GetDeploymentRequest as GetDeploymentRequest$1, GetDeploymentResponse as GetDeploymentResponse$1, PublishDeploymentRequest as PublishDeploymentRequest$1, PublishDeploymentResponse as PublishDeploymentResponse$1, PublishRCDeploymentRequest as PublishRCDeploymentRequest$1, PublishRCDeploymentResponse as PublishRCDeploymentResponse$1, ListDeploymentsRequest as ListDeploymentsRequest$1, ListDeploymentsResponse as ListDeploymentsResponse$1, QueryDeploymentsRequest as QueryDeploymentsRequest$1, QueryDeploymentsResponse as QueryDeploymentsResponse$1, ReportDeploymentPipelineResultRequest as ReportDeploymentPipelineResultRequest$1, ReportDeploymentPipelineResultResponse as ReportDeploymentPipelineResultResponse$1, GetDeploymentPipelineDescriptionRequest as GetDeploymentPipelineDescriptionRequest$1, GetDeploymentPipelineDescriptionResponse as GetDeploymentPipelineDescriptionResponse$1, UpdateExtendedFieldsRequest as UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsResponse as UpdateExtendedFieldsResponse$1 } from './index.typings.mjs'; import '@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>; } 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 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 | 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 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 | null; } interface UpdateExtendedFieldsResponse { /** Updated Deployment. */ deployment?: Deployment; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createDeployment(): __PublicMethodMetaInfo<'POST', {}, CreateDeploymentRequest$1, CreateDeploymentRequest, CreateDeploymentResponse$1, CreateDeploymentResponse>; declare function getDeployment(): __PublicMethodMetaInfo<'GET', { deploymentId: string; }, GetDeploymentRequest$1, GetDeploymentRequest, GetDeploymentResponse$1, GetDeploymentResponse>; declare function publishDeployment(): __PublicMethodMetaInfo<'POST', { deploymentId: string; }, PublishDeploymentRequest$1, PublishDeploymentRequest, PublishDeploymentResponse$1, PublishDeploymentResponse>; declare function publishRcDeployment(): __PublicMethodMetaInfo<'POST', { deploymentId: string; }, PublishRCDeploymentRequest$1, PublishRCDeploymentRequest, PublishRCDeploymentResponse$1, PublishRCDeploymentResponse>; declare function listDeployments(): __PublicMethodMetaInfo<'GET', {}, ListDeploymentsRequest$1, ListDeploymentsRequest, ListDeploymentsResponse$1, ListDeploymentsResponse>; declare function queryDeployments(): __PublicMethodMetaInfo<'POST', {}, QueryDeploymentsRequest$1, QueryDeploymentsRequest, QueryDeploymentsResponse$1, QueryDeploymentsResponse>; declare function reportDeploymentPipelineResult(): __PublicMethodMetaInfo<'POST', { deploymentId: string; }, ReportDeploymentPipelineResultRequest$1, ReportDeploymentPipelineResultRequest, ReportDeploymentPipelineResultResponse$1, ReportDeploymentPipelineResultResponse>; declare function getDeploymentPipelineDescription(): __PublicMethodMetaInfo<'GET', { deploymentId: string; }, GetDeploymentPipelineDescriptionRequest$1, GetDeploymentPipelineDescriptionRequest, GetDeploymentPipelineDescriptionResponse$1, GetDeploymentPipelineDescriptionResponse>; declare function updateExtendedFields(): __PublicMethodMetaInfo<'POST', { id: string; }, UpdateExtendedFieldsRequest$1, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse$1, UpdateExtendedFieldsResponse>; export { type __PublicMethodMetaInfo, createDeployment, getDeployment, getDeploymentPipelineDescription, listDeployments, publishDeployment, publishRcDeployment, queryDeployments, reportDeploymentPipelineResult, updateExtendedFields };