import { GetSenderDetailsRequest as GetSenderDetailsRequest$1, GetSenderDetailsResponse as GetSenderDetailsResponse$1, UpdateSenderDetailsRequest as UpdateSenderDetailsRequest$1, UpdateSenderDetailsResponse as UpdateSenderDetailsResponse$1, VerifySenderEmailRequest as VerifySenderEmailRequest$1, VerifySenderEmailResponse as VerifySenderEmailResponse$1, ResolveActualFromAddressRequest as ResolveActualFromAddressRequest$1, ResolveActualFromAddressResponse as ResolveActualFromAddressResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; /** * A sender details object contains the information that is displayed as the email sender's name and email address. * If sending email campaigns with a public email domain (e.g. @gmail.com or @yahoo.com), the email address will not * be displayed in the 'from' header. Instead, the email address is replaced with @wixemails.com (or @wixsitemail.com for free users), * and the sender's email is placed in the 'reply-to' header. * * If sending email campaigns with an email from a Wix managed domain, that email will be displayed in the 'from' header. * If sending with an email from a custom domain that is not managed by Wix, a line will be inserted that states that the * email was sent via wixemails.com. */ interface SenderDetails { /** Display name of sender. */ fromName?: string; /** * Email address of sender. * @format EMAIL */ fromEmail?: string; /** * Date and time the sender's email address was verified. * @readonly */ dateVerified?: Date | null; } interface GetSenderDetailsRequest { } interface GetSenderDetailsResponse { /** Current sender details. */ senderDetails?: SenderDetails; } interface UpdateSenderDetailsRequest { /** New sender details. */ senderDetails: SenderDetails; } interface UpdateSenderDetailsResponse { /** Whether email address needs verification. */ verificationNeeded?: boolean; } interface VerifySenderEmailRequest { /** Verification code. */ verificationCode: string; } interface VerifySenderEmailResponse { } interface ResolveActualFromAddressRequest { /** * User's provided address from which to send email marketing campaign. * @format EMAIL */ fromAddress: string; } interface ResolveActualFromAddressResponse { /** * Actual from-address that will be used for email distribution. * @format EMAIL */ actualFromAddress?: string; } 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; } /** @docsIgnore */ type VerifyEmailApplicationErrors = { code?: 'INVALID_VERIFICATION_CODE'; description?: string; data?: Record; }; type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function getSenderDetails(): __PublicMethodMetaInfo<'GET', {}, GetSenderDetailsRequest$1, GetSenderDetailsRequest, GetSenderDetailsResponse$1, GetSenderDetailsResponse>; declare function updateSenderDetails(): __PublicMethodMetaInfo<'PATCH', {}, UpdateSenderDetailsRequest$1, UpdateSenderDetailsRequest, UpdateSenderDetailsResponse$1, UpdateSenderDetailsResponse>; declare function verifyEmail(): __PublicMethodMetaInfo<'POST', {}, VerifySenderEmailRequest$1, VerifySenderEmailRequest, VerifySenderEmailResponse$1, VerifySenderEmailResponse>; declare function resolveActualFromAddress(): __PublicMethodMetaInfo<'POST', {}, ResolveActualFromAddressRequest$1, ResolveActualFromAddressRequest, ResolveActualFromAddressResponse$1, ResolveActualFromAddressResponse>; export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type GetSenderDetailsRequest as GetSenderDetailsRequestOriginal, type GetSenderDetailsResponse as GetSenderDetailsResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ResolveActualFromAddressRequest as ResolveActualFromAddressRequestOriginal, type ResolveActualFromAddressResponse as ResolveActualFromAddressResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type SenderDetails as SenderDetailsOriginal, type UpdateSenderDetailsRequest as UpdateSenderDetailsRequestOriginal, type UpdateSenderDetailsResponse as UpdateSenderDetailsResponseOriginal, type VerifyEmailApplicationErrors as VerifyEmailApplicationErrorsOriginal, type VerifySenderEmailRequest as VerifySenderEmailRequestOriginal, type VerifySenderEmailResponse as VerifySenderEmailResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, getSenderDetails, resolveActualFromAddress, updateSenderDetails, verifyEmail };