@segment/actions-shared 1.151.0 → 1.152.0

package/dist/dotdigital/api/resources/dd-contact-api.d.ts

@@ -9,10 +9,25 @@ declare class DDContactApi extends DDApi {
         channelIdentifier: string;
         emailIdentifier?: string;
         mobileNumberIdentifier?: string;
-        listId: number;
+        emailType?: string;
+        optInType?: string;
+        updateEmailSubscription?: boolean;
+        emailSubscriptionStatus?: string;
+        emailResubscribe?: boolean;
+        resubscribeWithoutChallengeEmail?: boolean;
+        preferredLocale?: string;
+        redirectUrlAfterChallenge?: string;
+        updateSmsSubscription?: boolean;
+        smsSubscriptionStatus?: string;
+        listId?: number;
         dataFields?: {
             [k: string]: unknown;
         };
     }): Promise<Contact>;
+    unsubscribeContact(payload: {
+        channelIdentifier: string;
+        emailIdentifier?: string;
+        mobileNumberIdentifier?: string;
+    }): Promise<Contact>;
 }
 export default DDContactApi;

package/dist/dotdigital/api/resources/dd-contact-api.js

@@ -18,7 +18,55 @@ class DDContactApi extends dd_api_1.default {
         return response.data;
     }
     async upsertContact(payload) {
-        const { channelIdentifier, emailIdentifier, mobileNumberIdentifier, listId, dataFields } = payload;
+        const { channelIdentifier, emailIdentifier, mobileNumberIdentifier, emailType = 'html', optInType = 'single', updateEmailSubscription = true, emailSubscriptionStatus = 'subscribed', emailResubscribe = false, resubscribeWithoutChallengeEmail = false, preferredLocale, redirectUrlAfterChallenge, updateSmsSubscription = true, smsSubscriptionStatus = 'subscribed', listId, dataFields } = payload;
+        const idValue = channelIdentifier === 'email' ? emailIdentifier : mobileNumberIdentifier;
+        const identifiers = {
+            ...(emailIdentifier && { email: emailIdentifier }),
+            ...(mobileNumberIdentifier && { mobileNumber: mobileNumberIdentifier })
+        };
+        const channelProperties = {};
+        if (emailIdentifier) {
+            channelProperties.email = {
+                emailType,
+                optInType
+            };
+            if (updateEmailSubscription) {
+                if (emailSubscriptionStatus === 'subscribed') {
+                    if (emailResubscribe) {
+                        channelProperties.email.status = 'subscribed';
+                        const resubscribeOptions = {
+                            resubscribeWithNoChallenge: resubscribeWithoutChallengeEmail
+                        };
+                        if (!resubscribeWithoutChallengeEmail) {
+                            if (preferredLocale)
+                                resubscribeOptions.preferredLocale = preferredLocale;
+                            if (redirectUrlAfterChallenge)
+                                resubscribeOptions.redirectUrlAfterChallenge = redirectUrlAfterChallenge;
+                        }
+                        channelProperties.email.resubscribeOptions = resubscribeOptions;
+                    }
+                }
+                else if (emailSubscriptionStatus) {
+                    channelProperties.email.status = emailSubscriptionStatus;
+                }
+            }
+        }
+        if (mobileNumberIdentifier && updateSmsSubscription && smsSubscriptionStatus) {
+            channelProperties.sms = {
+                status: smsSubscriptionStatus
+            };
+        }
+        const data = {
+            identifiers,
+            channelProperties,
+            ...(listId && { lists: [listId] }),
+            dataFields: dataFields
+        };
+        const response = await this.patch(`/contacts/v3/${channelIdentifier}/${idValue}?merge-option=overwrite`, data);
+        return response.data;
+    }
+    async unsubscribeContact(payload) {
+        const { channelIdentifier, emailIdentifier, mobileNumberIdentifier } = payload;
         const idValue = channelIdentifier === 'email' ? emailIdentifier : mobileNumberIdentifier;
         const identifiers = {
             ...(emailIdentifier && { email: emailIdentifier }),
@@ -26,21 +74,15 @@ class DDContactApi extends dd_api_1.default {
         };
         const channelProperties = {
             ...(emailIdentifier && {
-                email: {
-                    status: 'subscribed',
-                    emailType: 'html',
-                    optInType: 'single'
-                }
+                email: { status: 'unsubscribed' }
             }),
             ...(mobileNumberIdentifier && {
-                sms: { status: 'subscribed' }
+                sms: { status: 'unsubscribed' }
             })
         };
         const data = {
             identifiers,
-            channelProperties,
-            lists: [listId],
-            dataFields: dataFields
+            channelProperties
         };
         const response = await this.patch(`/contacts/v3/${channelIdentifier}/${idValue}?merge-option=overwrite`, data);
         return response.data;

package/dist/dotdigital/api/resources/dd-contact-api.js.map

@@ -1 +1 @@
-{"version":3,"file":"dd-contact-api.js","sourceRoot":"","sources":["../../../../src/dotdigital/api/resources/dd-contact-api.ts"],"names":[],"mappings":";;;;;AACA,uDAA6B;AAG7B,MAAM,YAAa,SAAQ,gBAAK;IAC9B,YAAY,QAAgB,EAAE,MAAqB;QACjD,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACzB,CAAC;IAUD,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,OAA2B;QAC1D,MAAM,QAAQ,GAA8B,MAAM,IAAI,CAAC,GAAG,CAAU,gBAAgB,MAAM,IAAI,OAAO,EAAE,CAAC,CAAA;QACxG,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAUD,KAAK,CAAC,oBAAoB,CAAI,iBAAoC,EAAE,IAAO;QACzE,MAAM,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;QAC7D,MAAM,QAAQ,GAA8B,MAAM,IAAI,CAAC,KAAK,CAAa,gBAAgB,MAAM,IAAI,OAAO,EAAE,EAAE,IAAI,CAAC,CAAA;QACnH,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAOM,KAAK,CAAC,aAAa,CAAC,OAM1B;QACC,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAA;QAElG,MAAM,OAAO,GAAG,iBAAiB,KAAK,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,sBAAsB,CAAA;QAExF,MAAM,WAAW,GAAgB;YAC/B,GAAG,CAAC,eAAe,IAAI,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;YAClD,GAAG,CAAC,sBAAsB,IAAI,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC;SACxE,CAAA;QAED,MAAM,iBAAiB,GAAsB;YAC3C,GAAG,CAAC,eAAe,IAAI;gBACrB,KAAK,EAAE;oBACL,MAAM,EAAE,YAAY;oBACpB,SAAS,EAAE,MAAM;oBACjB,SAAS,EAAE,QAAQ;iBACpB;aACF,CAAC;YACF,GAAG,CAAC,sBAAsB,IAAI;gBAC5B,GAAG,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE;aAC9B,CAAC;SACH,CAAA;QAED,MAAM,IAAI,GAAsB;YAC9B,WAAW;YACX,iBAAiB;YACjB,KAAK,EAAE,CAAC,MAAM,CAAC;YACf,UAAU,EAAE,UAAwB;SACrC,CAAA;QAED,MAAM,QAAQ,GAA8B,MAAM,IAAI,CAAC,KAAK,CAC1D,gBAAgB,iBAAiB,IAAI,OAAO,yBAAyB,EACrE,IAAI,CACL,CAAA;QAED,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;CACF;AAED,kBAAe,YAAY,CAAA"}
+{"version":3,"file":"dd-contact-api.js","sourceRoot":"","sources":["../../../../src/dotdigital/api/resources/dd-contact-api.ts"],"names":[],"mappings":";;;;;AACA,uDAA6B;AAG7B,MAAM,YAAa,SAAQ,gBAAK;IAC9B,YAAY,QAAgB,EAAE,MAAqB;QACjD,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;IACzB,CAAC;IAUD,KAAK,CAAC,UAAU,CAAC,MAAc,EAAE,OAA2B;QAC1D,MAAM,QAAQ,GAA8B,MAAM,IAAI,CAAC,GAAG,CAAU,gBAAgB,MAAM,IAAI,OAAO,EAAE,CAAC,CAAA;QACxG,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAUD,KAAK,CAAC,oBAAoB,CAAI,iBAAoC,EAAE,IAAO;QACzE,MAAM,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;QAC7D,MAAM,QAAQ,GAA8B,MAAM,IAAI,CAAC,KAAK,CAAa,gBAAgB,MAAM,IAAI,OAAO,EAAE,EAAE,IAAI,CAAC,CAAA;QACnH,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAMM,KAAK,CAAC,aAAa,CAAC,OAgB1B;QACC,MAAM,EACJ,iBAAiB,EACjB,eAAe,EACf,sBAAsB,EACtB,SAAS,GAAG,MAAM,EAClB,SAAS,GAAG,QAAQ,EACpB,uBAAuB,GAAG,IAAI,EAC9B,uBAAuB,GAAG,YAAY,EACtC,gBAAgB,GAAG,KAAK,EACxB,gCAAgC,GAAG,KAAK,EACxC,eAAe,EACf,yBAAyB,EACzB,qBAAqB,GAAG,IAAI,EAC5B,qBAAqB,GAAG,YAAY,EACpC,MAAM,EACN,UAAU,EACX,GAAG,OAAO,CAAA;QAEX,MAAM,OAAO,GAAG,iBAAiB,KAAK,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,sBAAsB,CAAA;QAExF,MAAM,WAAW,GAAgB;YAC/B,GAAG,CAAC,eAAe,IAAI,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;YAClD,GAAG,CAAC,sBAAsB,IAAI,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC;SACxE,CAAA;QAED,MAAM,iBAAiB,GAAsB,EAAE,CAAA;QAG/C,IAAI,eAAe,EAAE,CAAC;YACpB,iBAAiB,CAAC,KAAK,GAAG;gBACxB,SAAS;gBACT,SAAS;aACV,CAAA;YAED,IAAI,uBAAuB,EAAE,CAAC;gBAC5B,IAAI,uBAAuB,KAAK,YAAY,EAAE,CAAC;oBAE7C,IAAI,gBAAgB,EAAE,CAAC;wBACrB,iBAAiB,CAAC,KAAK,CAAC,MAAM,GAAG,YAAY,CAAA;wBAE7C,MAAM,kBAAkB,GAAuB;4BAC7C,0BAA0B,EAAE,gCAAgC;yBAC7D,CAAA;wBAED,IAAI,CAAC,gCAAgC,EAAE,CAAC;4BACtC,IAAI,eAAe;gCAAE,kBAAkB,CAAC,eAAe,GAAG,eAAe,CAAA;4BACzE,IAAI,yBAAyB;gCAAE,kBAAkB,CAAC,yBAAyB,GAAG,yBAAyB,CAAA;wBACzG,CAAC;wBAED,iBAAiB,CAAC,KAAK,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;oBACjE,CAAC;gBACH,CAAC;qBAAM,IAAI,uBAAuB,EAAE,CAAC;oBAEnC,iBAAiB,CAAC,KAAK,CAAC,MAAM,GAAG,uBAAuB,CAAA;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC;QAGD,IAAI,sBAAsB,IAAI,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;YAC7E,iBAAiB,CAAC,GAAG,GAAG;gBACtB,MAAM,EAAE,qBAAqB;aAC9B,CAAA;QACH,CAAC;QAED,MAAM,IAAI,GAAsB;YAC9B,WAAW;YACX,iBAAiB;YACjB,GAAG,CAAC,MAAM,IAAI,EAAE,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,UAAU,EAAE,UAAwB;SACrC,CAAA;QAED,MAAM,QAAQ,GAA8B,MAAM,IAAI,CAAC,KAAK,CAC1D,gBAAgB,iBAAiB,IAAI,OAAO,yBAAyB,EACrE,IAAI,CACL,CAAA;QAED,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;IAOM,KAAK,CAAC,kBAAkB,CAAC,OAI/B;QACC,MAAM,EAAE,iBAAiB,EAAE,eAAe,EAAE,sBAAsB,EAAE,GAAG,OAAO,CAAA;QAE9E,MAAM,OAAO,GAAG,iBAAiB,KAAK,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,sBAAsB,CAAA;QAExF,MAAM,WAAW,GAAgB;YAC/B,GAAG,CAAC,eAAe,IAAI,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC;YAClD,GAAG,CAAC,sBAAsB,IAAI,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAC;SACxE,CAAA;QAED,MAAM,iBAAiB,GAAsB;YAC3C,GAAG,CAAC,eAAe,IAAI;gBACrB,KAAK,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE;aAClC,CAAC;YACF,GAAG,CAAC,sBAAsB,IAAI;gBAC5B,GAAG,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE;aAChC,CAAC;SACH,CAAA;QAED,MAAM,IAAI,GAAsB;YAC9B,WAAW;YACX,iBAAiB;SAClB,CAAA;QAED,MAAM,QAAQ,GAA8B,MAAM,IAAI,CAAC,KAAK,CAC1D,gBAAgB,iBAAiB,IAAI,OAAO,yBAAyB,EACrE,IAAI,CACL,CAAA;QAED,OAAO,QAAQ,CAAC,IAAI,CAAA;IACtB,CAAC;CACF;AAED,kBAAe,YAAY,CAAA"}

package/dist/dotdigital/api/types.d.ts

@@ -36,11 +36,17 @@ export interface Identifiers {
 export interface DataFields {
     [key: string]: string | number | boolean | null;
 }
+export interface ResubscribeOptions {
+    resubscribeWithNoChallenge?: boolean;
+    preferredLocale?: string;
+    redirectUrlAfterChallenge?: string;
+}
 export interface ChannelProperties {
     email?: {
-        status: string;
-        emailType: string;
-        optInType: string;
+        status?: string;
+        emailType?: string;
+        optInType?: string;
+        resubscribeOptions?: ResubscribeOptions;
     };
     sms?: {
         status: string;
@@ -97,7 +103,7 @@ export type ChannelIdentifier = {
 export interface UpsertContactJSON {
     identifiers: Identifiers;
     channelProperties: ChannelProperties;
-    lists: number[];
+    lists?: number[];
     dataFields?: DataFields;
 }
 export interface CpaasMessageBody {

package/dist/dotdigital/api/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/dotdigital/api/types.ts"],"names":[],"mappings":";;;AAyEA,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,gCAAe,CAAA;IACf,4CAA2B,CAAA;AAC7B,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/dotdigital/api/types.ts"],"names":[],"mappings":";;;AA+EA,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,kCAAiB,CAAA;IACjB,gCAAe,CAAA;IACf,4CAA2B,CAAA;AAC7B,CAAC,EAJW,aAAa,6BAAb,aAAa,QAIxB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@segment/actions-shared",
   "description": "Shared destination action methods and definitions.",
-  "version": "1.151.0",
+  "version": "1.152.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/action-destinations",
@@ -64,5 +64,5 @@
       "<rootDir>/test/setup-after-env.ts"
     ]
   },
-  "gitHead": "7a4452696fa871d1462e8c707948a6b5c77a9ad0"
+  "gitHead": "435786c4b8f370a4de536eca7bcebe078b72eb6f"
 }