@studyportals/domain-client 3.10.1 → 3.12.0-0

package/index.d.ts

@@ -3,15 +3,15 @@ import { ClientException } from "./src/exceptions/client-exception";
 import { InternalServerException } from "./src/exceptions/internal-server-exception";
 import { NotFoundException } from "./src/exceptions/not-found-exception";
 import { PropertyNotAvailableException } from "./src/exceptions/property-not-available-exception";
-import { IInternalLink } from "./src/models/common/i-internal-link";
-import { ILogo } from "./src/models/common/i-logo";
+import { IInternalLink } from "./src/models/programme-card/i-internal-link";
+import { ILogo } from "./src/models/programme-card/i-logo";
 import { ICover } from "./src/models/programme-card/i-cover";
 import { ILink } from "./src/models/programme-card/i-link";
 import { IOptionalLink } from "./src/models/programme-card/i-optional-link";
 import { ILocation } from "./src/models/programme-card/i-location";
 import { IClickTrackingData } from "./src/models/programme-card/i-click-tracking-data";
 import { ITracking } from "./src/models/programme-card/i-tracking";
-import { ITuitionFee } from "./src/models/common/i-tuition-fee";
+import { ITuitionFee } from "./src/models/programme-card/i-tuition-fee";
 import { IDuration } from "./src/models/programme-card/i-duration";
 import { IDeadline } from "./src/models/programme-card/i-deadline";
 import { IStartDate } from "./src/models/programme-card/i-start-date";
@@ -26,15 +26,17 @@ import { IGeoTargetingConfiguration } from "./src/models/search-projection/i-geo
 import { IGeoTargetingValues } from "./src/models/search-projection/i-geo-targeting-values";
 import { ISearchProjection } from "./src/models/search-projection/i-search-projection";
 import { SearchProjectionClient } from "./src/models/search-projection/search-projection-client";
-import { IEnglishRequirements } from "./src/models/common/i-english-requirements";
-import { ICity } from "./src/models/common/i-city";
+import { IEnglishRequirements } from "./src/models/bestfit-programme/i-english-requirements";
+import { ICity } from "./src/models/bestfit-programme/i-city";
 import { ILivingCost } from "./src/models/bestfit-programme/i-living-cost";
 import { IGPARequirement } from "./src/models/bestfit-programme/i-g-p-a-requirement";
 import { IBestFitProgramme } from "./src/models/bestfit-programme/i-best-fit-programme";
 import { BestfitProgrammeClient } from "./src/models/bestfit-programme/bestfit-programme-client";
-import { ICountry } from "./src/models/common/i-country";
+import { ICountry } from "./src/models/dotdigital-programme/i-country";
 import { IDotDigitalProgramme } from "./src/models/dotdigital-programme/i-dot-digital-programme";
 import { DotdigitalProgrammeClient } from "./src/models/dotdigital-programme/dotdigital-programme-client";
+import { ISitemapProgrammeInfo } from "./src/models/sitemap-programme-info/i-sitemap-programme-info";
+import { SitemapProgrammeInfoClient } from "./src/models/sitemap-programme-info/sitemap-programme-info-client";
 import { ISearchCountryFaq } from "./src/models/search-country-faq/i-search-country-faq";
 import { PublicSearchCountryFaqClient } from "./src/models/search-country-faq/public-search-country-faq-client";
 import { ISitemapCountryInfo } from "./src/models/sitemap-countries-info/i-sitemap-country-info";
@@ -52,7 +54,6 @@ import { ISitemapRankingsInfo } from "./src/models/sitemap-rankings-info/i-sitem
 import { SitemapRankingsInfoClient } from "./src/models/sitemap-rankings-info/sitemap-rankings-info-client";
 import { ISitemapArticleInfo } from "./src/models/sitemap-articles-info/i-sitemap-article-info";
 import { SitemapArticlesInfoClient } from "./src/models/sitemap-articles-info/sitemap-articles-info-client";
-import { PortalType } from "./src/types/portal-type";
-import { PortalMap } from "./src/types/portal-map";
-import { ModelClient } from "./src/model-client";
-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, IDotDigitalProgramme, DotdigitalProgrammeClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISitemapCountryInfo, SitemapCountriesInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, PortalType, PortalMap, ModelClient };
+import { ISitemapCityInfo } from "./src/models/sitemap-cities-info/i-sitemap-city-info";
+import { SitemapCitiesInfoClient } from "./src/models/sitemap-cities-info/sitemap-cities-info-client";
+export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, IInternalLink, ILogo, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, ITuitionFee, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, IEnglishRequirements, ICity, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ICountry, IDotDigitalProgramme, DotdigitalProgrammeClient, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISearchCountryFaq, PublicSearchCountryFaqClient, ISitemapCountryInfo, SitemapCountriesInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, IReview, IDotDigitalOrganisation, DotdigitalOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient };

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelClient = exports.PortalType = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.SitemapOrganisationsInfoClient = exports.DotdigitalOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountriesInfoClient = exports.PublicSearchCountryFaqClient = exports.DotdigitalProgrammeClient = exports.BestfitProgrammeClient = exports.SearchProjectionClient = exports.ProgrammeCardClient = exports.PropertyNotAvailableException = exports.NotFoundException = exports.InternalServerException = exports.ClientException = exports.BadRequestException = void 0;
+exports.SitemapCitiesInfoClient = exports.SitemapArticlesInfoClient = exports.SitemapRankingsInfoClient = exports.SitemapOrganisationsInfoClient = exports.DotdigitalOrganisationClient = exports.SitemapDisciplinesInfoClient = exports.PublicSearchDisciplineClient = exports.SitemapCountriesInfoClient = exports.PublicSearchCountryFaqClient = exports.SitemapProgrammeInfoClient = exports.DotdigitalProgrammeClient = 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");
@@ -19,6 +19,8 @@ const bestfit_programme_client_1 = require("./src/models/bestfit-programme/bestf
 Object.defineProperty(exports, "BestfitProgrammeClient", { enumerable: true, get: function () { return bestfit_programme_client_1.BestfitProgrammeClient; } });
 const dotdigital_programme_client_1 = require("./src/models/dotdigital-programme/dotdigital-programme-client");
 Object.defineProperty(exports, "DotdigitalProgrammeClient", { enumerable: true, get: function () { return dotdigital_programme_client_1.DotdigitalProgrammeClient; } });
+const sitemap_programme_info_client_1 = require("./src/models/sitemap-programme-info/sitemap-programme-info-client");
+Object.defineProperty(exports, "SitemapProgrammeInfoClient", { enumerable: true, get: function () { return sitemap_programme_info_client_1.SitemapProgrammeInfoClient; } });
 const public_search_country_faq_client_1 = require("./src/models/search-country-faq/public-search-country-faq-client");
 Object.defineProperty(exports, "PublicSearchCountryFaqClient", { enumerable: true, get: function () { return public_search_country_faq_client_1.PublicSearchCountryFaqClient; } });
 const sitemap_countries_info_client_1 = require("./src/models/sitemap-countries-info/sitemap-countries-info-client");
@@ -35,8 +37,6 @@ const sitemap_rankings_info_client_1 = require("./src/models/sitemap-rankings-in
 Object.defineProperty(exports, "SitemapRankingsInfoClient", { enumerable: true, get: function () { return sitemap_rankings_info_client_1.SitemapRankingsInfoClient; } });
 const sitemap_articles_info_client_1 = require("./src/models/sitemap-articles-info/sitemap-articles-info-client");
 Object.defineProperty(exports, "SitemapArticlesInfoClient", { enumerable: true, get: function () { return sitemap_articles_info_client_1.SitemapArticlesInfoClient; } });
-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");
-Object.defineProperty(exports, "ModelClient", { enumerable: true, get: function () { return model_client_1.ModelClient; } });
+const sitemap_cities_info_client_1 = require("./src/models/sitemap-cities-info/sitemap-cities-info-client");
+Object.defineProperty(exports, "SitemapCitiesInfoClient", { enumerable: true, get: function () { return sitemap_cities_info_client_1.SitemapCitiesInfoClient; } });
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AA2D3E,oGA3DQ,2CAAmB,OA2DR;AA1DpB,wEAAmE;AA2DlE,gGA3DQ,kCAAe,OA2DR;AA1DhB,0FAAoF;AA2DnF,wGA3DQ,mDAAuB,OA2DR;AA1DxB,8EAAwE;AA2DvE,kGA3DQ,uCAAiB,OA2DR;AA1DlB,wGAAiG;AA2DhG,8GA3DQ,gEAA6B,OA2DR;AA3C9B,6FAAwF;AAwDvF,oGAxDQ,2CAAmB,OAwDR;AAjDpB,sGAAiG;AAwDhG,uGAxDQ,iDAAsB,OAwDR;AAlDvB,sGAAiG;AAsDhG,uGAtDQ,iDAAsB,OAsDR;AAnDvB,+GAA0G;AAyDzG,0GAzDQ,uDAAyB,OAyDR;AAvD1B,uHAAgH;AAyD/G,6GAzDQ,+DAA4B,OAyDR;AAvD7B,qHAA+G;AAyD9G,2GAzDQ,0DAA0B,OAyDR;AAvD3B,oHAA8G;AAyD7G,6GAzDQ,8DAA4B,OAyDR;AAvD7B,2HAAqH;AAyDpH,6GAzDQ,8DAA4B,OAyDR;AAtD7B,wHAAmH;AA2DlH,6GA3DQ,6DAA4B,OA2DR;AAzD7B,iIAA2H;AA2D1H,+GA3DQ,kEAA8B,OA2DR;AAzD/B,kHAA4G;AA2D3G,0GA3DQ,wDAAyB,OA2DR;AAzD1B,kHAA4G;AA2D3G,0GA3DQ,wDAAyB,OA2DR;AA1D1B,yDAAqD;AA2DpD,2FA3DQ,wBAAU,OA2DR;AAzDX,qDAAiD;AA2DhD,4FA3DQ,0BAAW,OA2DR"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AAAA,kFAA4E;AA4D3E,oGA5DQ,2CAAmB,OA4DR;AA3DpB,wEAAmE;AA4DlE,gGA5DQ,kCAAe,OA4DR;AA3DhB,0FAAoF;AA4DnF,wGA5DQ,mDAAuB,OA4DR;AA3DxB,8EAAwE;AA4DvE,kGA5DQ,uCAAiB,OA4DR;AA3DlB,wGAAiG;AA4DhG,8GA5DQ,gEAA6B,OA4DR;AA5C9B,6FAAwF;AA4DvF,oGA5DQ,2CAAmB,OA4DR;AArDpB,sGAAiG;AA4DhG,uGA5DQ,iDAAsB,OA4DR;AAtDvB,sGAAiG;AA4DhG,uGA5DQ,iDAAsB,OA4DR;AAzDvB,+GAA0G;AA4DzG,0GA5DQ,uDAAyB,OA4DR;AA1D1B,qHAA+G;AA4D9G,2GA5DQ,0DAA0B,OA4DR;AA1D3B,uHAAgH;AA4D/G,6GA5DQ,+DAA4B,OA4DR;AA1D7B,qHAA+G;AA4D9G,2GA5DQ,0DAA0B,OA4DR;AA1D3B,oHAA8G;AA4D7G,6GA5DQ,8DAA4B,OA4DR;AA1D7B,2HAAqH;AA4DpH,6GA5DQ,8DAA4B,OA4DR;AAzD7B,wHAAmH;AA4DlH,6GA5DQ,6DAA4B,OA4DR;AA1D7B,iIAA2H;AA4D1H,+GA5DQ,kEAA8B,OA4DR;AA1D/B,kHAA4G;AA4D3G,0GA5DQ,wDAAyB,OA4DR;AA1D1B,kHAA4G;AA4D3G,0GA5DQ,wDAAyB,OA4DR;AA1D1B,4GAAsG;AA4DrG,wGA5DQ,oDAAuB,OA4DR"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studyportals/domain-client",
-  "version": "3.10.1",
+  "version": "3.12.0-0",
   "description": "Responsible for fetching data from the Domain API",
   "main": "bin/index.js",
   "author": "StudyPortals B.V.",

package/src/models/programme-card/i-location.d.ts

@@ -2,6 +2,10 @@ import { IOptionalLink } from "../../..";
 export interface ILocation {
     getArea(): IOptionalLink;
     canShowArea(): boolean;
+    getAreaId(): number;
     getCity(): IOptionalLink;
+    getCityId(): number;
     getCountry(): IOptionalLink;
+    getCountryId(): number;
+    hasAreaId(): boolean;
 }

package/src/models/sitemap-cities-info/i-sitemap-city-info.d.ts

@@ -0,0 +1,14 @@
+export interface ISitemapCityInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+    /**
+     * @return boolean
+     */
+    shouldBeInSitemap(): boolean;
+}

package/src/models/sitemap-cities-info/i-sitemap-city-info.js

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

package/src/models/sitemap-cities-info/i-sitemap-city-info.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"i-sitemap-city-info.js","sourceRoot":"","sources":["../../../../src/models/sitemap-cities-info/i-sitemap-city-info.ts"],"names":[],"mappings":""}

package/src/models/sitemap-cities-info/sitemap-cities-info-client.d.ts

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

package/src/models/sitemap-cities-info/sitemap-cities-info-client.js

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

package/src/models/sitemap-cities-info/sitemap-cities-info-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap-cities-info-client.js","sourceRoot":"","sources":["../../../../src/models/sitemap-cities-info/sitemap-cities-info-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,uBAAwB,SAAQ,0BAA6B;IAC/D,YAAY;QACrB,OAAO,qBAAqB,CAAC;IAC9B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,0DAYC"}

package/src/models/sitemap-programme-info/i-sitemap-programme-info.d.ts

@@ -0,0 +1,10 @@
+export interface ISitemapProgrammeInfo {
+    /**
+     * @return number
+     */
+    getId(): number;
+    /**
+     * @return string
+     */
+    getPath(): string;
+}

package/src/models/sitemap-programme-info/i-sitemap-programme-info.js

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

package/src/models/sitemap-programme-info/i-sitemap-programme-info.js.map

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

package/src/models/sitemap-programme-info/sitemap-programme-info-client.d.ts

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

package/src/models/sitemap-programme-info/sitemap-programme-info-client.js

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

package/src/models/sitemap-programme-info/sitemap-programme-info-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap-programme-info-client.js","sourceRoot":"","sources":["../../../../src/models/sitemap-programme-info/sitemap-programme-info-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,0BAA2B,SAAQ,0BAAkC;IACvE,YAAY;QACrB,OAAO,wBAAwB,CAAC;IACjC,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,gEAYC"}