@studyportals/campaign-management-api-interface 0.19.1-2 → 0.20.1-1

package/index.d.ts

@@ -10,6 +10,5 @@ import { PrivateCampaignManagementAPIClient } from "./src/private-campaign-manag
 import { UserCampaignManagementAPIClient } from "./src/user-campaign-management-api.client";
 import { StudyCampaignManagementAPIClient } from "./src/study-campaign-management-api.client";
 import { MinimalOrganisationDto } from "./src/domain/organisations/minimal-organisations.dto";
-import { CmsGroupDto } from "./src/domain/users/cms-group.dto";
-import { DetailedUserDto } from "./src/domain/users/detailed-user.dto";
-export { AuditorCampaignManagementAPIClient, OrganisationsCampaignManagementAPIClient, CampaignManagementAPIClient, PrivateCampaignManagementAPIClient, UserCampaignManagementAPIClient, StudyCampaignManagementAPIClient, AuditorEntityType, AuditorOperation, GetAuditorDto, CampaignsEntitiesConfigDto, MinimalOrganisationDto, DetailedUserDto, CmsGroupDto, NumberMap, Pricing, ICampaignAuditorData };
+import { LinkType } from "./src/domain/studies/enums/link-type.enum";
+export { AuditorCampaignManagementAPIClient, OrganisationsCampaignManagementAPIClient, CampaignManagementAPIClient, PrivateCampaignManagementAPIClient, UserCampaignManagementAPIClient, StudyCampaignManagementAPIClient, AuditorEntityType, AuditorOperation, LinkType, GetAuditorDto, CampaignsEntitiesConfigDto, MinimalOrganisationDto, NumberMap, Pricing, ICampaignAuditorData };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Pricing = exports.CmsGroupDto = exports.DetailedUserDto = exports.MinimalOrganisationDto = exports.CampaignsEntitiesConfigDto = exports.GetAuditorDto = exports.AuditorOperation = exports.AuditorEntityType = exports.StudyCampaignManagementAPIClient = exports.UserCampaignManagementAPIClient = exports.PrivateCampaignManagementAPIClient = exports.CampaignManagementAPIClient = exports.OrganisationsCampaignManagementAPIClient = exports.AuditorCampaignManagementAPIClient = void 0;
+exports.Pricing = exports.MinimalOrganisationDto = exports.CampaignsEntitiesConfigDto = exports.GetAuditorDto = exports.LinkType = exports.AuditorOperation = exports.AuditorEntityType = 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");
@@ -25,8 +25,6 @@ const study_campaign_management_api_client_1 = require("./src/study-campaign-man
 Object.defineProperty(exports, "StudyCampaignManagementAPIClient", { enumerable: true, get: function () { return study_campaign_management_api_client_1.StudyCampaignManagementAPIClient; } });
 const minimal_organisations_dto_1 = require("./src/domain/organisations/minimal-organisations.dto");
 Object.defineProperty(exports, "MinimalOrganisationDto", { enumerable: true, get: function () { return minimal_organisations_dto_1.MinimalOrganisationDto; } });
-const cms_group_dto_1 = require("./src/domain/users/cms-group.dto");
-Object.defineProperty(exports, "CmsGroupDto", { enumerable: true, get: function () { return cms_group_dto_1.CmsGroupDto; } });
-const detailed_user_dto_1 = require("./src/domain/users/detailed-user.dto");
-Object.defineProperty(exports, "DetailedUserDto", { enumerable: true, get: function () { return detailed_user_dto_1.DetailedUserDto; } });
+const link_type_enum_1 = require("./src/domain/studies/enums/link-type.enum");
+Object.defineProperty(exports, "LinkType", { enumerable: true, get: function () { return link_type_enum_1.LinkType; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,yGAAkG;AAiB9F,mHAjBK,2EAAkC,OAiBL;AAhBtC,qHAA8G;AAiB1G,yHAjBK,uFAAwC,OAiBL;AAhB5C,yFAAmF;AAiB/E,4GAjBK,4DAA2B,OAiBL;AAhB/B,kGAAwF;AAsBpF,kGAtBK,4CAAiB,OAsBL;AArBrB,8FAAqF;AAsBjF,iGAtBK,yCAAgB,OAsBL;AArBpB,0EAAqE;AAwBjE,8FAxBK,+BAAa,OAwBL;AAvBjB,qGAAgG;AA0B5F,2GA1BK,yDAA0B,OA0BL;AAzB9B,gGAAgH;AAmC5G,wFAnCgB,+BAAO,OAmChB;AAlCX,yGAAkG;AAY9F,mHAZK,2EAAkC,OAYL;AAXtC,mGAA4F;AAYxF,gHAZK,qEAA+B,OAYL;AAXnC,qGAA8F;AAY1F,iHAZK,uEAAgC,OAYL;AAXpC,oGAA8F;AAwB1F,uGAxBK,kDAAsB,OAwBL;AAvB1B,oEAA+D;AA2B3D,4FA3BK,2BAAW,OA2BL;AA1Bf,4EAAuE;AAyBnE,gGAzBK,mCAAe,OAyBL"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,yGAAkG;AAgB9F,mHAhBK,2EAAkC,OAgBL;AAftC,qHAA8G;AAgB1G,yHAhBK,uFAAwC,OAgBL;AAf5C,yFAAmF;AAgB/E,4GAhBK,4DAA2B,OAgBL;AAf/B,kGAAwF;AAqBpF,kGArBK,4CAAiB,OAqBL;AApBrB,8FAAqF;AAqBjF,iGArBK,yCAAgB,OAqBL;AApBpB,0EAAqE;AAwBjE,8FAxBK,+BAAa,OAwBL;AAvBjB,qGAAgG;AA0B5F,2GA1BK,yDAA0B,OA0BL;AAzB9B,gGAAgH;AA+B5G,wFA/BgB,+BAAO,OA+BhB;AA9BX,yGAAkG;AAW9F,mHAXK,2EAAkC,OAWL;AAVtC,mGAA4F;AAWxF,gHAXK,qEAA+B,OAWL;AAVnC,qGAA8F;AAW1F,iHAXK,uEAAgC,OAWL;AAVpC,oGAA8F;AAwB1F,uGAxBK,kDAAsB,OAwBL;AAvB1B,8EAAqE;AAcjE,yFAdK,yBAAQ,OAcL"}

package/package.json

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

package/src/domain/studies/enums/link-type.enum.d.ts

@@ -0,0 +1,15 @@
+export declare enum LinkType {
+    OTHER = "other",
+    HOMEPAGE = "homepage",
+    FEATURED = "featured",
+    FACEBOOK = "facebook",
+    TWITTER = "twitter",
+    RSS = "rss",
+    FLICKR = "flickr",
+    FUNDING = "funding",
+    PIXEL = "pixel",
+    YOUTUBE = "youtube",
+    INSTAGRAM = "instagram",
+    SWAPPABLE = "swappable",
+    TUITION_FEE = "tuition-fee"
+}

package/src/domain/studies/enums/link-type.enum.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LinkType = void 0;
+var LinkType;
+(function (LinkType) {
+    LinkType["OTHER"] = "other";
+    LinkType["HOMEPAGE"] = "homepage";
+    LinkType["FEATURED"] = "featured";
+    LinkType["FACEBOOK"] = "facebook";
+    LinkType["TWITTER"] = "twitter";
+    LinkType["RSS"] = "rss";
+    LinkType["FLICKR"] = "flickr";
+    LinkType["FUNDING"] = "funding";
+    LinkType["PIXEL"] = "pixel";
+    LinkType["YOUTUBE"] = "youtube";
+    LinkType["INSTAGRAM"] = "instagram";
+    LinkType["SWAPPABLE"] = "swappable";
+    LinkType["TUITION_FEE"] = "tuition-fee";
+})(LinkType = exports.LinkType || (exports.LinkType = {}));
+//# sourceMappingURL=link-type.enum.js.map

package/src/domain/studies/enums/link-type.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link-type.enum.js","sourceRoot":"","sources":["../../../../../src/domain/studies/enums/link-type.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,QAcX;AAdD,WAAY,QAAQ;IAChB,2BAAe,CAAA;IACf,iCAAqB,CAAA;IACrB,iCAAqB,CAAA;IACrB,iCAAqB,CAAA;IACrB,+BAAmB,CAAA;IACnB,uBAAW,CAAA;IACX,6BAAiB,CAAA;IACjB,+BAAmB,CAAA;IACnB,2BAAe,CAAA;IACf,+BAAmB,CAAA;IACnB,mCAAuB,CAAA;IACvB,mCAAuB,CAAA;IACvB,uCAA2B,CAAA;AAC/B,CAAC,EAdW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAcnB"}

package/src/domain/studies/link-dto.d.ts

@@ -1,5 +1,7 @@
+import { LinkType } from "./enums/link-type.enum";
 export declare class LinkDto {
     url: string;
-    type: string;
+    type: LinkType;
     description: string;
+    name?: string;
 }

package/src/domain/studies/link-dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"link-dto.js","sourceRoot":"","sources":["../../../../src/domain/studies/link-dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,OAAO;CAInB;AAJD,0BAIC"}
+{"version":3,"file":"link-dto.js","sourceRoot":"","sources":["../../../../src/domain/studies/link-dto.ts"],"names":[],"mappings":";;;AAEA,MAAa,OAAO;CAKnB;AALD,0BAKC"}

package/src/domain/users/search-users.dto.d.ts

@@ -0,0 +1,6 @@
+export declare class SearchUserDto {
+    id: number;
+    name: string;
+    email: string;
+    constructor(id: number, name: string, email: string);
+}

package/src/domain/users/search-users.dto.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchUserDto = void 0;
+class SearchUserDto {
+    constructor(id, name, email) {
+        this.id = id;
+        this.name = name;
+        this.email = email;
+    }
+}
+exports.SearchUserDto = SearchUserDto;
+//# sourceMappingURL=search-users.dto.js.map

package/src/domain/users/search-users.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-users.dto.js","sourceRoot":"","sources":["../../../../src/domain/users/search-users.dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,aAAa;IAKzB,YACC,EAAU,EACV,IAAY,EACZ,KAAa;QAEb,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACpB,CAAC;CACD;AAdD,sCAcC"}

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

@@ -1,9 +1,13 @@
 import "reflect-metadata";
 import { GetEBPUsersDto } from "./domain/users/get-ebp-users.dto";
+import { SearchUserDto } from "./domain/users/search-users.dto";
 export declare class UserCampaignManagementAPIClient {
     private readonly baseUrl;
     constructor(baseUrl: string);
     getAllUsersWithEbpPsm(jwt?: string): Promise<GetEBPUsersDto[]>;
+    searchUsers(searchParam: string, limit?: number, jwt?: string): Promise<SearchUserDto[]>;
+    attachToOrganisation(userId: number, organisationId: number, jwt?: string): Promise<void>;
     private getRequest;
+    private postRequest;
     private buildBaseUrl;
 }

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

@@ -23,11 +23,27 @@ let UserCampaignManagementAPIClient = class UserCampaignManagementAPIClient {
         const getEBPUsersDtos = result.body;
         return getEBPUsersDtos;
     }
+    async searchUsers(searchParam, limit, jwt = "") {
+        const path = 'users/search-users';
+        const result = await this.postRequest(path, { searchParam, limit }, jwt);
+        const users = result.body;
+        return users;
+    }
+    async attachToOrganisation(userId, organisationId, jwt = "") {
+        const path = 'users/attach-to-organisation';
+        await this.postRequest(path, { userId, organisationId }, jwt);
+    }
     async getRequest(relative = "", jwt = "") {
         return await superagent.get(this.buildBaseUrl(relative))
             .set("Content-Type", "application/json")
             .set("Authorization", jwt);
     }
+    async postRequest(relative = "", body, jwt = "") {
+        return await superagent.post(this.buildBaseUrl(relative))
+            .set("Content-Type", "application/json")
+            .set("Authorization", jwt)
+            .send(body);
+    }
     buildBaseUrl(relative) {
         return `${this.baseUrl}/${relative}`;
     }

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

@@ -1 +1 @@
-{"version":3,"file":"user-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/user-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAE1B,yCAAuC;AACvC,yCAAyC;AAIlC,IAAM,+BAA+B,GAArC,MAAM,+BAA+B;IAC3C,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,qBAAqB,CAAC,MAAc,EAAE;QAClD,MAAM,IAAI,GAAG,kCAAkC,CAAC;QAEhD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAChD,MAAM,eAAe,GAAG,MAAM,CAAC,IAAwB,CAAC;QAExD,OAAO,eAAe,CAAC;IACxB,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE,EAAE,MAAc,EAAE;QAC/D,OAAO,MAAM,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACtD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACvC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;IAC7B,CAAC;IAGO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AAxBY,+BAA+B;IAD3C,IAAA,sBAAU,GAAE;;GACA,+BAA+B,CAwB3C;AAxBY,0EAA+B"}
+{"version":3,"file":"user-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/user-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAE1B,yCAAuC;AACvC,yCAAyC;AAKlC,IAAM,+BAA+B,GAArC,MAAM,+BAA+B;IAC3C,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,qBAAqB,CAAC,MAAc,EAAE;QAClD,MAAM,IAAI,GAAG,kCAAkC,CAAC;QAEhD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAChD,MAAM,eAAe,GAAG,MAAM,CAAC,IAAwB,CAAC;QAExD,OAAO,eAAe,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,KAAc,EAAE,MAAc,EAAE;QAC7E,MAAM,IAAI,GAAG,oBAAoB,CAAC;QAElC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,GAAG,CAAC,CAAC;QACzE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAuB,CAAC;QAE7C,OAAO,KAAK,CAAC;IACd,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,MAAc,EAAE,cAAsB,EAAE,MAAc,EAAE;QACzF,MAAM,IAAI,GAAG,8BAA8B,CAAC;QAE5C,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,GAAG,CAAC,CAAC;IAC/D,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE,EAAE,MAAc,EAAE;QAC/D,OAAO,MAAM,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;aACtD,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC;aACvC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,MAAc,EAAE;QAC3E,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;AA9CY,+BAA+B;IAD3C,IAAA,sBAAU,GAAE;;GACA,+BAA+B,CA8C3C;AA9CY,0EAA+B"}

package/src/domain/users/cms-group.dto.d.ts

@@ -1,5 +0,0 @@
-export declare class CmsGroupDto {
-    readonly id: number;
-    readonly name: string;
-    constructor(id: number, name: string);
-}

package/src/domain/users/cms-group.dto.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CmsGroupDto = void 0;
-class CmsGroupDto {
-    constructor(id, name) {
-        this.id = id;
-        this.name = name;
-    }
-}
-exports.CmsGroupDto = CmsGroupDto;
-//# sourceMappingURL=cms-group.dto.js.map

package/src/domain/users/cms-group.dto.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cms-group.dto.js","sourceRoot":"","sources":["../../../../src/domain/users/cms-group.dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,WAAW;IACpB,YACoB,EAAU,EACV,IAAY;QADZ,OAAE,GAAF,EAAE,CAAQ;QACV,SAAI,GAAJ,IAAI,CAAQ;IAC7B,CAAC;CACP;AALD,kCAKC"}

package/src/domain/users/detailed-user.dto.d.ts

@@ -1,14 +0,0 @@
-import { CmsGroupDto } from "./cms-group.dto";
-export declare class DetailedUserDto {
-    readonly id: number;
-    readonly fullName: string;
-    readonly email: string;
-    readonly Role: string;
-    readonly cmsGroups: CmsGroupDto[];
-    readonly phoneNumber: string;
-    readonly canSeeleads: boolean;
-    readonly hasTableauAccess: boolean;
-    readonly hasERTAccess: boolean;
-    readonly hasSMTAccess: boolean;
-    constructor(id: number, fullName: string, email: string, Role: string, cmsGroups: CmsGroupDto[], phoneNumber: string, canSeeleads: boolean, hasTableauAccess: boolean, hasERTAccess: boolean, hasSMTAccess: boolean);
-}

package/src/domain/users/detailed-user.dto.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DetailedUserDto = void 0;
-class DetailedUserDto {
-    constructor(id, fullName, email, Role, cmsGroups, phoneNumber, canSeeleads, hasTableauAccess, hasERTAccess, hasSMTAccess) {
-        this.id = id;
-        this.fullName = fullName;
-        this.email = email;
-        this.Role = Role;
-        this.cmsGroups = cmsGroups;
-        this.phoneNumber = phoneNumber;
-        this.canSeeleads = canSeeleads;
-        this.hasTableauAccess = hasTableauAccess;
-        this.hasERTAccess = hasERTAccess;
-        this.hasSMTAccess = hasSMTAccess;
-    }
-}
-exports.DetailedUserDto = DetailedUserDto;
-//# sourceMappingURL=detailed-user.dto.js.map

package/src/domain/users/detailed-user.dto.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"detailed-user.dto.js","sourceRoot":"","sources":["../../../../src/domain/users/detailed-user.dto.ts"],"names":[],"mappings":";;;AAEA,MAAa,eAAe;IACxB,YACoB,EAAU,EACV,QAAgB,EAChB,KAAa,EACb,IAAY,EACZ,SAAwB,EACxB,WAAmB,EACnB,WAAoB,EACpB,gBAAyB,EACzB,YAAqB,EACrB,YAAqB;QATrB,OAAE,GAAF,EAAE,CAAQ;QACV,aAAQ,GAAR,QAAQ,CAAQ;QAChB,UAAK,GAAL,KAAK,CAAQ;QACb,SAAI,GAAJ,IAAI,CAAQ;QACZ,cAAS,GAAT,SAAS,CAAe;QACxB,gBAAW,GAAX,WAAW,CAAQ;QACnB,gBAAW,GAAX,WAAW,CAAS;QACpB,qBAAgB,GAAhB,gBAAgB,CAAS;QACzB,iBAAY,GAAZ,YAAY,CAAS;QACrB,iBAAY,GAAZ,YAAY,CAAS;IACrC,CAAC;CACR;AAbD,0CAaC"}