@studyportals/domain-client 3.22.0 → 3.24.0-beta.0

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.
Files changed (3) hide show
  1. package/package.json +1 -1
  2. package/src/models/dotdigital-programme/i-dot-digital-programme.d.ts +7 -1
  3. package/src/models/ranking-cards/i-ranking-card.d.ts +20 -2
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@studyportals/domain-client",
3
- "version": "3.22.0",
3
+ "version": "3.24.0-beta.0",
4
4
  "description": "Responsible for fetching data from the Domain API",
5
5
  "main": "bin/index.js",
6
6
  "author": "StudyPortals B.V.",
package/src/models/dotdigital-programme/i-dot-digital-programme.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITuitionFee } from "../../..";
1
+ import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITiming, ITuitionFee } from "../../..";
2
2
  export interface IDotDigitalProgramme {
3
3
  /**
4
4
  * Campaign type of the campaign the programme is attached to
@@ -67,6 +67,12 @@ export interface IDotDigitalProgramme {
67
67
  */
68
68
  getReviewRating(): number;
69
69
  canShowReviewRating(): boolean;
70
+ /**
71
+ * Get all start dates
72
+ *
73
+ * @return ITiming[]
74
+ */
75
+ getTimings(): ITiming[];
70
76
  /**
71
77
  * Title of the programme.
72
78
  *
package/src/models/ranking-cards/i-ranking-card.d.ts CHANGED
@@ -43,11 +43,29 @@ export interface IRankingCard {
43
43
  */
44
44
  getPosition(): number | null;
45
45
  /**
46
- * Defines the percentage categories in the Studyportals ranking.
46
+ * Retrieves the ranking position for the organisation in the Studyportals ranking in the country of the university.
47
+ *
48
+ * @return number | null
49
+ */
50
+ getPositionInCountry(): number | null;
51
+ /**
52
+ * Retrieves the ranking position for the organisation in the Studyportals ranking in the region of the university.
53
+ *
54
+ * @return number | null
55
+ */
56
+ getPositionInRegion(): number | null;
57
+ /**
58
+ * Retrieves the percentage category in the Studyportals ranking.
59
+ *
60
+ * @return string | null
61
+ */
62
+ getGlobalPositionPercentage(): string | null;
63
+ /**
64
+ * Retrieves the percentage category in the Studyportals ranking for the current location.
47
65
  *
48
66
  * @return string | null
49
67
  */
50
- getGlobalPositionPercentageCategories(): string | null;
68
+ getCountryPositionPercentage(): string | null;
51
69
  /**
52
70
  * Get the year the organisation was ranked.
53
71
  *