import { CreateConnectedDomainRequest as CreateConnectedDomainRequest$1, CreateConnectedDomainResponse as CreateConnectedDomainResponse$1, GetConnectedDomainRequest as GetConnectedDomainRequest$1, GetConnectedDomainResponse as GetConnectedDomainResponse$1, DeleteConnectedDomainRequest as DeleteConnectedDomainRequest$1, DeleteConnectedDomainResponse as DeleteConnectedDomainResponse$1, ListConnectedDomainsRequest as ListConnectedDomainsRequest$1, ListConnectedDomainsResponse as ListConnectedDomainsResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; /** A `connectedDomain` object holds information about an external domain and its connection to a Wix site. */ interface ConnectedDomain { /** * ID of the connected domain. Identical to the domain name including TLD. * @format HOSTNAME * @readonly */ id?: string; /** * Domain name including TLD. * Both root domains and subdomains are supported. * @format HOSTNAME */ domain?: string; /** How the domain is connected to the Wix site. */ connectionType?: ConnectionTypeWithLiterals; /** * Information about the site to which the domain is assigned, and whether * it's the primary domain or a redirect. */ siteInfo?: SiteInfo; /** * Whether the site owner receives standard email notifications from Wix about * the connected domain. * * Default: `false` */ suppressNotifications?: boolean; /** * DNS propagation status. * @readonly */ dnsPropagationStatus?: DnsPropagationStatusWithLiterals; /** * Date and time the `connectedDomain` object was created in * `YYYY-MM-DDThh:mm:ss.sssZ` format. * @readonly */ createdDate?: Date | null; /** * Date and time the `connectedDomain` object was last updated in * `YYYY-MM-DDThh:mm:ss.sssZ` format. * @readonly */ updatedDate?: Date | null; } declare enum ConnectionType { /** The domain is connected by pointing. Wix doesn't manage DNS information. */ POINTING = "POINTING", /** The domain is connected by nameservers. Wix manages DNS information. */ NAMESERVERS = "NAMESERVERS", /** The domain isn't visible to site visitors. */ HIDDEN = "HIDDEN" } /** @enumType */ type ConnectionTypeWithLiterals = ConnectionType | 'POINTING' | 'NAMESERVERS' | 'HIDDEN'; interface SiteInfo extends SiteInfoAssignmentInfoOneOf { /** * Redirect information, relevant when `assignmentType` = `REDIRECT`. * @readonly */ redirectInfo?: RedirectAssignmentInfo; /** * ID of the site to which the domain is assigned. * @readonly * @format GUID */ id?: string | null; /** * The relationship assigned for this domain to the site. * * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains). */ assignmentType?: AssignmentTypeWithLiterals; } /** @oneof */ interface SiteInfoAssignmentInfoOneOf { /** * Redirect information, relevant when `assignmentType` = `REDIRECT`. * @readonly */ redirectInfo?: RedirectAssignmentInfo; } declare enum AssignmentType { /** The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site. */ PRIMARY = "PRIMARY", /** A redirect domain for a site. Each site can have multiple redirect domains. When this type is assigned, this domain will redirect to the primary domain. */ REDIRECT = "REDIRECT" } /** @enumType */ type AssignmentTypeWithLiterals = AssignmentType | 'PRIMARY' | 'REDIRECT'; interface RedirectAssignmentInfo { /** * Primary domain to which this domain will redirect. * @format HOSTNAME * @readonly */ primaryDomain?: string; } declare enum DnsPropagationStatus { /** The domain's DNS propagation process has successfully finished. */ COMPLETED = "COMPLETED", /** The domain's DNS propagation process has failed. */ FAILED = "FAILED", /** The domain's DNS propagation process has started but hasn't successfully completed yet. */ IN_PROGRESS = "IN_PROGRESS" } /** @enumType */ type DnsPropagationStatusWithLiterals = DnsPropagationStatus | 'COMPLETED' | 'FAILED' | 'IN_PROGRESS'; interface CreateConnectedDomainRequest { /** Domain to connect. */ connectedDomain: ConnectedDomain; } interface CreateConnectedDomainResponse { /** Connected domain. */ connectedDomain?: ConnectedDomain; } interface GetConnectedDomainRequest { /** * ID of the connected domain. Identical to the domain name including TLD. * @format HOSTNAME */ connectedDomainId: string; } interface GetConnectedDomainResponse { /** Retrieved connected domain. */ connectedDomain?: ConnectedDomain; } interface DeleteConnectedDomainRequest { /** * ID of the connected domain to delete. Identical to the domain name including TLD. * @format HOSTNAME */ connectedDomainId: string; } interface DeleteConnectedDomainResponse { } interface ListConnectedDomainsRequest { /** Cursor paging options. */ paging?: CursorPaging; } interface CursorPaging { /** * Number of domains to load. * * Min: `0` * Max: `100` * @max 100 */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * You can get the relevant cursor token * from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. */ cursor?: string | null; } interface ListConnectedDomainsResponse { /** Metadata about the returned list of connected domains. */ pagingMetadata?: CursorPagingMetadata; /** Retrieved connected domains. */ connectedDomains?: ConnectedDomain[]; } interface CursorPagingMetadata { /** Number of domains returned in the response. */ count?: number | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors; /** * Indicates if there are more results after the current page. * If `true`, another page of results can be retrieved. * If `false`, this is the last page. */ hasNext?: boolean | null; } interface Cursors { /** Cursor pointing to next page in the list of results. */ next?: string | null; /** Cursor pointing to previous page in the list of results. */ prev?: string | null; } 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 { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } 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. */ currentEntityAsJson?: string; } interface EntityDeletedEvent { /** Entity that was deleted. */ deletedEntityAsJson?: string | null; } interface ActionEvent { bodyAsJson?: 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; /** Details related to the account */ accountInfo?: AccountInfo; } 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'; interface AccountInfo { /** * ID of the Wix account associated with the event. * @format GUID */ accountId?: string | null; /** * ID of the parent Wix account. Only included when accountId belongs to a child account. * @format GUID */ parentAccountId?: string | null; /** * ID of the Wix site associated with the event. Only included when the event is tied to a specific site. * @format GUID */ siteId?: string | null; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function createConnectedDomain(): __PublicMethodMetaInfo<'POST', {}, CreateConnectedDomainRequest$1, CreateConnectedDomainRequest, CreateConnectedDomainResponse$1, CreateConnectedDomainResponse>; declare function getConnectedDomain(): __PublicMethodMetaInfo<'GET', { connectedDomainId: string; }, GetConnectedDomainRequest$1, GetConnectedDomainRequest, GetConnectedDomainResponse$1, GetConnectedDomainResponse>; declare function deleteConnectedDomain(): __PublicMethodMetaInfo<'DELETE', { connectedDomainId: string; }, DeleteConnectedDomainRequest$1, DeleteConnectedDomainRequest, DeleteConnectedDomainResponse$1, DeleteConnectedDomainResponse>; declare function listConnectedDomains(): __PublicMethodMetaInfo<'GET', {}, ListConnectedDomainsRequest$1, ListConnectedDomainsRequest, ListConnectedDomainsResponse$1, ListConnectedDomainsResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, AssignmentType as AssignmentTypeOriginal, type AssignmentTypeWithLiterals as AssignmentTypeWithLiteralsOriginal, type ConnectedDomain as ConnectedDomainOriginal, ConnectionType as ConnectionTypeOriginal, type ConnectionTypeWithLiterals as ConnectionTypeWithLiteralsOriginal, type CreateConnectedDomainRequest as CreateConnectedDomainRequestOriginal, type CreateConnectedDomainResponse as CreateConnectedDomainResponseOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DeleteConnectedDomainRequest as DeleteConnectedDomainRequestOriginal, type DeleteConnectedDomainResponse as DeleteConnectedDomainResponseOriginal, DnsPropagationStatus as DnsPropagationStatusOriginal, type DnsPropagationStatusWithLiterals as DnsPropagationStatusWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type GetConnectedDomainRequest as GetConnectedDomainRequestOriginal, type GetConnectedDomainResponse as GetConnectedDomainResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ListConnectedDomainsRequest as ListConnectedDomainsRequestOriginal, type ListConnectedDomainsResponse as ListConnectedDomainsResponseOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type RedirectAssignmentInfo as RedirectAssignmentInfoOriginal, type RestoreInfo as RestoreInfoOriginal, type SiteInfoAssignmentInfoOneOf as SiteInfoAssignmentInfoOneOfOriginal, type SiteInfo as SiteInfoOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createConnectedDomain, deleteConnectedDomain, getConnectedDomain, listConnectedDomains };