@studyportals/domain-client 10.2.0 → 10.3.1-beta.1

package/index.d.ts

@@ -57,7 +57,7 @@ import { ISitemapOrganisationInfo } from "./src/models/sitemap-organisations-inf
 import { SitemapOrganisationsInfoClient } from "./src/models/sitemap-organisations-info/sitemap-organisations-info-client.js";
 import { IOrganisationCard } from "./src/models/organisation-card/i-organisation-card.js";
 import { OrganisationCardClient } from "./src/models/organisation-card/organisation-card-client.js";
-import { IOrganisationSearchDocument } from "./src/models/organisation-search-document/i-organisation-search-document.js";
+import { IOrganisationSearchDocument, IOrganisationSearchDocumentReviews } from "./src/models/organisation-search-document/i-organisation-search-document.js";
 import { OrganisationSearchDocumentClient } from "./src/models/organisation-search-document/organisation-search-document-client.js";
 import { ISitemapRankingsInfo } from "./src/models/sitemap-rankings-info/i-sitemap-rankings-info.js";
 import { SitemapRankingsInfoClient } from "./src/models/sitemap-rankings-info/sitemap-rankings-info-client.js";
@@ -84,6 +84,6 @@ import { ICopilotRankingCard } from "./src/models/copilot-country/i-copilot-rank
 import { IReviewRating } from "./src/models/common/i-review-rating.js";
 import { IScholarshipCard } from "./src/models/scholarship-card/i-scholarship-card.js";
 import { IRankingDiscipline } from './src/models/organisation-card/i-ranking-discipline.js';
-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, IFaqStaticContent, PublicFaqStaticContentClient, IFaq, IStaticContentUrl, 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, ScholarshipCardV2Client, IScholarshipCard, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, ICitySearchDocument, CitySearchDocumentClient, IRanking, PortalType, PortalMap, ModelClient, IRankingDiscipline, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard, IReviewRating };
+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, IFaqStaticContent, PublicFaqStaticContentClient, IFaq, IStaticContentUrl, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, IOrganisationSearchDocumentReviews, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, ScholarshipCardV2Client, IScholarshipCard, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, ICitySearchDocument, CitySearchDocumentClient, IRanking, PortalType, PortalMap, ModelClient, IRankingDiscipline, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard, IReviewRating };
 export * from './src/clients/index.js';
 export * from './protobuf/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@studyportals/domain-client",
-	"version": "10.2.0",
+	"version": "10.3.1-beta.1",
 	"description": "Responsible for fetching data from the Domain API",
 	"type": "module",
 	"main": "index.js",

package/protobuf/PartnerApi/PartnerApiScholarship.d.ts

@@ -27,6 +27,7 @@ export interface PartnerApiEligibility {
     studyLevel: Degree[];
     scholarshipType: ApplicationBasis[];
     description?: string | undefined;
+    destinationCountries?: QualifiedCountries | undefined;
 }
 export interface PartnerApiScholarshipOrganisation {
     id: number;

package/protobuf/PartnerApi/PartnerApiScholarship.js

@@ -1,7 +1,7 @@
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v2.11.8
-//   protoc               v3.21.12
+//   protoc-gen-ts_proto  v2.7.7
+//   protoc               v6.33.2
 // source: PartnerApi/PartnerApiScholarship.proto
 /* eslint-disable */
 import { Link } from "../Link.js";
@@ -112,6 +112,9 @@ export const PartnerApiEligibility = {
                 ? object.scholarshipType.map((e) => ApplicationBasis.fromJSON(e))
                 : [],
             description: isSet(object.description) ? globalThis.String(object.description) : undefined,
+            destinationCountries: isSet(object.destinationCountries)
+                ? QualifiedCountries.fromJSON(object.destinationCountries)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -128,6 +131,9 @@ export const PartnerApiEligibility = {
         if (message.description !== undefined) {
             obj.description = message.description;
         }
+        if (message.destinationCountries !== undefined) {
+            obj.destinationCountries = QualifiedCountries.toJSON(message.destinationCountries);
+        }
         return obj;
     },
 };

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

@@ -179,4 +179,16 @@ export interface IOrganisationSearchDocument {
      * @return Record<string, number> | null
      */
     getRankedPositionByDiscipline(): Record<string, number> | null;
+    /**
+     * Gets the reviews of the organisation: average rating (null without reviews), number of reviews
+     * and GSSA scores per category of the latest GSSA edition (null when not available)
+     *
+     * @return IOrganisationSearchDocumentReviews
+     */
+    getReviews(): IOrganisationSearchDocumentReviews;
+}
+export interface IOrganisationSearchDocumentReviews {
+    average: number | null;
+    quantity: number;
+    gssaScores: Record<string, number | null> | null;
 }