@wix/auto_sdk_email-subscriptions_email-subscriptions 1.0.4 → 1.0.6

package/build/{internal/cjs/src/emailsubscriptions-v1-emailsubscription-email-subscriptions.universal.d.ts → es/index.typings.d.mts}

@@ -1,4 +1,6 @@
-export interface EmailSubscription {
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface EmailSubscription {
     /**
      * Email subscription ID.
      * @format GUID
@@ -22,7 +24,7 @@ export interface EmailSubscription {
      *
      * Defaults to `NOT_SET`.
      */
-    subscriptionStatus?: SubscriptionEnumStatus;
+    subscriptionStatus?: SubscriptionEnumStatusWithLiterals;
     /**
      * Indicates last reported status of sent emails.
      *
@@ -36,7 +38,7 @@ export interface EmailSubscription {
      *
      * Defaults to `NOT_SET`.
      */
-    deliverabilityStatus?: Status;
+    deliverabilityStatus?: StatusWithLiterals;
     /**
      * Date and time the email subscription was created.
      * @readonly
@@ -48,7 +50,7 @@ export interface EmailSubscription {
      */
     _updatedDate?: Date | null;
 }
-export declare enum SubscriptionEnumStatus {
+declare enum SubscriptionEnumStatus {
     UNKNOWN = "UNKNOWN",
     /** No Subscription exists */
     NOT_SET = "NOT_SET",
@@ -59,7 +61,9 @@ export declare enum SubscriptionEnumStatus {
     /** UnSubscribed */
     UNSUBSCRIBED = "UNSUBSCRIBED"
 }
-export declare enum Status {
+/** @enumType */
+type SubscriptionEnumStatusWithLiterals = SubscriptionEnumStatus | 'UNKNOWN' | 'NOT_SET' | 'PENDING' | 'SUBSCRIBED' | 'UNSUBSCRIBED';
+declare enum Status {
     NOT_SET = "NOT_SET",
     /** valid/deferral */
     VALID = "VALID",
@@ -70,28 +74,30 @@ export declare enum Status {
     /** 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. */
-export interface EmailSubscriptionChanged {
+interface EmailSubscriptionChanged {
     /** Email subscription that changed. */
     subscription?: EmailSubscription;
 }
-export interface GetEmailSubscriptionRequest {
+interface GetEmailSubscriptionRequest {
     /** @format GUID */
     _id: string;
 }
-export interface GetEmailSubscriptionResponse {
+interface GetEmailSubscriptionResponse {
     /** Returned email subscription */
     emailSubscription?: EmailSubscription;
 }
-export interface UpdateEmailSubscriptionRequest {
+interface UpdateEmailSubscriptionRequest {
     /** Email subscription to update */
     subscription?: EmailSubscription;
 }
-export interface UpdateEmailSubscriptionResponse {
+interface UpdateEmailSubscriptionResponse {
     /** Updated email subscription */
     subscription?: EmailSubscription;
 }
-export interface QueryEmailSubscriptionsRequest {
+interface QueryEmailSubscriptionsRequest {
     /**
      * Filter options.
      * Currently, querying is supported on the `email` field
@@ -104,19 +110,19 @@ export interface QueryEmailSubscriptionsRequest {
      */
     paging?: Paging;
 }
-export interface Paging {
+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 {
+interface QueryEmailSubscriptionsResponse {
     /** List of subscribed emails that matched the query options. */
     subscriptions?: EmailSubscription[];
     /** Metadata for the paginated results. */
     metadata?: PagingMetadata;
 }
-export interface PagingMetadata {
+interface PagingMetadata {
     /** Number of items returned in the response. */
     count?: number | null;
     /** Offset that was requested. */
@@ -126,15 +132,15 @@ export interface PagingMetadata {
     /** Flag that indicates the server failed to calculate the `total` field. */
     tooManyToCount?: boolean | null;
 }
-export interface UpsertEmailSubscriptionRequest {
+interface UpsertEmailSubscriptionRequest {
     /** Email subscription to update or create. */
     subscription?: EmailSubscription;
 }
-export interface UpsertEmailSubscriptionResponse {
+interface UpsertEmailSubscriptionResponse {
     /** Updated or created email subscription. */
     subscription?: EmailSubscription;
 }
-export interface BulkUpsertEmailSubscriptionRequest {
+interface BulkUpsertEmailSubscriptionRequest {
     /**
      * List of email subscriptions to update or create.
      * @minSize 1
@@ -142,13 +148,13 @@ export interface BulkUpsertEmailSubscriptionRequest {
      */
     subscriptions: EmailSubscription[];
 }
-export interface BulkUpsertEmailSubscriptionResponse {
+interface BulkUpsertEmailSubscriptionResponse {
     /** List of updated or created email subscriptions. */
     results?: BulkUpsertEmailSubscriptionResult[];
     /** Numbers of successful and failed actions. */
     metadata?: Metadata;
 }
-export interface BulkUpsertEmailSubscriptionResult {
+interface BulkUpsertEmailSubscriptionResult {
     /** Position of the requested email subscription in the bulk array. */
     originalIndex?: number;
     /** New or updated email subscription. */
@@ -159,19 +165,19 @@ export interface BulkUpsertEmailSubscriptionResult {
      */
     error?: Error;
 }
-export interface Error {
+interface Error {
     /** Error code. */
     errorCode?: string;
     /** Message that contains details about the error. */
     message?: string;
 }
-export interface Metadata {
+interface Metadata {
     /** Number of successful actions. */
     totalSuccess?: number;
     /** Number of failed actions. */
     totalFailure?: number;
 }
-export interface GenerateUnsubscribeLinkRequest {
+interface GenerateUnsubscribeLinkRequest {
     /**
      * Email address the unsubscribe link is for.
      * @format EMAIL
@@ -189,55 +195,51 @@ export interface GenerateUnsubscribeLinkRequest {
      */
     language?: string | null;
 }
-export interface GenerateUnsubscribeLinkResponse {
+interface GenerateUnsubscribeLinkResponse {
     /** The unsubscribe link. */
     link?: string;
 }
-export interface RenderUnsubscribePageRequest {
+interface RenderUnsubscribePageRequest {
     /** Payload */
     payload?: string;
     /** Language */
     language?: string | null;
 }
-export interface RawHttpResponse {
+interface RawHttpResponse {
     body?: Uint8Array;
     statusCode?: number | null;
     headers?: HeadersEntry[];
 }
-export interface HeadersEntry {
+interface HeadersEntry {
     key?: string;
     value?: string;
 }
-export interface ConfirmUnsubscribeActionRequest {
+interface ConfirmUnsubscribeActionRequest {
     /** Payload */
     payload?: string;
 }
-export interface Empty {
+interface Empty {
 }
-export interface DomainEvent extends DomainEventBodyOneOf {
+interface DomainEvent extends DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     * 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;
     /**
-     * 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
+     * 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 */
+    /** 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
@@ -247,29 +249,25 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     /** 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.
+     * 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 */
-export interface DomainEventBodyOneOf {
+interface DomainEventBodyOneOf {
     createdEvent?: EntityCreatedEvent;
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
 }
-export interface EntityCreatedEvent {
+interface EntityCreatedEvent {
     entity?: string;
 }
-export interface RestoreInfo {
+interface RestoreInfo {
     deletedDate?: Date | null;
 }
-export interface EntityUpdatedEvent {
+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.
@@ -277,14 +275,14 @@ export interface EntityUpdatedEvent {
      */
     currentEntity?: string;
 }
-export interface EntityDeletedEvent {
-    /** Entity that was deleted */
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
-export interface ActionEvent {
+interface ActionEvent {
     body?: string;
 }
-export interface MessageEnvelope {
+interface MessageEnvelope {
     /**
      * App instance ID.
      * @format GUID
@@ -300,7 +298,7 @@ export interface MessageEnvelope {
     /** Stringify payload. */
     data?: string;
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -322,10 +320,10 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
      */
     appId?: string;
     /** @readonly */
-    identityType?: WebhookIdentityType;
+    identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -347,58 +345,26 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
-export declare enum WebhookIdentityType {
+declare enum WebhookIdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface V1RenderUnsubscribePageRequest {
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface V1RenderUnsubscribePageRequest {
     /** Payload */
     payload?: string;
     /** Language */
     language?: string | null;
 }
-export interface V1ConfirmUnsubscribeActionRequest {
+interface V1ConfirmUnsubscribeActionRequest {
     /** Payload */
     payload?: string;
 }
-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 {
+interface BaseEventMetadata {
     /**
      * App instance ID.
      * @format GUID
@@ -412,11 +378,13 @@ export interface BaseEventMetadata {
     /** The identification type and identity data. */
     identity?: IdentificationData;
 }
-export interface EmailsubscriptionEmailSubscriptionChangedEnvelope {
+interface EmailsubscriptionEmailSubscriptionChangedEnvelope {
     data: EmailSubscriptionChanged;
     metadata: BaseEventMetadata;
 }
-/** @permissionScope Manage Email Subscriptions
+/** @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Manage Email Subscriptions
  * @permissionScopeId SCOPE.DC-MANAGE.EMAIL-SUBSCRIPTIONS
  * @permissionId EMAIL_SUBSCRIPTIONS.VIEW
  * @webhook
@@ -425,20 +393,7 @@ export interface EmailsubscriptionEmailSubscriptionChangedEnvelope {
  * @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>;
+declare function onEmailsubscriptionEmailSubscriptionChanged(handler: (event: EmailsubscriptionEmailSubscriptionChangedEnvelope) => void | Promise<void>): void;
 /**
  * Retrieves email subscriptions,
  * given the provided paging, filtering, and sorting.
@@ -466,13 +421,11 @@ export declare function getEmailSubscription(_id: string): Promise<EmailSubscrip
  * @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 {
+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).
@@ -488,13 +441,11 @@ export interface QueryEmailSubscriptionsOptions {
  * @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 {
+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;
 }
@@ -505,12 +456,10 @@ export interface UpsertEmailSubscriptionOptions {
  * @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>;
+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.
  *
@@ -521,13 +470,11 @@ export declare function bulkUpsertEmailSubscription(subscriptions: EmailSubscrip
  * @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 {
+declare function generateUnsubscribeLink(emailAddress: string, options?: GenerateUnsubscribeLinkOptions): Promise<NonNullablePaths<GenerateUnsubscribeLinkResponse, `link`, 2>>;
+interface GenerateUnsubscribeLinkOptions {
     /** Arbitrary parameters for closing-the-loop. */
     metadata?: Record<string, string>;
     /**
@@ -540,4 +487,5 @@ export interface GenerateUnsubscribeLinkOptions {
      */
     language?: string | null;
 }
-export {};
+
+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, onEmailsubscriptionEmailSubscriptionChanged, queryEmailSubscriptions, upsertEmailSubscription };