@studyportals/domain-client 4.15.0 → 4.16.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 (210) hide show
  1. package/index.d.ts +82 -85
  2. package/index.js +61 -63
  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 +51 -51
  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 -7
  58. package/src/models/copilot-country/copilot-country-client.js +16 -16
  59. package/src/models/copilot-country/i-copilot-country.d.ts +39 -39
  60. package/src/models/copilot-country/i-copilot-country.js +2 -2
  61. package/src/models/copilot-country/i-copilot-ranking-card.d.ts +38 -38
  62. package/src/models/copilot-country/i-copilot-ranking-card.js +2 -2
  63. package/src/models/copilot-programme/copilot-programme-client.d.ts +7 -7
  64. package/src/models/copilot-programme/copilot-programme-client.js +16 -16
  65. package/src/models/copilot-programme/i-copilot-programme.d.ts +125 -125
  66. package/src/models/copilot-programme/i-copilot-programme.js +2 -2
  67. package/src/models/customerio-organisation/customerio-organisation-client.d.ts +7 -7
  68. package/src/models/customerio-organisation/customerio-organisation-client.js +16 -16
  69. package/src/models/customerio-organisation/i-customer-io-organisation.d.ts +35 -35
  70. package/src/models/customerio-organisation/i-customer-io-organisation.js +2 -2
  71. package/src/models/customerio-organisation/i-review.d.ts +7 -7
  72. package/src/models/customerio-organisation/i-review.js +2 -2
  73. package/src/models/customerio-programme/customerio-programme-client.d.ts +7 -7
  74. package/src/models/customerio-programme/customerio-programme-client.js +16 -16
  75. package/src/models/customerio-programme/i-customer-io-programme.d.ts +107 -107
  76. package/src/models/customerio-programme/i-customer-io-programme.js +2 -2
  77. package/src/models/customerio-programme/i-internal-link.d.ts +28 -28
  78. package/src/models/customerio-programme/i-internal-link.js +2 -2
  79. package/src/models/organisation-card/i-organisation-card.d.ts +36 -36
  80. package/src/models/organisation-card/i-organisation-card.js +2 -2
  81. package/src/models/organisation-card/i-ranking-discipline.d.ts +4 -4
  82. package/src/models/organisation-card/i-ranking-discipline.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 +32 -32
  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 +116 -116
  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.d.ts +18 -18
  126. package/src/models/ranking-cards/i-ranking.js +2 -2
  127. package/src/models/scholarship-card/i-scholarship-card.d.ts +15 -15
  128. package/src/models/scholarship-card/i-scholarship-card.js +2 -2
  129. package/src/models/scholarship-card/public-scholarship-card-client.d.ts +7 -7
  130. package/src/models/scholarship-card/public-scholarship-card-client.js +16 -16
  131. package/src/models/search-country-faq/i-search-country-faq.d.ts +14 -18
  132. package/src/models/search-country-faq/i-search-country-faq.js +2 -2
  133. package/src/models/search-country-faq/public-search-country-faq-client.d.ts +7 -7
  134. package/src/models/search-country-faq/public-search-country-faq-client.js +16 -16
  135. package/src/models/search-discipline/i-search-discipline.d.ts +26 -26
  136. package/src/models/search-discipline/i-search-discipline.js +2 -2
  137. package/src/models/search-discipline/public-search-discipline-client.d.ts +7 -7
  138. package/src/models/search-discipline/public-search-discipline-client.js +16 -16
  139. package/src/models/search-projection/i-geo-targeting-configuration.d.ts +38 -38
  140. package/src/models/search-projection/i-geo-targeting-configuration.js +2 -2
  141. package/src/models/search-projection/i-geo-targeting-values.d.ts +30 -30
  142. package/src/models/search-projection/i-geo-targeting-values.js +2 -2
  143. package/src/models/search-projection/i-organisation-values.d.ts +46 -46
  144. package/src/models/search-projection/i-organisation-values.js +2 -2
  145. package/src/models/search-projection/i-premium-values.d.ts +35 -35
  146. package/src/models/search-projection/i-premium-values.js +2 -2
  147. package/src/models/search-projection/i-search-projection.d.ts +186 -186
  148. package/src/models/search-projection/i-search-projection.js +2 -2
  149. package/src/models/search-projection/i-tuition-values.d.ts +50 -50
  150. package/src/models/search-projection/i-tuition-values.js +2 -2
  151. package/src/models/search-projection/search-projection-client.d.ts +7 -7
  152. package/src/models/search-projection/search-projection-client.js +16 -16
  153. package/src/models/sitemap-articles-info/i-sitemap-article-info.d.ts +14 -14
  154. package/src/models/sitemap-articles-info/i-sitemap-article-info.js +2 -2
  155. package/src/models/sitemap-articles-info/sitemap-articles-info-client.d.ts +7 -7
  156. package/src/models/sitemap-articles-info/sitemap-articles-info-client.js +16 -16
  157. package/src/models/sitemap-cities-info/i-sitemap-city-info.d.ts +14 -14
  158. package/src/models/sitemap-cities-info/i-sitemap-city-info.js +2 -2
  159. package/src/models/sitemap-cities-info/sitemap-cities-info-client.d.ts +7 -7
  160. package/src/models/sitemap-cities-info/sitemap-cities-info-client.js +16 -16
  161. package/src/models/sitemap-countries-info/i-sitemap-country-info.d.ts +14 -14
  162. package/src/models/sitemap-countries-info/i-sitemap-country-info.js +2 -2
  163. package/src/models/sitemap-countries-info/sitemap-countries-info-client.d.ts +7 -7
  164. package/src/models/sitemap-countries-info/sitemap-countries-info-client.js +16 -16
  165. package/src/models/sitemap-country-degree-info/i-degree-info.d.ts +14 -14
  166. package/src/models/sitemap-country-degree-info/i-degree-info.js +2 -2
  167. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.d.ts +11 -11
  168. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.js +2 -2
  169. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.d.ts +7 -7
  170. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.js +16 -16
  171. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.d.ts +14 -14
  172. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.js +2 -2
  173. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.d.ts +7 -7
  174. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.js +16 -16
  175. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.d.ts +26 -26
  176. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.js +2 -2
  177. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.d.ts +7 -7
  178. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.js +16 -16
  179. package/src/models/sitemap-programme-info/i-sitemap-programme-info.d.ts +26 -26
  180. package/src/models/sitemap-programme-info/i-sitemap-programme-info.js +2 -2
  181. package/src/models/sitemap-programme-info/sitemap-programme-info-client.d.ts +7 -7
  182. package/src/models/sitemap-programme-info/sitemap-programme-info-client.js +16 -16
  183. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.d.ts +14 -14
  184. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.js +2 -2
  185. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.d.ts +7 -7
  186. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.js +16 -16
  187. package/src/types/portal-map.d.ts +2 -2
  188. package/src/types/portal-map.js +2 -2
  189. package/src/types/portal-type.d.ts +7 -7
  190. package/src/types/portal-type.js +11 -11
  191. package/src/types.d.ts +4 -4
  192. package/src/types.js +2 -2
  193. package/src/models/compare-programme/i-english-requirements.d.ts +0 -51
  194. package/src/models/compare-programme/i-english-requirements.js +0 -3
  195. package/src/models/compare-programme/i-english-requirements.js.map +0 -1
  196. package/src/models/compare-programme/i-g-p-a-requirement.d.ts +0 -20
  197. package/src/models/compare-programme/i-g-p-a-requirement.js +0 -3
  198. package/src/models/compare-programme/i-g-p-a-requirement.js.map +0 -1
  199. package/src/models/compare-programme/i-living-cost.d.ts +0 -20
  200. package/src/models/compare-programme/i-living-cost.js +0 -3
  201. package/src/models/compare-programme/i-living-cost.js.map +0 -1
  202. package/src/models/ranking-cards/i-ranking-card.d.ts +0 -87
  203. package/src/models/ranking-cards/i-ranking-card.js +0 -3
  204. package/src/models/ranking-cards/i-ranking-card.js.map +0 -1
  205. package/src/models/ranking-cards/i-ranking-cards.d.ts +0 -15
  206. package/src/models/ranking-cards/i-ranking-cards.js +0 -3
  207. package/src/models/ranking-cards/i-ranking-cards.js.map +0 -1
  208. package/src/models/ranking-cards/public-ranking-cards-client.d.ts +0 -7
  209. package/src/models/ranking-cards/public-ranking-cards-client.js +0 -17
  210. package/src/models/ranking-cards/public-ranking-cards-client.js.map +0 -1
@@ -1,72 +1,72 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.ModelFactory = void 0;
4
- const InternalLinkFactory_1 = require("./factories/InternalLinkFactory");
5
- const DateFactory_1 = require("./factories/DateFactory");
6
- const i_model_description_1 = require("./i-model-description");
7
- const property_not_available_exception_1 = require("./exceptions/property-not-available-exception");
8
- class ModelFactory {
9
- constructor(portalMap = new Map()) {
10
- const factories = new Map();
11
- factories.set('IInternalLink', new InternalLinkFactory_1.InternalLinkFactory(portalMap));
12
- factories.set('SerializableDateTime', new DateFactory_1.DateFactory());
13
- this.customClassFactories = factories;
14
- }
15
- fromDescription(data) {
16
- return this.unpackClass(data);
17
- }
18
- fromDescriptions(data) {
19
- const models = [];
20
- for (const modelDescription of data) {
21
- models.push(this.unpackClass(modelDescription));
22
- }
23
- return models;
24
- }
25
- unpackClass(data) {
26
- const unpacked = {};
27
- for (const functionName in data.func) {
28
- unpacked[functionName] = this.getCallable(functionName, data);
29
- }
30
- const factory = this.customClassFactories.get(data.class);
31
- if (factory !== undefined) {
32
- return factory.create(unpacked, data.parameters);
33
- }
34
- return unpacked;
35
- }
36
- getCallable(functionName, data) {
37
- const propertyName = functionName.substr(3);
38
- const canShowFunction = 'canShow' + propertyName;
39
- const value = data.func[functionName];
40
- let returnValue;
41
- if ((0, i_model_description_1.isModelDescription)(value)) {
42
- returnValue = this.unpackClass(value);
43
- }
44
- else if (Array.isArray(value)) {
45
- returnValue = this.unpackArray(value);
46
- }
47
- else {
48
- returnValue = value;
49
- }
50
- if (canShowFunction in data.func) {
51
- return () => {
52
- if (data.func[canShowFunction] === false) {
53
- throw new property_not_available_exception_1.PropertyNotAvailableException(`Property '${propertyName}' not available`);
54
- }
55
- return returnValue;
56
- };
57
- }
58
- return () => {
59
- return returnValue;
60
- };
61
- }
62
- unpackArray(list) {
63
- return list.map(item => {
64
- if ((0, i_model_description_1.isModelDescription)(item)) {
65
- return this.unpackClass(item);
66
- }
67
- return item;
68
- });
69
- }
70
- }
71
- exports.ModelFactory = ModelFactory;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ModelFactory = void 0;
4
+ const InternalLinkFactory_1 = require("./factories/InternalLinkFactory");
5
+ const DateFactory_1 = require("./factories/DateFactory");
6
+ const i_model_description_1 = require("./i-model-description");
7
+ const property_not_available_exception_1 = require("./exceptions/property-not-available-exception");
8
+ class ModelFactory {
9
+ constructor(portalMap = new Map()) {
10
+ const factories = new Map();
11
+ factories.set('IInternalLink', new InternalLinkFactory_1.InternalLinkFactory(portalMap));
12
+ factories.set('SerializableDateTime', new DateFactory_1.DateFactory());
13
+ this.customClassFactories = factories;
14
+ }
15
+ fromDescription(data) {
16
+ return this.unpackClass(data);
17
+ }
18
+ fromDescriptions(data) {
19
+ const models = [];
20
+ for (const modelDescription of data) {
21
+ models.push(this.unpackClass(modelDescription));
22
+ }
23
+ return models;
24
+ }
25
+ unpackClass(data) {
26
+ const unpacked = {};
27
+ for (const functionName in data.func) {
28
+ unpacked[functionName] = this.getCallable(functionName, data);
29
+ }
30
+ const factory = this.customClassFactories.get(data.class);
31
+ if (factory !== undefined) {
32
+ return factory.create(unpacked, data.parameters);
33
+ }
34
+ return unpacked;
35
+ }
36
+ getCallable(functionName, data) {
37
+ const propertyName = functionName.substr(3);
38
+ const canShowFunction = 'canShow' + propertyName;
39
+ const value = data.func[functionName];
40
+ let returnValue;
41
+ if ((0, i_model_description_1.isModelDescription)(value)) {
42
+ returnValue = this.unpackClass(value);
43
+ }
44
+ else if (Array.isArray(value)) {
45
+ returnValue = this.unpackArray(value);
46
+ }
47
+ else {
48
+ returnValue = value;
49
+ }
50
+ if (canShowFunction in data.func) {
51
+ return () => {
52
+ if (data.func[canShowFunction] === false) {
53
+ throw new property_not_available_exception_1.PropertyNotAvailableException(`Property '${propertyName}' not available`);
54
+ }
55
+ return returnValue;
56
+ };
57
+ }
58
+ return () => {
59
+ return returnValue;
60
+ };
61
+ }
62
+ unpackArray(list) {
63
+ return list.map(item => {
64
+ if ((0, i_model_description_1.isModelDescription)(item)) {
65
+ return this.unpackClass(item);
66
+ }
67
+ return item;
68
+ });
69
+ }
70
+ }
71
+ exports.ModelFactory = ModelFactory;
72
72
  //# sourceMappingURL=model-factory.js.map
@@ -1,7 +1,7 @@
1
- import { IBestFitProgramme } from "../../..";
2
- import { ModelClient } from "../../model-client";
3
- export declare class BestfitProgrammeClient extends ModelClient<IBestFitProgramme> {
4
- protected getModelName(): string;
5
- protected getVersion(): string;
6
- isPublic(): boolean;
7
- }
1
+ import { IBestFitProgramme } from "../../..";
2
+ import { ModelClient } from "../../model-client";
3
+ export declare class BestfitProgrammeClient extends ModelClient<IBestFitProgramme> {
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.BestfitProgrammeClient = void 0;
4
- const model_client_1 = require("../../model-client");
5
- class BestfitProgrammeClient extends model_client_1.ModelClient {
6
- getModelName() {
7
- return 'bestfit-programme';
8
- }
9
- getVersion() {
10
- return 'v1';
11
- }
12
- isPublic() {
13
- return false;
14
- }
15
- }
16
- exports.BestfitProgrammeClient = BestfitProgrammeClient;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BestfitProgrammeClient = void 0;
4
+ const model_client_1 = require("../../model-client");
5
+ class BestfitProgrammeClient extends model_client_1.ModelClient {
6
+ getModelName() {
7
+ return 'bestfit-programme';
8
+ }
9
+ getVersion() {
10
+ return 'v1';
11
+ }
12
+ isPublic() {
13
+ return false;
14
+ }
15
+ }
16
+ exports.BestfitProgrammeClient = BestfitProgrammeClient;
17
17
  //# sourceMappingURL=bestfit-programme-client.js.map
@@ -1,82 +1,82 @@
1
- import { ICity, IEnglishRequirements, IGPARequirement, ILivingCost, ITuitionFee } from "../../..";
2
- export interface IBestFitProgramme {
3
- /**
4
- * Average university ranking across multiple ranking institutes.
5
- *
6
- * @return number
7
- */
8
- getAverageRankingPosition(): number;
9
- canShowAverageRankingPosition(): boolean;
10
- /**
11
- * City which programme is given in
12
- *
13
- * @return ICity
14
- */
15
- getCity(): ICity;
16
- /**
17
- * Get country id the programme is teached in
18
- *
19
- * @return number
20
- */
21
- getCountryId(): number;
22
- /**
23
- * Discipline ids which the program is linked to.
24
- *
25
- * @return number[]
26
- */
27
- getDisciplineIds(): number[];
28
- canShowDisciplineIds(): boolean;
29
- /**
30
- * English level requirements.
31
- *
32
- * @return IEnglishRequirements
33
- */
34
- getEnglishRequirements(): IEnglishRequirements;
35
- /**
36
- * GPA requirements
37
- *
38
- * @return IGPARequirement
39
- */
40
- getGPA(): IGPARequirement;
41
- canShowGPA(): boolean;
42
- /**
43
- * Id of the programme.
44
- *
45
- * @return number
46
- */
47
- getId(): number;
48
- /**
49
- * Estimated living cost based on universities location.
50
- *
51
- * @return ILivingCost
52
- */
53
- getLivingCost(): ILivingCost;
54
- canShowLivingCost(): boolean;
55
- /**
56
- * Minimum required education level
57
- *
58
- * @return string | null
59
- */
60
- getRequiredEducationalLevel(): string | null;
61
- canShowRequiredEducationalLevel(): boolean;
62
- /**
63
- * The programmes tuition fees
64
- *
65
- * @return ITuitionFee[]
66
- */
67
- getTuitionFees(): ITuitionFee[];
68
- canShowTuitionFees(): boolean;
69
- /**
70
- * Amount of years required as work experience
71
- *
72
- * @return number
73
- */
74
- getWorkExperienceYears(): number;
75
- canShowWorkExperienceYears(): boolean;
76
- /**
77
- * Indicates whenever a programme is fully online or not
78
- *
79
- * @return boolean
80
- */
81
- isFullyOnline(): boolean;
82
- }
1
+ import { ICity, IEnglishRequirements, IGPARequirement, ILivingCost, ITuitionFee } from "../../..";
2
+ export interface IBestFitProgramme {
3
+ /**
4
+ * Average university ranking across multiple ranking institutes.
5
+ *
6
+ * @return number
7
+ */
8
+ getAverageRankingPosition(): number;
9
+ canShowAverageRankingPosition(): boolean;
10
+ /**
11
+ * City which programme is given in
12
+ *
13
+ * @return ICity
14
+ */
15
+ getCity(): ICity;
16
+ /**
17
+ * Get country id the programme is teached in
18
+ *
19
+ * @return number
20
+ */
21
+ getCountryId(): number;
22
+ /**
23
+ * Discipline ids which the program is linked to.
24
+ *
25
+ * @return number[]
26
+ */
27
+ getDisciplineIds(): number[];
28
+ canShowDisciplineIds(): boolean;
29
+ /**
30
+ * English level requirements.
31
+ *
32
+ * @return IEnglishRequirements
33
+ */
34
+ getEnglishRequirements(): IEnglishRequirements;
35
+ /**
36
+ * GPA requirements
37
+ *
38
+ * @return IGPARequirement
39
+ */
40
+ getGPA(): IGPARequirement;
41
+ canShowGPA(): boolean;
42
+ /**
43
+ * Id of the programme.
44
+ *
45
+ * @return number
46
+ */
47
+ getId(): number;
48
+ /**
49
+ * Estimated living cost based on universities location.
50
+ *
51
+ * @return ILivingCost
52
+ */
53
+ getLivingCost(): ILivingCost;
54
+ canShowLivingCost(): boolean;
55
+ /**
56
+ * Minimum required education level
57
+ *
58
+ * @return string | null
59
+ */
60
+ getRequiredEducationalLevel(): string | null;
61
+ canShowRequiredEducationalLevel(): boolean;
62
+ /**
63
+ * The programmes tuition fees
64
+ *
65
+ * @return ITuitionFee[]
66
+ */
67
+ getTuitionFees(): ITuitionFee[];
68
+ canShowTuitionFees(): boolean;
69
+ /**
70
+ * Amount of years required as work experience
71
+ *
72
+ * @return number
73
+ */
74
+ getWorkExperienceYears(): number;
75
+ canShowWorkExperienceYears(): boolean;
76
+ /**
77
+ * Indicates whenever a programme is fully online or not
78
+ *
79
+ * @return boolean
80
+ */
81
+ isFullyOnline(): boolean;
82
+ }
@@ -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-best-fit-programme.js.map
@@ -1,14 +1,14 @@
1
- export interface ICity {
2
- /**
3
- * Get city id
4
- *
5
- * @return number
6
- */
7
- getId(): number;
8
- /**
9
- * Get city name
10
- *
11
- * @return string
12
- */
13
- getName(): string;
14
- }
1
+ export interface ICity {
2
+ /**
3
+ * Get city id
4
+ *
5
+ * @return number
6
+ */
7
+ getId(): number;
8
+ /**
9
+ * Get city name
10
+ *
11
+ * @return string
12
+ */
13
+ getName(): string;
14
+ }
@@ -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-city.js.map
@@ -1,20 +1,20 @@
1
- export interface ILivingCost {
2
- /**
3
- * Get the applicable currency.
4
- *
5
- * @return string
6
- */
7
- getCurrency(): string;
8
- /**
9
- * Get the maximum living cost in the provided currency.
10
- *
11
- * @return number
12
- */
13
- getMax(): number;
14
- /**
15
- * Get the minimum living cost in the provided currency.
16
- *
17
- * @return number
18
- */
19
- getMin(): number;
20
- }
1
+ export interface ILivingCost {
2
+ /**
3
+ * Get the applicable currency.
4
+ *
5
+ * @return string
6
+ */
7
+ getCurrency(): string;
8
+ /**
9
+ * Get the maximum living cost in the provided currency.
10
+ *
11
+ * @return number
12
+ */
13
+ getMax(): number;
14
+ /**
15
+ * Get the minimum living cost in the provided currency.
16
+ *
17
+ * @return number
18
+ */
19
+ getMin(): number;
20
+ }
@@ -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-living-cost.js.map
@@ -1,14 +1,14 @@
1
- export interface ICity {
2
- /**
3
- * Get city id
4
- *
5
- * @return number
6
- */
7
- getId(): number;
8
- /**
9
- * Get city name
10
- *
11
- * @return string
12
- */
13
- getName(): string;
14
- }
1
+ export interface ICity {
2
+ /**
3
+ * Get city id
4
+ *
5
+ * @return number
6
+ */
7
+ getId(): number;
8
+ /**
9
+ * Get city name
10
+ *
11
+ * @return string
12
+ */
13
+ getName(): string;
14
+ }
@@ -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-city.js.map
@@ -1,20 +1,20 @@
1
- export interface ICountry {
2
- /**
3
- * Get country iso code
4
- *
5
- * @return string
6
- */
7
- getISOCode(): string;
8
- /**
9
- * Get country id
10
- *
11
- * @return number
12
- */
13
- getId(): number;
14
- /**
15
- * Get country name
16
- *
17
- * @return string
18
- */
19
- getName(): string;
20
- }
1
+ export interface ICountry {
2
+ /**
3
+ * Get country iso code
4
+ *
5
+ * @return string
6
+ */
7
+ getISOCode(): string;
8
+ /**
9
+ * Get country id
10
+ *
11
+ * @return number
12
+ */
13
+ getId(): number;
14
+ /**
15
+ * Get country name
16
+ *
17
+ * @return string
18
+ */
19
+ getName(): string;
20
+ }
@@ -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-country.js.map
@@ -1,51 +1,51 @@
1
- export interface IEnglishRequirements {
2
- /**
3
- * Required score for Cambridge english
4
- *
5
- * @return number
6
- */
7
- getCambridgeEnglish(): number;
8
- canShowCambridgeEnglish(): boolean;
9
- /**
10
- * Required score for Duolingo
11
- *
12
- * @return number
13
- */
14
- getDuolingo(): number;
15
- canShowDuolingo(): boolean;
16
- /**
17
- * Required score for IELTS tests
18
- *
19
- * @return number
20
- */
21
- getIELTS(): number;
22
- canShowIELTS(): boolean;
23
- /**
24
- * Required score for PTE
25
- *
26
- * @return number
27
- */
28
- getPTE(): number;
29
- canShowPTE(): boolean;
30
- /**
31
- * Required score for TOEFL internet
32
- *
33
- * @return number
34
- */
35
- getTOEFLInternet(): number;
36
- canShowTOEFLInternet(): boolean;
37
- /**
38
- * Required score for TOEFL paper
39
- *
40
- * @return number
41
- */
42
- getTOEFLPaper(): number;
43
- canShowTOEFLPaper(): boolean;
44
- /**
45
- * Required score for OTE
46
- *
47
- * @return number
48
- */
49
- getOte(): number;
50
- canShowOte(): boolean;
51
- }
1
+ export interface IEnglishRequirements {
2
+ /**
3
+ * Required score for Cambridge english
4
+ *
5
+ * @return number
6
+ */
7
+ getCambridgeEnglish(): number;
8
+ canShowCambridgeEnglish(): boolean;
9
+ /**
10
+ * Required score for Duolingo
11
+ *
12
+ * @return number
13
+ */
14
+ getDuolingo(): number;
15
+ canShowDuolingo(): boolean;
16
+ /**
17
+ * Required score for IELTS tests
18
+ *
19
+ * @return number
20
+ */
21
+ getIELTS(): number;
22
+ canShowIELTS(): boolean;
23
+ /**
24
+ * Required score for PTE
25
+ *
26
+ * @return number
27
+ */
28
+ getPTE(): number;
29
+ canShowPTE(): boolean;
30
+ /**
31
+ * Required score for TOEFL internet
32
+ *
33
+ * @return number
34
+ */
35
+ getTOEFLInternet(): number;
36
+ canShowTOEFLInternet(): boolean;
37
+ /**
38
+ * Required score for TOEFL paper
39
+ *
40
+ * @return number
41
+ */
42
+ getTOEFLPaper(): number;
43
+ canShowTOEFLPaper(): boolean;
44
+ /**
45
+ * Required score for OTE
46
+ *
47
+ * @return number
48
+ */
49
+ getOte(): number;
50
+ canShowOte(): boolean;
51
+ }
@@ -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-english-requirements.js.map