@studyportals/campaign-management-api-interface 0.33.0 → 0.33.1-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/index.d.ts +2 -1
- package/index.js +3 -1
- package/index.js.map +1 -1
- package/package.json +1 -1
- package/src/domain/links/create-link.dto.d.ts +8 -0
- package/src/domain/links/create-link.dto.js +7 -0
- package/src/domain/links/create-link.dto.js.map +1 -0
- package/src/domain/links/link-entity-type.enum.d.ts +5 -0
- package/src/domain/links/link-entity-type.enum.js +10 -0
- package/src/domain/links/link-entity-type.enum.js.map +1 -0
- package/src/domain/links/parent-entity.dto.d.ts +5 -0
- package/src/domain/links/parent-entity.dto.js +7 -0
- package/src/domain/links/parent-entity.dto.js.map +1 -0
- package/src/domain/links/update-link.dto.d.ts +4 -0
- package/src/domain/links/update-link.dto.js +8 -0
- package/src/domain/links/update-link.dto.js.map +1 -0
- package/src/links-campaign-management-api.client.d.ts +11 -0
- package/src/links-campaign-management-api.client.js +49 -0
- package/src/links-campaign-management-api.client.js.map +1 -0
- package/src/organisations-campaign-management-api.client.js +4 -6
- package/src/organisations-campaign-management-api.client.js.map +1 -1
package/index.d.ts
CHANGED
|
@@ -14,4 +14,5 @@ import { CmsGroupDto } from "./src/domain/users/cms-group.dto";
|
|
|
14
14
|
import { DetailedUserDto } from "./src/domain/users/detailed-user.dto";
|
|
15
15
|
import { LinkType } from "./src/domain/studies/enums/link-type.enum";
|
|
16
16
|
import { PersistGoogleLinkerResultDto } from "./src/domain/campaign/persist-google-linker-result.dto";
|
|
17
|
-
|
|
17
|
+
import { LinkEntityType } from "./src/domain/links/link-entity-type.enum";
|
|
18
|
+
export { AuditorCampaignManagementAPIClient, OrganisationsCampaignManagementAPIClient, CampaignManagementAPIClient, PrivateCampaignManagementAPIClient, UserCampaignManagementAPIClient, StudyCampaignManagementAPIClient, AuditorEntityType, AuditorOperation, LinkType, LinkEntityType, GetAuditorDto, PersistGoogleLinkerResultDto, CampaignsEntitiesConfigDto, MinimalOrganisationDto, DetailedUserDto, CmsGroupDto, NumberMap, Pricing, ICampaignAuditorData };
|
package/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Pricing = exports.CmsGroupDto = exports.DetailedUserDto = exports.MinimalOrganisationDto = exports.CampaignsEntitiesConfigDto = exports.PersistGoogleLinkerResultDto = exports.GetAuditorDto = exports.LinkType = exports.AuditorOperation = exports.AuditorEntityType = exports.StudyCampaignManagementAPIClient = exports.UserCampaignManagementAPIClient = exports.PrivateCampaignManagementAPIClient = exports.CampaignManagementAPIClient = exports.OrganisationsCampaignManagementAPIClient = exports.AuditorCampaignManagementAPIClient = void 0;
|
|
3
|
+
exports.Pricing = exports.CmsGroupDto = exports.DetailedUserDto = exports.MinimalOrganisationDto = exports.CampaignsEntitiesConfigDto = exports.PersistGoogleLinkerResultDto = exports.GetAuditorDto = exports.LinkEntityType = exports.LinkType = exports.AuditorOperation = exports.AuditorEntityType = exports.StudyCampaignManagementAPIClient = exports.UserCampaignManagementAPIClient = exports.PrivateCampaignManagementAPIClient = exports.CampaignManagementAPIClient = exports.OrganisationsCampaignManagementAPIClient = exports.AuditorCampaignManagementAPIClient = void 0;
|
|
4
4
|
const auditor_campaign_management_api_client_1 = require("./src/auditor-campaign-management-api.client");
|
|
5
5
|
Object.defineProperty(exports, "AuditorCampaignManagementAPIClient", { enumerable: true, get: function () { return auditor_campaign_management_api_client_1.AuditorCampaignManagementAPIClient; } });
|
|
6
6
|
const organisations_campaign_management_api_client_1 = require("./src/organisations-campaign-management-api.client");
|
|
@@ -33,4 +33,6 @@ const link_type_enum_1 = require("./src/domain/studies/enums/link-type.enum");
|
|
|
33
33
|
Object.defineProperty(exports, "LinkType", { enumerable: true, get: function () { return link_type_enum_1.LinkType; } });
|
|
34
34
|
const persist_google_linker_result_dto_1 = require("./src/domain/campaign/persist-google-linker-result.dto");
|
|
35
35
|
Object.defineProperty(exports, "PersistGoogleLinkerResultDto", { enumerable: true, get: function () { return persist_google_linker_result_dto_1.PersistGoogleLinkerResultDto; } });
|
|
36
|
+
const link_entity_type_enum_1 = require("./src/domain/links/link-entity-type.enum");
|
|
37
|
+
Object.defineProperty(exports, "LinkEntityType", { enumerable: true, get: function () { return link_entity_type_enum_1.LinkEntityType; } });
|
|
36
38
|
//# sourceMappingURL=index.js.map
|
package/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,yGAAkG;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,yGAAkG;AAoB9F,mHApBK,2EAAkC,OAoBL;AAnBtC,qHAA8G;AAoB1G,yHApBK,uFAAwC,OAoBL;AAnB5C,yFAAmF;AAoB/E,4GApBK,4DAA2B,OAoBL;AAnB/B,kGAAwF;AAyBpF,kGAzBK,4CAAiB,OAyBL;AAxBrB,8FAAqF;AAyBjF,iGAzBK,yCAAgB,OAyBL;AAxBpB,0EAAqE;AA4BjE,8FA5BK,+BAAa,OA4BL;AA3BjB,qGAAgG;AA+B5F,2GA/BK,yDAA0B,OA+BL;AA9B9B,gGAAgH;AAwC5G,wFAxCgB,+BAAO,OAwChB;AAvCX,yGAAkG;AAe9F,mHAfK,2EAAkC,OAeL;AAdtC,mGAA4F;AAexF,gHAfK,qEAA+B,OAeL;AAdnC,qGAA8F;AAe1F,iHAfK,uEAAgC,OAeL;AAdpC,oGAA8F;AA6B1F,uGA7BK,kDAAsB,OA6BL;AA5B1B,oEAA+D;AAgC3D,4FAhCK,2BAAW,OAgCL;AA/Bf,4EAAuE;AA8BnE,gGA9BK,mCAAe,OA8BL;AA7BnB,8EAAqE;AAgBjE,yFAhBK,yBAAQ,OAgBL;AAfZ,6GAAsG;AAmBlG,6GAnBK,+DAA4B,OAmBL;AAlBhC,oFAA0E;AAezE,+FAfQ,sCAAc,OAeR"}
|
package/package.json
CHANGED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-link.dto.js","sourceRoot":"","sources":["../../../../src/domain/links/create-link.dto.ts"],"names":[],"mappings":";;;AAEA,MAAa,aAAa;CAMzB;AAND,sCAMC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.LinkEntityType = void 0;
|
|
4
|
+
var LinkEntityType;
|
|
5
|
+
(function (LinkEntityType) {
|
|
6
|
+
LinkEntityType["STUDY"] = "study";
|
|
7
|
+
LinkEntityType["ORGANISATION"] = "organisation";
|
|
8
|
+
LinkEntityType["COUNTRY"] = "country";
|
|
9
|
+
})(LinkEntityType = exports.LinkEntityType || (exports.LinkEntityType = {}));
|
|
10
|
+
//# sourceMappingURL=link-entity-type.enum.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"link-entity-type.enum.js","sourceRoot":"","sources":["../../../../src/domain/links/link-entity-type.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAIX;AAJD,WAAY,cAAc;IACzB,iCAAe,CAAA;IACf,+CAA6B,CAAA;IAC7B,qCAAmB,CAAA;AACpB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"parent-entity.dto.js","sourceRoot":"","sources":["../../../../src/domain/links/parent-entity.dto.ts"],"names":[],"mappings":";;;AAEA,MAAa,eAAe;CAG3B;AAHD,0CAGC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.UpdateLinkDto = void 0;
|
|
4
|
+
const create_link_dto_1 = require("./create-link.dto");
|
|
5
|
+
class UpdateLinkDto extends create_link_dto_1.CreateLinkDto {
|
|
6
|
+
}
|
|
7
|
+
exports.UpdateLinkDto = UpdateLinkDto;
|
|
8
|
+
//# sourceMappingURL=update-link.dto.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"update-link.dto.js","sourceRoot":"","sources":["../../../../src/domain/links/update-link.dto.ts"],"names":[],"mappings":";;;AAAA,uDAAiD;AAEjD,MAAa,aAAc,SAAQ,+BAAa;CAE/C;AAFD,sCAEC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import "reflect-metadata";
|
|
2
|
+
import { CreateLinkDto } from "./domain/links/create-link.dto";
|
|
3
|
+
import { UpdateLinkDto } from "./domain/links/update-link.dto";
|
|
4
|
+
import { ParentEntityDto } from "./domain/links/parent-entity.dto";
|
|
5
|
+
export declare class LinksCampaignManagementAPIClient {
|
|
6
|
+
private readonly baseUrl;
|
|
7
|
+
constructor(baseUrl: string);
|
|
8
|
+
createOrUpdateLinks(parentEntity: ParentEntityDto, linksToCreate: CreateLinkDto[], linksToUpdate: UpdateLinkDto[], jwt?: string): Promise<void>;
|
|
9
|
+
private postRequest;
|
|
10
|
+
private buildBaseUrl;
|
|
11
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.LinksCampaignManagementAPIClient = void 0;
|
|
13
|
+
require("reflect-metadata");
|
|
14
|
+
const inversify_1 = require("inversify");
|
|
15
|
+
const superagent = require("superagent");
|
|
16
|
+
let LinksCampaignManagementAPIClient = class LinksCampaignManagementAPIClient {
|
|
17
|
+
constructor(baseUrl) {
|
|
18
|
+
this.baseUrl = baseUrl;
|
|
19
|
+
}
|
|
20
|
+
async createOrUpdateLinks(parentEntity, linksToCreate, linksToUpdate, jwt = "") {
|
|
21
|
+
const sendData = {
|
|
22
|
+
entityType: parentEntity.type,
|
|
23
|
+
entityId: parentEntity.id,
|
|
24
|
+
linksToCreate,
|
|
25
|
+
linksToUpdate
|
|
26
|
+
};
|
|
27
|
+
// update path when decided on the path and if changed
|
|
28
|
+
const path = 'links/create-or-update-links';
|
|
29
|
+
const result = await this.postRequest(path, sendData, jwt);
|
|
30
|
+
if (result.status !== 200) {
|
|
31
|
+
throw new Error("Failed to create or update links");
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
async postRequest(relative = "", data, jwt = "") {
|
|
35
|
+
return await superagent.post(this.buildBaseUrl(relative))
|
|
36
|
+
.set("Content-Type", "application/json")
|
|
37
|
+
.set("Authorization", jwt)
|
|
38
|
+
.send(data);
|
|
39
|
+
}
|
|
40
|
+
buildBaseUrl(relative) {
|
|
41
|
+
return `${this.baseUrl}/${relative}`;
|
|
42
|
+
}
|
|
43
|
+
};
|
|
44
|
+
LinksCampaignManagementAPIClient = __decorate([
|
|
45
|
+
(0, inversify_1.injectable)(),
|
|
46
|
+
__metadata("design:paramtypes", [String])
|
|
47
|
+
], LinksCampaignManagementAPIClient);
|
|
48
|
+
exports.LinksCampaignManagementAPIClient = LinksCampaignManagementAPIClient;
|
|
49
|
+
//# sourceMappingURL=links-campaign-management-api.client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"links-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/links-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAM1B,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,aAA8B,EAC9B,aAA8B,EAC9B,MAAc,EAAE;QAEhB,MAAM,QAAQ,GAAG;YAChB,UAAU,EAAE,YAAY,CAAC,IAAI;YAC7B,QAAQ,EAAE,YAAY,CAAC,EAAE;YACzB,aAAa;YACb,aAAa;SACb,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;QAC3D,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;YAC1B,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;SACpD;IACF,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;AApCY,gCAAgC;IAD5C,IAAA,sBAAU,GAAE;;GACA,gCAAgC,CAoC5C;AApCY,4EAAgC"}
|
|
@@ -41,12 +41,10 @@ let OrganisationsCampaignManagementAPIClient = class OrganisationsCampaignManage
|
|
|
41
41
|
}
|
|
42
42
|
}
|
|
43
43
|
async postRequest(relative = "", data, jwt = "") {
|
|
44
|
-
|
|
45
|
-
.set("Content-Type", "application/json")
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
}
|
|
49
|
-
return await request.send(data);
|
|
44
|
+
return await superagent.post(this.buildBaseUrl(relative))
|
|
45
|
+
.set("Content-Type", "application/json")
|
|
46
|
+
.set("Authorization", jwt)
|
|
47
|
+
.send(data);
|
|
50
48
|
}
|
|
51
49
|
async getRequest(relative = "", jwt = "") {
|
|
52
50
|
return await superagent.get(this.buildBaseUrl(relative))
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"organisations-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/organisations-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAG1B,yCAAuC;AAEvC,yCAAyC;AAIlC,IAAM,wCAAwC,GAA9C,MAAM,wCAAwC;IACpD,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,sBAAsB,CAAC,cAAsB,EAAE,GAAG,GAAG,EAAE;QACnE,IAAI;YACH,MAAM,IAAI,GAAG,yBAAyB,cAAc,EAAE,CAAC;YACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAEhD,OAAO,MAAM,CAAC,IAA8B,CAAC;SAC7C;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;SAC1D;IACF,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,UAAkB,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,GAAC,EAAE;QACtE,IAAI;YACH,MAAM,IAAI,GAAG,sBAAsB,CAAC;YACpC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;gBAC3C,UAAU,EAAE,UAAU;gBACtB,KAAK,EAAE,KAAK;aACZ,EAAE,GAAG,CAAC,CAAC;YAER,OAAO,MAAM,CAAC,IAAgC,CAAC;SAC/C;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,EAAE,CAAC,CAAC;SACvD;IACF,CAAC;IAEO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"organisations-campaign-management-api.client.js","sourceRoot":"","sources":["../../src/organisations-campaign-management-api.client.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4BAA0B;AAG1B,yCAAuC;AAEvC,yCAAyC;AAIlC,IAAM,wCAAwC,GAA9C,MAAM,wCAAwC;IACpD,YACkB,OAAe;QAAf,YAAO,GAAP,OAAO,CAAQ;IAC7B,CAAC;IAEE,KAAK,CAAC,sBAAsB,CAAC,cAAsB,EAAE,GAAG,GAAG,EAAE;QACnE,IAAI;YACH,MAAM,IAAI,GAAG,yBAAyB,cAAc,EAAE,CAAC;YACvD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAEhD,OAAO,MAAM,CAAC,IAA8B,CAAC;SAC7C;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,EAAE,CAAC,CAAC;SAC1D;IACF,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,UAAkB,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,GAAC,EAAE;QACtE,IAAI;YACH,MAAM,IAAI,GAAG,sBAAsB,CAAC;YACpC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;gBAC3C,UAAU,EAAE,UAAU;gBACtB,KAAK,EAAE,KAAK;aACZ,EAAE,GAAG,CAAC,CAAC;YAER,OAAO,MAAM,CAAC,IAAgC,CAAC;SAC/C;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,8BAA8B,KAAK,EAAE,CAAC,CAAC;SACvD;IACF,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,KAAK,CAAC,UAAU,CAAC,WAAmB,EAAE,EAAE,GAAG,GAAG,EAAE;QACvD,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,EAAE,CAAC;IACV,CAAC;IAGO,YAAY,CAAC,QAAgB;QACpC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,QAAQ,EAAE,CAAC;IACtC,CAAC;CACD,CAAA;AAhDY,wCAAwC;IADpD,IAAA,sBAAU,GAAE;;GACA,wCAAwC,CAgDpD;AAhDY,4FAAwC"}
|