@studyportals/campaign-management-api-interface 3.6.1 → 3.6.2-1

package/package.json

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

package/src/domain/organisations/index.d.ts

@@ -1,5 +1,6 @@
 import { SourceLinkLevels } from "./enums/source-link-levels.enum";
 import { SourceLinkSubTypes } from "./enums/source-link-sub-types.enum";
 import { SourceLinkTypes } from "./enums/source-link-types.enum";
+import { SourceLinkDataDto } from "./source-link-data.dto";
 import { SourceLinkDto } from "./source-links.dto";
-export { SourceLinkDto, SourceLinkLevels, SourceLinkSubTypes, SourceLinkTypes };
+export { SourceLinkDto, SourceLinkDataDto, SourceLinkLevels, SourceLinkSubTypes, SourceLinkTypes };

package/src/domain/organisations/index.js

@@ -1,12 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SourceLinkTypes = exports.SourceLinkSubTypes = exports.SourceLinkLevels = exports.SourceLinkDto = void 0;
+exports.SourceLinkTypes = exports.SourceLinkSubTypes = exports.SourceLinkLevels = exports.SourceLinkDataDto = exports.SourceLinkDto = void 0;
 const source_link_levels_enum_1 = require("./enums/source-link-levels.enum");
 Object.defineProperty(exports, "SourceLinkLevels", { enumerable: true, get: function () { return source_link_levels_enum_1.SourceLinkLevels; } });
 const source_link_sub_types_enum_1 = require("./enums/source-link-sub-types.enum");
 Object.defineProperty(exports, "SourceLinkSubTypes", { enumerable: true, get: function () { return source_link_sub_types_enum_1.SourceLinkSubTypes; } });
 const source_link_types_enum_1 = require("./enums/source-link-types.enum");
 Object.defineProperty(exports, "SourceLinkTypes", { enumerable: true, get: function () { return source_link_types_enum_1.SourceLinkTypes; } });
+const source_link_data_dto_1 = require("./source-link-data.dto");
+Object.defineProperty(exports, "SourceLinkDataDto", { enumerable: true, get: function () { return source_link_data_dto_1.SourceLinkDataDto; } });
 const source_links_dto_1 = require("./source-links.dto");
 Object.defineProperty(exports, "SourceLinkDto", { enumerable: true, get: function () { return source_links_dto_1.SourceLinkDto; } });
 //# sourceMappingURL=index.js.map

package/src/domain/organisations/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/domain/organisations/index.ts"],"names":[],"mappings":";;;AAAA,6EAAmE;AASlE,iGATQ,0CAAgB,OASR;AARjB,mFAAwE;AASvE,mGATQ,+CAAkB,OASR;AARnB,2EAAiE;AAShE,gGATQ,wCAAe,OASR;AARhB,yDAAmD;AAIlD,8FAJQ,gCAAa,OAIR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/domain/organisations/index.ts"],"names":[],"mappings":";;;AAAA,6EAAmE;AAWlE,iGAXQ,0CAAgB,OAWR;AAVjB,mFAAwE;AAWvE,mGAXQ,+CAAkB,OAWR;AAVnB,2EAAiE;AAWhE,gGAXQ,wCAAe,OAWR;AAVhB,iEAA2D;AAM1D,kGANQ,wCAAiB,OAMR;AALlB,yDAAmD;AAIlD,8FAJQ,gCAAa,OAIR"}

package/src/domain/organisations/source-link-data.dto.d.ts

@@ -0,0 +1,12 @@
+import { SourceLinkLevels } from "./enums/source-link-levels.enum";
+import { SourceLinkSubTypes } from "./enums/source-link-sub-types.enum";
+import { SourceLinkTypes } from "./enums/source-link-types.enum";
+export declare class SourceLinkDataDto {
+    readonly organisationId: number;
+    readonly level: SourceLinkLevels;
+    readonly type: SourceLinkTypes;
+    readonly subType: SourceLinkSubTypes | null;
+    readonly url: string | null;
+    readonly doesExist: boolean;
+    constructor(organisationId: number, level: SourceLinkLevels, type: SourceLinkTypes, subType: SourceLinkSubTypes | null, url: string | null, doesExist: boolean);
+}

package/src/domain/organisations/source-link-data.dto.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SourceLinkDataDto = void 0;
+class SourceLinkDataDto {
+    constructor(organisationId, level, type, subType, url, doesExist) {
+        this.organisationId = organisationId;
+        this.level = level;
+        this.type = type;
+        this.subType = subType;
+        this.url = url;
+        this.doesExist = doesExist;
+    }
+}
+exports.SourceLinkDataDto = SourceLinkDataDto;
+//# sourceMappingURL=source-link-data.dto.js.map

package/src/domain/organisations/source-link-data.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"source-link-data.dto.js","sourceRoot":"","sources":["../../../../src/domain/organisations/source-link-data.dto.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAC7B,YACiB,cAAsB,EACtB,KAAuB,EACvB,IAAqB,EACrB,OAAkC,EAClC,GAAkB,EAClB,SAAkB;QALlB,mBAAc,GAAd,cAAc,CAAQ;QACtB,UAAK,GAAL,KAAK,CAAkB;QACvB,SAAI,GAAJ,IAAI,CAAiB;QACrB,YAAO,GAAP,OAAO,CAA2B;QAClC,QAAG,GAAH,GAAG,CAAe;QAClB,cAAS,GAAT,SAAS,CAAS;IAChC,CAAC;CACJ;AATD,8CASC"}

package/src/domain/organisations/source-links.dto.d.ts

@@ -1,7 +1,8 @@
 import { SourceLinkLevels } from "./enums/source-link-levels.enum";
 import { SourceLinkSubTypes } from "./enums/source-link-sub-types.enum";
 import { SourceLinkTypes } from "./enums/source-link-types.enum";
-export declare class SourceLinkDto {
+import { SourceLinkDataDto } from "./source-link-data.dto";
+export declare class SourceLinkDto extends SourceLinkDataDto {
     readonly id: number;
     readonly organisationId: number;
     readonly level: SourceLinkLevels;

package/src/domain/organisations/source-links.dto.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SourceLinkDto = void 0;
-class SourceLinkDto {
+const source_link_data_dto_1 = require("./source-link-data.dto");
+class SourceLinkDto extends source_link_data_dto_1.SourceLinkDataDto {
     constructor(id, organisationId, level, type, subType, url, doesExist) {
+        super(organisationId, level, type, subType, url, doesExist);
         this.id = id;
         this.organisationId = organisationId;
         this.level = level;

package/src/domain/organisations/source-links.dto.js.map

@@ -1 +1 @@
-{"version":3,"file":"source-links.dto.js","sourceRoot":"","sources":["../../../../src/domain/organisations/source-links.dto.ts"],"names":[],"mappings":";;;AAIA,MAAa,aAAa;IACzB,YACiB,EAAU,EACV,cAAsB,EACtB,KAAuB,EACvB,IAAqB,EACrB,OAAkC,EAClC,GAAkB,EAClB,SAAkB;QANlB,OAAE,GAAF,EAAE,CAAQ;QACV,mBAAc,GAAd,cAAc,CAAQ;QACtB,UAAK,GAAL,KAAK,CAAkB;QACvB,SAAI,GAAJ,IAAI,CAAiB;QACrB,YAAO,GAAP,OAAO,CAA2B;QAClC,QAAG,GAAH,GAAG,CAAe;QAClB,cAAS,GAAT,SAAS,CAAS;IAChC,CAAC;CACJ;AAVD,sCAUC"}
+{"version":3,"file":"source-links.dto.js","sourceRoot":"","sources":["../../../../src/domain/organisations/source-links.dto.ts"],"names":[],"mappings":";;;AAGA,iEAA2D;AAE3D,MAAa,aAAc,SAAQ,wCAAiB;IACnD,YACiB,EAAU,EACV,cAAsB,EACtB,KAAuB,EACvB,IAAqB,EACrB,OAAkC,EAClC,GAAkB,EAClB,SAAkB;QAElC,KAAK,CAAC,cAAc,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC;QAR5C,OAAE,GAAF,EAAE,CAAQ;QACV,mBAAc,GAAd,cAAc,CAAQ;QACtB,UAAK,GAAL,KAAK,CAAkB;QACvB,SAAI,GAAJ,IAAI,CAAiB;QACrB,YAAO,GAAP,OAAO,CAA2B;QAClC,QAAG,GAAH,GAAG,CAAe;QAClB,cAAS,GAAT,SAAS,CAAS;IAGnC,CAAC;CACD;AAZD,sCAYC"}

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

@@ -1,13 +1,16 @@
 import "reflect-metadata";
 import { MinimalOrganisationDto } from "./domain/organisations/minimal-organisations.dto";
-import { SourceLinkDto } from "./domain/organisations";
+import { SourceLinkDataDto, SourceLinkDto } from "./domain/organisations";
 export declare class OrganisationsCampaignManagementAPIClient {
     private readonly baseUrl;
     constructor(baseUrl: string);
     getMinimalOrganisation(organisationID: number, jwt?: string): Promise<MinimalOrganisationDto>;
     searchOrganisations(searchTerm: string, jwt?: string, limit?: number): Promise<MinimalOrganisationDto[]>;
     getSourceLinks(organisationID: number, jwt?: string): Promise<SourceLinkDto[]>;
+    createSourceLinks(sourceLinks: SourceLinkDataDto[], jwt?: string): Promise<void>;
+    updateSourceLinks(sourceLinks: SourceLinkDto[], jwt?: string): Promise<void>;
     private postRequest;
+    private putRequest;
     private getRequest;
     private buildBaseUrl;
 }

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

@@ -31,8 +31,8 @@ let OrganisationsCampaignManagementAPIClient = class OrganisationsCampaignManage
         try {
             const path = `organisations/search`;
             const result = await this.postRequest(path, {
-                searchTerm: searchTerm,
-                limit: limit
+                searchTerm,
+                limit
             }, jwt);
             return result.body;
         }
@@ -50,12 +50,42 @@ let OrganisationsCampaignManagementAPIClient = class OrganisationsCampaignManage
             throw new Error(`getSourceLinks error: ${error}`);
         }
     }
+    async createSourceLinks(sourceLinks, jwt = "") {
+        try {
+            const path = `organisations/source-links`;
+            const result = await this.postRequest(path, sourceLinks, jwt);
+            if (result.status !== 201) {
+                throw new Error(`createSourceLinks status is not 201. ${result.body}`);
+            }
+        }
+        catch (error) {
+            throw new Error(`createSourceLinks error: ${error}`);
+        }
+    }
+    async updateSourceLinks(sourceLinks, jwt = "") {
+        try {
+            const path = `organisations/source-links`;
+            const result = await this.putRequest(path, sourceLinks, jwt);
+            if (result.status === 200) {
+                throw new Error(`updateSourceLinks status is not 200. ${result.body}`);
+            }
+        }
+        catch (error) {
+            throw new Error(`updateSourceLinks error: ${error}`);
+        }
+    }
     async postRequest(relative = "", data, jwt = "") {
         return await superagent.post(this.buildBaseUrl(relative))
             .set("Content-Type", "application/json")
             .set("Authorization", jwt)
             .send(data);
     }
+    async putRequest(relative = "", data, jwt = "") {
+        return await superagent.put(this.buildBaseUrl(relative))
+            .set("Content-Type", "application/json")
+            .set("Authorization", jwt)
+            .send(data);
+    }
     async getRequest(relative = "", jwt = "") {
         return await superagent.get(this.buildBaseUrl(relative))
             .set("Content-Type", "application/json")

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

@@ -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;AAKlC,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,GAAG,GAAC,EAAE,EAAE,KAAK,GAAG,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;IAEM,KAAK,CAAC,cAAc,CAAC,cAAsB,EAAE,GAAG,GAAG,EAAE;QAC3D,IAAI;YACH,MAAM,IAAI,GAAG,iBAAiB,cAAc,eAAe,CAAC;YAC5D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAEhD,OAAO,MAAM,CAAC,IAAuB,CAAC;SACtC;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,EAAE,CAAC,CAAC;SAClD;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;AA3DY,wCAAwC;IADpD,IAAA,sBAAU,GAAE;;GACA,wCAAwC,CA2DpD;AA3DY,4FAAwC"}
+{"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;AAKlC,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,GAAG,GAAC,EAAE,EAAE,KAAK,GAAG,EAAE;QACtE,IAAI;YACH,MAAM,IAAI,GAAG,sBAAsB,CAAC;YACpC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE;gBAC3C,UAAU;gBACV,KAAK;aACL,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;IAEM,KAAK,CAAC,cAAc,CAAC,cAAsB,EAAE,GAAG,GAAG,EAAE;QAC3D,IAAI;YACH,MAAM,IAAI,GAAG,iBAAiB,cAAc,eAAe,CAAC;YAC5D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;YAEhD,OAAO,MAAM,CAAC,IAAuB,CAAC;SACtC;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,EAAE,CAAC,CAAC;SAClD;IACF,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,WAAgC,EAAE,GAAG,GAAG,EAAE;QACxE,IAAI;YACH,MAAM,IAAI,GAAG,4BAA4B,CAAC;YAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;YAC9D,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;gBAC1B,MAAM,IAAI,KAAK,CAAC,wCAAwC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;aACvE;SACD;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,4BAA4B,KAAK,EAAE,CAAC,CAAC;SACrD;IACF,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,WAA4B,EAAE,GAAG,GAAG,EAAE;QACpE,IAAI;YACH,MAAM,IAAI,GAAG,4BAA4B,CAAC;YAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;YAC7D,IAAI,MAAM,CAAC,MAAM,KAAK,GAAG,EAAE;gBAC1B,MAAM,IAAI,KAAK,CAAC,wCAAwC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;aACvE;SACD;QAAC,OAAO,KAAK,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,4BAA4B,KAAK,EAAE,CAAC,CAAC;SACrD;IACF,CAAC;IAGO,KAAK,CAAC,WAAW,CAAC,WAAmB,EAAE,EAAE,IAAY,EAAE,GAAG,GAAG,EAAE;QACtE,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,IAAY,EAAE,GAAG,GAAG,EAAE;QACrE,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,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;AA3FY,wCAAwC;IADpD,IAAA,sBAAU,GAAE;;GACA,wCAAwC,CA2FpD;AA3FY,4FAAwC"}