@studyportals/domain-client 5.0.0 → 5.1.0

package/index.d.ts

@@ -64,6 +64,8 @@ import { ISitemapCityInfo } from "./src/models/sitemap-cities-info/i-sitemap-cit
 import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitemap-cities-info-client";
 import { IScholarshipCard } from "./src/models/scholarship-card/i-scholarship-card";
 import { PublicScholarshipCardClient } from "./src/models/scholarship-card/public-scholarship-card-client";
+import { IScholarshipSearchDocument } from "./src/models/scholarship-search-document/i-scholarship-search-document";
+import { ScholarshipSearchDocumentClient } from "./src/models/scholarship-search-document/scholarship-search-document-client";
 import { IRanking } from './src/models/ranking-cards/i-ranking';
 import { PortalType } from "./src/types/portal-type";
 import { PortalMap } from "./src/types/portal-map";
@@ -77,4 +79,4 @@ import { CopilotProgrammeClient } from "./src/models/copilot-programme/copilot-p
 import { ICopilotCountry } from "./src/models/copilot-country/i-copilot-country";
 import { CopilotCountryClient } from "./src/models/copilot-country/copilot-country-client";
 import { ICopilotRankingCard } from "./src/models/copilot-country/i-copilot-ranking-card";
-export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, ICustomerIOProgramme, CustomerIOProgrammeClient, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, IRanking, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, IRankingDiscipline, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard };
+export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, ICustomerIOProgramme, CustomerIOProgrammeClient, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, IScholarshipCard, PublicScholarshipCardClient, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, IRanking, ICompareProgramme, CompareProgrammeClient, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, IRankingDiscipline, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CopilotCountryClient = exports.CopilotProgrammeClient = exports.OrganisationCardClient = exports.PublicOrganisationForSearchClient = exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.OrganisationSearchDocumentClient = exports.SitemapOrganisationsInfoClient = exports.CustomerIOOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountryDegreeInfoClient = exports.SitemapCountriesInfoClient = exports.SitemapProgrammeInfoClient = exports.CustomerIOProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
+exports.CopilotCountryClient = exports.CopilotProgrammeClient = exports.OrganisationCardClient = exports.PublicOrganisationForSearchClient = exports.ModelClient = exports.PortalType = exports.CompareProgrammeClient = exports.ScholarshipSearchDocumentClient = exports.PublicScholarshipCardClient = exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.OrganisationSearchDocumentClient = exports.SitemapOrganisationsInfoClient = exports.CustomerIOOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountryDegreeInfoClient = exports.SitemapCountriesInfoClient = exports.SitemapProgrammeInfoClient = exports.CustomerIOProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
 const bad_request_exception_1 = require("./src/exceptions/bad-request-exception");
 Object.defineProperty(exports, "BadRequestException", { enumerable: true, get: function () { return bad_request_exception_1.BadRequestException; } });
 const client_exception_1 = require("./src/exceptions/client-exception");
@@ -45,6 +45,8 @@ const sitemap_cities_info_client_1 = require("./src/models/sitemap-cities-info/s
 Object.defineProperty(exports, "SitemapCitiesInfoClient", { enumerable: true, get: function () { return sitemap_cities_info_client_1.SitemapCitiesInfoClient; } });
 const public_scholarship_card_client_1 = require("./src/models/scholarship-card/public-scholarship-card-client");
 Object.defineProperty(exports, "PublicScholarshipCardClient", { enumerable: true, get: function () { return public_scholarship_card_client_1.PublicScholarshipCardClient; } });
+const scholarship_search_document_client_1 = require("./src/models/scholarship-search-document/scholarship-search-document-client");
+Object.defineProperty(exports, "ScholarshipSearchDocumentClient", { enumerable: true, get: function () { return scholarship_search_document_client_1.ScholarshipSearchDocumentClient; } });
 const portal_type_1 = require("./src/types/portal-type");
 Object.defineProperty(exports, "PortalType", { enumerable: true, get: function () { return portal_type_1.PortalType; } });
 const model_client_1 = require("./src/model-client");

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AAiF3E,oGAjFQ,2CAAmB,OAiFR;AAhFpB,wEAAmE;AAiFlE,gGAjFQ,kCAAe,OAiFR;AAhFhB,0FAAoF;AAiFnF,wGAjFQ,mDAAuB,OAiFR;AAhFxB,8EAAwE;AAiFvE,kGAjFQ,uCAAiB,OAiFR;AAhFlB,wGAAiG;AAiFhG,8GAjFQ,gEAA6B,OAiFR;AApE9B,6FAAwF;AAiFvF,oGAjFQ,2CAAmB,OAiFR;AA1EpB,sGAAiG;AAiFhG,uGAjFQ,iDAAsB,OAiFR;AA7EvB,sGAAiG;AAiFhG,uGAjFQ,iDAAsB,OAiFR;AA3EvB,+GAA0G;AAiFzG,0GAjFQ,uDAAyB,OAiFR;AA/E1B,qHAA+G;AAiF9G,2GAjFQ,0DAA0B,OAiFR;AA/E3B,qHAA+G;AAiF9G,2GAjFQ,0DAA0B,OAiFR;AA9E3B,oIAA6H;AAiF5H,+GAjFQ,mEAA8B,OAiFR;AA/E/B,oHAA8G;AAiF7G,6GAjFQ,8DAA4B,OAiFR;AA/E7B,2HAAqH;AAiFpH,6GAjFQ,8DAA4B,OAiFR;AA5E7B,wHAAmH;AAiFlH,6GAjFQ,6DAA4B,OAiFR;AA/E7B,iIAA2H;AAiF1H,+GAjFQ,kEAA8B,OAiFR;AA9E/B,sGAAiG;AAmGhG,uGAnGQ,iDAAsB,OAmGR;AAjGvB,uIAAiI;AA8EhI,iHA9EQ,sEAAgC,OA8ER;AA5EjC,kHAA4G;AA8E3G,0GA9EQ,wDAAyB,OA8ER;AA5E1B,kHAA4G;AA8E3G,0GA9EQ,wDAAyB,OA8ER;AA5E1B,4GAAsG;AA8ErG,wGA9EQ,oDAAuB,OA8ER;AA5ExB,iHAA2G;AA8E1G,4GA9EQ,4DAA2B,OA8ER;AA5E5B,yDAAqD;AAgFpD,2FAhFQ,wBAAU,OAgFR;AA9EX,qDAAiD;AAgFhD,4FAhFQ,0BAAW,OAgFR;AA9EZ,sGAAgG;AA2E/F,uGA3EQ,iDAAsB,OA2ER;AAzEvB,sIAA8H;AA8E7H,kHA9EQ,yEAAiC,OA8ER;AA5ElC,sGAAgG;AAkF/F,uGAlFQ,iDAAsB,OAkFR;AAhFvB,gGAA0F;AAiFzF,qGAjFQ,6CAAoB,OAiFR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA6E;AAmF5E,oGAnFQ,2CAAmB,OAmFR;AAlFpB,wEAAoE;AAmFnE,gGAnFQ,kCAAe,OAmFR;AAlFhB,0FAAqF;AAmFpF,wGAnFQ,mDAAuB,OAmFR;AAlFxB,8EAAyE;AAmFxE,kGAnFQ,uCAAiB,OAmFR;AAlFlB,wGAAkG;AAmFjG,8GAnFQ,gEAA6B,OAmFR;AAtE9B,6FAAwF;AAmFvF,oGAnFQ,2CAAmB,OAmFR;AA5EpB,sGAAiG;AAmFhG,uGAnFQ,iDAAsB,OAmFR;AA/EvB,sGAAiG;AAmFhG,uGAnFQ,iDAAsB,OAmFR;AA7EvB,+GAA0G;AAmFzG,0GAnFQ,uDAAyB,OAmFR;AAjF1B,qHAA+G;AAmF9G,2GAnFQ,0DAA0B,OAmFR;AAjF3B,qHAA+G;AAmF9G,2GAnFQ,0DAA0B,OAmFR;AAhF3B,oIAA6H;AAmF5H,+GAnFQ,mEAA8B,OAmFR;AAjF/B,oHAA8G;AAmF7G,6GAnFQ,8DAA4B,OAmFR;AAjF7B,2HAAqH;AAmFpH,6GAnFQ,8DAA4B,OAmFR;AA9E7B,wHAAmH;AAmFlH,6GAnFQ,6DAA4B,OAmFR;AAjF7B,iIAA2H;AAmF1H,+GAnFQ,kEAA8B,OAmFR;AAhF/B,sGAAiG;AAuGhG,uGAvGQ,iDAAsB,OAuGR;AArGvB,uIAAiI;AAgFhI,iHAhFQ,sEAAgC,OAgFR;AA9EjC,kHAA4G;AAgF3G,0GAhFQ,wDAAyB,OAgFR;AA9E1B,kHAA4G;AAgF3G,0GAhFQ,wDAAyB,OAgFR;AA9E1B,4GAAsG;AAgFrG,wGAhFQ,oDAAuB,OAgFR;AA9ExB,iHAA2G;AAgF1G,4GAhFQ,4DAA2B,OAgFR;AA9E5B,oIAA8H;AAgF7H,gHAhFQ,oEAA+B,OAgFR;AA9EhC,yDAAqD;AAkFpD,2FAlFQ,wBAAU,OAkFR;AAhFX,qDAAiD;AAkFhD,4FAlFQ,0BAAW,OAkFR;AAhFZ,sGAAiG;AA6EhG,uGA7EQ,iDAAsB,OA6ER;AA3EvB,sIAA+H;AAgF9H,kHAhFQ,yEAAiC,OAgFR;AA9ElC,sGAAiG;AAoFhG,uGApFQ,iDAAsB,OAoFR;AAlFvB,gGAA2F;AAmF1F,qGAnFQ,6CAAoB,OAmFR"}

package/package.json

@@ -1,55 +1,55 @@
 {
-  "name": "@studyportals/domain-client",
-  "version": "5.0.0",
-  "description": "Responsible for fetching data from the Domain API",
-  "main": "index.js",
-  "author": "StudyPortals B.V.",
-  "contributors": [
-    "braaibander <danny@studyportals.com>"
-  ],
-  "license": "BSD-3-Clause",
-  "scripts": {
-    "test": "mocha --reporter spec \"tests/**/*.test.ts\"",
-    "coverage": "nyc mocha --reporter dot \"tests/**/*.test.ts\"",
-    "lint": "eslint . --ext .ts --max-warnings=0",
-    "lint:fix": "eslint . --ext .ts --fix",
-    "pre-push": "npm run test && npm run coverage && npm run lint",
-    "prepare-dist": "npm run test  && rm -fR bin && npx tsc && cp package.json bin/package.json && rm -fR bin/tests",
-    "publish-beta": "npm version prerelease --preid=beta && npm run prepare-dist && npm publish ./bin --tag beta",
-    "publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
-    "publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
-    "publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
-    "publish-current": "npm run prepare-dist && npm publish ./bin"
-  },
-  "husky": {
-    "hooks": {
-      "pre-push": "npm run pre-push"
-    }
-  },
-  "dependencies": {
-    "axios": "^1.6.0"
-  },
-  "devDependencies": {
-    "@studyportals/code-style": "^2.0.4",
-    "@testdeck/mocha": "^0.3.3",
-    "@types/axios": "^0.14.0",
-    "@types/mocha": "^10.0.0",
-    "@types/moxios": "^0.4.9",
-    "@types/node": "^14.14.8",
-    "@types/reflect-metadata": "^0.1.0",
-    "@typescript-eslint/eslint-plugin": "^4.8.1",
-    "@typescript-eslint/parser": "^4.8.1",
-    "eslint": "^7.13.0",
-    "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-mocha": "^10.1.0",
-    "husky": "^4.3.0",
-    "mocha": "^10.1.0",
-    "moxios": "^0.4.0",
-    "nyc": "^15.1.0",
-    "source-map-support": "^0.5.19",
-    "ts-node": "^10.9.1",
-    "tslint": "^6.1.3",
-    "typemoq": "^2.1.0",
-    "typescript": "^4.9.3"
-  }
+	"name": "@studyportals/domain-client",
+	"version": "5.1.0",
+	"description": "Responsible for fetching data from the Domain API",
+	"main": "index.js",
+	"author": "StudyPortals B.V.",
+	"contributors": [
+		"braaibander <danny@studyportals.com>"
+	],
+	"license": "BSD-3-Clause",
+	"scripts": {
+		"test": "mocha --reporter spec \"tests/**/*.test.ts\"",
+		"coverage": "nyc mocha --reporter dot \"tests/**/*.test.ts\"",
+		"lint": "eslint . --ext .ts --max-warnings=0",
+		"lint:fix": "eslint . --ext .ts --fix",
+		"pre-push": "npm run test && npm run coverage && npm run lint",
+		"prepare-dist": "npm run test  && rm -fR bin && npx tsc && cp package.json bin/package.json && rm -fR bin/tests",
+		"publish-beta": "npm run prepare-dist && npm publish ./bin --tag beta",
+		"publish-major": "npm version major && npm run prepare-dist && npm publish ./bin",
+		"publish-minor": "npm version minor && npm run prepare-dist && npm publish ./bin",
+		"publish-patch": "npm version patch && npm run prepare-dist && npm publish ./bin",
+		"publish-current": "npm run prepare-dist && npm publish ./bin"
+	},
+	"husky": {
+		"hooks": {
+			"pre-push": "npm run pre-push"
+		}
+	},
+	"dependencies": {
+		"axios": "^1.6.0"
+	},
+	"devDependencies": {
+		"@studyportals/code-style": "^2.0.4",
+		"@testdeck/mocha": "^0.3.3",
+		"@types/axios": "^0.14.0",
+		"@types/mocha": "^10.0.0",
+		"@types/moxios": "^0.4.9",
+		"@types/node": "^14.14.8",
+		"@types/reflect-metadata": "^0.1.0",
+		"@typescript-eslint/eslint-plugin": "^4.8.1",
+		"@typescript-eslint/parser": "^4.8.1",
+		"eslint": "^7.13.0",
+		"eslint-plugin-import": "^2.22.1",
+		"eslint-plugin-mocha": "^10.1.0",
+		"husky": "^4.3.0",
+		"mocha": "^10.1.0",
+		"moxios": "^0.4.0",
+		"nyc": "^15.1.0",
+		"source-map-support": "^0.5.19",
+		"ts-node": "^10.9.1",
+		"tslint": "^6.1.3",
+		"typemoq": "^2.1.0",
+		"typescript": "^4.9.3"
+	}
 }

package/src/models/organisation-search-document/i-organisation-search-document.d.ts

@@ -48,19 +48,19 @@ export interface IOrganisationSearchDocument {
      */
     getPremiumType(): string | null;
     /**
-     * Cheked whether the organisation has studies taught both online and on campus
+     * Checks whether the organisation has studies taught both online and on campus
      *
      * @return boolean
      */
     hasDeliveryMethodBlended(): boolean;
     /**
-     * Cheked whether the organisation has studies taught on campus
+     * Checks whether the organisation has studies taught on campus
      *
      * @return boolean
      */
     hasDeliveryMethodOnCampus(): boolean;
     /**
-     * Cheked whether the organisation has studies taught online
+     * Checks whether the organisation has studies taught online
      *
      * @return boolean
      */

package/src/models/scholarship-search-document/i-scholarship-search-document.d.ts

@@ -0,0 +1,38 @@
+export interface IScholarshipSearchDocument {
+    /**
+     * @return number[]
+     */
+    getDegrees(): number[];
+    /**
+     * @return string[]
+     */
+    getDestinationCountryIsoCodes(): string[];
+    /**
+     * @return number[]
+     */
+    getDestinationRegionIds(): number[];
+    /**
+     * @return number[]
+     */
+    getDisciplineIds(): number[];
+    /**
+     * @return number[]
+     */
+    getFormats(): number[];
+    getId(): number;
+    /**
+     * @return string[]
+     */
+    getOriginCountryIsoCodes(): string[];
+    getPresence(): number;
+    getTitle(): string;
+    /**
+     * @return number[]
+     */
+    getTypes(): number[];
+    getUniversityProviderId(): number | null;
+    isEligibleForAllDestinationCountries(): boolean;
+    isEligibleForAllDestinationRegions(): boolean;
+    isEligibleForAllDisciplines(): boolean;
+    isEligibleForAllOriginCountries(): boolean;
+}

package/src/models/scholarship-search-document/i-scholarship-search-document.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=i-scholarship-search-document.js.map

package/src/models/scholarship-search-document/i-scholarship-search-document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-scholarship-search-document.js","sourceRoot":"","sources":["../../../../src/models/scholarship-search-document/i-scholarship-search-document.ts"],"names":[],"mappings":""}

package/src/models/scholarship-search-document/scholarship-search-document-client.d.ts

@@ -0,0 +1,7 @@
+import { IScholarshipSearchDocument } from "../../..";
+import { ModelClient } from "../../model-client";
+export declare class ScholarshipSearchDocumentClient extends ModelClient<IScholarshipSearchDocument> {
+    protected getModelName(): string;
+    protected getVersion(): string;
+    isPublic(): boolean;
+}

package/src/models/scholarship-search-document/scholarship-search-document-client.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScholarshipSearchDocumentClient = void 0;
+const model_client_1 = require("../../model-client");
+class ScholarshipSearchDocumentClient extends model_client_1.ModelClient {
+    getModelName() {
+        return 'scholarship-search-document';
+    }
+    getVersion() {
+        return 'v1';
+    }
+    isPublic() {
+        return false;
+    }
+}
+exports.ScholarshipSearchDocumentClient = ScholarshipSearchDocumentClient;
+//# sourceMappingURL=scholarship-search-document-client.js.map

package/src/models/scholarship-search-document/scholarship-search-document-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scholarship-search-document-client.js","sourceRoot":"","sources":["../../../../src/models/scholarship-search-document/scholarship-search-document-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,+BAAgC,SAAQ,0BAAuC;IACjF,YAAY;QACrB,OAAO,6BAA6B,CAAC;IACtC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,0EAYC"}