@studyportals/domain-client 5.1.0-beta.0 → 5.2.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 (194) hide show
  1. package/index.d.ts +80 -82
  2. package/index.js +59 -61
  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/copilot-country/copilot-country-client.d.ts +7 -7
  54. package/src/models/copilot-country/copilot-country-client.js +16 -16
  55. package/src/models/copilot-country/i-copilot-country.d.ts +39 -39
  56. package/src/models/copilot-country/i-copilot-country.js +2 -2
  57. package/src/models/copilot-country/i-copilot-ranking-card.d.ts +38 -38
  58. package/src/models/copilot-country/i-copilot-ranking-card.js +2 -2
  59. package/src/models/copilot-programme/copilot-programme-client.d.ts +7 -7
  60. package/src/models/copilot-programme/copilot-programme-client.js +16 -16
  61. package/src/models/copilot-programme/i-copilot-programme.d.ts +125 -125
  62. package/src/models/copilot-programme/i-copilot-programme.js +2 -2
  63. package/src/models/customerio-organisation/customerio-organisation-client.d.ts +7 -7
  64. package/src/models/customerio-organisation/customerio-organisation-client.js +16 -16
  65. package/src/models/customerio-organisation/i-customer-io-organisation.d.ts +35 -35
  66. package/src/models/customerio-organisation/i-customer-io-organisation.js +2 -2
  67. package/src/models/customerio-organisation/i-review.d.ts +7 -7
  68. package/src/models/customerio-organisation/i-review.js +2 -2
  69. package/src/models/customerio-programme/customerio-programme-client.d.ts +7 -7
  70. package/src/models/customerio-programme/customerio-programme-client.js +16 -16
  71. package/src/models/customerio-programme/i-customer-io-programme.d.ts +107 -107
  72. package/src/models/customerio-programme/i-customer-io-programme.js +2 -2
  73. package/src/models/customerio-programme/i-internal-link.d.ts +28 -28
  74. package/src/models/customerio-programme/i-internal-link.js +2 -2
  75. package/src/models/organisation-card/i-organisation-card.d.ts +36 -36
  76. package/src/models/organisation-card/i-organisation-card.js +2 -2
  77. package/src/models/organisation-card/i-ranking-discipline.d.ts +4 -4
  78. package/src/models/organisation-card/i-ranking-discipline.js +2 -2
  79. package/src/models/organisation-card/organisation-card-client.d.ts +7 -7
  80. package/src/models/organisation-card/organisation-card-client.js +16 -16
  81. package/src/models/organisation-for-search/i-organisation-for-search.d.ts +32 -32
  82. package/src/models/organisation-for-search/i-organisation-for-search.js +2 -2
  83. package/src/models/organisation-for-search/public-organisation-for-search-client.d.ts +7 -7
  84. package/src/models/organisation-for-search/public-organisation-for-search-client.js +16 -16
  85. package/src/models/organisation-search-document/i-organisation-search-document.d.ts +116 -116
  86. package/src/models/organisation-search-document/i-organisation-search-document.js +2 -2
  87. package/src/models/organisation-search-document/organisation-search-document-client.d.ts +7 -7
  88. package/src/models/organisation-search-document/organisation-search-document-client.js +16 -16
  89. package/src/models/programme-card/i-click-tracking-data.d.ts +5 -5
  90. package/src/models/programme-card/i-click-tracking-data.js +2 -2
  91. package/src/models/programme-card/i-cover.d.ts +14 -14
  92. package/src/models/programme-card/i-cover.js +2 -2
  93. package/src/models/programme-card/i-deadline.d.ts +20 -20
  94. package/src/models/programme-card/i-deadline.js +2 -2
  95. package/src/models/programme-card/i-duration.d.ts +40 -40
  96. package/src/models/programme-card/i-duration.js +2 -2
  97. package/src/models/programme-card/i-internal-link.d.ts +28 -28
  98. package/src/models/programme-card/i-internal-link.js +2 -2
  99. package/src/models/programme-card/i-link.d.ts +22 -22
  100. package/src/models/programme-card/i-link.js +2 -2
  101. package/src/models/programme-card/i-location.d.ts +12 -12
  102. package/src/models/programme-card/i-location.js +2 -2
  103. package/src/models/programme-card/i-logo.d.ts +14 -14
  104. package/src/models/programme-card/i-logo.js +2 -2
  105. package/src/models/programme-card/i-optional-link.d.ts +23 -23
  106. package/src/models/programme-card/i-optional-link.js +2 -2
  107. package/src/models/programme-card/i-programme-card.d.ts +205 -205
  108. package/src/models/programme-card/i-programme-card.js +2 -2
  109. package/src/models/programme-card/i-start-date.d.ts +33 -33
  110. package/src/models/programme-card/i-start-date.js +2 -2
  111. package/src/models/programme-card/i-timing.d.ts +45 -45
  112. package/src/models/programme-card/i-timing.js +2 -2
  113. package/src/models/programme-card/i-tracked-link.d.ts +29 -29
  114. package/src/models/programme-card/i-tracked-link.js +2 -2
  115. package/src/models/programme-card/i-tracking.d.ts +46 -46
  116. package/src/models/programme-card/i-tracking.js +2 -2
  117. package/src/models/programme-card/i-tuition-fee.d.ts +50 -50
  118. package/src/models/programme-card/i-tuition-fee.js +2 -2
  119. package/src/models/programme-card/programme-card-client.d.ts +7 -7
  120. package/src/models/programme-card/programme-card-client.js +16 -16
  121. package/src/models/ranking-cards/i-ranking.d.ts +18 -18
  122. package/src/models/ranking-cards/i-ranking.js +2 -2
  123. package/src/models/scholarship-card/i-scholarship-card.d.ts +15 -15
  124. package/src/models/scholarship-card/i-scholarship-card.js +2 -2
  125. package/src/models/scholarship-card/public-scholarship-card-client.d.ts +7 -7
  126. package/src/models/scholarship-card/public-scholarship-card-client.js +16 -16
  127. package/src/models/scholarship-search-document/i-scholarship-search-document.d.ts +38 -38
  128. package/src/models/scholarship-search-document/i-scholarship-search-document.js +2 -2
  129. package/src/models/scholarship-search-document/scholarship-search-document-client.d.ts +7 -7
  130. package/src/models/scholarship-search-document/scholarship-search-document-client.js +16 -16
  131. package/src/models/search-discipline/i-search-discipline.d.ts +26 -26
  132. package/src/models/search-discipline/i-search-discipline.js +2 -2
  133. package/src/models/search-discipline/public-search-discipline-client.d.ts +7 -7
  134. package/src/models/search-discipline/public-search-discipline-client.js +16 -16
  135. package/src/models/search-projection/i-geo-targeting-configuration.d.ts +38 -38
  136. package/src/models/search-projection/i-geo-targeting-configuration.js +2 -2
  137. package/src/models/search-projection/i-geo-targeting-values.d.ts +30 -30
  138. package/src/models/search-projection/i-geo-targeting-values.js +2 -2
  139. package/src/models/search-projection/i-organisation-values.d.ts +46 -46
  140. package/src/models/search-projection/i-organisation-values.js +2 -2
  141. package/src/models/search-projection/i-premium-values.d.ts +35 -35
  142. package/src/models/search-projection/i-premium-values.js +2 -2
  143. package/src/models/search-projection/i-search-projection.d.ts +186 -186
  144. package/src/models/search-projection/i-search-projection.js +2 -2
  145. package/src/models/search-projection/i-tuition-values.d.ts +50 -50
  146. package/src/models/search-projection/i-tuition-values.js +2 -2
  147. package/src/models/search-projection/search-projection-client.d.ts +7 -7
  148. package/src/models/search-projection/search-projection-client.js +16 -16
  149. package/src/models/sitemap-articles-info/i-sitemap-article-info.d.ts +26 -26
  150. package/src/models/sitemap-articles-info/i-sitemap-article-info.js +2 -2
  151. package/src/models/sitemap-articles-info/sitemap-articles-info-client.d.ts +7 -7
  152. package/src/models/sitemap-articles-info/sitemap-articles-info-client.js +16 -16
  153. package/src/models/sitemap-cities-info/i-sitemap-city-info.d.ts +14 -14
  154. package/src/models/sitemap-cities-info/i-sitemap-city-info.js +2 -2
  155. package/src/models/sitemap-cities-info/sitemap-cities-info-client.d.ts +7 -7
  156. package/src/models/sitemap-cities-info/sitemap-cities-info-client.js +16 -16
  157. package/src/models/sitemap-countries-info/i-sitemap-country-info.d.ts +14 -14
  158. package/src/models/sitemap-countries-info/i-sitemap-country-info.js +2 -2
  159. package/src/models/sitemap-countries-info/sitemap-countries-info-client.d.ts +7 -7
  160. package/src/models/sitemap-countries-info/sitemap-countries-info-client.js +16 -16
  161. package/src/models/sitemap-country-degree-info/i-degree-info.d.ts +14 -14
  162. package/src/models/sitemap-country-degree-info/i-degree-info.js +2 -2
  163. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.d.ts +11 -11
  164. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.js +2 -2
  165. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.d.ts +7 -7
  166. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.js +16 -16
  167. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.d.ts +14 -14
  168. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.js +2 -2
  169. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.d.ts +7 -7
  170. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.js +16 -16
  171. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.d.ts +26 -26
  172. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.js +2 -2
  173. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.d.ts +7 -7
  174. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.js +16 -16
  175. package/src/models/sitemap-programme-info/i-sitemap-programme-info.d.ts +26 -26
  176. package/src/models/sitemap-programme-info/i-sitemap-programme-info.js +2 -2
  177. package/src/models/sitemap-programme-info/sitemap-programme-info-client.d.ts +7 -7
  178. package/src/models/sitemap-programme-info/sitemap-programme-info-client.js +16 -16
  179. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.d.ts +14 -14
  180. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.js +2 -2
  181. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.d.ts +7 -7
  182. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.js +16 -16
  183. package/src/types/portal-map.d.ts +2 -2
  184. package/src/types/portal-map.js +2 -2
  185. package/src/types/portal-type.d.ts +7 -7
  186. package/src/types/portal-type.js +11 -11
  187. package/src/types.d.ts +4 -4
  188. package/src/types.js +2 -2
  189. package/src/models/compare-programme/compare-programme-client.d.ts +0 -7
  190. package/src/models/compare-programme/compare-programme-client.js +0 -17
  191. package/src/models/compare-programme/compare-programme-client.js.map +0 -1
  192. package/src/models/compare-programme/i-compare-programme.d.ts +0 -108
  193. package/src/models/compare-programme/i-compare-programme.js +0 -3
  194. package/src/models/compare-programme/i-compare-programme.js.map +0 -1
@@ -1,17 +1,17 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SitemapRankingsInfoClient = void 0;
4
- const model_client_1 = require("../../model-client");
5
- class SitemapRankingsInfoClient extends model_client_1.ModelClient {
6
- getModelName() {
7
- return 'sitemap-rankings-info';
8
- }
9
- getVersion() {
10
- return 'v1';
11
- }
12
- isPublic() {
13
- return false;
14
- }
15
- }
16
- exports.SitemapRankingsInfoClient = SitemapRankingsInfoClient;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SitemapRankingsInfoClient = void 0;
4
+ const model_client_1 = require("../../model-client");
5
+ class SitemapRankingsInfoClient extends model_client_1.ModelClient {
6
+ getModelName() {
7
+ return 'sitemap-rankings-info';
8
+ }
9
+ getVersion() {
10
+ return 'v1';
11
+ }
12
+ isPublic() {
13
+ return false;
14
+ }
15
+ }
16
+ exports.SitemapRankingsInfoClient = SitemapRankingsInfoClient;
17
17
  //# sourceMappingURL=sitemap-rankings-info-client.js.map
@@ -1,2 +1,2 @@
1
- import { PortalType } from "./portal-type";
2
- export type PortalMap = Map<PortalType, string>;
1
+ import { PortalType } from "./portal-type";
2
+ export type PortalMap = Map<PortalType, string>;
@@ -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=portal-map.js.map
@@ -1,7 +1,7 @@
1
- export declare enum PortalType {
2
- MASTER = "master",
3
- BACHELOR = "bachelor",
4
- PHD = "phd",
5
- SHORT = "short",
6
- DISTANCE_LEARNING = "distance_learning"
7
- }
1
+ export declare enum PortalType {
2
+ MASTER = "master",
3
+ BACHELOR = "bachelor",
4
+ PHD = "phd",
5
+ SHORT = "short",
6
+ DISTANCE_LEARNING = "distance_learning"
7
+ }
@@ -1,12 +1,12 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PortalType = void 0;
4
- var PortalType;
5
- (function (PortalType) {
6
- PortalType["MASTER"] = "master";
7
- PortalType["BACHELOR"] = "bachelor";
8
- PortalType["PHD"] = "phd";
9
- PortalType["SHORT"] = "short";
10
- PortalType["DISTANCE_LEARNING"] = "distance_learning";
11
- })(PortalType = exports.PortalType || (exports.PortalType = {}));
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PortalType = void 0;
4
+ var PortalType;
5
+ (function (PortalType) {
6
+ PortalType["MASTER"] = "master";
7
+ PortalType["BACHELOR"] = "bachelor";
8
+ PortalType["PHD"] = "phd";
9
+ PortalType["SHORT"] = "short";
10
+ PortalType["DISTANCE_LEARNING"] = "distance_learning";
11
+ })(PortalType = exports.PortalType || (exports.PortalType = {}));
12
12
  //# sourceMappingURL=portal-type.js.map
package/src/types.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export type Model = Record<string, Callable>;
2
- export type Callable = () => CallableReturnType | CallableReturnType[];
3
- export type CallableReturnType = AcceptedType | Model;
4
- export type AcceptedType = string | string[] | number | number[] | boolean | null | Date;
1
+ export type Model = Record<string, Callable>;
2
+ export type Callable = () => CallableReturnType | CallableReturnType[];
3
+ export type CallableReturnType = AcceptedType | Model;
4
+ export type AcceptedType = string | string[] | number | number[] | boolean | null | Date;
package/src/types.js CHANGED
@@ -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=types.js.map
@@ -1,7 +0,0 @@
1
- import { ICompareProgramme } from "../../..";
2
- import { ModelClient } from "../../model-client";
3
- export declare class CompareProgrammeClient extends ModelClient<ICompareProgramme> {
4
- protected getModelName(): string;
5
- protected getVersion(): string;
6
- isPublic(): boolean;
7
- }
@@ -1,17 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CompareProgrammeClient = void 0;
4
- const model_client_1 = require("../../model-client");
5
- class CompareProgrammeClient extends model_client_1.ModelClient {
6
- getModelName() {
7
- return 'compare-programme';
8
- }
9
- getVersion() {
10
- return 'v1';
11
- }
12
- isPublic() {
13
- return false;
14
- }
15
- }
16
- exports.CompareProgrammeClient = CompareProgrammeClient;
17
- //# sourceMappingURL=compare-programme-client.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"compare-programme-client.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/compare-programme-client.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AAEjD,MAAa,sBAAuB,SAAQ,0BAA8B;IAC/D,YAAY;QACrB,OAAO,mBAAmB,CAAC;IAC5B,CAAC;IAES,UAAU;QACnB,OAAO,IAAI,CAAC;IACb,CAAC;IAEM,QAAQ;QACd,OAAO,KAAK,CAAC;IACd,CAAC;CACD;AAZD,wDAYC"}
@@ -1,108 +0,0 @@
1
- import { IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ITiming, ITuitionFee } from "../../..";
2
- export interface ICompareProgramme {
3
- /**
4
- * Degree of programme
5
- *
6
- * @return string
7
- */
8
- getDegree(): string;
9
- /**
10
- * Duration of the programme
11
- *
12
- * @return IDuration | null
13
- */
14
- getDuration(): IDuration | null;
15
- /**
16
- * English level requirements.
17
- *
18
- * @return IEnglishRequirements
19
- */
20
- getEnglishRequirements(): IEnglishRequirements;
21
- /**
22
- * GPA requirements
23
- *
24
- * @return IGPARequirement | null
25
- */
26
- getGPA(): IGPARequirement | null;
27
- /**
28
- * Id of the programme.
29
- *
30
- * @return number
31
- */
32
- getId(): number;
33
- /**
34
- * Estimated living cost based on universities' location.
35
- *
36
- * @return ILivingCost | null
37
- */
38
- getLivingCost(): ILivingCost | null;
39
- /**
40
- * Indicates where a programme is taught
41
- *
42
- * @return ILocation | null
43
- */
44
- getLocation(): ILocation | null;
45
- /**
46
- * Get a link to the programme page.
47
- *
48
- * The link contains the page path as url and the programme name as the
49
- * link description.
50
- *
51
- * @return IInternalLink
52
- */
53
- getProgrammeLink(): IInternalLink;
54
- /**
55
- * The universities review quantity
56
- *
57
- * @return number | null
58
- */
59
- getReviewQuantity(): number | null;
60
- /**
61
- * The universities review rating
62
- *
63
- * @return number | null
64
- */
65
- getReviewRating(): number | null;
66
- /**
67
- * Get all start dates
68
- *
69
- * @return ITiming[]
70
- */
71
- getTimings(): ITiming[];
72
- /**
73
- * Title of the programme.
74
- *
75
- * @return string
76
- */
77
- getTitle(): string;
78
- /**
79
- * The programmes tuition fees
80
- *
81
- * @return ITuitionFee[]
82
- */
83
- getTuitionFees(): ITuitionFee[];
84
- /**
85
- * Returns a link to the university
86
- *
87
- * @return ILink
88
- */
89
- getUniversityLink(): ILink;
90
- /**
91
- * Amount of years required as work experience
92
- *
93
- * @return number | null
94
- */
95
- getWorkExperienceYears(): number | null;
96
- /**
97
- * Indicates whenever a programme is fully online or not
98
- *
99
- * @return boolean
100
- */
101
- isFullyOnline(): boolean;
102
- /**
103
- * Is programme public
104
- *
105
- * @return boolean
106
- */
107
- isPublic(): boolean;
108
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=i-compare-programme.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"i-compare-programme.js","sourceRoot":"","sources":["../../../../src/models/compare-programme/i-compare-programme.ts"],"names":[],"mappings":""}