@studyportals/campaign-management-api-interface 0.28.2 → 0.31.0
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 +1 -1
- package/src/domain/users/delete-client.dto.d.ts +4 -0
- package/src/domain/users/delete-client.dto.js +10 -0
- package/src/domain/users/delete-client.dto.js.map +1 -0
- package/src/domain/users/detailed-user.dto.d.ts +2 -2
- package/src/domain/users/detailed-user.dto.js.map +1 -1
- package/src/user-campaign-management-api.client.d.ts +4 -0
- package/src/user-campaign-management-api.client.js +14 -0
- package/src/user-campaign-management-api.client.js.map +1 -1
package/package.json
CHANGED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DeleteClientDto = void 0;
|
|
4
|
+
class DeleteClientDto {
|
|
5
|
+
constructor(id) {
|
|
6
|
+
this.id = id;
|
|
7
|
+
}
|
|
8
|
+
}
|
|
9
|
+
exports.DeleteClientDto = DeleteClientDto;
|
|
10
|
+
//# sourceMappingURL=delete-client.dto.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"delete-client.dto.js","sourceRoot":"","sources":["../../../../src/domain/users/delete-client.dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,eAAe;IAC3B,YACiB,EAAU;QAAV,OAAE,GAAF,EAAE,CAAQ;IACvB,CAAC;CACL;AAJD,0CAIC"}
|
|
@@ -3,12 +3,12 @@ export declare class DetailedUserDto {
|
|
|
3
3
|
readonly id: number;
|
|
4
4
|
readonly fullName: string;
|
|
5
5
|
readonly email: string;
|
|
6
|
-
readonly lastLogin: UTCDateTime;
|
|
6
|
+
readonly lastLogin: UTCDateTime | undefined;
|
|
7
7
|
readonly role: string;
|
|
8
8
|
readonly phoneNumber: string;
|
|
9
9
|
readonly hasTableauAccess: boolean;
|
|
10
10
|
readonly hasERTAccess: boolean;
|
|
11
11
|
readonly hasSMTAccess: boolean;
|
|
12
12
|
readonly activeCampaigns: number[];
|
|
13
|
-
constructor(id: number, fullName: string, email: string, lastLogin: UTCDateTime, role: string, phoneNumber: string, hasTableauAccess: boolean, hasERTAccess: boolean, hasSMTAccess: boolean, activeCampaigns: number[]);
|
|
13
|
+
constructor(id: number, fullName: string, email: string, lastLogin: UTCDateTime | undefined, role: string, phoneNumber: string, hasTableauAccess: boolean, hasERTAccess: boolean, hasSMTAccess: boolean, activeCampaigns: number[]);
|
|
14
14
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"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,
|
|
1
|
+
{"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,SAAkC,EAClC,IAAY,EACZ,WAAmB,EACnB,gBAAyB,EACzB,YAAqB,EACrB,YAAqB,EACrB,eAAyB;QATzB,OAAE,GAAF,EAAE,CAAQ;QACV,aAAQ,GAAR,QAAQ,CAAQ;QAChB,UAAK,GAAL,KAAK,CAAQ;QACb,cAAS,GAAT,SAAS,CAAyB;QAClC,SAAI,GAAJ,IAAI,CAAQ;QACZ,gBAAW,GAAX,WAAW,CAAQ;QACnB,qBAAgB,GAAhB,gBAAgB,CAAS;QACzB,iBAAY,GAAZ,YAAY,CAAS;QACrB,iBAAY,GAAZ,YAAY,CAAS;QACrB,oBAAe,GAAf,eAAe,CAAU;IACzC,CAAC;CACR;AAbD,0CAaC"}
|
|
@@ -5,18 +5,22 @@ 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
7
|
import { UserDto } from "./domain/users/user.dto";
|
|
8
|
+
import { DeleteClientDto } from "./domain/users/delete-client.dto";
|
|
8
9
|
export declare class UserCampaignManagementAPIClient {
|
|
9
10
|
private readonly baseUrl;
|
|
10
11
|
constructor(baseUrl: string);
|
|
11
12
|
createClient(user: CreateClientDto, jwt?: string): Promise<number>;
|
|
12
13
|
getUserByEmail(email: string, jwt?: string): Promise<UserDto>;
|
|
13
14
|
updateClient(user: UpdateClientDto, jwt?: string): Promise<void>;
|
|
15
|
+
deleteClient(user: DeleteClientDto, jwt?: string): Promise<void>;
|
|
14
16
|
getAllUsersWithEbpPsm(jwt?: string): Promise<GetEBPUsersDto[]>;
|
|
15
17
|
searchUsers(searchTerm: string, limit?: number, jwt?: string): Promise<SearchUserDto[]>;
|
|
16
18
|
attachToOrganisation(userId: number, organisationId: number, jwt?: string): Promise<void>;
|
|
19
|
+
detachFromOrganisation(userId: number, organisationId: number, jwt?: string): Promise<void>;
|
|
17
20
|
getDetailedUsersByOrganisationID(organisationID: number, jwt?: string): Promise<DetailedUserDto[]>;
|
|
18
21
|
private getRequest;
|
|
19
22
|
private postRequest;
|
|
20
23
|
private putRequest;
|
|
24
|
+
private deleteRequest;
|
|
21
25
|
private buildBaseUrl;
|
|
22
26
|
}
|
|
@@ -31,6 +31,10 @@ let UserCampaignManagementAPIClient = class UserCampaignManagementAPIClient {
|
|
|
31
31
|
const path = 'users/update-client';
|
|
32
32
|
await this.putRequest(path, user, jwt);
|
|
33
33
|
}
|
|
34
|
+
async deleteClient(user, jwt = "") {
|
|
35
|
+
const path = 'users/delete-client';
|
|
36
|
+
await this.deleteRequest(path, user, jwt);
|
|
37
|
+
}
|
|
34
38
|
async getAllUsersWithEbpPsm(jwt = "") {
|
|
35
39
|
const path = 'users/get-all-users-with-ebp-psm';
|
|
36
40
|
const result = await this.getRequest(path, jwt);
|
|
@@ -47,6 +51,10 @@ let UserCampaignManagementAPIClient = class UserCampaignManagementAPIClient {
|
|
|
47
51
|
const path = 'users/attach-user-to-organisation';
|
|
48
52
|
await this.postRequest(path, { userId, organisationId }, jwt);
|
|
49
53
|
}
|
|
54
|
+
async detachFromOrganisation(userId, organisationId, jwt = "") {
|
|
55
|
+
const path = 'users/detach-user-from-organisation';
|
|
56
|
+
await this.postRequest(path, { userId, organisationId }, jwt);
|
|
57
|
+
}
|
|
50
58
|
async getDetailedUsersByOrganisationID(organisationID, jwt = "") {
|
|
51
59
|
const path = `users/get-detailed-users-by-organisation-id/${organisationID}`;
|
|
52
60
|
const result = await this.getRequest(path, jwt);
|
|
@@ -69,6 +77,12 @@ let UserCampaignManagementAPIClient = class UserCampaignManagementAPIClient {
|
|
|
69
77
|
.set("Authorization", jwt)
|
|
70
78
|
.send(body);
|
|
71
79
|
}
|
|
80
|
+
async deleteRequest(relative = "", body, jwt = "") {
|
|
81
|
+
return await superagent.del(this.buildBaseUrl(relative))
|
|
82
|
+
.set("Content-Type", "application/json")
|
|
83
|
+
.set("Authorization", jwt)
|
|
84
|
+
.send(body);
|
|
85
|
+
}
|
|
72
86
|
buildBaseUrl(relative) {
|
|
73
87
|
return `${this.baseUrl}/${relative}`;
|
|
74
88
|
}
|
|
@@ -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;
|
|
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;AAUlC,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,YAAY,CAAC,IAAqB,EAAE,MAAc,EAAE;QAChE,MAAM,IAAI,GAAG,qBAAqB,CAAC;QAEnC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;IAC3C,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,sBAAsB,CAAC,MAAc,EAAE,cAAsB,EAAE,MAAc,EAAE;QAC3F,MAAM,IAAI,GAAG,qCAAqC,CAAC;QAEnD,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,KAAK,CAAC,aAAa,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,MAAc,EAAE;QAC7E,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;AArGY,+BAA+B;IAD3C,IAAA,sBAAU,GAAE;;GACA,+BAA+B,CAqG3C;AArGY,0EAA+B"}
|