@studyportals/campaign-management-api-interface 0.27.1 → 0.28.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@studyportals/campaign-management-api-interface",
3
- "version": "0.27.1",
3
+ "version": "0.28.1",
4
4
  "scripts": {
5
5
  "compile": "rm -fR bin && npx tsc",
6
6
  "test-u": "jest -c jest.config.unit.json --maxWorkers=1",
@@ -0,0 +1,23 @@
1
+ export declare enum CmsGroupEnum {
2
+ UNIVERSITIES = 1,
3
+ UNIVERSITIES_INQUIRIES = 9,
4
+ SALES = 18,
5
+ DATA_ENTRY = 19,
6
+ CAMPAIGN_ASSISTANT = 20,
7
+ DEVELOPERS = 21,
8
+ FORMER_EMPLOYEES = 22,
9
+ ACCOUNT_MANAGERS = 23,
10
+ EMPLOYEES = 30,
11
+ SEO_SPECIALISTS = 31,
12
+ COGNITO_TESTERS = 33,
13
+ SIA_ADMINS = 34,
14
+ EBP = 36,
15
+ DATA_ENTRY_MANAGEMENT = 37,
16
+ CITY_MANAGERS = 38,
17
+ EBP_PARTNERSHIP_SUCCESS_MANAGER = 39,
18
+ EBP_PARTNERSHIP_SUCCESS_MANAGER_REVIEWER = 40,
19
+ EBP_DATA_ENRICHMENT = 41,
20
+ EBP_CLIENT_ENROLMENTS_REVIEWER = 42,
21
+ DQS_CONTROL = 43,
22
+ TABLEAU_CLIENT_REPORTING = 45
23
+ }
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CmsGroupEnum = void 0;
4
+ var CmsGroupEnum;
5
+ (function (CmsGroupEnum) {
6
+ CmsGroupEnum[CmsGroupEnum["UNIVERSITIES"] = 1] = "UNIVERSITIES";
7
+ CmsGroupEnum[CmsGroupEnum["UNIVERSITIES_INQUIRIES"] = 9] = "UNIVERSITIES_INQUIRIES";
8
+ CmsGroupEnum[CmsGroupEnum["SALES"] = 18] = "SALES";
9
+ CmsGroupEnum[CmsGroupEnum["DATA_ENTRY"] = 19] = "DATA_ENTRY";
10
+ CmsGroupEnum[CmsGroupEnum["CAMPAIGN_ASSISTANT"] = 20] = "CAMPAIGN_ASSISTANT";
11
+ CmsGroupEnum[CmsGroupEnum["DEVELOPERS"] = 21] = "DEVELOPERS";
12
+ CmsGroupEnum[CmsGroupEnum["FORMER_EMPLOYEES"] = 22] = "FORMER_EMPLOYEES";
13
+ CmsGroupEnum[CmsGroupEnum["ACCOUNT_MANAGERS"] = 23] = "ACCOUNT_MANAGERS";
14
+ CmsGroupEnum[CmsGroupEnum["EMPLOYEES"] = 30] = "EMPLOYEES";
15
+ CmsGroupEnum[CmsGroupEnum["SEO_SPECIALISTS"] = 31] = "SEO_SPECIALISTS";
16
+ CmsGroupEnum[CmsGroupEnum["COGNITO_TESTERS"] = 33] = "COGNITO_TESTERS";
17
+ CmsGroupEnum[CmsGroupEnum["SIA_ADMINS"] = 34] = "SIA_ADMINS";
18
+ CmsGroupEnum[CmsGroupEnum["EBP"] = 36] = "EBP";
19
+ CmsGroupEnum[CmsGroupEnum["DATA_ENTRY_MANAGEMENT"] = 37] = "DATA_ENTRY_MANAGEMENT";
20
+ CmsGroupEnum[CmsGroupEnum["CITY_MANAGERS"] = 38] = "CITY_MANAGERS";
21
+ CmsGroupEnum[CmsGroupEnum["EBP_PARTNERSHIP_SUCCESS_MANAGER"] = 39] = "EBP_PARTNERSHIP_SUCCESS_MANAGER";
22
+ CmsGroupEnum[CmsGroupEnum["EBP_PARTNERSHIP_SUCCESS_MANAGER_REVIEWER"] = 40] = "EBP_PARTNERSHIP_SUCCESS_MANAGER_REVIEWER";
23
+ CmsGroupEnum[CmsGroupEnum["EBP_DATA_ENRICHMENT"] = 41] = "EBP_DATA_ENRICHMENT";
24
+ CmsGroupEnum[CmsGroupEnum["EBP_CLIENT_ENROLMENTS_REVIEWER"] = 42] = "EBP_CLIENT_ENROLMENTS_REVIEWER";
25
+ CmsGroupEnum[CmsGroupEnum["DQS_CONTROL"] = 43] = "DQS_CONTROL";
26
+ CmsGroupEnum[CmsGroupEnum["TABLEAU_CLIENT_REPORTING"] = 45] = "TABLEAU_CLIENT_REPORTING";
27
+ })(CmsGroupEnum = exports.CmsGroupEnum || (exports.CmsGroupEnum = {}));
28
+ //# sourceMappingURL=cms-group.enum.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cms-group.enum.js","sourceRoot":"","sources":["../../../../src/domain/users/cms-group.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAsBX;AAtBD,WAAY,YAAY;IACpB,+DAAgB,CAAA;IAChB,mFAA0B,CAAA;IAC1B,kDAAU,CAAA;IACV,4DAAe,CAAA;IACf,4EAAuB,CAAA;IACvB,4DAAe,CAAA;IACf,wEAAqB,CAAA;IACrB,wEAAqB,CAAA;IACrB,0DAAc,CAAA;IACd,sEAAoB,CAAA;IACpB,sEAAoB,CAAA;IACpB,4DAAe,CAAA;IACf,8CAAQ,CAAA;IACR,kFAA0B,CAAA;IAC1B,kEAAkB,CAAA;IAClB,sGAAoC,CAAA;IACpC,wHAA6C,CAAA;IAC7C,8EAAwB,CAAA;IACxB,oGAAmC,CAAA;IACnC,8DAAgB,CAAA;IAChB,wFAA6B,CAAA;AACjC,CAAC,EAtBW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAsBvB"}
@@ -0,0 +1,11 @@
1
+ import { CmsGroupDto } from "./cms-group.dto";
2
+ export declare class UserDto {
3
+ readonly id: number;
4
+ readonly name: string;
5
+ readonly email: string;
6
+ readonly groups: CmsGroupDto[];
7
+ readonly phone?: string | undefined;
8
+ readonly role?: string | undefined;
9
+ constructor(id: number, name: string, email: string, groups: CmsGroupDto[], phone?: string | undefined, role?: string | undefined);
10
+ isInternal(): boolean;
11
+ }
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.UserDto = void 0;
4
+ const cms_group_enum_1 = require("./cms-group.enum");
5
+ class UserDto {
6
+ constructor(id, name, email, groups, phone, role) {
7
+ this.id = id;
8
+ this.name = name;
9
+ this.email = email;
10
+ this.groups = groups;
11
+ this.phone = phone;
12
+ this.role = role;
13
+ }
14
+ isInternal() {
15
+ for (const group of this.groups) {
16
+ if (group.id === cms_group_enum_1.CmsGroupEnum.EMPLOYEES) {
17
+ return true;
18
+ }
19
+ }
20
+ return false;
21
+ }
22
+ }
23
+ exports.UserDto = UserDto;
24
+ //# sourceMappingURL=user.dto.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"user.dto.js","sourceRoot":"","sources":["../../../../src/domain/users/user.dto.ts"],"names":[],"mappings":";;;AACA,qDAAgD;AAEhD,MAAa,OAAO;IACnB,YACiB,EAAU,EACV,IAAY,EACZ,KAAa,EACb,MAAqB,EACrB,KAAc,EACd,IAAa;QALb,OAAE,GAAF,EAAE,CAAQ;QACV,SAAI,GAAJ,IAAI,CAAQ;QACZ,UAAK,GAAL,KAAK,CAAQ;QACb,WAAM,GAAN,MAAM,CAAe;QACrB,UAAK,GAAL,KAAK,CAAS;QACd,SAAI,GAAJ,IAAI,CAAS;IAC1B,CAAC;IAEE,UAAU;QAChB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE;YAChC,IAAI,KAAK,CAAC,EAAE,KAAK,6BAAY,CAAC,SAAS,EAAE;gBACxC,OAAO,IAAI,CAAC;aACZ;SACD;QAED,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAnBD,0BAmBC"}
@@ -4,10 +4,12 @@ import { SearchUserDto } from "./domain/users/search-users.dto";
4
4
  import { DetailedUserDto } from "./domain/users/detailed-user.dto";
5
5
  import { CreateClientDto } from "./domain/users/create-client.dto";
6
6
  import { UpdateClientDto } from "./domain/users/update-client.dto";
7
+ import { UserDto } from "./domain/users/user.dto";
7
8
  export declare class UserCampaignManagementAPIClient {
8
9
  private readonly baseUrl;
9
10
  constructor(baseUrl: string);
10
11
  createClient(user: CreateClientDto, jwt?: string): Promise<number>;
12
+ getUserByEmail(email: string, jwt?: string): Promise<UserDto>;
11
13
  updateClient(user: UpdateClientDto, jwt?: string): Promise<void>;
12
14
  getAllUsersWithEbpPsm(jwt?: string): Promise<GetEBPUsersDto[]>;
13
15
  searchUsers(searchTerm: string, limit?: number, jwt?: string): Promise<SearchUserDto[]>;
@@ -22,6 +22,11 @@ let UserCampaignManagementAPIClient = class UserCampaignManagementAPIClient {
22
22
  const result = await this.postRequest(path, user, jwt);
23
23
  return Number(result.text);
24
24
  }
25
+ async getUserByEmail(email, jwt = "") {
26
+ const path = `users/get-user-by-email?email=${encodeURIComponent(email)}`;
27
+ const result = await this.getRequest(path, jwt);
28
+ return result.body;
29
+ }
25
30
  async updateClient(user, jwt = "") {
26
31
  const path = 'users/update-client';
27
32
  await this.putRequest(path, user, jwt);
@@ -1 +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;AAQlC,IAAM,+BAA+B,GAArC,MAAM,+BAA+B;IAC3C,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,YAAY,CAAC,IAAqB,EAAE,MAAc,EAAE;QAChE,MAAM,IAAI,GAAG,qBAAqB,CAAC;QAEnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAEvD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,IAAqB,EAAE,MAAc,EAAE;QAChE,MAAM,IAAI,GAAG,qBAAqB,CAAC;QAEnC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,GAAG,GAAG,EAAE;QAC1C,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,UAAkB,EAAE,KAAc,EAAE,MAAc,EAAE;QAC5E,MAAM,IAAI,GAAG,oBAAoB,CAAC;QAElC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,GAAG,CAAC,CAAC;QACxE,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,mCAAmC,CAAC;QAEjD,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,GAAG,CAAC,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAAC,cAAsB,EAAE,GAAG,GAAG,EAAE;QAC7E,MAAM,IAAI,GAAG,+CAA+C,cAAc,EAAE,CAAC;QAE7E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAEhD,OAAO,MAAM,CAAC,IAAyB,CAAC;IACzC,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;IAEO,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,MAAc,EAAE;QAC1E,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;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;AA1EY,+BAA+B;IAD3C,IAAA,sBAAU,GAAE;;GACA,+BAA+B,CA0E3C;AA1EY,0EAA+B"}
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;AASlC,IAAM,+BAA+B,GAArC,MAAM,+BAA+B;IAC3C,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,YAAY,CAAC,IAAqB,EAAE,MAAc,EAAE;QAChE,MAAM,IAAI,GAAG,qBAAqB,CAAC;QAEnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAEvD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,cAAc,CAAC,KAAa,EAAE,MAAc,EAAE;QAC1D,MAAM,IAAI,GAAG,iCAAiC,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;QAE1E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAEhD,OAAO,MAAM,CAAC,IAAe,CAAC;IAC/B,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,IAAqB,EAAE,MAAc,EAAE;QAChE,MAAM,IAAI,GAAG,qBAAqB,CAAC;QAEnC,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IACxC,CAAC;IAEM,KAAK,CAAC,qBAAqB,CAAC,GAAG,GAAG,EAAE;QAC1C,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,UAAkB,EAAE,KAAc,EAAE,MAAc,EAAE;QAC5E,MAAM,IAAI,GAAG,oBAAoB,CAAC;QAElC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,EAAE,GAAG,CAAC,CAAC;QACxE,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,mCAAmC,CAAC;QAEjD,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,GAAG,CAAC,CAAC;IAC/D,CAAC;IAEM,KAAK,CAAC,gCAAgC,CAAC,cAAsB,EAAE,GAAG,GAAG,EAAE;QAC7E,MAAM,IAAI,GAAG,+CAA+C,cAAc,EAAE,CAAC;QAE7E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAEhD,OAAO,MAAM,CAAC,IAAyB,CAAC;IACzC,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;IAEO,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,MAAc,EAAE;QAC1E,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;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;AAlFY,+BAA+B;IAD3C,IAAA,sBAAU,GAAE;;GACA,+BAA+B,CAkF3C;AAlFY,0EAA+B"}