@studyportals/domain-client 3.14.0 → 3.16.0-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 (193) hide show
  1. package/index.d.ts +69 -67
  2. package/index.js +51 -49
  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 -14
  42. package/src/models/common/i-country.js +2 -2
  43. package/src/models/common/i-english-requirements.d.ts +44 -30
  44. package/src/models/common/i-english-requirements.js +2 -2
  45. package/src/models/{bestfit-programme → common}/i-g-p-a-requirement.d.ts +20 -20
  46. package/src/models/{bestfit-programme → common}/i-g-p-a-requirement.js +2 -2
  47. package/src/models/common/i-g-p-a-requirement.js.map +1 -0
  48. package/src/models/common/i-internal-link.d.ts +28 -28
  49. package/src/models/common/i-internal-link.js +2 -2
  50. package/src/models/common/i-logo.d.ts +14 -14
  51. package/src/models/common/i-logo.js +2 -2
  52. package/src/models/common/i-tuition-fee.d.ts +50 -50
  53. package/src/models/common/i-tuition-fee.js +2 -2
  54. package/src/models/compare-programme/compare-programme-client.d.ts +7 -0
  55. package/src/models/compare-programme/compare-programme-client.js +17 -0
  56. package/src/models/compare-programme/compare-programme-client.js.map +1 -0
  57. package/src/models/compare-programme/i-compare-programme.d.ts +108 -0
  58. package/src/models/{dotdigital-organisation/i-country.js → compare-programme/i-compare-programme.js} +3 -3
  59. package/src/models/compare-programme/i-compare-programme.js.map +1 -0
  60. package/src/models/dotdigital-organisation/dotdigital-organisation-client.d.ts +7 -7
  61. package/src/models/dotdigital-organisation/dotdigital-organisation-client.js +16 -16
  62. package/src/models/dotdigital-organisation/i-dot-digital-organisation.d.ts +35 -35
  63. package/src/models/dotdigital-organisation/i-dot-digital-organisation.js +2 -2
  64. package/src/models/dotdigital-organisation/i-review.d.ts +7 -7
  65. package/src/models/dotdigital-organisation/i-review.js +2 -2
  66. package/src/models/dotdigital-programme/dotdigital-programme-client.d.ts +7 -7
  67. package/src/models/dotdigital-programme/dotdigital-programme-client.js +16 -16
  68. package/src/models/dotdigital-programme/i-dot-digital-programme.d.ts +101 -89
  69. package/src/models/dotdigital-programme/i-dot-digital-programme.js +2 -2
  70. package/src/models/dotdigital-programme/i-internal-link.d.ts +28 -28
  71. package/src/models/dotdigital-programme/i-internal-link.js +2 -2
  72. package/src/models/programme-card/i-click-tracking-data.d.ts +5 -5
  73. package/src/models/programme-card/i-click-tracking-data.js +2 -2
  74. package/src/models/programme-card/i-cover.d.ts +14 -14
  75. package/src/models/programme-card/i-cover.js +2 -2
  76. package/src/models/programme-card/i-deadline.d.ts +20 -20
  77. package/src/models/programme-card/i-deadline.js +2 -2
  78. package/src/models/programme-card/i-duration.d.ts +40 -40
  79. package/src/models/programme-card/i-duration.js +2 -2
  80. package/src/models/programme-card/i-internal-link.d.ts +28 -28
  81. package/src/models/programme-card/i-internal-link.js +2 -2
  82. package/src/models/programme-card/i-link.d.ts +22 -22
  83. package/src/models/programme-card/i-link.js +2 -2
  84. package/src/models/programme-card/i-location.d.ts +12 -11
  85. package/src/models/programme-card/i-location.js +2 -2
  86. package/src/models/programme-card/i-logo.d.ts +14 -14
  87. package/src/models/programme-card/i-logo.js +2 -2
  88. package/src/models/programme-card/i-optional-link.d.ts +23 -23
  89. package/src/models/programme-card/i-optional-link.js +2 -2
  90. package/src/models/programme-card/i-programme-card.d.ts +178 -178
  91. package/src/models/programme-card/i-programme-card.js +2 -2
  92. package/src/models/programme-card/i-start-date.d.ts +33 -33
  93. package/src/models/programme-card/i-start-date.js +2 -2
  94. package/src/models/programme-card/i-timing.d.ts +45 -45
  95. package/src/models/programme-card/i-timing.js +2 -2
  96. package/src/models/programme-card/i-tracked-link.d.ts +29 -29
  97. package/src/models/programme-card/i-tracked-link.js +2 -2
  98. package/src/models/programme-card/i-tracking.d.ts +46 -46
  99. package/src/models/programme-card/i-tracking.js +2 -2
  100. package/src/models/programme-card/i-tuition-fee.d.ts +50 -50
  101. package/src/models/programme-card/i-tuition-fee.js +2 -2
  102. package/src/models/programme-card/programme-card-client.d.ts +7 -7
  103. package/src/models/programme-card/programme-card-client.js +16 -16
  104. package/src/models/scholarship-card/i-scholarship-card.d.ts +46 -46
  105. package/src/models/scholarship-card/i-scholarship-card.js +2 -2
  106. package/src/models/scholarship-card/public-scholarship-card-client.d.ts +7 -7
  107. package/src/models/scholarship-card/public-scholarship-card-client.js +16 -16
  108. package/src/models/search-country-faq/i-search-country-faq.d.ts +18 -18
  109. package/src/models/search-country-faq/i-search-country-faq.js +2 -2
  110. package/src/models/search-country-faq/public-search-country-faq-client.d.ts +7 -7
  111. package/src/models/search-country-faq/public-search-country-faq-client.js +16 -16
  112. package/src/models/search-discipline/i-search-discipline.d.ts +26 -26
  113. package/src/models/search-discipline/i-search-discipline.js +2 -2
  114. package/src/models/search-discipline/public-search-discipline-client.d.ts +7 -7
  115. package/src/models/search-discipline/public-search-discipline-client.js +16 -16
  116. package/src/models/search-projection/i-geo-targeting-configuration.d.ts +38 -38
  117. package/src/models/search-projection/i-geo-targeting-configuration.js +2 -2
  118. package/src/models/search-projection/i-geo-targeting-values.d.ts +30 -30
  119. package/src/models/search-projection/i-geo-targeting-values.js +2 -2
  120. package/src/models/search-projection/i-organisation-values.d.ts +40 -40
  121. package/src/models/search-projection/i-organisation-values.js +2 -2
  122. package/src/models/search-projection/i-premium-values.d.ts +35 -35
  123. package/src/models/search-projection/i-premium-values.js +2 -2
  124. package/src/models/search-projection/i-search-projection.d.ts +180 -180
  125. package/src/models/search-projection/i-search-projection.js +2 -2
  126. package/src/models/search-projection/i-tuition-values.d.ts +50 -50
  127. package/src/models/search-projection/i-tuition-values.js +2 -2
  128. package/src/models/search-projection/search-projection-client.d.ts +7 -7
  129. package/src/models/search-projection/search-projection-client.js +16 -16
  130. package/src/models/sitemap-articles-info/i-sitemap-article-info.d.ts +14 -14
  131. package/src/models/sitemap-articles-info/i-sitemap-article-info.js +2 -2
  132. package/src/models/sitemap-articles-info/sitemap-articles-info-client.d.ts +7 -7
  133. package/src/models/sitemap-articles-info/sitemap-articles-info-client.js +16 -16
  134. package/src/models/sitemap-cities-info/i-sitemap-city-info.d.ts +14 -14
  135. package/src/models/sitemap-cities-info/i-sitemap-city-info.js +2 -2
  136. package/src/models/sitemap-cities-info/sitemap-cities-info-client.d.ts +7 -7
  137. package/src/models/sitemap-cities-info/sitemap-cities-info-client.js +16 -16
  138. package/src/models/sitemap-countries-info/i-sitemap-country-info.d.ts +14 -14
  139. package/src/models/sitemap-countries-info/i-sitemap-country-info.js +2 -2
  140. package/src/models/sitemap-countries-info/sitemap-countries-info-client.d.ts +7 -7
  141. package/src/models/sitemap-countries-info/sitemap-countries-info-client.js +16 -16
  142. package/src/models/sitemap-country-degree-info/i-degree-info.d.ts +14 -14
  143. package/src/models/sitemap-country-degree-info/i-degree-info.js +2 -2
  144. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.d.ts +11 -11
  145. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.js +2 -2
  146. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.d.ts +7 -7
  147. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.js +16 -16
  148. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.d.ts +14 -14
  149. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.js +2 -2
  150. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.d.ts +7 -7
  151. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.js +16 -16
  152. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.d.ts +26 -26
  153. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.js +2 -2
  154. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.d.ts +7 -7
  155. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.js +16 -16
  156. package/src/models/sitemap-programme-info/i-sitemap-programme-info.d.ts +26 -26
  157. package/src/models/sitemap-programme-info/i-sitemap-programme-info.js +2 -2
  158. package/src/models/sitemap-programme-info/sitemap-programme-info-client.d.ts +7 -7
  159. package/src/models/sitemap-programme-info/sitemap-programme-info-client.js +16 -16
  160. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.d.ts +14 -14
  161. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.js +2 -2
  162. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.d.ts +7 -7
  163. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.js +16 -16
  164. package/src/types/portal-map.d.ts +2 -2
  165. package/src/types/portal-map.js +2 -2
  166. package/src/types/portal-type.d.ts +7 -7
  167. package/src/types/portal-type.js +11 -11
  168. package/src/types.d.ts +4 -4
  169. package/src/types.js +2 -2
  170. package/src/models/bestfit-programme/i-english-requirements.d.ts +0 -37
  171. package/src/models/bestfit-programme/i-english-requirements.js +0 -3
  172. package/src/models/bestfit-programme/i-english-requirements.js.map +0 -1
  173. package/src/models/bestfit-programme/i-g-p-a-requirement.js.map +0 -1
  174. package/src/models/bestfit-programme/i-tuition-fee.d.ts +0 -50
  175. package/src/models/bestfit-programme/i-tuition-fee.js +0 -3
  176. package/src/models/bestfit-programme/i-tuition-fee.js.map +0 -1
  177. package/src/models/dotdigital-organisation/i-city.d.ts +0 -14
  178. package/src/models/dotdigital-organisation/i-city.js +0 -3
  179. package/src/models/dotdigital-organisation/i-city.js.map +0 -1
  180. package/src/models/dotdigital-organisation/i-country.d.ts +0 -14
  181. package/src/models/dotdigital-organisation/i-country.js.map +0 -1
  182. package/src/models/dotdigital-programme/i-country.d.ts +0 -14
  183. package/src/models/dotdigital-programme/i-country.js +0 -3
  184. package/src/models/dotdigital-programme/i-country.js.map +0 -1
  185. package/src/models/dotdigital-programme/i-english-requirements.d.ts +0 -37
  186. package/src/models/dotdigital-programme/i-english-requirements.js +0 -3
  187. package/src/models/dotdigital-programme/i-english-requirements.js.map +0 -1
  188. package/src/models/dotdigital-programme/i-logo.d.ts +0 -14
  189. package/src/models/dotdigital-programme/i-logo.js +0 -3
  190. package/src/models/dotdigital-programme/i-logo.js.map +0 -1
  191. package/src/models/dotdigital-programme/i-tuition-fee.d.ts +0 -50
  192. package/src/models/dotdigital-programme/i-tuition-fee.js +0 -3
  193. package/src/models/dotdigital-programme/i-tuition-fee.js.map +0 -1
@@ -1,50 +0,0 @@
1
- export interface ITuitionFee {
2
- /**
3
- * Get the tuition amount per unit in the provided currency.
4
- *
5
- * Note: all transformable units will be converted to yearly amounts. This
6
- * includes per semester and full programme tuition fees.
7
- *
8
- * @return number
9
- */
10
- getAmount(): number;
11
- /**
12
- * Get the applicable currency.
13
- *
14
- * @return string
15
- */
16
- getCurrency(): string;
17
- /**
18
- * Get the original tuition amount before any transformation step.
19
- *
20
- * @return number
21
- */
22
- getOriginalAmount(): number;
23
- /**
24
- * Get the original tuition unit before any transformation step.
25
- *
26
- * @return string
27
- */
28
- getOriginalUnit(): string;
29
- /**
30
- * Get targeted audience (national, international, eea, etc).
31
- *
32
- * @return string
33
- */
34
- getTarget(): string;
35
- /**
36
- * Get the unit the tuition fee applies for.
37
- *
38
- * Note: all transformable units will be converted to 'year'. This means
39
- * this value will be either 'year', 'module' or 'credit'.
40
- *
41
- * @return string
42
- */
43
- getUnit(): string;
44
- /**
45
- * True if the study is free for this target audience.
46
- *
47
- * @return boolean
48
- */
49
- isFree(): boolean;
50
- }
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=i-tuition-fee.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"i-tuition-fee.js","sourceRoot":"","sources":["../../../../src/models/dotdigital-programme/i-tuition-fee.ts"],"names":[],"mappings":""}