@wix/auto_sdk_email-marketing_campaigns 1.0.11 → 1.0.13

package/build/internal/es/src/email-marketing-v1-campaign-campaigns.universal.d.ts

@@ -1,3 +1,4 @@
+import { NonNullablePaths } from '@wix/sdk-types';
 export interface Campaign {
     /**
      * Campaign ID.
@@ -196,117 +197,6 @@ export declare enum CampaignTypeEnum {
     /** Triggered email. */
     TRIGGERED = "TRIGGERED"
 }
-export interface ListStatisticsRequest {
-    /**
-     * IDs of the campaigns to retrieve (max 100 campaigns).
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
-     */
-    campaignIds: string[];
-}
-export interface ListStatisticsResponse {
-    /** List of statistics. */
-    statistics?: CampaignStatisticsContainer[];
-}
-export interface CampaignStatisticsContainer {
-    /**
-     * Campaign ID.
-     * @format GUID
-     */
-    campaignId?: string;
-    /** Landing page statistics. */
-    landingPage?: LandingPageStatistics;
-    /** Email campaign statistics. */
-    email?: DistributionStatistics;
-}
-export interface ListRecipientsRequest {
-    /**
-     * Campaign ID.
-     * @format GUID
-     */
-    campaignId: string;
-    /** Email activity to filter. */
-    activity: RecipientsActivityEnum;
-    /** Pagination options. */
-    paging?: CursorPaging;
-}
-export declare enum RecipientsActivityEnum {
-    UNKNOWN = "UNKNOWN",
-    DELIVERED = "DELIVERED",
-    OPENED = "OPENED",
-    CLICKED = "CLICKED",
-    BOUNCED = "BOUNCED",
-    NOT_SENT = "NOT_SENT",
-    SENT = "SENT",
-    NOT_OPENED = "NOT_OPENED"
-}
-export interface CursorPaging {
-    /**
-     * Number of items to load.
-     * @max 1000
-     */
-    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.
-     */
-    cursor?: string | null;
-}
-export interface ListRecipientsResponse {
-    /** List of recipients. */
-    recipients?: CampaignRecipientDetails[];
-    /** Details on the paged set of returned results. */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface CampaignRecipientDetails {
-    /**
-     * Contact ID.
-     * @format GUID
-     */
-    contactId?: string;
-    /** Date and time of the last activity. */
-    lastActivityDate?: Date | null;
-    /**
-     * Primary email address of the contact.
-     * @format EMAIL
-     */
-    emailAddress?: string;
-    /**
-     * Full name of the contact (optional).
-     * @maxLength 100
-     */
-    fullName?: string | null;
-    /** Is this contact currently deleted from the site or not. */
-    contactDeleted?: boolean;
-}
-export interface PagingMetadataV2 {
-    /** 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. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
-}
-export interface Cursors {
-    /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
-     */
-    next?: string | null;
-    /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
-     */
-    prev?: string | null;
-}
 export interface GetCampaignMappingRequest {
     /**
      * rule ID in automations
@@ -549,6 +439,117 @@ export interface Decimal {
 }
 export interface SendTestBulkResponse {
 }
+export interface ListStatisticsRequest {
+    /**
+     * IDs of the campaigns to retrieve (max 100 campaigns).
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    campaignIds: string[];
+}
+export interface ListStatisticsResponse {
+    /** List of statistics. */
+    statistics?: CampaignStatisticsContainer[];
+}
+export interface CampaignStatisticsContainer {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+    /** Landing page statistics. */
+    landingPage?: LandingPageStatistics;
+    /** Email campaign statistics. */
+    email?: DistributionStatistics;
+}
+export interface ListRecipientsRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+    /** Email activity to filter. */
+    activity: RecipientsActivityEnum;
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
+export declare enum RecipientsActivityEnum {
+    UNKNOWN = "UNKNOWN",
+    DELIVERED = "DELIVERED",
+    OPENED = "OPENED",
+    CLICKED = "CLICKED",
+    BOUNCED = "BOUNCED",
+    NOT_SENT = "NOT_SENT",
+    SENT = "SENT",
+    NOT_OPENED = "NOT_OPENED"
+}
+export interface CursorPaging {
+    /**
+     * Number of items to load.
+     * @max 1000
+     */
+    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.
+     */
+    cursor?: string | null;
+}
+export interface ListRecipientsResponse {
+    /** List of recipients. */
+    recipients?: CampaignRecipientDetails[];
+    /** Details on the paged set of returned results. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface CampaignRecipientDetails {
+    /**
+     * Contact ID.
+     * @format GUID
+     */
+    contactId?: string;
+    /** Date and time of the last activity. */
+    lastActivityDate?: Date | null;
+    /**
+     * Primary email address of the contact.
+     * @format EMAIL
+     */
+    emailAddress?: string;
+    /**
+     * Full name of the contact (optional).
+     * @maxLength 100
+     */
+    fullName?: string | null;
+    /** Is this contact currently deleted from the site or not. */
+    contactDeleted?: boolean;
+}
+export interface PagingMetadataV2 {
+    /** 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. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
 export interface GetCampaignRequest {
     /**
      * Campaign ID.
@@ -1117,25 +1118,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     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
@@ -1145,12 +1142,8 @@ 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;
 }
@@ -1176,7 +1169,7 @@ export interface EntityUpdatedEvent {
     currentEntity?: string;
 }
 export interface EntityDeletedEvent {
-    /** Entity that was deleted */
+    /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
 export interface ActionEvent {
@@ -1437,94 +1430,6 @@ export interface SubscribeFromLandingPageResponse {
     /** @format GUID */
     contactId?: string;
 }
-interface LandingPageStatisticsNonNullableFields {
-    opened: number;
-    clicked: number;
-}
-interface DistributionStatisticsNonNullableFields {
-    delivered: number;
-    opened: number;
-    clicked: number;
-    bounced: number;
-    complained: number;
-    notSent: number;
-}
-interface CampaignStatisticsContainerNonNullableFields {
-    campaignId: string;
-    landingPage?: LandingPageStatisticsNonNullableFields;
-    email?: DistributionStatisticsNonNullableFields;
-}
-export interface ListStatisticsResponseNonNullableFields {
-    statistics: CampaignStatisticsContainerNonNullableFields[];
-}
-interface CampaignRecipientDetailsNonNullableFields {
-    contactId: string;
-    emailAddress: string;
-    contactDeleted: boolean;
-}
-export interface ListRecipientsResponseNonNullableFields {
-    recipients: CampaignRecipientDetailsNonNullableFields[];
-}
-interface TotalStatisticsNonNullableFields {
-    mailsSent: number;
-    opened: number;
-    clicked: number;
-}
-interface CampaignStatisticsNonNullableFields {
-    landingPage?: LandingPageStatisticsNonNullableFields;
-    emailCampaign?: DistributionStatisticsNonNullableFields;
-    total?: TotalStatisticsNonNullableFields;
-}
-interface PublishingDataNonNullableFields {
-    landingPageUrl: string;
-    statistics?: CampaignStatisticsNonNullableFields;
-    wasResentToNonOpeners: boolean;
-}
-interface RejectionDataNonNullableFields {
-    rejectionReasons: RejectionReasonEnum[];
-}
-export interface CampaignNonNullableFields {
-    campaignId: string;
-    editorType: CampaignEditorTypeEnum;
-    status: CampaignStatusEnum;
-    visibilityStatus: CampaignVisibilityStatusEnum;
-    distributionStatus: Enum;
-    publishingData?: PublishingDataNonNullableFields;
-    rejectionData?: RejectionDataNonNullableFields;
-    sendingState: CampaignSendingStateEnum;
-    campaignType: CampaignTypeEnum;
-    emailSubject: string;
-}
-export interface GetCampaignResponseNonNullableFields {
-    campaign?: CampaignNonNullableFields;
-}
-export interface ListCampaignsResponseNonNullableFields {
-    campaigns: CampaignNonNullableFields[];
-}
-export interface PublishCampaignResponseNonNullableFields {
-    publishingData?: PublishingDataNonNullableFields;
-}
-export interface ReuseCampaignResponseNonNullableFields {
-    campaign?: CampaignNonNullableFields;
-}
-interface CampaignAudienceNonNullableFields {
-    contactIds: string[];
-    labelIds: string[];
-    segmentIds: string[];
-    activeContactsOnly: boolean;
-}
-export interface GetAudienceResponseNonNullableFields {
-    audience?: CampaignAudienceNonNullableFields;
-}
-export interface IdentifySenderAddressResponseNonNullableFields {
-    senderAddress: string;
-}
-export interface ValidateLinkResponseNonNullableFields {
-    valid: boolean;
-}
-export interface ValidateHtmlLinksResponseNonNullableFields {
-    blacklistedLinks: string[];
-}
 export interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -1540,25 +1445,21 @@ export interface BaseEventMetadata {
     identity?: IdentificationData;
 }
 export interface EventMetadata extends BaseEventMetadata {
-    /**
-     * 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
@@ -1568,12 +1469,8 @@ export interface EventMetadata extends BaseEventMetadata {
     /** 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;
 }
@@ -1583,6 +1480,8 @@ export interface CampaignDistributedEnvelope {
 }
 /**
  * Triggered when a campaign is successfully distributed to all recipients.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1604,6 +1503,8 @@ export interface CampaignPausedEnvelope {
 }
 /**
  * Triggered when a scheduled campaign is paused.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1625,6 +1526,8 @@ export interface CampaignPublishedEnvelope {
 }
 /**
  * Triggered when a draft campaign is published.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1646,6 +1549,8 @@ export interface CampaignRejectedEnvelope {
 }
 /**
  * Triggered when a campaign is identified as abusive and rejected without sending emails to recipients.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1667,6 +1572,8 @@ export interface CampaignScheduledEnvelope {
 }
 /**
  * Triggered when a campaign is scheduled to be sent out at the specific time.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1688,6 +1595,8 @@ export interface CampaignTerminatedEnvelope {
 }
 /**
  * Triggered when the mailing list isn't clean and campaign was terminated.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1709,6 +1618,8 @@ export interface CampaignCreatedEnvelope {
 }
 /**
  * Triggered when a campaign is created.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1729,6 +1640,8 @@ export interface CampaignDeletedEnvelope {
 }
 /**
  * Triggered when a campaign is deleted.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1750,6 +1663,8 @@ export interface CampaignEmailActivityUpdatedEnvelope {
 }
 /**
  * Triggered when an email campaign has a new recipient activity.
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1765,6 +1680,7 @@ export interface CampaignEmailActivityUpdatedEnvelope {
  * @slug email_activity_updated
  */
 export declare function onCampaignEmailActivityUpdated(handler: (event: CampaignEmailActivityUpdatedEnvelope) => void | Promise<void>): void;
+type CampaignNonNullablePaths = `campaignId` | `editorType` | `status` | `visibilityStatus` | `distributionStatus` | `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked` | `emailSubject`;
 /**
  * Retrieves a list of statistics for up to 100 selected campaigns.
  *
@@ -1777,6 +1693,8 @@ export declare function onCampaignEmailActivityUpdated(handler: (event: Campaign
  * @public
  * @requiredField campaignIds
  * @permissionId Shoutout.Read
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1788,7 +1706,7 @@ export declare function onCampaignEmailActivityUpdated(handler: (event: Campaign
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics
  */
-export declare function listStatistics(campaignIds: string[]): Promise<ListStatisticsResponse & ListStatisticsResponseNonNullableFields>;
+export declare function listStatistics(campaignIds: string[]): Promise<NonNullablePaths<ListStatisticsResponse, `statistics` | `statistics.${number}.campaignId` | `statistics.${number}.landingPage.opened` | `statistics.${number}.landingPage.clicked` | `statistics.${number}.email.delivered` | `statistics.${number}.email.opened` | `statistics.${number}.email.clicked` | `statistics.${number}.email.bounced` | `statistics.${number}.email.complained` | `statistics.${number}.email.notSent`>>;
 /**
  * Retrieves a list of recipients for a selected campaign based on a specific recipient activity.
  *
@@ -1805,6 +1723,8 @@ export declare function listStatistics(campaignIds: string[]): Promise<ListStati
  * @requiredField campaignId
  * @param options - Options to use when getting the list of recipients.
  * @permissionId Shoutout.Read
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1816,7 +1736,7 @@ export declare function listStatistics(campaignIds: string[]): Promise<ListStati
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients
  */
-export declare function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise<ListRecipientsResponse & ListRecipientsResponseNonNullableFields>;
+export declare function listRecipients(campaignId: string, activity: RecipientsActivityEnum, options?: ListRecipientsOptions): Promise<NonNullablePaths<ListRecipientsResponse, `recipients` | `recipients.${number}.contactId` | `recipients.${number}.emailAddress` | `recipients.${number}.contactDeleted`>>;
 export interface ListRecipientsOptions {
     /** Pagination options. */
     paging?: CursorPaging;
@@ -1828,6 +1748,8 @@ export interface ListRecipientsOptions {
  * @requiredField campaignId
  * @param options - Options to use when getting a campaign.
  * @permissionId Shoutout.Manage
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1838,7 +1760,7 @@ export interface ListRecipientsOptions {
  * @returns Campaign information.
  * @fqn wix.emailmarketing.api.v1.CampaignService.Get
  */
-export declare function getCampaign(campaignId: string, options?: GetCampaignOptions): Promise<Campaign & CampaignNonNullableFields>;
+export declare function getCampaign(campaignId: string, options?: GetCampaignOptions): Promise<NonNullablePaths<Campaign, CampaignNonNullablePaths>>;
 export interface GetCampaignOptions {
     /**
      * Whether a returned campaign should include `publishingData.statistics`.
@@ -1854,6 +1776,8 @@ export interface GetCampaignOptions {
  * @public
  * @param options - Options to use when getting the list of campaigns.
  * @permissionId Shoutout.Read
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1865,7 +1789,9 @@ export interface GetCampaignOptions {
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.List
  */
-export declare function listCampaigns(options?: ListCampaignsOptions): Promise<ListCampaignsResponse & ListCampaignsResponseNonNullableFields>;
+export declare function listCampaigns(options?: ListCampaignsOptions): Promise<NonNullablePaths<ListCampaignsResponse, {
+    [P in CampaignNonNullablePaths]: `campaigns.${number}.${P}`;
+}[CampaignNonNullablePaths]>>;
 export interface ListCampaignsOptions {
     /** Paging parameters. */
     paging?: Paging;
@@ -1889,6 +1815,8 @@ export interface ListCampaignsOptions {
  * @requiredField campaignId
  * @param options - Options to use when publishing a campaign.
  * @permissionId Shoutout.Manage
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1898,7 +1826,7 @@ export interface ListCampaignsOptions {
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.Publish
  */
-export declare function publishCampaign(campaignId: string, options?: PublishCampaignOptions): Promise<PublishCampaignResponse & PublishCampaignResponseNonNullableFields>;
+export declare function publishCampaign(campaignId: string, options?: PublishCampaignOptions): Promise<NonNullablePaths<PublishCampaignResponse, `publishingData.landingPageUrl` | `publishingData.statistics.landingPage.opened` | `publishingData.statistics.landingPage.clicked` | `publishingData.statistics.emailCampaign.delivered` | `publishingData.statistics.emailCampaign.opened` | `publishingData.statistics.emailCampaign.clicked` | `publishingData.statistics.emailCampaign.bounced` | `publishingData.statistics.emailCampaign.complained` | `publishingData.statistics.emailCampaign.notSent` | `publishingData.statistics.total.mailsSent` | `publishingData.statistics.total.opened` | `publishingData.statistics.total.clicked`>>;
 export interface PublishCampaignOptions {
     /** Email distribution options. Pass this object in the request if you need to distribute your marketing campaign with emails. */
     emailDistributionOptions?: EmailDistributionOptions;
@@ -1913,6 +1841,8 @@ export interface PublishCampaignOptions {
  * @requiredField options.toEmailAddress
  * @param options - Options for sending a test email.
  * @permissionId Shoutout.Manage
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1922,7 +1852,7 @@ export interface PublishCampaignOptions {
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.SendTest
  */
-export declare function sendTest(campaignId: string, options?: SendTestOptions): Promise<void>;
+export declare function sendTest(campaignId: string, options?: NonNullablePaths<SendTestOptions, `toEmailAddress`>): Promise<void>;
 export interface SendTestOptions {
     /**
      * Email subject.
@@ -1941,6 +1871,8 @@ export interface SendTestOptions {
  * @public
  * @requiredField campaignId
  * @permissionId Shoutout.Manage
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1959,6 +1891,8 @@ export declare function pauseScheduling(campaignId: string): Promise<void>;
  * @requiredField campaignId
  * @requiredField sendAt
  * @permissionId Shoutout.Manage
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1968,13 +1902,15 @@ export declare function pauseScheduling(campaignId: string): Promise<void>;
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.Reschedule
  */
-export declare function reschedule(campaignId: string, sendAt: Date | null): Promise<void>;
+export declare function reschedule(campaignId: string, sendAt: Date): Promise<void>;
 /**
  * Permanently deletes a campaign.
  * @param campaignId - Campaign ID.
  * @public
  * @requiredField campaignId
  * @permissionId Shoutout.Manage
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -1991,6 +1927,8 @@ export declare function deleteCampaign(campaignId: string): Promise<void>;
  * @public
  * @requiredField campaignId
  * @permissionId Shoutout.Manage
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -2000,13 +1938,17 @@ export declare function deleteCampaign(campaignId: string): Promise<void>;
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.Reuse
  */
-export declare function reuseCampaign(campaignId: string): Promise<ReuseCampaignResponse & ReuseCampaignResponseNonNullableFields>;
+export declare function reuseCampaign(campaignId: string): Promise<NonNullablePaths<ReuseCampaignResponse, {
+    [P in CampaignNonNullablePaths]: `campaign.${P}`;
+}[CampaignNonNullablePaths]>>;
 /**
  * Retrieves the audience of a paused campaign. Use this method to retrieve all selected audience of the paused campaign at once, so they can be passed in bulk when the campaign is published again after being paused.
  * @param campaignId - Campaign ID.
  * @public
  * @requiredField campaignId
  * @permissionId Shoutout.Manage
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -2016,13 +1958,15 @@ export declare function reuseCampaign(campaignId: string): Promise<ReuseCampaign
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.GetAudience
  */
-export declare function getAudience(campaignId: string): Promise<GetAudienceResponse & GetAudienceResponseNonNullableFields>;
+export declare function getAudience(campaignId: string): Promise<NonNullablePaths<GetAudienceResponse, `audience.contactIds` | `audience.labelIds` | `audience.segmentIds` | `audience.activeContactsOnly`>>;
 /**
  * Checks if the sender's email address will be used as the "from" address or will it be replaced and to what exactly.
  * @param emailAddress - Email address to verify.
  * @public
  * @requiredField emailAddress
  * @permissionId Shoutout.Manage
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Access Verticals by Automations
  * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
  * @permissionScope Set Up Automations
@@ -2032,7 +1976,7 @@ export declare function getAudience(campaignId: string): Promise<GetAudienceResp
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress
  */
-export declare function identifySenderAddress(emailAddress: string): Promise<IdentifySenderAddressResponse & IdentifySenderAddressResponseNonNullableFields>;
+export declare function identifySenderAddress(emailAddress: string): Promise<NonNullablePaths<IdentifySenderAddressResponse, `senderAddress`>>;
 /**
  * Validates any provided link. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
  *
@@ -2050,7 +1994,7 @@ export declare function identifySenderAddress(emailAddress: string): Promise<Ide
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateLink
  */
-export declare function validateLink(url: string): Promise<ValidateLinkResponse & ValidateLinkResponseNonNullableFields>;
+export declare function validateLink(url: string): Promise<NonNullablePaths<ValidateLinkResponse, `valid`>>;
 /**
  * Validates links that are inside the provided HTML. This method automatically takes out links from the HTML block and validates them. Call this method when you want to check whether the link complies with the abuse rules and can be used in a campaign.
  * @param html - HTML string with links.
@@ -2066,5 +2010,5 @@ export declare function validateLink(url: string): Promise<ValidateLinkResponse
  * @applicableIdentity APP
  * @fqn wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks
  */
-export declare function validateHtmlLinks(html: string): Promise<ValidateHtmlLinksResponse & ValidateHtmlLinksResponseNonNullableFields>;
+export declare function validateHtmlLinks(html: string): Promise<NonNullablePaths<ValidateHtmlLinksResponse, `blacklistedLinks`>>;
 export {};