@wix/auto_sdk_email-subscriptions_email-subscriptions 1.0.4 → 1.0.6

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

@@ -1 +1,502 @@
-export * from './src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.js';
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface EmailSubscription {
+    /**
+     * Email subscription ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Email address.
+     * @format EMAIL
+     */
+    email?: string;
+    /**
+     * Indicates the recipient's opt-in or opt-out status
+     * for marketing emails.
+     *
+     * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
+     * - `PENDING`: Subscription confirmation was requested,
+     * but recipient hasn't confirmed yet.
+     * - `SUBSCRIBED`: Recipient has opted in to marketing emails.
+     * - `UNSUBSCRIBED`: Recipient has opted out of marketing emails.
+     *
+     * Defaults to `NOT_SET`.
+     */
+    subscriptionStatus?: SubscriptionEnumStatusWithLiterals;
+    /**
+     * Indicates last reported status of sent emails.
+     *
+     * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
+     * - `VALID`: Emails to this email address are being delivered successfully.
+     * - `BOUNCED`: The last email to the recipient bounced or was rejected.
+     * - `SPAM_COMPLAINT`: The recipient registered a spam complaint
+     * with their email provider.
+     * - `INACTIVE`: Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.)
+     * This status might impact subsequent emails sent to this address.
+     *
+     * Defaults to `NOT_SET`.
+     */
+    deliverabilityStatus?: StatusWithLiterals;
+    /**
+     * Date and time the email subscription was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the email subscription was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+}
+declare enum SubscriptionEnumStatus {
+    UNKNOWN = "UNKNOWN",
+    /** No Subscription exists */
+    NOT_SET = "NOT_SET",
+    /** Pending Subscription */
+    PENDING = "PENDING",
+    /** Subscribed */
+    SUBSCRIBED = "SUBSCRIBED",
+    /** UnSubscribed */
+    UNSUBSCRIBED = "UNSUBSCRIBED"
+}
+/** @enumType */
+type SubscriptionEnumStatusWithLiterals = SubscriptionEnumStatus | 'UNKNOWN' | 'NOT_SET' | 'PENDING' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
+declare enum Status {
+    NOT_SET = "NOT_SET",
+    /** valid/deferral */
+    VALID = "VALID",
+    /** bounced/rejected/invalid */
+    BOUNCED = "BOUNCED",
+    /** spam/complaint */
+    SPAM_COMPLAINT = "SPAM_COMPLAINT",
+    /** valid, but no activity reported */
+    INACTIVE = "INACTIVE"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'NOT_SET' | 'VALID' | 'BOUNCED' | 'SPAM_COMPLAINT' | 'INACTIVE';
+/** Triggered when an email subscription's status is changed. */
+interface EmailSubscriptionChanged {
+    /** Email subscription that changed. */
+    subscription?: EmailSubscription;
+}
+interface GetEmailSubscriptionRequest {
+    /** @format GUID */
+    _id: string;
+}
+interface GetEmailSubscriptionResponse {
+    /** Returned email subscription */
+    emailSubscription?: EmailSubscription;
+}
+interface UpdateEmailSubscriptionRequest {
+    /** Email subscription to update */
+    subscription?: EmailSubscription;
+}
+interface UpdateEmailSubscriptionResponse {
+    /** Updated email subscription */
+    subscription?: EmailSubscription;
+}
+interface QueryEmailSubscriptionsRequest {
+    /**
+     * Filter options.
+     * Currently, querying is supported on the `email` field
+     * with the `$in` array filter.
+     */
+    filter: Record<string, any> | null;
+    /**
+     * Pagination options. For more information, see
+     * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     */
+    paging?: Paging;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface QueryEmailSubscriptionsResponse {
+    /** List of subscribed emails that matched the query options. */
+    subscriptions?: EmailSubscription[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+interface UpsertEmailSubscriptionRequest {
+    /** Email subscription to update or create. */
+    subscription?: EmailSubscription;
+}
+interface UpsertEmailSubscriptionResponse {
+    /** Updated or created email subscription. */
+    subscription?: EmailSubscription;
+}
+interface BulkUpsertEmailSubscriptionRequest {
+    /**
+     * List of email subscriptions to update or create.
+     * @minSize 1
+     * @maxSize 100
+     */
+    subscriptions: EmailSubscription[];
+}
+interface BulkUpsertEmailSubscriptionResponse {
+    /** List of updated or created email subscriptions. */
+    results?: BulkUpsertEmailSubscriptionResult[];
+    /** Numbers of successful and failed actions. */
+    metadata?: Metadata;
+}
+interface BulkUpsertEmailSubscriptionResult {
+    /** Position of the requested email subscription in the bulk array. */
+    originalIndex?: number;
+    /** New or updated email subscription. */
+    emailSubscription?: EmailSubscription;
+    /**
+     * Error information if the action failed.
+     * Omitted from successful actions.
+     */
+    error?: Error;
+}
+interface Error {
+    /** Error code. */
+    errorCode?: string;
+    /** Message that contains details about the error. */
+    message?: string;
+}
+interface Metadata {
+    /** Number of successful actions. */
+    totalSuccess?: number;
+    /** Number of failed actions. */
+    totalFailure?: number;
+}
+interface GenerateUnsubscribeLinkRequest {
+    /**
+     * Email address the unsubscribe link is for.
+     * @format EMAIL
+     */
+    emailAddress: string;
+    /** Arbitrary parameters for closing-the-loop. */
+    metadata?: Record<string, string>;
+    /**
+     * Language for displaying unsubscribe confirmation page.
+     *
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     *
+     * Default: `EN`
+     * @format LANGUAGE
+     */
+    language?: string | null;
+}
+interface GenerateUnsubscribeLinkResponse {
+    /** The unsubscribe link. */
+    link?: string;
+}
+interface RenderUnsubscribePageRequest {
+    /** Payload */
+    payload?: string;
+    /** Language */
+    language?: string | null;
+}
+interface RawHttpResponse {
+    body?: Uint8Array;
+    statusCode?: number | null;
+    headers?: HeadersEntry[];
+}
+interface HeadersEntry {
+    key?: string;
+    value?: string;
+}
+interface ConfirmUnsubscribeActionRequest {
+    /** Payload */
+    payload?: string;
+}
+interface Empty {
+}
+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';
+interface V1RenderUnsubscribePageRequest {
+    /** Payload */
+    payload?: string;
+    /** Language */
+    language?: string | null;
+}
+interface V1ConfirmUnsubscribeActionRequest {
+    /** Payload */
+    payload?: string;
+}
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EmailsubscriptionEmailSubscriptionChangedEnvelope {
+    data: EmailSubscriptionChanged;
+    metadata: BaseEventMetadata;
+}
+/** @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Email Subscriptions
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
+ * @permissionId EMAIL_SUBSCRIPTIONS.VIEW
+ * @webhook
+ * @eventType com.wixpress.emailsubscriptions.v1.EmailSubscriptionChanged
+ * @serviceIdentifier com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService
+ * @slug email_subscription_changed
+ * @documentationMaturity preview
+ */
+declare function onEmailsubscriptionEmailSubscriptionChanged(handler: (event: EmailsubscriptionEmailSubscriptionChangedEnvelope) => void | Promise<void>): void;
+/**
+ * Get Email Subscription
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId EMAIL_SUBSCRIPTIONS.VIEW
+ * @applicableIdentity APP
+ * @returns Returned email subscription
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GetEmailSubscription
+ */
+declare function getEmailSubscription(_id: string): Promise<NonNullablePaths<EmailSubscription, `email` | `subscriptionStatus` | `deliverabilityStatus`, 2>>;
+/**
+ * Retrieves email subscriptions,
+ * given the provided paging, filtering, and sorting.
+ *
+ * Currently, querying is supported on the `email` field
+ * with the `$in` array filter.
+ * For example, to query for emails `"me@my.com"` and `"you@your.org"`,
+ * the filter should be formed like this:
+ *
+ * ```json
+ * { "filter": {
+ * "email": {
+ * "$in": ["me@my.com", "you@your.org"]
+ * }
+ * }
+ * }
+ * ```
+ *
+ * To learn how to query email subscriptions, see
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+ * @param filter - Filter options.
+ * Currently, querying is supported on the `email` field
+ * with the `$in` array filter.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField filter
+ * @permissionId EMAIL_SUBSCRIPTIONS.VIEW
+ * @applicableIdentity APP
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.QueryEmailSubscriptions
+ */
+declare function queryEmailSubscriptions(filter: Record<string, any>, options?: QueryEmailSubscriptionsOptions): Promise<NonNullablePaths<QueryEmailSubscriptionsResponse, `subscriptions` | `subscriptions.${number}.email` | `subscriptions.${number}.subscriptionStatus` | `subscriptions.${number}.deliverabilityStatus`, 4>>;
+interface QueryEmailSubscriptionsOptions {
+    /**
+     * Pagination options. For more information, see
+     * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
+     */
+    paging?: Paging;
+}
+/**
+ * Updates or creates an email subscription for the requested email.
+ *
+ * An email subscription is returned in the response
+ * whether it was updated or created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.subscription.email
+ * @permissionId EMAIL_SUBSCRIPTIONS.MODIFY
+ * @applicableIdentity APP
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.UpsertEmailSubscription
+ */
+declare function upsertEmailSubscription(options?: NonNullablePaths<UpsertEmailSubscriptionOptions, `subscription.email`, 3>): Promise<NonNullablePaths<UpsertEmailSubscriptionResponse, `subscription.email` | `subscription.subscriptionStatus` | `subscription.deliverabilityStatus`, 3>>;
+interface UpsertEmailSubscriptionOptions {
+    /** Email subscription to update or create. */
+    subscription?: EmailSubscription;
+}
+/**
+ * Updates or creates multiple email subscriptions.
+ * @param subscriptions - List of email subscriptions to update or create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField subscriptions
+ * @permissionId EMAIL_SUBSCRIPTIONS.MODIFY
+ * @applicableIdentity APP
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.BulkUpsertEmailSubscription
+ */
+declare function bulkUpsertEmailSubscription(subscriptions: EmailSubscription[]): Promise<NonNullablePaths<BulkUpsertEmailSubscriptionResponse, `results` | `results.${number}.originalIndex` | `results.${number}.emailSubscription.email` | `results.${number}.emailSubscription.subscriptionStatus` | `results.${number}.emailSubscription.deliverabilityStatus` | `results.${number}.error.errorCode` | `results.${number}.error.message` | `metadata.totalSuccess` | `metadata.totalFailure`, 5>>;
+/**
+ * Creates an unsubscribe link to be shared with the relevant recipient.
+ *
+ * If someone clicks the **Unsubscribe** button on the confirmation page,
+ * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.
+ * @param emailAddress - Email address the unsubscribe link is for.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField emailAddress
+ * @permissionId EMAIL_SUBSCRIPTIONS.VIEW
+ * @applicableIdentity APP
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GenerateUnsubscribeLink
+ */
+declare function generateUnsubscribeLink(emailAddress: string, options?: GenerateUnsubscribeLinkOptions): Promise<NonNullablePaths<GenerateUnsubscribeLinkResponse, `link`, 2>>;
+interface GenerateUnsubscribeLinkOptions {
+    /** Arbitrary parameters for closing-the-loop. */
+    metadata?: Record<string, string>;
+    /**
+     * Language for displaying unsubscribe confirmation page.
+     *
+     * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+     *
+     * Default: `EN`
+     * @format LANGUAGE
+     */
+    language?: string | null;
+}
+
+export { type ActionEvent, type BaseEventMetadata, type BulkUpsertEmailSubscriptionRequest, type BulkUpsertEmailSubscriptionResponse, type BulkUpsertEmailSubscriptionResult, type ConfirmUnsubscribeActionRequest, type DomainEvent, type DomainEventBodyOneOf, type EmailSubscription, type EmailSubscriptionChanged, type EmailsubscriptionEmailSubscriptionChangedEnvelope, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Error, type GenerateUnsubscribeLinkOptions, type GenerateUnsubscribeLinkRequest, type GenerateUnsubscribeLinkResponse, type GetEmailSubscriptionRequest, type GetEmailSubscriptionResponse, type HeadersEntry, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type Metadata, type Paging, type PagingMetadata, type QueryEmailSubscriptionsOptions, type QueryEmailSubscriptionsRequest, type QueryEmailSubscriptionsResponse, type RawHttpResponse, type RenderUnsubscribePageRequest, type RestoreInfo, Status, type StatusWithLiterals, SubscriptionEnumStatus, type SubscriptionEnumStatusWithLiterals, type UpdateEmailSubscriptionRequest, type UpdateEmailSubscriptionResponse, type UpsertEmailSubscriptionOptions, type UpsertEmailSubscriptionRequest, type UpsertEmailSubscriptionResponse, type V1ConfirmUnsubscribeActionRequest, type V1RenderUnsubscribePageRequest, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, bulkUpsertEmailSubscription, generateUnsubscribeLink, getEmailSubscription, onEmailsubscriptionEmailSubscriptionChanged, queryEmailSubscriptions, upsertEmailSubscription };