@studyportals/campaign-management-api-interface 2.3.2-2 → 2.3.2-3
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/associate-software-token.dto.d.ts +4 -0
- package/src/domain/users/associate-software-token.dto.js +7 -0
- package/src/domain/users/associate-software-token.dto.js.map +1 -0
- package/src/domain/users/authentication-result.dto.d.ts +6 -0
- package/src/domain/users/authentication-result.dto.js +7 -0
- package/src/domain/users/authentication-result.dto.js.map +1 -0
- package/src/domain/users/refresh.d.ts +4 -0
- package/src/domain/users/refresh.js +7 -0
- package/src/domain/users/refresh.js.map +1 -0
- package/src/domain/users/sign-up-result.dto.d.ts +4 -0
- package/src/domain/users/sign-up-result.dto.js +7 -0
- package/src/domain/users/sign-up-result.dto.js.map +1 -0
- package/src/domain/users/verify-mfa-result.dto.d.ts +3 -0
- package/src/domain/users/verify-mfa-result.dto.js +7 -0
- package/src/domain/users/verify-mfa-result.dto.js.map +1 -0
- package/src/user-campaign-management-api.client.d.ts +9 -0
- package/src/user-campaign-management-api.client.js +25 -0
- package/src/user-campaign-management-api.client.js.map +1 -1
package/package.json
CHANGED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AssociateSoftwareToken = void 0;
|
|
4
|
+
class AssociateSoftwareToken {
|
|
5
|
+
}
|
|
6
|
+
exports.AssociateSoftwareToken = AssociateSoftwareToken;
|
|
7
|
+
//# sourceMappingURL=associate-software-token.dto.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"associate-software-token.dto.js","sourceRoot":"","sources":["../../../../src/domain/users/associate-software-token.dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,sBAAsB;CAGlC;AAHD,wDAGC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.AuthenticationResultDto = void 0;
|
|
4
|
+
class AuthenticationResultDto {
|
|
5
|
+
}
|
|
6
|
+
exports.AuthenticationResultDto = AuthenticationResultDto;
|
|
7
|
+
//# sourceMappingURL=authentication-result.dto.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"authentication-result.dto.js","sourceRoot":"","sources":["../../../../src/domain/users/authentication-result.dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,uBAAuB;CAKnC;AALD,0DAKC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"refresh.js","sourceRoot":"","sources":["../../../../src/domain/users/refresh.ts"],"names":[],"mappings":";;;AAAA,MAAa,eAAe;CAG3B;AAHD,0CAGC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sign-up-result.dto.js","sourceRoot":"","sources":["../../../../src/domain/users/sign-up-result.dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,eAAe;CAG3B;AAHD,0CAGC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"verify-mfa-result.dto.js","sourceRoot":"","sources":["../../../../src/domain/users/verify-mfa-result.dto.ts"],"names":[],"mappings":";;;AAAA,MAAa,kBAAkB;CAE9B;AAFD,gDAEC"}
|
|
@@ -7,6 +7,10 @@ import { UpdateClientDto } from "./domain/users/update-client.dto";
|
|
|
7
7
|
import { UserDto } from "./domain/users/user.dto";
|
|
8
8
|
import { DeleteClientDto } from "./domain/users/delete-client.dto";
|
|
9
9
|
import { SearchUserWithOrganisationDto } from "./domain/users/search-user-with-organisation.dto";
|
|
10
|
+
import { AuthenticationResultDto } from "./domain/users/authentication-result.dto";
|
|
11
|
+
import { SignUpResultDto } from "./domain/users/sign-up-result.dto";
|
|
12
|
+
import { AssociateSoftwareToken } from "./domain/users/associate-software-token.dto";
|
|
13
|
+
import { VerifyMfaResultDto } from "./domain/users/verify-mfa-result.dto";
|
|
10
14
|
export declare class UserCampaignManagementAPIClient {
|
|
11
15
|
private readonly baseUrl;
|
|
12
16
|
constructor(baseUrl: string);
|
|
@@ -20,6 +24,11 @@ export declare class UserCampaignManagementAPIClient {
|
|
|
20
24
|
attachToOrganisation(userId: number, organisationId: number, jwt?: string): Promise<void>;
|
|
21
25
|
detachFromOrganisation(userId: number, organisationId: number, jwt?: string): Promise<void>;
|
|
22
26
|
getDetailedUsersByOrganisationID(organisationID: number, jwt?: string): Promise<DetailedUserDto[]>;
|
|
27
|
+
signUpUser(username: string, password: string): Promise<SignUpResultDto>;
|
|
28
|
+
authenticateUser(username: string, password: string, mfaCode?: string): Promise<AuthenticationResultDto>;
|
|
29
|
+
refreshJWt(refreshToken: string, jwt: string): Promise<AuthenticationResultDto>;
|
|
30
|
+
setupMfa(accessToken: string, jwt: string): Promise<AssociateSoftwareToken>;
|
|
31
|
+
verifyMfa(accessToken: string, mfaCode: string, jwt: string): Promise<VerifyMfaResultDto>;
|
|
23
32
|
private getRequest;
|
|
24
33
|
private postRequest;
|
|
25
34
|
private putRequest;
|
|
@@ -66,6 +66,31 @@ let UserCampaignManagementAPIClient = class UserCampaignManagementAPIClient {
|
|
|
66
66
|
const result = await this.getRequest(path, jwt);
|
|
67
67
|
return result.body;
|
|
68
68
|
}
|
|
69
|
+
async signUpUser(username, password) {
|
|
70
|
+
const path = 'users/sign-up-user';
|
|
71
|
+
const result = await this.postRequest(path, { username, password });
|
|
72
|
+
return result.body;
|
|
73
|
+
}
|
|
74
|
+
async authenticateUser(username, password, mfaCode = "") {
|
|
75
|
+
const path = 'users/authenticate-user';
|
|
76
|
+
const result = await this.postRequest(path, { username, password, mfaCode });
|
|
77
|
+
return result.body;
|
|
78
|
+
}
|
|
79
|
+
async refreshJWt(refreshToken, jwt) {
|
|
80
|
+
const path = 'users/refresh-jwt';
|
|
81
|
+
const result = await this.postRequest(path, { refreshToken }, jwt);
|
|
82
|
+
return result.body;
|
|
83
|
+
}
|
|
84
|
+
async setupMfa(accessToken, jwt) {
|
|
85
|
+
const path = 'users/setup-mfa';
|
|
86
|
+
const result = await this.postRequest(path, { accessToken }, jwt);
|
|
87
|
+
return result.body;
|
|
88
|
+
}
|
|
89
|
+
async verifyMfa(accessToken, mfaCode, jwt) {
|
|
90
|
+
const path = 'users/verify-mfa';
|
|
91
|
+
const result = await this.postRequest(path, { accessToken, mfaCode: mfaCode }, jwt);
|
|
92
|
+
return result.body;
|
|
93
|
+
}
|
|
69
94
|
async getRequest(relative = "", jwt = "") {
|
|
70
95
|
return await superagent.get(this.buildBaseUrl(relative))
|
|
71
96
|
.set("Content-Type", "application/json")
|
|
@@ -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;AAelC,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,MAAc,EAAE,EAAE,KAAc;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,sCAAsC,CAClD,UAAkB,EAAE,MAAc,EAAE,EAAE,KAAc;QAEpD,MAAM,IAAI,GAAG,kDAAkD,CAAC;QAEhE,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,IAAuC,CAAC;QAE7D,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;IAEM,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,QAAgB;QACzD,MAAM,IAAI,GAAG,oBAAoB,CAAC;QAElC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QAEpE,OAAO,MAAM,CAAC,IAAuB,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,gBAAgB,CAAC,QAAgB,EAAE,QAAgB,EAAE,OAAO,GAAG,EAAE;QAC7E,MAAM,IAAI,GAAG,yBAAyB,CAAC;QAEvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAE7E,OAAO,MAAM,CAAC,IAA+B,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,YAAoB,EAAE,GAAW;QACxD,MAAM,IAAI,GAAG,mBAAmB,CAAC;QAEjC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,YAAY,EAAE,EAAE,GAAG,CAAC,CAAC;QAEnE,OAAO,MAAM,CAAC,IAA+B,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,QAAQ,CAAC,WAAmB,EAAE,GAAW;QACrD,MAAM,IAAI,GAAG,iBAAiB,CAAC;QAE/B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,EAAE,GAAG,CAAC,CAAC;QAElE,OAAO,MAAM,CAAC,IAA8B,CAAC;IAC9C,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,WAAmB,EAAE,OAAe,EAAE,GAAW;QACvE,MAAM,IAAI,GAAG,kBAAkB,CAAC;QAEhC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,GAAG,CAAC,CAAC;QAEpF,OAAO,MAAM,CAAC,IAA0B,CAAC;IAC1C,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;AAxJY,+BAA+B;IAD3C,IAAA,sBAAU,GAAE;;GACA,+BAA+B,CAwJ3C;AAxJY,0EAA+B"}
|