@wix/auto_sdk_email-transmissions_email-transmissions 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,744 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
+
+/**
+ * An EmailTransmission is entity used for sending emails.
+ * Creating an entity of this type will trigger an email to be sent to the specified recipients.
+ * The email will be sent asynchronously, and the status of the transmission can be tracked using the EmailTransmission entity.
+ */
+interface EmailTransmission extends EmailTransmissionTypeOptionsOneOf, EmailTransmissionStatusOptionsOneOf {
+    /** Options for marketing email. */
+    marketingOptions?: MarketingOptions;
+    /**
+     * Options for rejected email transmission.
+     * @readonly
+     */
+    rejectedOptions?: RejectedOptions;
+    /**
+     * EmailTransmission ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Date and time the EmailTransmission was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the EmailTransmission was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Revision number, which increments by 1 each time the EmailTransmission is updated.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Email subject (optional). Default - empty.
+     * @maxLength 200
+     */
+    emailSubject?: string | null;
+    /**
+     * Full HTML content of the email to be sent.
+     * Note that this field is not returned in the QueryEmailTransmissions endpoint for performance reasons. Use GetEmailTransmission to retrieve the full content of a specific email transmission.
+     * Important: in order to save storage space, this field will only be stored for 30 days after the email transmission is created. After that, it will be deleted and will not be retrievable anymore.
+     * @maxLength 1000000
+     */
+    emailHtmlContent?: string;
+    /**
+     * Request metadata (optional). Default - empty.
+     * Provided values will be passed to the ESP and then included in various callbacks to identify the context in which an email was sent.
+     * Length of each key and value must be between 1 and 50 alphanumeric characters.
+     * @maxSize 10
+     */
+    metadata?: Record<string, string>;
+    /**
+     * Sender name (optional). Default - empty.
+     * @minLength 1
+     * @maxLength 50
+     */
+    senderName?: string | null;
+    /**
+     * Sender email address (optional). Default - wix owned email address (for example "no-reply@wixsitemail.com").
+     * If provided sender email address is unauthenticated and cannot be used for sending emails (for example gmail.com), it will be replaced with wix owned email address.
+     * In that case provided email address will be used as reply-to unless reply-to email address is provided explicitly.
+     * @format EMAIL
+     */
+    senderEmailAddress?: string | null;
+    /** Recipient to whom replies will be sent (optional). Default - empty (which effectively resolves to "sender_email_address"). */
+    replyTo?: Recipient;
+    /**
+     * Recipients to whom the email will be sent.
+     * @minSize 1
+     * @maxSize 100
+     */
+    toRecipients?: Recipient[];
+    /** Email type - transactional or marketing. */
+    type?: TypeWithLiterals;
+    /**
+     * Email transmission status.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+}
+/** @oneof */
+interface EmailTransmissionTypeOptionsOneOf {
+    /** Options for marketing email. */
+    marketingOptions?: MarketingOptions;
+}
+/** @oneof */
+interface EmailTransmissionStatusOptionsOneOf {
+    /**
+     * Options for rejected email transmission.
+     * @readonly
+     */
+    rejectedOptions?: RejectedOptions;
+}
+interface Recipient extends RecipientValueOneOf {
+    /**
+     * Recipient email address will be resolved from Contacts API.
+     * @format GUID
+     */
+    contactId?: string;
+    /**
+     * Recipient email address will be resolved from Users API.
+     * @format GUID
+     */
+    userId?: string;
+    /**
+     * Contact will be created with this email address if it does not exist yet.
+     * @format EMAIL
+     */
+    emailAddress?: string;
+    /**
+     * Recipient name (optional). Default - empty.
+     * @minLength 1
+     * @maxLength 50
+     */
+    name?: string | null;
+    /**
+     * Failure reason - filled if the recipient was skipped and the email was not sent to them. Otherwise, it will be NONE.
+     * @readonly
+     */
+    failureReason?: FailureReasonWithLiterals;
+}
+/** @oneof */
+interface RecipientValueOneOf {
+    /**
+     * Recipient email address will be resolved from Contacts API.
+     * @format GUID
+     */
+    contactId?: string;
+    /**
+     * Recipient email address will be resolved from Users API.
+     * @format GUID
+     */
+    userId?: string;
+    /**
+     * Contact will be created with this email address if it does not exist yet.
+     * @format EMAIL
+     */
+    emailAddress?: string;
+}
+declare enum FailureReason {
+    /** Present in case of successfully sent email. */
+    NONE = "NONE",
+    /** Contact or user not found by given ID. */
+    RECIPIENT_NOT_FOUND = "RECIPIENT_NOT_FOUND",
+    /** Contact or user has empty email address. */
+    EMAIL_ADDRESS_MISSING = "EMAIL_ADDRESS_MISSING",
+    /** Email address is invalid (no such mailbox exist). */
+    EMAIL_ADDRESS_INVALID = "EMAIL_ADDRESS_INVALID",
+    /** Email address has bounced previously and cannot be sent to again. */
+    EMAIL_ADDRESS_BOUNCED = "EMAIL_ADDRESS_BOUNCED",
+    /** Recipient did not give consent to send marketing emails. */
+    MARKETING_CONSENT_NOT_GIVEN = "MARKETING_CONSENT_NOT_GIVEN",
+    /** User is currently not a collaborator on the site. */
+    NOT_SITE_COLLABORATOR = "NOT_SITE_COLLABORATOR"
+}
+/** @enumType */
+type FailureReasonWithLiterals = FailureReason | 'NONE' | 'RECIPIENT_NOT_FOUND' | 'EMAIL_ADDRESS_MISSING' | 'EMAIL_ADDRESS_INVALID' | 'EMAIL_ADDRESS_BOUNCED' | 'MARKETING_CONSENT_NOT_GIVEN' | 'NOT_SITE_COLLABORATOR';
+declare enum Type {
+    /** Email is mostly sent to a single recipient in response to an action they took. No unsubscribe link is added to the email. */
+    TRANSACTIONAL = "TRANSACTIONAL",
+    /** Email is sent to multiple recipients, usually as part of a marketing campaign. Unsubscribe link is added to the email. */
+    MARKETING = "MARKETING"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'TRANSACTIONAL' | 'MARKETING';
+interface MarketingOptions {
+    /**
+     * Placeholder that will be replaced with the actual unsubscribe URL in the email content (optional, case sensitive).
+     * Make sure it's unique and not used anywhere else in the email content.
+     * For example, you can use a placeholder like {{unsubscribe_url}} or [UNSUBSCRIBE_URL].
+     * If it's not provided, then unsubscribe URL (in site main language) text will be added to the bottom of the email.
+     * @maxLength 100
+     */
+    unsubscribeUrlPlaceholder?: string | null;
+}
+declare enum Status {
+    /** Email transmission has been successfully created (and will be processed shortly). */
+    ACCEPTED = "ACCEPTED",
+    /** Email transmission is currently being processed (checking content, resolving recipients, sending emails). */
+    IN_PROGRESS = "IN_PROGRESS",
+    /** Email transmission has been fully processed (per recipient information is now available). */
+    PROCESSED = "PROCESSED",
+    /** Email transmission failed abuse check and no emails will be sent. */
+    REJECTED = "REJECTED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'ACCEPTED' | 'IN_PROGRESS' | 'PROCESSED' | 'REJECTED';
+interface RejectedOptions {
+    /**
+     * Reasons for email transmission rejection.
+     * @minSize 1
+     * @maxSize 10
+     * @readonly
+     */
+    rejectionReasons?: RejectionReasonWithLiterals[];
+}
+declare enum RejectionReason {
+    BLACKLISTED_SENDER_EMAIL = "BLACKLISTED_SENDER_EMAIL",
+    BLACKLISTED_SENDER_NAME = "BLACKLISTED_SENDER_NAME",
+    BLACKLISTED_REPLY_TO_EMAIL = "BLACKLISTED_REPLY_TO_EMAIL",
+    BLACKLISTED_REPLY_TO_NAME = "BLACKLISTED_REPLY_TO_NAME",
+    BLACKLISTED_LINK = "BLACKLISTED_LINK",
+    BLACKLISTED_TEXT = "BLACKLISTED_TEXT"
+}
+/** @enumType */
+type RejectionReasonWithLiterals = RejectionReason | 'BLACKLISTED_SENDER_EMAIL' | 'BLACKLISTED_SENDER_NAME' | 'BLACKLISTED_REPLY_TO_EMAIL' | 'BLACKLISTED_REPLY_TO_NAME' | 'BLACKLISTED_LINK' | 'BLACKLISTED_TEXT';
+interface SendEmailTransmissionRequest {
+    /** EmailTransmission to be created. */
+    emailTransmission: EmailTransmission;
+    /**
+     * Idempotency key used to prevent duplicate email transmissions (optional).
+     * If a request with the same idempotency key is received, the server will return the same response as the original request.
+     * @format GUID
+     */
+    idempotencyKey?: string | null;
+}
+interface SendEmailTransmissionResponse {
+    /** The created EmailTransmission. */
+    emailTransmission?: EmailTransmission;
+}
+interface AccountSuspendedErrorDetails {
+    /**
+     * URL of the page where the user can contact support or learn more about the suspension.
+     * @format WEB_URL
+     */
+    termsOfServicePageUrl?: string;
+}
+interface OutOfQuotaErrorDetails {
+    /**
+     * URL of the page where the user can upgrade their plan or purchase more quota.
+     * @format WEB_URL
+     */
+    packagePickerUrl?: string;
+}
+interface GetEmailTransmissionRequest {
+    /**
+     * ID of the EmailTransmission to retrieve.
+     * @format GUID
+     */
+    emailTransmissionId: string;
+}
+interface GetEmailTransmissionResponse {
+    /** The requested EmailTransmission. */
+    emailTransmission?: EmailTransmission;
+}
+interface QueryEmailTransmissionsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     * @maxSize 4
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @minLength 1
+     * @maxLength 50
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @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.
+     * @maxLength 1000
+     */
+    cursor?: string | null;
+}
+interface QueryEmailTransmissionsResponse {
+    /** List of EmailTransmissions. */
+    emailTransmissions?: EmailTransmission[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    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.
+     * @maxLength 1000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to previous page in the list of results.
+     * @maxLength 1000
+     */
+    prev?: string | null;
+}
+interface DeleteEmailTransmissionRequest {
+    /**
+     * Id of the EmailTransmission to delete.
+     * @format GUID
+     */
+    emailTransmissionId: string;
+}
+interface DeleteEmailTransmissionResponse {
+}
+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 Empty {
+}
+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 SendEmailTransmissionApplicationErrors = {
+    code?: 'ACCOUNT_SUSPENDED';
+    description?: string;
+    data?: AccountSuspendedErrorDetails;
+} | {
+    code?: 'UNVERIFIED_SENDER_EMAIL';
+    description?: string;
+    data?: Record<string, any>;
+} | {
+    code?: 'OUT_OF_QUOTA';
+    description?: string;
+    data?: OutOfQuotaErrorDetails;
+};
+/** @docsIgnore */
+type SendEmailTransmissionValidationErrors = {
+    ruleName?: 'INVALID_METADATA';
+};
+/** @docsIgnore */
+type DeleteEmailTransmissionApplicationErrors = {
+    code?: 'EMAIL_TRANSMISSION_IS_IN_PROGRESS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Create and send new email transmission.
+ * @param emailTransmission - EmailTransmission to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField emailTransmission
+ * @requiredField emailTransmission.emailHtmlContent
+ * @requiredField emailTransmission.toRecipients
+ * @requiredField emailTransmission.type
+ * @permissionId shoutout.manage
+ * @applicableIdentity APP
+ * @fqn wix.emails.transmissions.v1.EmailTransmissionService.SendEmailTransmission
+ */
+declare function sendEmailTransmission(emailTransmission: NonNullablePaths<EmailTransmission, `emailHtmlContent` | `toRecipients` | `type`, 2>, options?: SendEmailTransmissionOptions): Promise<NonNullablePaths<SendEmailTransmissionResponse, `emailTransmission.rejectedOptions.rejectionReasons` | `emailTransmission._id` | `emailTransmission.emailHtmlContent` | `emailTransmission.replyTo.contactId` | `emailTransmission.replyTo.userId` | `emailTransmission.replyTo.emailAddress` | `emailTransmission.replyTo.failureReason` | `emailTransmission.toRecipients` | `emailTransmission.type` | `emailTransmission.status`, 4> & {
+    __applicationErrorsType?: SendEmailTransmissionApplicationErrors;
+    __validationErrorsType?: SendEmailTransmissionValidationErrors;
+}>;
+interface SendEmailTransmissionOptions {
+    /**
+     * Idempotency key used to prevent duplicate email transmissions (optional).
+     * If a request with the same idempotency key is received, the server will return the same response as the original request.
+     * @format GUID
+     */
+    idempotencyKey?: string | null;
+}
+/**
+ * Get email transmission by ID.
+ * @param emailTransmissionId - ID of the EmailTransmission to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField emailTransmissionId
+ * @permissionId shoutout.read
+ * @applicableIdentity APP
+ * @returns The requested EmailTransmission.
+ * @fqn wix.emails.transmissions.v1.EmailTransmissionService.GetEmailTransmission
+ */
+declare function getEmailTransmission(emailTransmissionId: string): Promise<NonNullablePaths<EmailTransmission, `rejectedOptions.rejectionReasons` | `_id` | `emailHtmlContent` | `replyTo.contactId` | `replyTo.userId` | `replyTo.emailAddress` | `replyTo.failureReason` | `toRecipients` | `type` | `status`, 3>>;
+/**
+ * Query email transmissions.
+ * Note that field "email_html_content" is not returned in this endpoint for performance reasons. Use GetEmailTransmission to retrieve the full content of a specific email transmission.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId shoutout.read
+ * @applicableIdentity APP
+ * @fqn wix.emails.transmissions.v1.EmailTransmissionService.QueryEmailTransmissions
+ */
+declare function queryEmailTransmissions(): EmailTransmissionsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface EmailTransmissionsQueryResult extends QueryCursorResult {
+    items: EmailTransmission[];
+    query: EmailTransmissionsQueryBuilder;
+    next: () => Promise<EmailTransmissionsQueryResult>;
+    prev: () => Promise<EmailTransmissionsQueryResult>;
+}
+interface EmailTransmissionsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_updatedDate' | 'emailSubject' | 'type' | 'status', value: any) => EmailTransmissionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_updatedDate' | 'emailSubject' | 'type' | 'status', value: any) => EmailTransmissionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_updatedDate' | 'emailSubject', value: any) => EmailTransmissionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_updatedDate' | 'emailSubject', value: any) => EmailTransmissionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_updatedDate' | 'emailSubject', value: any) => EmailTransmissionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_updatedDate' | 'emailSubject', value: any) => EmailTransmissionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'emailSubject', value: string) => EmailTransmissionsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_updatedDate' | 'emailSubject', value: any[]) => EmailTransmissionsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_updatedDate' | 'emailSubject' | 'type' | 'status', value: any) => EmailTransmissionsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_updatedDate' | 'emailSubject', value: boolean) => EmailTransmissionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_updatedDate' | 'emailSubject' | 'type' | 'status'>) => EmailTransmissionsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_updatedDate' | 'emailSubject' | 'type' | 'status'>) => EmailTransmissionsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => EmailTransmissionsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => EmailTransmissionsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<EmailTransmissionsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.emails.transmissions.v1.EmailTransmissionService.QueryEmailTransmissions
+ * @requiredField query
+ */
+declare function typedQueryEmailTransmissions(query: EmailTransmissionQuery): Promise<NonNullablePaths<QueryEmailTransmissionsResponse, `emailTransmissions` | `emailTransmissions.${number}._id` | `emailTransmissions.${number}.emailHtmlContent` | `emailTransmissions.${number}.replyTo.contactId` | `emailTransmissions.${number}.replyTo.userId` | `emailTransmissions.${number}.replyTo.emailAddress` | `emailTransmissions.${number}.replyTo.failureReason` | `emailTransmissions.${number}.type` | `emailTransmissions.${number}.status`, 5>>;
+interface EmailTransmissionQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_id', 'status', 'type'];
+            operators: ['$eq', '$in', '$ne'];
+            sort: 'BOTH';
+        },
+        {
+            fields: ['_updatedDate', 'emailSubject'];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<EmailTransmission, EmailTransmissionQuerySpec>;
+type EmailTransmissionQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    */
+    cursorPaging?: {
+        /**
+      Number of items to load.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | 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.
+      @maxLength: 1000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object in the following format:
+    `"filter" : {
+    "fieldName1": "value1",
+    "fieldName2":{"$operator":"value2"}
+    }`
+    Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object in the following format:
+    `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+    @maxSize: 4
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @minLength: 1,
+      @maxLength: 50
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<EmailTransmission, EmailTransmissionQuerySpec, EmailTransmissionQuery>;
+        Filter: _wix_sdk_types.FilterFactory<EmailTransmission, EmailTransmissionQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<EmailTransmissionQuerySpec>;
+    };
+};
+/**
+ * Delete email transmission by ID.
+ * Note that this operation is only allowed for PROCESSED or REJECTED email transmissions. Deleting an ACCEPTED or IN_PROGRESS email transmission will result in an error.
+ * @param emailTransmissionId - Id of the EmailTransmission to delete.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField emailTransmissionId
+ * @permissionId shoutout.manage
+ * @applicableIdentity APP
+ * @fqn wix.emails.transmissions.v1.EmailTransmissionService.DeleteEmailTransmission
+ */
+declare function deleteEmailTransmission(emailTransmissionId: string): Promise<void & {
+    __applicationErrorsType?: DeleteEmailTransmissionApplicationErrors;
+}>;
+
+export { type AccountInfo, type AccountSuspendedErrorDetails, type ActionEvent, type CommonQueryWithEntityContext, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteEmailTransmissionApplicationErrors, type DeleteEmailTransmissionRequest, type DeleteEmailTransmissionResponse, type DomainEvent, type DomainEventBodyOneOf, type EmailTransmission, type EmailTransmissionQuery, type EmailTransmissionQuerySpec, type EmailTransmissionStatusOptionsOneOf, type EmailTransmissionTypeOptionsOneOf, type EmailTransmissionsQueryBuilder, type EmailTransmissionsQueryResult, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, FailureReason, type FailureReasonWithLiterals, type GetEmailTransmissionRequest, type GetEmailTransmissionResponse, type IdentificationData, type IdentificationDataIdOneOf, type MarketingOptions, type MessageEnvelope, type OutOfQuotaErrorDetails, type QueryEmailTransmissionsRequest, type QueryEmailTransmissionsResponse, type Recipient, type RecipientValueOneOf, type RejectedOptions, RejectionReason, type RejectionReasonWithLiterals, type RestoreInfo, type SendEmailTransmissionApplicationErrors, type SendEmailTransmissionOptions, type SendEmailTransmissionRequest, type SendEmailTransmissionResponse, type SendEmailTransmissionValidationErrors, SortOrder, type SortOrderWithLiterals, type Sorting, Status, type StatusWithLiterals, Type, type TypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, deleteEmailTransmission, getEmailTransmission, queryEmailTransmissions, sendEmailTransmission, typedQueryEmailTransmissions, utils };