@wix/auto_sdk_email-subscriptions_email-subscriptions 1.0.0

package/build/internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.d.ts

@@ -0,0 +1,468 @@
+export interface EmailSubscription {
+    /**
+     * Email subscription ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** Email address. */
+    email?: string;
+    /**
+     * Indicates the recipient's opt-in or opt-out status
+     * for marketing emails.
+     *
+     * Default: `NOT_SET`.
+     */
+    subscriptionStatus?: SubscriptionEnumStatus;
+    /**
+     * Indicates last reported status of sent emails.
+     *
+     * Default: `NOT_SET`.
+     */
+    deliverabilityStatus?: Status;
+    /**
+     * 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;
+}
+export declare enum SubscriptionEnumStatus {
+    /** Undefined status. */
+    UNKNOWN = "UNKNOWN",
+    /** No status specified. This is the default, initial value before any info about the email address is known. */
+    NOT_SET = "NOT_SET",
+    /** Subscription confirmation was requested, but recipient hasn't confirmed yet. */
+    PENDING = "PENDING",
+    /** Recipient has opted in to marketing emails. */
+    SUBSCRIBED = "SUBSCRIBED",
+    /** Recipient has opted out of marketing emails. */
+    UNSUBSCRIBED = "UNSUBSCRIBED"
+}
+export declare enum Status {
+    /** No status specified. This is the initial default value before any info about the email address is known. */
+    NOT_SET = "NOT_SET",
+    /** Emails to this email address are being delivered successfully. */
+    VALID = "VALID",
+    /** The last email to the recipient bounced or was rejected. */
+    BOUNCED = "BOUNCED",
+    /** The recipient registered a spam complaint with their email provider. */
+    SPAM_COMPLAINT = "SPAM_COMPLAINT",
+    /** 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. */
+    INACTIVE = "INACTIVE"
+}
+export interface V1RenderUnsubscribePageRequest {
+    /** Payload */
+    payload?: string;
+    /** Language */
+    language?: string | null;
+}
+export interface RawHttpResponse {
+    body?: Uint8Array;
+    statusCode?: number | null;
+    headers?: HeadersEntry[];
+}
+export interface HeadersEntry {
+    key?: string;
+    value?: string;
+}
+export interface V1ConfirmUnsubscribeActionRequest {
+    /** Payload */
+    payload?: string;
+}
+export interface Empty {
+}
+export interface EmailSubscriptionChanged {
+    /** subscription */
+    subscription?: EmailSubscription;
+}
+export interface GetEmailSubscriptionRequest {
+    _id: string;
+}
+export interface GetEmailSubscriptionResponse {
+    /** Returned email subscription */
+    emailSubscription?: EmailSubscription;
+}
+export interface UpdateEmailSubscriptionRequest {
+    /** Email subscription to update */
+    subscription?: EmailSubscription;
+}
+export interface UpdateEmailSubscriptionResponse {
+    /** Updated email subscription */
+    subscription?: EmailSubscription;
+}
+export 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;
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface QueryEmailSubscriptionsResponse {
+    /** List of subscribed emails that matched the query options. */
+    subscriptions?: EmailSubscription[];
+    /** Metadata for the paginated results. */
+    metadata?: PagingMetadata;
+}
+export 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;
+}
+export interface UpsertEmailSubscriptionRequest {
+    /** Email subscription to update or create. */
+    subscription?: EmailSubscription;
+}
+export interface UpsertEmailSubscriptionResponse {
+    /** Updated or created email subscription. */
+    subscription?: EmailSubscription;
+}
+export interface BulkUpsertEmailSubscriptionRequest {
+    /** List of email subscriptions to update or create. */
+    subscriptions: EmailSubscription[];
+}
+export interface BulkUpsertEmailSubscriptionResponse {
+    /** List of updated or created email subscriptions. */
+    results?: BulkUpsertEmailSubscriptionResult[];
+    /** Numbers of successful and failed actions. */
+    metadata?: Metadata;
+}
+export 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;
+}
+export interface Error {
+    /** Error code. */
+    errorCode?: string;
+    /** Message that contains details about the error. */
+    message?: string;
+}
+export interface Metadata {
+    /** Number of successful actions. */
+    totalSuccess?: number;
+    /** Number of failed actions. */
+    totalFailure?: number;
+}
+export interface GenerateUnsubscribeLinkRequest {
+    /** Email address the unsubscribe link is for. */
+    emailAddress: string;
+    /** Arbitrary parameters for closing-the-loop. */
+    metadata?: Record<string, string>;
+    /** Language for displaying unsubscribe confirmation page (optional - default EN). */
+    language?: string | null;
+}
+export interface GenerateUnsubscribeLinkResponse {
+    /** The unsubscribe link. */
+    link?: string;
+}
+export interface RenderUnsubscribePageRequest {
+    /** Payload */
+    payload?: string;
+    /** Language */
+    language?: string | null;
+}
+export interface ConfirmUnsubscribeActionRequest {
+    /** Payload */
+    payload?: string;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entity?: string;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export 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;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntity?: string | null;
+}
+export interface ActionEvent {
+    body?: string;
+}
+export interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export interface EmailSubscriptionNonNullableFields {
+    email: string;
+    subscriptionStatus: SubscriptionEnumStatus;
+    deliverabilityStatus: Status;
+}
+export interface GetEmailSubscriptionResponseNonNullableFields {
+    emailSubscription?: EmailSubscriptionNonNullableFields;
+}
+export interface QueryEmailSubscriptionsResponseNonNullableFields {
+    subscriptions: EmailSubscriptionNonNullableFields[];
+}
+export interface UpsertEmailSubscriptionResponseNonNullableFields {
+    subscription?: EmailSubscriptionNonNullableFields;
+}
+interface ErrorNonNullableFields {
+    errorCode: string;
+    message: string;
+}
+interface BulkUpsertEmailSubscriptionResultNonNullableFields {
+    originalIndex: number;
+    emailSubscription?: EmailSubscriptionNonNullableFields;
+    error?: ErrorNonNullableFields;
+}
+interface MetadataNonNullableFields {
+    totalSuccess: number;
+    totalFailure: number;
+}
+export interface BulkUpsertEmailSubscriptionResponseNonNullableFields {
+    results: BulkUpsertEmailSubscriptionResultNonNullableFields[];
+    metadata?: MetadataNonNullableFields;
+}
+export interface GenerateUnsubscribeLinkResponseNonNullableFields {
+    link: string;
+}
+export interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+export interface EmailsubscriptionEmailSubscriptionChangedEnvelope {
+    data: EmailSubscriptionChanged;
+    metadata: BaseEventMetadata;
+}
+/** @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
+ */
+export declare function onEmailsubscriptionEmailSubscriptionChanged(handler: (event: EmailsubscriptionEmailSubscriptionChangedEnvelope) => void | Promise<void>): void;
+/**
+ * Get Email Subscription
+ * @internal
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @permissionId EMAIL_SUBSCRIPTIONS.VIEW
+ * @permissionScope Manage Email Subscriptions
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
+ * @applicableIdentity APP
+ * @returns Returned email subscription
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GetEmailSubscription
+ */
+export declare function getEmailSubscription(_id: string): Promise<EmailSubscription & EmailSubscriptionNonNullableFields>;
+/**
+ * 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
+ * @permissionScope Manage Email Subscriptions
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.QueryEmailSubscriptions
+ */
+export declare function queryEmailSubscriptions(filter: Record<string, any> | null, options?: QueryEmailSubscriptionsOptions): Promise<QueryEmailSubscriptionsResponse & QueryEmailSubscriptionsResponseNonNullableFields>;
+export 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 always returned in the response,
+ * regardless of whether it was updated or created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.subscription.email
+ * @permissionId EMAIL_SUBSCRIPTIONS.MODIFY
+ * @permissionScope Manage Email Subscriptions
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.UpsertEmailSubscription
+ */
+export declare function upsertEmailSubscription(options?: UpsertEmailSubscriptionOptions): Promise<UpsertEmailSubscriptionResponse & UpsertEmailSubscriptionResponseNonNullableFields>;
+export 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
+ * @permissionScope Manage Email Subscriptions
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.BulkUpsertEmailSubscription
+ */
+export declare function bulkUpsertEmailSubscription(subscriptions: EmailSubscription[]): Promise<BulkUpsertEmailSubscriptionResponse & BulkUpsertEmailSubscriptionResponseNonNullableFields>;
+/**
+ * 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
+ * @permissionScope Manage Email Subscriptions
+ * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.emailsubscriptions.v1.EmailSubscriptionsService.GenerateUnsubscribeLink
+ */
+export declare function generateUnsubscribeLink(emailAddress: string, options?: GenerateUnsubscribeLinkOptions): Promise<GenerateUnsubscribeLinkResponse & GenerateUnsubscribeLinkResponseNonNullableFields>;
+export interface GenerateUnsubscribeLinkOptions {
+    /** Arbitrary parameters for closing-the-loop. */
+    metadata?: Record<string, string>;
+    /** Language for displaying unsubscribe confirmation page (optional - default EN). */
+    language?: string | null;
+}
+export {};