@studyportals/domain-client 3.32.0-organisations.0 → 3.33.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 (198) hide show
  1. package/index.d.ts +83 -79
  2. package/index.js +63 -59
  3. package/index.js.map +1 -1
  4. package/package.json +55 -55
  5. package/src/domain-client.d.ts +14 -14
  6. package/src/domain-client.js +60 -60
  7. package/src/exceptions/bad-request-exception.d.ts +2 -2
  8. package/src/exceptions/bad-request-exception.js +6 -6
  9. package/src/exceptions/client-exception.d.ts +2 -2
  10. package/src/exceptions/client-exception.js +6 -6
  11. package/src/exceptions/internal-server-exception.d.ts +2 -2
  12. package/src/exceptions/internal-server-exception.js +6 -6
  13. package/src/exceptions/not-found-exception.d.ts +2 -2
  14. package/src/exceptions/not-found-exception.js +6 -6
  15. package/src/exceptions/property-not-available-exception.d.ts +2 -2
  16. package/src/exceptions/property-not-available-exception.js +6 -6
  17. package/src/factories/DateFactory.d.ts +5 -5
  18. package/src/factories/DateFactory.js +9 -9
  19. package/src/factories/InternalLinkFactory.d.ts +9 -9
  20. package/src/factories/InternalLinkFactory.js +19 -19
  21. package/src/i-api-response.d.ts +6 -6
  22. package/src/i-api-response.js +2 -2
  23. package/src/i-class-factory.d.ts +4 -4
  24. package/src/i-class-factory.js +2 -2
  25. package/src/i-model-description.d.ts +7 -7
  26. package/src/i-model-description.js +9 -9
  27. package/src/model-client.d.ts +16 -16
  28. package/src/model-client.js +45 -45
  29. package/src/model-factory.d.ts +11 -11
  30. package/src/model-factory.js +71 -71
  31. package/src/models/bestfit-programme/bestfit-programme-client.d.ts +7 -7
  32. package/src/models/bestfit-programme/bestfit-programme-client.js +16 -16
  33. package/src/models/bestfit-programme/i-best-fit-programme.d.ts +82 -82
  34. package/src/models/bestfit-programme/i-best-fit-programme.js +2 -2
  35. package/src/models/bestfit-programme/i-city.d.ts +14 -14
  36. package/src/models/bestfit-programme/i-city.js +2 -2
  37. package/src/models/bestfit-programme/i-living-cost.d.ts +20 -20
  38. package/src/models/bestfit-programme/i-living-cost.js +2 -2
  39. package/src/models/common/i-city.d.ts +14 -14
  40. package/src/models/common/i-city.js +2 -2
  41. package/src/models/common/i-country.d.ts +20 -20
  42. package/src/models/common/i-country.js +2 -2
  43. package/src/models/common/i-english-requirements.d.ts +44 -44
  44. package/src/models/common/i-english-requirements.js +2 -2
  45. package/src/models/common/i-g-p-a-requirement.d.ts +20 -20
  46. package/src/models/common/i-g-p-a-requirement.js +2 -2
  47. package/src/models/common/i-internal-link.d.ts +28 -28
  48. package/src/models/common/i-internal-link.js +2 -2
  49. package/src/models/common/i-logo.d.ts +14 -14
  50. package/src/models/common/i-logo.js +2 -2
  51. package/src/models/common/i-tuition-fee.d.ts +50 -50
  52. package/src/models/common/i-tuition-fee.js +2 -2
  53. package/src/models/compare-programme/compare-programme-client.d.ts +7 -7
  54. package/src/models/compare-programme/compare-programme-client.js +16 -16
  55. package/src/models/compare-programme/i-compare-programme.d.ts +108 -108
  56. package/src/models/compare-programme/i-compare-programme.js +2 -2
  57. package/src/models/copilot-country/copilot-country-client.d.ts +7 -0
  58. package/src/models/copilot-country/copilot-country-client.js +17 -0
  59. package/src/models/copilot-country/copilot-country-client.js.map +1 -0
  60. package/src/models/copilot-country/i-copilot-country.d.ts +32 -0
  61. package/src/models/copilot-country/i-copilot-country.js +3 -0
  62. package/src/models/copilot-country/i-copilot-country.js.map +1 -0
  63. package/src/models/copilot-programme/copilot-programme-client.d.ts +7 -0
  64. package/src/models/copilot-programme/copilot-programme-client.js +17 -0
  65. package/src/models/copilot-programme/copilot-programme-client.js.map +1 -0
  66. package/src/models/copilot-programme/i-copilot-programme.d.ts +92 -0
  67. package/src/models/copilot-programme/i-copilot-programme.js +3 -0
  68. package/src/models/copilot-programme/i-copilot-programme.js.map +1 -0
  69. package/src/models/dotdigital-organisation/dotdigital-organisation-client.d.ts +7 -7
  70. package/src/models/dotdigital-organisation/dotdigital-organisation-client.js +16 -16
  71. package/src/models/dotdigital-organisation/i-dot-digital-organisation.d.ts +35 -35
  72. package/src/models/dotdigital-organisation/i-dot-digital-organisation.js +2 -2
  73. package/src/models/dotdigital-organisation/i-review.d.ts +7 -7
  74. package/src/models/dotdigital-organisation/i-review.js +2 -2
  75. package/src/models/dotdigital-programme/dotdigital-programme-client.d.ts +7 -7
  76. package/src/models/dotdigital-programme/dotdigital-programme-client.js +16 -16
  77. package/src/models/dotdigital-programme/i-dot-digital-programme.d.ts +107 -107
  78. package/src/models/dotdigital-programme/i-dot-digital-programme.js +2 -2
  79. package/src/models/dotdigital-programme/i-internal-link.d.ts +28 -28
  80. package/src/models/dotdigital-programme/i-internal-link.js +2 -2
  81. package/src/models/organisation-card/i-organisation-card.d.ts +17 -17
  82. package/src/models/organisation-card/i-organisation-card.js +2 -2
  83. package/src/models/organisation-card/organisation-card-client.d.ts +7 -7
  84. package/src/models/organisation-card/organisation-card-client.js +16 -16
  85. package/src/models/organisation-for-search/i-organisation-for-search.d.ts +26 -26
  86. package/src/models/organisation-for-search/i-organisation-for-search.js +2 -2
  87. package/src/models/organisation-for-search/public-organisation-for-search-client.d.ts +7 -7
  88. package/src/models/organisation-for-search/public-organisation-for-search-client.js +16 -16
  89. package/src/models/organisation-search-document/i-organisation-search-document.d.ts +74 -69
  90. package/src/models/organisation-search-document/i-organisation-search-document.js +2 -2
  91. package/src/models/organisation-search-document/organisation-search-document-client.d.ts +7 -7
  92. package/src/models/organisation-search-document/organisation-search-document-client.js +16 -16
  93. package/src/models/programme-card/i-click-tracking-data.d.ts +5 -5
  94. package/src/models/programme-card/i-click-tracking-data.js +2 -2
  95. package/src/models/programme-card/i-cover.d.ts +14 -14
  96. package/src/models/programme-card/i-cover.js +2 -2
  97. package/src/models/programme-card/i-deadline.d.ts +20 -20
  98. package/src/models/programme-card/i-deadline.js +2 -2
  99. package/src/models/programme-card/i-duration.d.ts +40 -40
  100. package/src/models/programme-card/i-duration.js +2 -2
  101. package/src/models/programme-card/i-internal-link.d.ts +28 -28
  102. package/src/models/programme-card/i-internal-link.js +2 -2
  103. package/src/models/programme-card/i-link.d.ts +22 -22
  104. package/src/models/programme-card/i-link.js +2 -2
  105. package/src/models/programme-card/i-location.d.ts +12 -12
  106. package/src/models/programme-card/i-location.js +2 -2
  107. package/src/models/programme-card/i-logo.d.ts +14 -14
  108. package/src/models/programme-card/i-logo.js +2 -2
  109. package/src/models/programme-card/i-optional-link.d.ts +23 -23
  110. package/src/models/programme-card/i-optional-link.js +2 -2
  111. package/src/models/programme-card/i-programme-card.d.ts +205 -205
  112. package/src/models/programme-card/i-programme-card.js +2 -2
  113. package/src/models/programme-card/i-start-date.d.ts +33 -33
  114. package/src/models/programme-card/i-start-date.js +2 -2
  115. package/src/models/programme-card/i-timing.d.ts +45 -45
  116. package/src/models/programme-card/i-timing.js +2 -2
  117. package/src/models/programme-card/i-tracked-link.d.ts +29 -29
  118. package/src/models/programme-card/i-tracked-link.js +2 -2
  119. package/src/models/programme-card/i-tracking.d.ts +46 -46
  120. package/src/models/programme-card/i-tracking.js +2 -2
  121. package/src/models/programme-card/i-tuition-fee.d.ts +50 -50
  122. package/src/models/programme-card/i-tuition-fee.js +2 -2
  123. package/src/models/programme-card/programme-card-client.d.ts +7 -7
  124. package/src/models/programme-card/programme-card-client.js +16 -16
  125. package/src/models/ranking-cards/i-ranking-card.d.ts +87 -87
  126. package/src/models/ranking-cards/i-ranking-card.js +2 -2
  127. package/src/models/ranking-cards/i-ranking-cards.d.ts +15 -15
  128. package/src/models/ranking-cards/i-ranking-cards.js +2 -2
  129. package/src/models/ranking-cards/i-ranking.d.ts +18 -18
  130. package/src/models/ranking-cards/i-ranking.js +2 -2
  131. package/src/models/ranking-cards/public-ranking-cards-client.d.ts +7 -7
  132. package/src/models/ranking-cards/public-ranking-cards-client.js +16 -16
  133. package/src/models/scholarship-card/i-scholarship-card.d.ts +15 -15
  134. package/src/models/scholarship-card/i-scholarship-card.js +2 -2
  135. package/src/models/scholarship-card/public-scholarship-card-client.d.ts +7 -7
  136. package/src/models/scholarship-card/public-scholarship-card-client.js +16 -16
  137. package/src/models/search-country-faq/i-search-country-faq.d.ts +18 -18
  138. package/src/models/search-country-faq/i-search-country-faq.js +2 -2
  139. package/src/models/search-country-faq/public-search-country-faq-client.d.ts +7 -7
  140. package/src/models/search-country-faq/public-search-country-faq-client.js +16 -16
  141. package/src/models/search-discipline/i-search-discipline.d.ts +26 -26
  142. package/src/models/search-discipline/i-search-discipline.js +2 -2
  143. package/src/models/search-discipline/public-search-discipline-client.d.ts +7 -7
  144. package/src/models/search-discipline/public-search-discipline-client.js +16 -16
  145. package/src/models/search-projection/i-geo-targeting-configuration.d.ts +38 -38
  146. package/src/models/search-projection/i-geo-targeting-configuration.js +2 -2
  147. package/src/models/search-projection/i-geo-targeting-values.d.ts +30 -30
  148. package/src/models/search-projection/i-geo-targeting-values.js +2 -2
  149. package/src/models/search-projection/i-organisation-values.d.ts +40 -40
  150. package/src/models/search-projection/i-organisation-values.js +2 -2
  151. package/src/models/search-projection/i-premium-values.d.ts +35 -35
  152. package/src/models/search-projection/i-premium-values.js +2 -2
  153. package/src/models/search-projection/i-search-projection.d.ts +180 -180
  154. package/src/models/search-projection/i-search-projection.js +2 -2
  155. package/src/models/search-projection/i-tuition-values.d.ts +50 -50
  156. package/src/models/search-projection/i-tuition-values.js +2 -2
  157. package/src/models/search-projection/search-projection-client.d.ts +7 -7
  158. package/src/models/search-projection/search-projection-client.js +16 -16
  159. package/src/models/sitemap-articles-info/i-sitemap-article-info.d.ts +14 -14
  160. package/src/models/sitemap-articles-info/i-sitemap-article-info.js +2 -2
  161. package/src/models/sitemap-articles-info/sitemap-articles-info-client.d.ts +7 -7
  162. package/src/models/sitemap-articles-info/sitemap-articles-info-client.js +16 -16
  163. package/src/models/sitemap-cities-info/i-sitemap-city-info.d.ts +14 -14
  164. package/src/models/sitemap-cities-info/i-sitemap-city-info.js +2 -2
  165. package/src/models/sitemap-cities-info/sitemap-cities-info-client.d.ts +7 -7
  166. package/src/models/sitemap-cities-info/sitemap-cities-info-client.js +16 -16
  167. package/src/models/sitemap-countries-info/i-sitemap-country-info.d.ts +14 -14
  168. package/src/models/sitemap-countries-info/i-sitemap-country-info.js +2 -2
  169. package/src/models/sitemap-countries-info/sitemap-countries-info-client.d.ts +7 -7
  170. package/src/models/sitemap-countries-info/sitemap-countries-info-client.js +16 -16
  171. package/src/models/sitemap-country-degree-info/i-degree-info.d.ts +14 -14
  172. package/src/models/sitemap-country-degree-info/i-degree-info.js +2 -2
  173. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.d.ts +11 -11
  174. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.js +2 -2
  175. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.d.ts +7 -7
  176. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.js +16 -16
  177. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.d.ts +14 -14
  178. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.js +2 -2
  179. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.d.ts +7 -7
  180. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.js +16 -16
  181. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.d.ts +26 -26
  182. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.js +2 -2
  183. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.d.ts +7 -7
  184. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.js +16 -16
  185. package/src/models/sitemap-programme-info/i-sitemap-programme-info.d.ts +26 -26
  186. package/src/models/sitemap-programme-info/i-sitemap-programme-info.js +2 -2
  187. package/src/models/sitemap-programme-info/sitemap-programme-info-client.d.ts +7 -7
  188. package/src/models/sitemap-programme-info/sitemap-programme-info-client.js +16 -16
  189. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.d.ts +14 -14
  190. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.js +2 -2
  191. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.d.ts +7 -7
  192. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.js +16 -16
  193. package/src/types/portal-map.d.ts +2 -2
  194. package/src/types/portal-map.js +2 -2
  195. package/src/types/portal-type.d.ts +7 -7
  196. package/src/types/portal-type.js +11 -11
  197. package/src/types.d.ts +4 -4
  198. package/src/types.js +2 -2
@@ -1,35 +1,35 @@
1
- import { ICity, ICountry, IReview } from "../../..";
2
- export interface IDotDigitalOrganisation {
3
- getAboutCareer(): string | null;
4
- getAboutEducation(): string | null;
5
- getAboutHistory(): string | null;
6
- getAboutResearch(): string | null;
7
- getAcademicStaff(): number | null;
8
- getAmountOfProgrammes(): number;
9
- getAverageStudentRating(): number | null;
10
- getCity(): ICity;
11
- getCountry(): ICountry;
12
- getCoverUrl(): string | null;
13
- getFemaleStudents(): number | null;
14
- getId(): number;
15
- getLogoUrl(): string | null;
16
- getName(): string | null;
17
- getOrganisationUrl(): string;
18
- /**
19
- * @return string[] | null
20
- */
21
- getReasons(): string[] | null;
22
- /**
23
- * @return IReview[]
24
- */
25
- getReviews(): IReview[];
26
- getServicesHousing(): string | null;
27
- getServicesICT(): string | null;
28
- getServicesLibrary(): string | null;
29
- getServicesMedical(): string | null;
30
- getServicesStudent(): string | null;
31
- getStudentLifeCampus(): string | null;
32
- getStudentLifeSport(): string | null;
33
- getStudents(): number | null;
34
- getStudentsInternational(): number | null;
35
- }
1
+ import { ICity, ICountry, IReview } from "../../..";
2
+ export interface IDotDigitalOrganisation {
3
+ getAboutCareer(): string | null;
4
+ getAboutEducation(): string | null;
5
+ getAboutHistory(): string | null;
6
+ getAboutResearch(): string | null;
7
+ getAcademicStaff(): number | null;
8
+ getAmountOfProgrammes(): number;
9
+ getAverageStudentRating(): number | null;
10
+ getCity(): ICity;
11
+ getCountry(): ICountry;
12
+ getCoverUrl(): string | null;
13
+ getFemaleStudents(): number | null;
14
+ getId(): number;
15
+ getLogoUrl(): string | null;
16
+ getName(): string | null;
17
+ getOrganisationUrl(): string;
18
+ /**
19
+ * @return string[] | null
20
+ */
21
+ getReasons(): string[] | null;
22
+ /**
23
+ * @return IReview[]
24
+ */
25
+ getReviews(): IReview[];
26
+ getServicesHousing(): string | null;
27
+ getServicesICT(): string | null;
28
+ getServicesLibrary(): string | null;
29
+ getServicesMedical(): string | null;
30
+ getServicesStudent(): string | null;
31
+ getStudentLifeCampus(): string | null;
32
+ getStudentLifeSport(): string | null;
33
+ getStudents(): number | null;
34
+ getStudentsInternational(): number | null;
35
+ }
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=i-dot-digital-organisation.js.map
@@ -1,7 +1,7 @@
1
- export interface IReview {
2
- getEndDate(): Date | null;
3
- getRating(): number;
4
- getReview(): string | null;
5
- getStartDate(): Date | null;
6
- getTitle(): string | null;
7
- }
1
+ export interface IReview {
2
+ getEndDate(): Date | null;
3
+ getRating(): number;
4
+ getReview(): string | null;
5
+ getStartDate(): Date | null;
6
+ getTitle(): string | null;
7
+ }
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=i-review.js.map
@@ -1,7 +1,7 @@
1
- import { IDotDigitalProgramme } from "../../..";
2
- import { ModelClient } from "../../model-client";
3
- export declare class DotdigitalProgrammeClient extends ModelClient<IDotDigitalProgramme> {
4
- protected getModelName(): string;
5
- protected getVersion(): string;
6
- isPublic(): boolean;
7
- }
1
+ import { IDotDigitalProgramme } from "../../..";
2
+ import { ModelClient } from "../../model-client";
3
+ export declare class DotdigitalProgrammeClient extends ModelClient<IDotDigitalProgramme> {
4
+ protected getModelName(): string;
5
+ protected getVersion(): string;
6
+ isPublic(): boolean;
7
+ }
@@ -1,17 +1,17 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DotdigitalProgrammeClient = void 0;
4
- const model_client_1 = require("../../model-client");
5
- class DotdigitalProgrammeClient extends model_client_1.ModelClient {
6
- getModelName() {
7
- return 'dotdigital-programme';
8
- }
9
- getVersion() {
10
- return 'v1';
11
- }
12
- isPublic() {
13
- return false;
14
- }
15
- }
16
- exports.DotdigitalProgrammeClient = DotdigitalProgrammeClient;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DotdigitalProgrammeClient = void 0;
4
+ const model_client_1 = require("../../model-client");
5
+ class DotdigitalProgrammeClient extends model_client_1.ModelClient {
6
+ getModelName() {
7
+ return 'dotdigital-programme';
8
+ }
9
+ getVersion() {
10
+ return 'v1';
11
+ }
12
+ isPublic() {
13
+ return false;
14
+ }
15
+ }
16
+ exports.DotdigitalProgrammeClient = DotdigitalProgrammeClient;
17
17
  //# sourceMappingURL=dotdigital-programme-client.js.map
@@ -1,107 +1,107 @@
1
- import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITiming, ITuitionFee } from "../../..";
2
- export interface IDotDigitalProgramme {
3
- /**
4
- * Campaign type of the campaign the programme is attached to
5
- *
6
- * @return number
7
- */
8
- getCampaignType(): number;
9
- canShowCampaignType(): boolean;
10
- /**
11
- * Get country the programme is teached in
12
- *
13
- * @return ICountry
14
- */
15
- getCountry(): ICountry;
16
- canShowCountry(): boolean;
17
- /**
18
- * Get discipline ids attached to this programme
19
- *
20
- * @return number[]
21
- */
22
- getDisciplineIds(): number[];
23
- /**
24
- * Education level
25
- *
26
- * @return string
27
- */
28
- getEducationalLevel(): string;
29
- /**
30
- * English level requirements.
31
- *
32
- * @return IEnglishRequirements
33
- */
34
- getEnglishRequirements(): IEnglishRequirements;
35
- /**
36
- * Id of the programme.
37
- *
38
- * @return number
39
- */
40
- getId(): number;
41
- /**
42
- * The last time the programme has been updated and verified
43
- *
44
- * @return Date
45
- */
46
- getLastUpdated(): Date;
47
- /**
48
- * University logo url
49
- *
50
- * @return ILogo
51
- */
52
- getLogo(): ILogo;
53
- canShowLogo(): boolean;
54
- /**
55
- * Get a link to the programme page.
56
- *
57
- * The link contains the page path as url and the programme name as the
58
- * link description.
59
- *
60
- * @return IInternalLink
61
- */
62
- getProgrammeLink(): IInternalLink;
63
- /**
64
- * The universities review rating
65
- *
66
- * @return number
67
- */
68
- getReviewRating(): number;
69
- canShowReviewRating(): boolean;
70
- /**
71
- * Get all start dates
72
- *
73
- * @return ITiming[]
74
- */
75
- getTimings(): ITiming[];
76
- /**
77
- * Title of the programme.
78
- *
79
- * @return string
80
- */
81
- getTitle(): string;
82
- /**
83
- * The programmes tuition fees
84
- *
85
- * @return ITuitionFee[]
86
- */
87
- getTuitionFees(): ITuitionFee[];
88
- canShowTuitionFees(): boolean;
89
- /**
90
- * University id
91
- *
92
- * @return number
93
- */
94
- getUniversityId(): number;
95
- /**
96
- * University title
97
- *
98
- * @return string
99
- */
100
- getUniversityTitle(): string;
101
- /**
102
- * Is programme public
103
- *
104
- * @return boolean
105
- */
106
- isPublic(): boolean;
107
- }
1
+ import { ICountry, IEnglishRequirements, IInternalLink, ILogo, ITiming, ITuitionFee } from "../../..";
2
+ export interface IDotDigitalProgramme {
3
+ /**
4
+ * Campaign type of the campaign the programme is attached to
5
+ *
6
+ * @return number
7
+ */
8
+ getCampaignType(): number;
9
+ canShowCampaignType(): boolean;
10
+ /**
11
+ * Get country the programme is teached in
12
+ *
13
+ * @return ICountry
14
+ */
15
+ getCountry(): ICountry;
16
+ canShowCountry(): boolean;
17
+ /**
18
+ * Get discipline ids attached to this programme
19
+ *
20
+ * @return number[]
21
+ */
22
+ getDisciplineIds(): number[];
23
+ /**
24
+ * Education level
25
+ *
26
+ * @return string
27
+ */
28
+ getEducationalLevel(): string;
29
+ /**
30
+ * English level requirements.
31
+ *
32
+ * @return IEnglishRequirements
33
+ */
34
+ getEnglishRequirements(): IEnglishRequirements;
35
+ /**
36
+ * Id of the programme.
37
+ *
38
+ * @return number
39
+ */
40
+ getId(): number;
41
+ /**
42
+ * The last time the programme has been updated and verified
43
+ *
44
+ * @return Date
45
+ */
46
+ getLastUpdated(): Date;
47
+ /**
48
+ * University logo url
49
+ *
50
+ * @return ILogo
51
+ */
52
+ getLogo(): ILogo;
53
+ canShowLogo(): boolean;
54
+ /**
55
+ * Get a link to the programme page.
56
+ *
57
+ * The link contains the page path as url and the programme name as the
58
+ * link description.
59
+ *
60
+ * @return IInternalLink
61
+ */
62
+ getProgrammeLink(): IInternalLink;
63
+ /**
64
+ * The universities review rating
65
+ *
66
+ * @return number
67
+ */
68
+ getReviewRating(): number;
69
+ canShowReviewRating(): boolean;
70
+ /**
71
+ * Get all start dates
72
+ *
73
+ * @return ITiming[]
74
+ */
75
+ getTimings(): ITiming[];
76
+ /**
77
+ * Title of the programme.
78
+ *
79
+ * @return string
80
+ */
81
+ getTitle(): string;
82
+ /**
83
+ * The programmes tuition fees
84
+ *
85
+ * @return ITuitionFee[]
86
+ */
87
+ getTuitionFees(): ITuitionFee[];
88
+ canShowTuitionFees(): boolean;
89
+ /**
90
+ * University id
91
+ *
92
+ * @return number
93
+ */
94
+ getUniversityId(): number;
95
+ /**
96
+ * University title
97
+ *
98
+ * @return string
99
+ */
100
+ getUniversityTitle(): string;
101
+ /**
102
+ * Is programme public
103
+ *
104
+ * @return boolean
105
+ */
106
+ isPublic(): boolean;
107
+ }
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=i-dot-digital-programme.js.map
@@ -1,28 +1,28 @@
1
- export interface IInternalLink {
2
- /**
3
- * Get an optional text describing the link (typically <a>-tags contents).
4
- *
5
- * @return string
6
- * @throws PropertyNotAvailableException
7
- */
8
- getDescription(): string;
9
- canShowDescription(): boolean;
10
- /**
11
- * Returns on which portal a this link should link towards.
12
- *
13
- * @return string
14
- */
15
- getPortalType(): string;
16
- /**
17
- * Get the url to refer to.
18
- *
19
- * Note that the url provided is always a relative URL. A base URL is needed
20
- * to make it a full valid path.
21
- * The only exception is when an external link is provided (meaning, outside
22
- * of StudyPortals-maintained domains). In this case a full url will be
23
- * provided.
24
- *
25
- * @return string
26
- */
27
- getUrl(): string;
28
- }
1
+ export interface IInternalLink {
2
+ /**
3
+ * Get an optional text describing the link (typically <a>-tags contents).
4
+ *
5
+ * @return string
6
+ * @throws PropertyNotAvailableException
7
+ */
8
+ getDescription(): string;
9
+ canShowDescription(): boolean;
10
+ /**
11
+ * Returns on which portal a this link should link towards.
12
+ *
13
+ * @return string
14
+ */
15
+ getPortalType(): string;
16
+ /**
17
+ * Get the url to refer to.
18
+ *
19
+ * Note that the url provided is always a relative URL. A base URL is needed
20
+ * to make it a full valid path.
21
+ * The only exception is when an external link is provided (meaning, outside
22
+ * of StudyPortals-maintained domains). In this case a full url will be
23
+ * provided.
24
+ *
25
+ * @return string
26
+ */
27
+ getUrl(): string;
28
+ }
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=i-internal-link.js.map
@@ -1,17 +1,17 @@
1
- export interface IOrganisationCard {
2
- getOrganisationCoverImageCdn(): string | null;
3
- getOrganisationHasDeliveryMethodBlended(): boolean;
4
- getOrganisationHasDeliveryMethodOnCampus(): boolean;
5
- getOrganisationHasDeliveryMethodOnline(): boolean;
6
- getOrganisationId(): number;
7
- getOrganisationLocationCityName(): string | null;
8
- getOrganisationLocationCityRelativeLinkOfDetailPage(): string | null;
9
- getOrganisationLocationCountryIsoCode(): string | null;
10
- getOrganisationLocationCountryRelativeLinkOfDetailPage(): string | null;
11
- getOrganisationLogoSquareCdn(): string | null;
12
- getOrganisationMayShowCoverImage(): boolean;
13
- getOrganisationMayShowLogoSquare(): boolean;
14
- getOrganisationName(): string;
15
- getOrganisationRelativeLinkOfDetailPage(): string;
16
- getOrganisationSummary(): string | null;
17
- }
1
+ export interface IOrganisationCard {
2
+ getOrganisationCoverImageCdn(): string | null;
3
+ getOrganisationHasDeliveryMethodBlended(): boolean;
4
+ getOrganisationHasDeliveryMethodOnCampus(): boolean;
5
+ getOrganisationHasDeliveryMethodOnline(): boolean;
6
+ getOrganisationId(): number;
7
+ getOrganisationLocationCityName(): string | null;
8
+ getOrganisationLocationCityRelativeLinkOfDetailPage(): string | null;
9
+ getOrganisationLocationCountryIsoCode(): string | null;
10
+ getOrganisationLocationCountryRelativeLinkOfDetailPage(): string | null;
11
+ getOrganisationLogoSquareCdn(): string | null;
12
+ getOrganisationMayShowCoverImage(): boolean;
13
+ getOrganisationMayShowLogoSquare(): boolean;
14
+ getOrganisationName(): string;
15
+ getOrganisationRelativeLinkOfDetailPage(): string;
16
+ getOrganisationSummary(): string | null;
17
+ }
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=i-organisation-card.js.map
@@ -1,7 +1,7 @@
1
- import { IOrganisationCard } from "../../..";
2
- import { ModelClient } from "../../model-client";
3
- export declare class OrganisationCardClient extends ModelClient<IOrganisationCard> {
4
- protected getModelName(): string;
5
- protected getVersion(): string;
6
- isPublic(): boolean;
7
- }
1
+ import { IOrganisationCard } from "../../..";
2
+ import { ModelClient } from "../../model-client";
3
+ export declare class OrganisationCardClient extends ModelClient<IOrganisationCard> {
4
+ protected getModelName(): string;
5
+ protected getVersion(): string;
6
+ isPublic(): boolean;
7
+ }
@@ -1,17 +1,17 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.OrganisationCardClient = void 0;
4
- const model_client_1 = require("../../model-client");
5
- class OrganisationCardClient extends model_client_1.ModelClient {
6
- getModelName() {
7
- return 'organisation-card';
8
- }
9
- getVersion() {
10
- return 'v1';
11
- }
12
- isPublic() {
13
- return false;
14
- }
15
- }
16
- exports.OrganisationCardClient = OrganisationCardClient;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.OrganisationCardClient = void 0;
4
+ const model_client_1 = require("../../model-client");
5
+ class OrganisationCardClient extends model_client_1.ModelClient {
6
+ getModelName() {
7
+ return 'organisation-card';
8
+ }
9
+ getVersion() {
10
+ return 'v1';
11
+ }
12
+ isPublic() {
13
+ return false;
14
+ }
15
+ }
16
+ exports.OrganisationCardClient = OrganisationCardClient;
17
17
  //# sourceMappingURL=organisation-card-client.js.map
@@ -1,26 +1,26 @@
1
- export interface IOrganisationForSearch {
2
- /**
3
- * Gets the ISO codes of all countries where the organisation has venues.
4
- *
5
- * @return string[]
6
- */
7
- getIsoCodesOfCountriesOfVenues(): string[];
8
- /**
9
- * Gets the ID of the organisation.
10
- *
11
- * @return number
12
- */
13
- getOrganisationId(): number;
14
- /**
15
- * Gets the name of the organisation.
16
- *
17
- * @return string
18
- */
19
- getOrganisationName(): string;
20
- /**
21
- * Gets the virtual name of the organisation.
22
- *
23
- * @return string
24
- */
25
- getOrganisationVirtualName(): string;
26
- }
1
+ export interface IOrganisationForSearch {
2
+ /**
3
+ * Gets the ISO codes of all countries where the organisation has venues.
4
+ *
5
+ * @return string[]
6
+ */
7
+ getIsoCodesOfCountriesOfVenues(): string[];
8
+ /**
9
+ * Gets the ID of the organisation.
10
+ *
11
+ * @return number
12
+ */
13
+ getOrganisationId(): number;
14
+ /**
15
+ * Gets the name of the organisation.
16
+ *
17
+ * @return string
18
+ */
19
+ getOrganisationName(): string;
20
+ /**
21
+ * Gets the virtual name of the organisation.
22
+ *
23
+ * @return string
24
+ */
25
+ getOrganisationVirtualName(): string;
26
+ }
@@ -1,3 +1,3 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  //# sourceMappingURL=i-organisation-for-search.js.map
@@ -1,7 +1,7 @@
1
- import { IOrganisationForSearch } from "../../..";
2
- import { ModelClient } from "../../model-client";
3
- export declare class PublicOrganisationForSearchClient extends ModelClient<IOrganisationForSearch> {
4
- protected getModelName(): string;
5
- protected getVersion(): string;
6
- isPublic(): boolean;
7
- }
1
+ import { IOrganisationForSearch } from "../../..";
2
+ import { ModelClient } from "../../model-client";
3
+ export declare class PublicOrganisationForSearchClient extends ModelClient<IOrganisationForSearch> {
4
+ protected getModelName(): string;
5
+ protected getVersion(): string;
6
+ isPublic(): boolean;
7
+ }
@@ -1,17 +1,17 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PublicOrganisationForSearchClient = void 0;
4
- const model_client_1 = require("../../model-client");
5
- class PublicOrganisationForSearchClient extends model_client_1.ModelClient {
6
- getModelName() {
7
- return 'organisation-for-search';
8
- }
9
- getVersion() {
10
- return 'v1';
11
- }
12
- isPublic() {
13
- return true;
14
- }
15
- }
16
- exports.PublicOrganisationForSearchClient = PublicOrganisationForSearchClient;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PublicOrganisationForSearchClient = void 0;
4
+ const model_client_1 = require("../../model-client");
5
+ class PublicOrganisationForSearchClient extends model_client_1.ModelClient {
6
+ getModelName() {
7
+ return 'organisation-for-search';
8
+ }
9
+ getVersion() {
10
+ return 'v1';
11
+ }
12
+ isPublic() {
13
+ return true;
14
+ }
15
+ }
16
+ exports.PublicOrganisationForSearchClient = PublicOrganisationForSearchClient;
17
17
  //# sourceMappingURL=public-organisation-for-search-client.js.map