@studyportals/campaign-management-api-interface 2.1.1-3 → 2.2.1-0

package/index.d.ts

@@ -14,6 +14,7 @@ import { LinkType } from "./src/domain/studies/enums/link-type.enum";
 import { PersistGoogleLinkerResultDto } from "./src/domain/campaign/persist-google-linker-result.dto";
 import { LinkEntityType } from "./src/domain/links/link-entity-type.enum";
 import { LinksCampaignManagementAPIClient } from './src/links-campaign-management-api.client';
+import { SwappingEnabledLinkTypes } from "./src/domain/links/swapping-enabled-link-types.enum";
 export * from "./src/domain/campaign";
 export * from "./src/domain/users";
-export { AuditorCampaignManagementAPIClient, OrganisationsCampaignManagementAPIClient, CampaignManagementAPIClient, PrivateCampaignManagementAPIClient, UserCampaignManagementAPIClient, StudyCampaignManagementAPIClient, LinksCampaignManagementAPIClient, AuditorEntityType, AuditorOperation, LinkType, LinkEntityType, GetAuditorDto, PersistGoogleLinkerResultDto, CampaignsEntitiesConfigDto, MinimalOrganisationDto, NumberMap, Pricing, ICampaignAuditorData };
+export { AuditorCampaignManagementAPIClient, OrganisationsCampaignManagementAPIClient, CampaignManagementAPIClient, PrivateCampaignManagementAPIClient, UserCampaignManagementAPIClient, StudyCampaignManagementAPIClient, LinksCampaignManagementAPIClient, AuditorEntityType, AuditorOperation, LinkType, LinkEntityType, SwappingEnabledLinkTypes, GetAuditorDto, PersistGoogleLinkerResultDto, CampaignsEntitiesConfigDto, MinimalOrganisationDto, NumberMap, Pricing, ICampaignAuditorData };

package/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Pricing = exports.MinimalOrganisationDto = exports.CampaignsEntitiesConfigDto = exports.PersistGoogleLinkerResultDto = exports.GetAuditorDto = exports.LinkEntityType = exports.LinkType = exports.AuditorOperation = exports.AuditorEntityType = exports.LinksCampaignManagementAPIClient = exports.StudyCampaignManagementAPIClient = exports.UserCampaignManagementAPIClient = exports.PrivateCampaignManagementAPIClient = exports.CampaignManagementAPIClient = exports.OrganisationsCampaignManagementAPIClient = exports.AuditorCampaignManagementAPIClient = void 0;
+exports.Pricing = exports.MinimalOrganisationDto = exports.CampaignsEntitiesConfigDto = exports.PersistGoogleLinkerResultDto = exports.GetAuditorDto = exports.SwappingEnabledLinkTypes = exports.LinkEntityType = exports.LinkType = exports.AuditorOperation = exports.AuditorEntityType = exports.LinksCampaignManagementAPIClient = exports.StudyCampaignManagementAPIClient = exports.UserCampaignManagementAPIClient = exports.PrivateCampaignManagementAPIClient = exports.CampaignManagementAPIClient = exports.OrganisationsCampaignManagementAPIClient = exports.AuditorCampaignManagementAPIClient = void 0;
 const auditor_campaign_management_api_client_1 = require("./src/auditor-campaign-management-api.client");
 Object.defineProperty(exports, "AuditorCampaignManagementAPIClient", { enumerable: true, get: function () { return auditor_campaign_management_api_client_1.AuditorCampaignManagementAPIClient; } });
 const organisations_campaign_management_api_client_1 = require("./src/organisations-campaign-management-api.client");
@@ -47,6 +47,8 @@ const link_entity_type_enum_1 = require("./src/domain/links/link-entity-type.enu
 Object.defineProperty(exports, "LinkEntityType", { enumerable: true, get: function () { return link_entity_type_enum_1.LinkEntityType; } });
 const links_campaign_management_api_client_1 = require("./src/links-campaign-management-api.client");
 Object.defineProperty(exports, "LinksCampaignManagementAPIClient", { enumerable: true, get: function () { return links_campaign_management_api_client_1.LinksCampaignManagementAPIClient; } });
+const swapping_enabled_link_types_enum_1 = require("./src/domain/links/swapping-enabled-link-types.enum");
+Object.defineProperty(exports, "SwappingEnabledLinkTypes", { enumerable: true, get: function () { return swapping_enabled_link_types_enum_1.SwappingEnabledLinkTypes; } });
 __exportStar(require("./src/domain/campaign"), exports);
 __exportStar(require("./src/domain/users"), exports);
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yGAAkG;AAsBjG,mHAtBQ,2EAAkC,OAsBR;AArBnC,qHAA8G;AAsB7G,yHAtBQ,uFAAwC,OAsBR;AArBzC,yFAAmF;AAsBlF,4GAtBQ,4DAA2B,OAsBR;AArB5B,kGAAwF;AA4BvF,kGA5BQ,4CAAiB,OA4BR;AA3BlB,8FAAqF;AA4BpF,iGA5BQ,yCAAgB,OA4BR;AA3BjB,0EAAqE;AA+BpE,8FA/BQ,+BAAa,OA+BR;AA9Bd,qGAAgG;AAkC/F,2GAlCQ,yDAA0B,OAkCR;AAjC3B,gGAAgH;AAuC/G,wFAvCmB,+BAAO,OAuCnB;AAtCR,yGAAkG;AAiBjG,mHAjBQ,2EAAkC,OAiBR;AAhBnC,mGAA4F;AAiB3F,gHAjBQ,qEAA+B,OAiBR;AAhBhC,qGAA8F;AAiB7F,iHAjBQ,uEAAgC,OAiBR;AAhBjC,oGAA8F;AAgC7F,uGAhCQ,kDAAsB,OAgCR;AA/BvB,8EAAqE;AAqBpE,yFArBQ,yBAAQ,OAqBR;AApBT,6GAAsG;AAwBrG,6GAxBQ,+DAA4B,OAwBR;AAvB7B,oFAA0E;AAoBzE,+FApBQ,sCAAc,OAoBR;AAnBf,qGAA8F;AAa7F,iHAbQ,uEAAgC,OAaR;AAXjC,wDAAsC;AACtC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yGAAkG;AAuBjG,mHAvBQ,2EAAkC,OAuBR;AAtBnC,qHAA8G;AAuB7G,yHAvBQ,uFAAwC,OAuBR;AAtBzC,yFAAmF;AAuBlF,4GAvBQ,4DAA2B,OAuBR;AAtB5B,kGAAwF;AA6BvF,kGA7BQ,4CAAiB,OA6BR;AA5BlB,8FAAqF;AA6BpF,iGA7BQ,yCAAgB,OA6BR;AA5BjB,0EAAqE;AAkCpE,8FAlCQ,+BAAa,OAkCR;AAjCd,qGAAgG;AAqC/F,2GArCQ,yDAA0B,OAqCR;AApC3B,gGAAgH;AA0C/G,wFA1CmB,+BAAO,OA0CnB;AAzCR,yGAAkG;AAkBjG,mHAlBQ,2EAAkC,OAkBR;AAjBnC,mGAA4F;AAkB3F,gHAlBQ,qEAA+B,OAkBR;AAjBhC,qGAA8F;AAkB7F,iHAlBQ,uEAAgC,OAkBR;AAjBjC,oGAA8F;AAmC7F,uGAnCQ,kDAAsB,OAmCR;AAlCvB,8EAAqE;AAsBpE,yFAtBQ,yBAAQ,OAsBR;AArBT,6GAAsG;AA2BrG,6GA3BQ,+DAA4B,OA2BR;AA1B7B,oFAA0E;AAqBzE,+FArBQ,sCAAc,OAqBR;AApBf,qGAA8F;AAc7F,iHAdQ,uEAAgC,OAcR;AAbjC,0GAA+F;AAoB9F,yGApBQ,2DAAwB,OAoBR;AAlBzB,wDAAsC;AACtC,qDAAmC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/campaign-management-api-interface",
-	"version": "2.1.1-3",
+	"version": "2.2.1-0",
 	"scripts": {
 		"compile": "rm -fR bin && npx tsc",
 		"test-u": "jest -c jest.config.unit.json --maxWorkers=1",

package/src/domain/links/swapping-active-link-for-studies-response.d.ts

@@ -0,0 +1,11 @@
+export declare class SwappingActiveLinkForStudiesResponse {
+    success: number[];
+    error: {
+        reason: string;
+        studyIDs: number[];
+    };
+    constructor(success: number[], error: {
+        reason: string;
+        studyIDs: number[];
+    });
+}

package/src/domain/links/swapping-active-link-for-studies-response.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwappingActiveLinkForStudiesResponse = void 0;
+class SwappingActiveLinkForStudiesResponse {
+    constructor(success, error) {
+        this.success = success;
+        this.error = error;
+    }
+}
+exports.SwappingActiveLinkForStudiesResponse = SwappingActiveLinkForStudiesResponse;
+//# sourceMappingURL=swapping-active-link-for-studies-response.js.map

package/src/domain/links/swapping-active-link-for-studies-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swapping-active-link-for-studies-response.js","sourceRoot":"","sources":["../../../../src/domain/links/swapping-active-link-for-studies-response.ts"],"names":[],"mappings":";;;AAAA,MAAa,oCAAoC;IAChD,YACQ,OAAiB,EACjB,KAA6C;QAD7C,YAAO,GAAP,OAAO,CAAU;QACjB,UAAK,GAAL,KAAK,CAAwC;IACjD,CAAC;CAEL;AAND,oFAMC"}

package/src/domain/links/swapping-enabled-link-types.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum SwappingEnabledLinkTypes {
+    HOMEPAGE = "homepage",
+    MICROSITE = "microsite"
+}

package/src/domain/links/swapping-enabled-link-types.enum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SwappingEnabledLinkTypes = void 0;
+var SwappingEnabledLinkTypes;
+(function (SwappingEnabledLinkTypes) {
+    SwappingEnabledLinkTypes["HOMEPAGE"] = "homepage";
+    SwappingEnabledLinkTypes["MICROSITE"] = "microsite";
+})(SwappingEnabledLinkTypes = exports.SwappingEnabledLinkTypes || (exports.SwappingEnabledLinkTypes = {}));
+//# sourceMappingURL=swapping-enabled-link-types.enum.js.map

package/src/domain/links/swapping-enabled-link-types.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swapping-enabled-link-types.enum.js","sourceRoot":"","sources":["../../../../src/domain/links/swapping-enabled-link-types.enum.ts"],"names":[],"mappings":";;;AAEA,IAAY,wBAGX;AAHD,WAAY,wBAAwB;IACnC,iDAA4B,CAAA;IAC5B,mDAA8B,CAAA;AAC/B,CAAC,EAHW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAGnC"}

package/src/links-campaign-management-api.client.d.ts

@@ -3,10 +3,13 @@ import { CreateLinkDto } from "./domain/links/create-link.dto";
 import { UpdateLinkDto } from "./domain/links/update-link.dto";
 import { ParentEntityDto } from "./domain/links/parent-entity.dto";
 import { CreateOrUpdateLinksResponse } from "./domain/links/create-or-update-link-response.dto";
+import { SwappingEnabledLinkTypes } from "./domain/links/swapping-enabled-link-types.enum";
+import { SwappingActiveLinkForStudiesResponse } from "./domain/links/swapping-active-link-for-studies-response";
 export declare class LinksCampaignManagementAPIClient {
     private readonly baseUrl;
     constructor(baseUrl: string);
     createOrUpdateLinks(parentEntity: ParentEntityDto, linksToBeCreated: CreateLinkDto[], linksToBeUpdated: UpdateLinkDto[], jwt?: string): Promise<CreateOrUpdateLinksResponse>;
+    swapActiveLinkForStudies(studyIds: number[], linkTypeIsGoingTobeActive: SwappingEnabledLinkTypes, jwt?: string): Promise<SwappingActiveLinkForStudiesResponse>;
     private postRequest;
     private buildBaseUrl;
 }

package/src/links-campaign-management-api.client.js

@@ -29,6 +29,15 @@ let LinksCampaignManagementAPIClient = class LinksCampaignManagementAPIClient {
         const result = await this.postRequest(path, sendData, jwt);
         return result.body;
     }
+    async swapActiveLinkForStudies(studyIds, linkTypeIsGoingTobeActive, jwt = "") {
+        const sendData = {
+            studyIds,
+            linkTypeIsGoingTobeActive
+        };
+        const path = 'links/study/swap-active-links';
+        const result = await this.postRequest(path, sendData, jwt);
+        return result.body;
+    }
     async postRequest(relative = "", data, jwt = "") {
         return await superagent.post(this.buildBaseUrl(relative))
             .set("Content-Type", "application/json")

package/src/links-campaign-management-api.client.js.map

@@ -1 +1 @@
-{"version":3,"file":"links-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/links-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAG1B,yCAAuC;AAEvC,yCAAyC;AAOlC,IAAM,gCAAgC,GAAtC,MAAM,gCAAgC;IAC5C,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,mBAAmB,CAC/B,YAA6B,EAC7B,gBAAiC,EACjC,gBAAiC,EACjC,MAAc,EAAE;QAEhB,MAAM,QAAQ,GAAG;YAChB,UAAU,EAAE,YAAY,CAAC,IAAI;YAC7B,QAAQ,EAAE,YAAY,CAAC,EAAE;YACzB,gBAAgB;YAChB,gBAAgB;SAChB,CAAC;QACF,sDAAsD;QACtD,MAAM,IAAI,GAAG,8BAA8B,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QAE3D,OAAO,MAAM,CAAC,IAAmC,CAAC;IACnD,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,GAAG,GAAG,EAAE;QACnE,OAAO,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACvD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACvC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;aACzB,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAGO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AAnCY,gCAAgC;IAD5C,IAAA,sBAAU,GAAE;;GACA,gCAAgC,CAmC5C;AAnCY,4EAAgC"}
+{"version":3,"file":"links-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/links-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAG1B,yCAAuC;AAEvC,yCAAyC;AASlC,IAAM,gCAAgC,GAAtC,MAAM,gCAAgC;IAC5C,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,mBAAmB,CAC/B,YAA6B,EAC7B,gBAAiC,EACjC,gBAAiC,EACjC,MAAc,EAAE;QAEhB,MAAM,QAAQ,GAAG;YAChB,UAAU,EAAE,YAAY,CAAC,IAAI;YAC7B,QAAQ,EAAE,YAAY,CAAC,EAAE;YACzB,gBAAgB;YAChB,gBAAgB;SAChB,CAAC;QACF,sDAAsD;QACtD,MAAM,IAAI,GAAG,8BAA8B,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QAE3D,OAAO,MAAM,CAAC,IAAmC,CAAC;IACnD,CAAC;IAEM,KAAK,CAAC,wBAAwB,CACpC,QAAkB,EAClB,yBAAmD,EACnD,MAAc,EAAE;QAEhB,MAAM,QAAQ,GAAG;YAChB,QAAQ;YACR,yBAAyB;SACzB,CAAC;QACF,MAAM,IAAI,GAAG,+BAA+B,CAAC;QAC7C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QAE3D,OAAO,MAAM,CAAC,IAA4C,CAAC;IAC5D,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,GAAG,GAAG,EAAE;QACnE,OAAO,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACvD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACvC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC;aACzB,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,CAAC;IAEO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AAjDY,gCAAgC;IAD5C,IAAA,sBAAU,GAAE;;GACA,gCAAgC,CAiD5C;AAjDY,4EAAgC"}