@wix/auto_sdk_email-marketing_campaigns 1.0.35 → 1.0.37

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

@@ -213,6 +213,120 @@ declare enum CampaignTypeEnum {
 }
 /** @enumType */
 type CampaignTypeEnumWithLiterals = CampaignTypeEnum | 'UNKNOWN' | 'EMAIL_MARKETING' | 'INVITATION' | 'AUTOMATION' | 'TRIGGERED';
+interface ListStatisticsRequest {
+    /**
+     * IDs of the campaigns to retrieve (max 100 campaigns).
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    campaignIds: string[];
+}
+interface ListStatisticsResponse {
+    /** List of statistics. */
+    statistics?: CampaignStatisticsContainer[];
+}
+interface CampaignStatisticsContainer {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId?: string;
+    /** Landing page statistics. */
+    landingPage?: LandingPageStatistics;
+    /** Email campaign statistics. */
+    email?: DistributionStatistics;
+}
+interface ListRecipientsRequest {
+    /**
+     * Campaign ID.
+     * @format GUID
+     */
+    campaignId: string;
+    /** Email activity to filter. */
+    activity: RecipientsActivityEnumWithLiterals;
+    /** Pagination options. */
+    paging?: CursorPaging;
+}
+declare enum RecipientsActivityEnum {
+    UNKNOWN = "UNKNOWN",
+    DELIVERED = "DELIVERED",
+    OPENED = "OPENED",
+    CLICKED = "CLICKED",
+    BOUNCED = "BOUNCED",
+    NOT_SENT = "NOT_SENT",
+    SENT = "SENT",
+    NOT_OPENED = "NOT_OPENED"
+}
+/** @enumType */
+type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
+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.
+     * @maxLength 1000
+     */
+    cursor?: string | null;
+}
+interface ListRecipientsResponse {
+    /** List of recipients. */
+    recipients?: CampaignRecipientDetails[];
+    /** Details on the paged set of returned results. */
+    pagingMetadata?: PagingMetadataV2;
+}
+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;
+}
+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;
+}
+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;
+}
 interface GetCampaignMappingRequest {
     /**
      * rule ID in automations
@@ -455,120 +569,6 @@ interface Decimal {
 }
 interface SendTestBulkResponse {
 }
-interface ListStatisticsRequest {
-    /**
-     * IDs of the campaigns to retrieve (max 100 campaigns).
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
-     */
-    campaignIds: string[];
-}
-interface ListStatisticsResponse {
-    /** List of statistics. */
-    statistics?: CampaignStatisticsContainer[];
-}
-interface CampaignStatisticsContainer {
-    /**
-     * Campaign ID.
-     * @format GUID
-     */
-    campaignId?: string;
-    /** Landing page statistics. */
-    landingPage?: LandingPageStatistics;
-    /** Email campaign statistics. */
-    email?: DistributionStatistics;
-}
-interface ListRecipientsRequest {
-    /**
-     * Campaign ID.
-     * @format GUID
-     */
-    campaignId: string;
-    /** Email activity to filter. */
-    activity: RecipientsActivityEnumWithLiterals;
-    /** Pagination options. */
-    paging?: CursorPaging;
-}
-declare enum RecipientsActivityEnum {
-    UNKNOWN = "UNKNOWN",
-    DELIVERED = "DELIVERED",
-    OPENED = "OPENED",
-    CLICKED = "CLICKED",
-    BOUNCED = "BOUNCED",
-    NOT_SENT = "NOT_SENT",
-    SENT = "SENT",
-    NOT_OPENED = "NOT_OPENED"
-}
-/** @enumType */
-type RecipientsActivityEnumWithLiterals = RecipientsActivityEnum | 'UNKNOWN' | 'DELIVERED' | 'OPENED' | 'CLICKED' | 'BOUNCED' | 'NOT_SENT' | 'SENT' | 'NOT_OPENED';
-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.
-     * @maxLength 1000
-     */
-    cursor?: string | null;
-}
-interface ListRecipientsResponse {
-    /** List of recipients. */
-    recipients?: CampaignRecipientDetails[];
-    /** Details on the paged set of returned results. */
-    pagingMetadata?: PagingMetadataV2;
-}
-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;
-}
-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;
-}
-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;
-}
 interface GetCampaignRequest {
     /**
      * Campaign ID.

package/build/cjs/index.typings.js

@@ -288,6 +288,9 @@ function listStatistics(payload) {
       method: "GET",
       methodFqn: "wix.emailmarketing.api.v1.CampaignStatisticsService.ListStatistics",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignStatisticsServiceUrl({
         protoPath: "/v1/campaigns/statistics",
         data: payload,
@@ -306,6 +309,9 @@ function listRecipients(payload) {
       method: "GET",
       methodFqn: "wix.emailmarketing.api.v1.CampaignStatisticsService.ListRecipients",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignStatisticsServiceUrl({
         protoPath: "/v1/campaigns/{campaignId}/statistics/recipients",
         data: payload,
@@ -330,6 +336,9 @@ function get(payload) {
       method: "GET",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService.Get",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/campaigns/{campaignId}",
         data: payload,
@@ -365,6 +374,9 @@ function list(payload) {
       method: "GET",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService.List",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/campaigns",
         data: serializedData,
@@ -400,6 +412,9 @@ function publish(payload) {
       method: "POST",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService.Publish",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/campaigns/{campaignId}/publish",
         data: serializedData,
@@ -430,6 +445,9 @@ function sendTest(payload) {
       method: "POST",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService.SendTest",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/campaigns/{campaignId}/test",
         data: serializedData,
@@ -448,6 +466,9 @@ function pauseScheduling(payload) {
       method: "POST",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService.PauseScheduling",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/campaigns/{campaignId}/pause-scheduling",
         data: payload,
@@ -472,6 +493,9 @@ function reschedule(payload) {
       method: "POST",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService.Reschedule",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/campaigns/{campaignId}/reschedule",
         data: serializedData,
@@ -490,6 +514,9 @@ function _delete(payload) {
       method: "DELETE",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService._delete",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/campaigns/{campaignId}",
         data: payload,
@@ -508,6 +535,9 @@ function reuse(payload) {
       method: "POST",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService.Reuse",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/campaigns/{campaignId}/reuse",
         data: payload,
@@ -537,6 +567,9 @@ function getAudience(payload) {
       method: "POST",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService.GetAudience",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/campaigns/{campaignId}/audience",
         data: payload,
@@ -555,6 +588,9 @@ function identifySenderAddress(payload) {
       method: "POST",
       methodFqn: "wix.emailmarketing.api.v1.CampaignService.IdentifySenderAddress",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignServiceUrl({
         protoPath: "/v1/identify-sender-address",
         data: payload,
@@ -573,6 +609,9 @@ function validateLink(payload) {
       method: "POST",
       methodFqn: "wix.emailmarketing.api.v1.CampaignValidationService.ValidateLink",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignValidationServiceUrl({
         protoPath: "/v1/campaign-validation/validate-link",
         data: payload,
@@ -591,6 +630,9 @@ function validateHtmlLinks(payload) {
       method: "POST",
       methodFqn: "wix.emailmarketing.api.v1.CampaignValidationService.ValidateHtmlLinks",
       packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
       url: resolveWixEmailmarketingApiV1CampaignValidationServiceUrl({
         protoPath: "/v1/campaign-validation/validate-html-links",
         data: payload,