@studyportals/domain-client 4.7.0 → 4.7.1-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (195) hide show
  1. package/index.d.ts +84 -84
  2. package/index.js +63 -63
  3. package/package.json +55 -55
  4. package/src/domain-client.d.ts +14 -14
  5. package/src/domain-client.js +60 -60
  6. package/src/exceptions/bad-request-exception.d.ts +2 -2
  7. package/src/exceptions/bad-request-exception.js +6 -6
  8. package/src/exceptions/client-exception.d.ts +2 -2
  9. package/src/exceptions/client-exception.js +6 -6
  10. package/src/exceptions/internal-server-exception.d.ts +2 -2
  11. package/src/exceptions/internal-server-exception.js +6 -6
  12. package/src/exceptions/not-found-exception.d.ts +2 -2
  13. package/src/exceptions/not-found-exception.js +6 -6
  14. package/src/exceptions/property-not-available-exception.d.ts +2 -2
  15. package/src/exceptions/property-not-available-exception.js +6 -6
  16. package/src/factories/DateFactory.d.ts +5 -5
  17. package/src/factories/DateFactory.js +9 -9
  18. package/src/factories/InternalLinkFactory.d.ts +9 -9
  19. package/src/factories/InternalLinkFactory.js +19 -19
  20. package/src/i-api-response.d.ts +6 -6
  21. package/src/i-api-response.js +2 -2
  22. package/src/i-class-factory.d.ts +4 -4
  23. package/src/i-class-factory.js +2 -2
  24. package/src/i-model-description.d.ts +7 -7
  25. package/src/i-model-description.js +9 -9
  26. package/src/model-client.d.ts +16 -16
  27. package/src/model-client.js +45 -45
  28. package/src/model-factory.d.ts +11 -11
  29. package/src/model-factory.js +71 -71
  30. package/src/models/bestfit-programme/bestfit-programme-client.d.ts +7 -7
  31. package/src/models/bestfit-programme/bestfit-programme-client.js +16 -16
  32. package/src/models/bestfit-programme/i-best-fit-programme.d.ts +82 -82
  33. package/src/models/bestfit-programme/i-best-fit-programme.js +2 -2
  34. package/src/models/bestfit-programme/i-city.d.ts +14 -14
  35. package/src/models/bestfit-programme/i-city.js +2 -2
  36. package/src/models/bestfit-programme/i-living-cost.d.ts +20 -20
  37. package/src/models/bestfit-programme/i-living-cost.js +2 -2
  38. package/src/models/common/i-city.d.ts +14 -14
  39. package/src/models/common/i-city.js +2 -2
  40. package/src/models/common/i-country.d.ts +20 -20
  41. package/src/models/common/i-country.js +2 -2
  42. package/src/models/common/i-english-requirements.d.ts +44 -44
  43. package/src/models/common/i-english-requirements.js +2 -2
  44. package/src/models/common/i-g-p-a-requirement.d.ts +20 -20
  45. package/src/models/common/i-g-p-a-requirement.js +2 -2
  46. package/src/models/common/i-internal-link.d.ts +28 -28
  47. package/src/models/common/i-internal-link.js +2 -2
  48. package/src/models/common/i-logo.d.ts +14 -14
  49. package/src/models/common/i-logo.js +2 -2
  50. package/src/models/common/i-tuition-fee.d.ts +50 -50
  51. package/src/models/common/i-tuition-fee.js +2 -2
  52. package/src/models/compare-programme/compare-programme-client.d.ts +7 -7
  53. package/src/models/compare-programme/compare-programme-client.js +16 -16
  54. package/src/models/compare-programme/i-compare-programme.d.ts +108 -108
  55. package/src/models/compare-programme/i-compare-programme.js +2 -2
  56. package/src/models/copilot-country/copilot-country-client.d.ts +7 -7
  57. package/src/models/copilot-country/copilot-country-client.js +16 -16
  58. package/src/models/copilot-country/i-copilot-country.d.ts +39 -39
  59. package/src/models/copilot-country/i-copilot-country.js +2 -2
  60. package/src/models/copilot-country/i-copilot-ranking-card.d.ts +38 -38
  61. package/src/models/copilot-country/i-copilot-ranking-card.js +2 -2
  62. package/src/models/copilot-programme/copilot-programme-client.d.ts +7 -7
  63. package/src/models/copilot-programme/copilot-programme-client.js +16 -16
  64. package/src/models/copilot-programme/i-copilot-programme.d.ts +101 -101
  65. package/src/models/copilot-programme/i-copilot-programme.js +2 -2
  66. package/src/models/customerio-organisation/customerio-organisation-client.d.ts +7 -7
  67. package/src/models/customerio-organisation/customerio-organisation-client.js +16 -16
  68. package/src/models/customerio-organisation/i-customer-io-organisation.d.ts +35 -35
  69. package/src/models/customerio-organisation/i-customer-io-organisation.js +2 -2
  70. package/src/models/customerio-organisation/i-review.d.ts +7 -7
  71. package/src/models/customerio-organisation/i-review.js +2 -2
  72. package/src/models/customerio-programme/customerio-programme-client.d.ts +7 -7
  73. package/src/models/customerio-programme/customerio-programme-client.js +16 -16
  74. package/src/models/customerio-programme/i-customer-io-programme.d.ts +107 -107
  75. package/src/models/customerio-programme/i-customer-io-programme.js +2 -2
  76. package/src/models/customerio-programme/i-internal-link.d.ts +28 -28
  77. package/src/models/customerio-programme/i-internal-link.js +2 -2
  78. package/src/models/organisation-card/i-organisation-card.d.ts +32 -31
  79. package/src/models/organisation-card/i-organisation-card.js +2 -2
  80. package/src/models/organisation-card/organisation-card-client.d.ts +7 -7
  81. package/src/models/organisation-card/organisation-card-client.js +16 -16
  82. package/src/models/organisation-for-search/i-organisation-for-search.d.ts +26 -26
  83. package/src/models/organisation-for-search/i-organisation-for-search.js +2 -2
  84. package/src/models/organisation-for-search/public-organisation-for-search-client.d.ts +7 -7
  85. package/src/models/organisation-for-search/public-organisation-for-search-client.js +16 -16
  86. package/src/models/organisation-search-document/i-organisation-search-document.d.ts +116 -116
  87. package/src/models/organisation-search-document/i-organisation-search-document.js +2 -2
  88. package/src/models/organisation-search-document/organisation-search-document-client.d.ts +7 -7
  89. package/src/models/organisation-search-document/organisation-search-document-client.js +16 -16
  90. package/src/models/programme-card/i-click-tracking-data.d.ts +5 -5
  91. package/src/models/programme-card/i-click-tracking-data.js +2 -2
  92. package/src/models/programme-card/i-cover.d.ts +14 -14
  93. package/src/models/programme-card/i-cover.js +2 -2
  94. package/src/models/programme-card/i-deadline.d.ts +20 -20
  95. package/src/models/programme-card/i-deadline.js +2 -2
  96. package/src/models/programme-card/i-duration.d.ts +40 -40
  97. package/src/models/programme-card/i-duration.js +2 -2
  98. package/src/models/programme-card/i-internal-link.d.ts +28 -28
  99. package/src/models/programme-card/i-internal-link.js +2 -2
  100. package/src/models/programme-card/i-link.d.ts +22 -22
  101. package/src/models/programme-card/i-link.js +2 -2
  102. package/src/models/programme-card/i-location.d.ts +12 -12
  103. package/src/models/programme-card/i-location.js +2 -2
  104. package/src/models/programme-card/i-logo.d.ts +14 -14
  105. package/src/models/programme-card/i-logo.js +2 -2
  106. package/src/models/programme-card/i-optional-link.d.ts +23 -23
  107. package/src/models/programme-card/i-optional-link.js +2 -2
  108. package/src/models/programme-card/i-programme-card.d.ts +205 -205
  109. package/src/models/programme-card/i-programme-card.js +2 -2
  110. package/src/models/programme-card/i-start-date.d.ts +33 -33
  111. package/src/models/programme-card/i-start-date.js +2 -2
  112. package/src/models/programme-card/i-timing.d.ts +45 -45
  113. package/src/models/programme-card/i-timing.js +2 -2
  114. package/src/models/programme-card/i-tracked-link.d.ts +29 -29
  115. package/src/models/programme-card/i-tracked-link.js +2 -2
  116. package/src/models/programme-card/i-tracking.d.ts +46 -46
  117. package/src/models/programme-card/i-tracking.js +2 -2
  118. package/src/models/programme-card/i-tuition-fee.d.ts +50 -50
  119. package/src/models/programme-card/i-tuition-fee.js +2 -2
  120. package/src/models/programme-card/programme-card-client.d.ts +7 -7
  121. package/src/models/programme-card/programme-card-client.js +16 -16
  122. package/src/models/ranking-cards/i-ranking-card.d.ts +87 -87
  123. package/src/models/ranking-cards/i-ranking-card.js +2 -2
  124. package/src/models/ranking-cards/i-ranking-cards.d.ts +15 -15
  125. package/src/models/ranking-cards/i-ranking-cards.js +2 -2
  126. package/src/models/ranking-cards/i-ranking.d.ts +18 -18
  127. package/src/models/ranking-cards/i-ranking.js +2 -2
  128. package/src/models/ranking-cards/public-ranking-cards-client.d.ts +7 -7
  129. package/src/models/ranking-cards/public-ranking-cards-client.js +16 -16
  130. package/src/models/scholarship-card/i-scholarship-card.d.ts +15 -15
  131. package/src/models/scholarship-card/i-scholarship-card.js +2 -2
  132. package/src/models/scholarship-card/public-scholarship-card-client.d.ts +7 -7
  133. package/src/models/scholarship-card/public-scholarship-card-client.js +16 -16
  134. package/src/models/search-country-faq/i-search-country-faq.d.ts +18 -18
  135. package/src/models/search-country-faq/i-search-country-faq.js +2 -2
  136. package/src/models/search-country-faq/public-search-country-faq-client.d.ts +7 -7
  137. package/src/models/search-country-faq/public-search-country-faq-client.js +16 -16
  138. package/src/models/search-discipline/i-search-discipline.d.ts +26 -26
  139. package/src/models/search-discipline/i-search-discipline.js +2 -2
  140. package/src/models/search-discipline/public-search-discipline-client.d.ts +7 -7
  141. package/src/models/search-discipline/public-search-discipline-client.js +16 -16
  142. package/src/models/search-projection/i-geo-targeting-configuration.d.ts +38 -38
  143. package/src/models/search-projection/i-geo-targeting-configuration.js +2 -2
  144. package/src/models/search-projection/i-geo-targeting-values.d.ts +30 -30
  145. package/src/models/search-projection/i-geo-targeting-values.js +2 -2
  146. package/src/models/search-projection/i-organisation-values.d.ts +40 -40
  147. package/src/models/search-projection/i-organisation-values.js +2 -2
  148. package/src/models/search-projection/i-premium-values.d.ts +35 -35
  149. package/src/models/search-projection/i-premium-values.js +2 -2
  150. package/src/models/search-projection/i-search-projection.d.ts +180 -180
  151. package/src/models/search-projection/i-search-projection.js +2 -2
  152. package/src/models/search-projection/i-tuition-values.d.ts +50 -50
  153. package/src/models/search-projection/i-tuition-values.js +2 -2
  154. package/src/models/search-projection/search-projection-client.d.ts +7 -7
  155. package/src/models/search-projection/search-projection-client.js +16 -16
  156. package/src/models/sitemap-articles-info/i-sitemap-article-info.d.ts +14 -14
  157. package/src/models/sitemap-articles-info/i-sitemap-article-info.js +2 -2
  158. package/src/models/sitemap-articles-info/sitemap-articles-info-client.d.ts +7 -7
  159. package/src/models/sitemap-articles-info/sitemap-articles-info-client.js +16 -16
  160. package/src/models/sitemap-cities-info/i-sitemap-city-info.d.ts +14 -14
  161. package/src/models/sitemap-cities-info/i-sitemap-city-info.js +2 -2
  162. package/src/models/sitemap-cities-info/sitemap-cities-info-client.d.ts +7 -7
  163. package/src/models/sitemap-cities-info/sitemap-cities-info-client.js +16 -16
  164. package/src/models/sitemap-countries-info/i-sitemap-country-info.d.ts +14 -14
  165. package/src/models/sitemap-countries-info/i-sitemap-country-info.js +2 -2
  166. package/src/models/sitemap-countries-info/sitemap-countries-info-client.d.ts +7 -7
  167. package/src/models/sitemap-countries-info/sitemap-countries-info-client.js +16 -16
  168. package/src/models/sitemap-country-degree-info/i-degree-info.d.ts +14 -14
  169. package/src/models/sitemap-country-degree-info/i-degree-info.js +2 -2
  170. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.d.ts +11 -11
  171. package/src/models/sitemap-country-degree-info/i-sitemap-country-degree-info.js +2 -2
  172. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.d.ts +7 -7
  173. package/src/models/sitemap-country-degree-info/sitemap-country-degree-info-client.js +16 -16
  174. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.d.ts +14 -14
  175. package/src/models/sitemap-disciplines-info/i-sitemap-discipline-info.js +2 -2
  176. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.d.ts +7 -7
  177. package/src/models/sitemap-disciplines-info/sitemap-disciplines-info-client.js +16 -16
  178. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.d.ts +26 -26
  179. package/src/models/sitemap-organisations-info/i-sitemap-organisation-info.js +2 -2
  180. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.d.ts +7 -7
  181. package/src/models/sitemap-organisations-info/sitemap-organisations-info-client.js +16 -16
  182. package/src/models/sitemap-programme-info/i-sitemap-programme-info.d.ts +26 -26
  183. package/src/models/sitemap-programme-info/i-sitemap-programme-info.js +2 -2
  184. package/src/models/sitemap-programme-info/sitemap-programme-info-client.d.ts +7 -7
  185. package/src/models/sitemap-programme-info/sitemap-programme-info-client.js +16 -16
  186. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.d.ts +14 -14
  187. package/src/models/sitemap-rankings-info/i-sitemap-rankings-info.js +2 -2
  188. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.d.ts +7 -7
  189. package/src/models/sitemap-rankings-info/sitemap-rankings-info-client.js +16 -16
  190. package/src/types/portal-map.d.ts +2 -2
  191. package/src/types/portal-map.js +2 -2
  192. package/src/types/portal-type.d.ts +7 -7
  193. package/src/types/portal-type.js +11 -11
  194. package/src/types.d.ts +4 -4
  195. package/src/types.js +2 -2
@@ -1,18 +1,18 @@
1
- export interface ISearchCountryFaq {
2
- /**
3
- * @return number
4
- */
5
- getId(): number;
6
- /**
7
- * @return string
8
- */
9
- getName(): string;
10
- /**
11
- * @return string
12
- */
13
- getRankingCountryLink(): string;
14
- /**
15
- * @return string[]
16
- */
17
- getTopFiveUniversities(): string[];
18
- }
1
+ export interface ISearchCountryFaq {
2
+ /**
3
+ * @return number
4
+ */
5
+ getId(): number;
6
+ /**
7
+ * @return string
8
+ */
9
+ getName(): string;
10
+ /**
11
+ * @return string
12
+ */
13
+ getRankingCountryLink(): string;
14
+ /**
15
+ * @return string[]
16
+ */
17
+ getTopFiveUniversities(): string[];
18
+ }
@@ -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-search-country-faq.js.map
@@ -1,7 +1,7 @@
1
- import { ISearchCountryFaq } from "../../..";
2
- import { ModelClient } from "../../model-client";
3
- export declare class PublicSearchCountryFaqClient extends ModelClient<ISearchCountryFaq> {
4
- protected getModelName(): string;
5
- protected getVersion(): string;
6
- isPublic(): boolean;
7
- }
1
+ import { ISearchCountryFaq } from "../../..";
2
+ import { ModelClient } from "../../model-client";
3
+ export declare class PublicSearchCountryFaqClient extends ModelClient<ISearchCountryFaq> {
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.PublicSearchCountryFaqClient = void 0;
4
- const model_client_1 = require("../../model-client");
5
- class PublicSearchCountryFaqClient extends model_client_1.ModelClient {
6
- getModelName() {
7
- return 'search-country-faq';
8
- }
9
- getVersion() {
10
- return 'v1';
11
- }
12
- isPublic() {
13
- return true;
14
- }
15
- }
16
- exports.PublicSearchCountryFaqClient = PublicSearchCountryFaqClient;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PublicSearchCountryFaqClient = void 0;
4
+ const model_client_1 = require("../../model-client");
5
+ class PublicSearchCountryFaqClient extends model_client_1.ModelClient {
6
+ getModelName() {
7
+ return 'search-country-faq';
8
+ }
9
+ getVersion() {
10
+ return 'v1';
11
+ }
12
+ isPublic() {
13
+ return true;
14
+ }
15
+ }
16
+ exports.PublicSearchCountryFaqClient = PublicSearchCountryFaqClient;
17
17
  //# sourceMappingURL=public-search-country-faq-client.js.map
@@ -1,26 +1,26 @@
1
- export interface ISearchDiscipline {
2
- /**
3
- * @return string | null
4
- */
5
- getIcon(): string | null;
6
- /**
7
- * @return number
8
- */
9
- getId(): number;
10
- /**
11
- * @return string
12
- */
13
- getName(): string;
14
- /**
15
- * @return string | null
16
- */
17
- getOldVirtualPath(): string | null;
18
- /**
19
- * @return number | null
20
- */
21
- getParentId(): number | null;
22
- /**
23
- * @return string
24
- */
25
- getVirtualPath(): string;
26
- }
1
+ export interface ISearchDiscipline {
2
+ /**
3
+ * @return string | null
4
+ */
5
+ getIcon(): string | null;
6
+ /**
7
+ * @return number
8
+ */
9
+ getId(): number;
10
+ /**
11
+ * @return string
12
+ */
13
+ getName(): string;
14
+ /**
15
+ * @return string | null
16
+ */
17
+ getOldVirtualPath(): string | null;
18
+ /**
19
+ * @return number | null
20
+ */
21
+ getParentId(): number | null;
22
+ /**
23
+ * @return string
24
+ */
25
+ getVirtualPath(): 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-search-discipline.js.map
@@ -1,7 +1,7 @@
1
- import { ISearchDiscipline } from "../../..";
2
- import { ModelClient } from "../../model-client";
3
- export declare class PublicSearchDisciplineClient extends ModelClient<ISearchDiscipline> {
4
- protected getModelName(): string;
5
- protected getVersion(): string;
6
- isPublic(): boolean;
7
- }
1
+ import { ISearchDiscipline } from "../../..";
2
+ import { ModelClient } from "../../model-client";
3
+ export declare class PublicSearchDisciplineClient extends ModelClient<ISearchDiscipline> {
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.PublicSearchDisciplineClient = void 0;
4
- const model_client_1 = require("../../model-client");
5
- class PublicSearchDisciplineClient extends model_client_1.ModelClient {
6
- getModelName() {
7
- return 'search-discipline';
8
- }
9
- getVersion() {
10
- return 'v1';
11
- }
12
- isPublic() {
13
- return true;
14
- }
15
- }
16
- exports.PublicSearchDisciplineClient = PublicSearchDisciplineClient;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.PublicSearchDisciplineClient = void 0;
4
+ const model_client_1 = require("../../model-client");
5
+ class PublicSearchDisciplineClient extends model_client_1.ModelClient {
6
+ getModelName() {
7
+ return 'search-discipline';
8
+ }
9
+ getVersion() {
10
+ return 'v1';
11
+ }
12
+ isPublic() {
13
+ return true;
14
+ }
15
+ }
16
+ exports.PublicSearchDisciplineClient = PublicSearchDisciplineClient;
17
17
  //# sourceMappingURL=public-search-discipline-client.js.map
@@ -1,38 +1,38 @@
1
- export interface IGeoTargetingConfiguration {
2
- /**
3
- * Bit set 1 of targeted country ID information.
4
- *
5
- * @return number
6
- */
7
- getBit1(): number;
8
- /**
9
- * Bit set 2 of targeted country ID information.
10
- *
11
- * @return number
12
- */
13
- getBit2(): number;
14
- /**
15
- * Bit set 3 of targeted country ID information.
16
- *
17
- * @return number
18
- */
19
- getBit3(): number;
20
- /**
21
- * Bit set 4 of targeted country ID information.
22
- *
23
- * @return number
24
- */
25
- getBit4(): number;
26
- /**
27
- * Bit set 5 of targeted country ID information.
28
- *
29
- * @return number
30
- */
31
- getBit5(): number;
32
- /**
33
- * List of all configured country IDs.
34
- *
35
- * @return number[]
36
- */
37
- getTargetedCountries(): number[];
38
- }
1
+ export interface IGeoTargetingConfiguration {
2
+ /**
3
+ * Bit set 1 of targeted country ID information.
4
+ *
5
+ * @return number
6
+ */
7
+ getBit1(): number;
8
+ /**
9
+ * Bit set 2 of targeted country ID information.
10
+ *
11
+ * @return number
12
+ */
13
+ getBit2(): number;
14
+ /**
15
+ * Bit set 3 of targeted country ID information.
16
+ *
17
+ * @return number
18
+ */
19
+ getBit3(): number;
20
+ /**
21
+ * Bit set 4 of targeted country ID information.
22
+ *
23
+ * @return number
24
+ */
25
+ getBit4(): number;
26
+ /**
27
+ * Bit set 5 of targeted country ID information.
28
+ *
29
+ * @return number
30
+ */
31
+ getBit5(): number;
32
+ /**
33
+ * List of all configured country IDs.
34
+ *
35
+ * @return number[]
36
+ */
37
+ getTargetedCountries(): number[];
38
+ }
@@ -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-geo-targeting-configuration.js.map
@@ -1,30 +1,30 @@
1
- import { IGeoTargetingConfiguration } from "../../..";
2
- export interface IGeoTargetingValues {
3
- /**
4
- * Geo-targeting configuration for "light premium" listing.
5
- *
6
- * @return IGeoTargetingConfiguration
7
- */
8
- getLightPremium(): IGeoTargetingConfiguration;
9
- canShowLightPremium(): boolean;
10
- /**
11
- * Geo-targeting configuration for "premium" listing.
12
- *
13
- * @return IGeoTargetingConfiguration
14
- */
15
- getPremium(): IGeoTargetingConfiguration;
16
- canShowPremium(): boolean;
17
- /**
18
- * Geo-targeting configuration for "super premium" listing.
19
- *
20
- * @return IGeoTargetingConfiguration
21
- */
22
- getSuperPremium(): IGeoTargetingConfiguration;
23
- canShowSuperPremium(): boolean;
24
- /**
25
- * Programme has active geo-targeting settings.
26
- *
27
- * @return boolean
28
- */
29
- isGeoTargeted(): boolean;
30
- }
1
+ import { IGeoTargetingConfiguration } from "../../..";
2
+ export interface IGeoTargetingValues {
3
+ /**
4
+ * Geo-targeting configuration for "light premium" listing.
5
+ *
6
+ * @return IGeoTargetingConfiguration
7
+ */
8
+ getLightPremium(): IGeoTargetingConfiguration;
9
+ canShowLightPremium(): boolean;
10
+ /**
11
+ * Geo-targeting configuration for "premium" listing.
12
+ *
13
+ * @return IGeoTargetingConfiguration
14
+ */
15
+ getPremium(): IGeoTargetingConfiguration;
16
+ canShowPremium(): boolean;
17
+ /**
18
+ * Geo-targeting configuration for "super premium" listing.
19
+ *
20
+ * @return IGeoTargetingConfiguration
21
+ */
22
+ getSuperPremium(): IGeoTargetingConfiguration;
23
+ canShowSuperPremium(): boolean;
24
+ /**
25
+ * Programme has active geo-targeting settings.
26
+ *
27
+ * @return boolean
28
+ */
29
+ isGeoTargeted(): boolean;
30
+ }
@@ -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-geo-targeting-values.js.map
@@ -1,40 +1,40 @@
1
- export interface IOrganisationValues {
2
- /**
3
- * Country ID of the top level organisation.
4
- *
5
- * @return number
6
- */
7
- getCountryId(): number;
8
- /**
9
- * ID of the programme's main organisation.
10
- *
11
- * First premium organisation or top level organisation.
12
- *
13
- * @return number
14
- */
15
- getId(): number;
16
- /**
17
- * Name of the programme's main organisation.
18
- *
19
- * First premium organisation or top level organisation.
20
- *
21
- * @return string
22
- */
23
- getName(): string;
24
- /**
25
- * List of all organisation IDs attached to the programme (main + sub).
26
- *
27
- * @return number[]
28
- */
29
- getOrganisations(): number[];
30
- /**
31
- * Region ID of the top level organisation.
32
- *
33
- * Currently only possible region ID is 38 (EEA region). All other regions
34
- * are ignored for this field.
35
- *
36
- * @return number
37
- */
38
- getRegionId(): number;
39
- canShowRegionId(): boolean;
40
- }
1
+ export interface IOrganisationValues {
2
+ /**
3
+ * Country ID of the top level organisation.
4
+ *
5
+ * @return number
6
+ */
7
+ getCountryId(): number;
8
+ /**
9
+ * ID of the programme's main organisation.
10
+ *
11
+ * First premium organisation or top level organisation.
12
+ *
13
+ * @return number
14
+ */
15
+ getId(): number;
16
+ /**
17
+ * Name of the programme's main organisation.
18
+ *
19
+ * First premium organisation or top level organisation.
20
+ *
21
+ * @return string
22
+ */
23
+ getName(): string;
24
+ /**
25
+ * List of all organisation IDs attached to the programme (main + sub).
26
+ *
27
+ * @return number[]
28
+ */
29
+ getOrganisations(): number[];
30
+ /**
31
+ * Region ID of the top level organisation.
32
+ *
33
+ * Currently only possible region ID is 38 (EEA region). All other regions
34
+ * are ignored for this field.
35
+ *
36
+ * @return number
37
+ */
38
+ getRegionId(): number;
39
+ canShowRegionId(): boolean;
40
+ }
@@ -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-values.js.map
@@ -1,35 +1,35 @@
1
- export interface IPremiumValues {
2
- /**
3
- * Bottom of the premium probability range (between 0.0 asn 1.0).
4
- *
5
- * @return number
6
- */
7
- getPremiumBottom(): number;
8
- canShowPremiumBottom(): boolean;
9
- /**
10
- * CPM value attached to the premium listing.
11
- *
12
- * @return number
13
- */
14
- getPremiumCpm(): number;
15
- canShowPremiumCpm(): boolean;
16
- /**
17
- * Top of the premium probability range (between 0.0 asn 1.0).
18
- *
19
- * @return number
20
- */
21
- getPremiumTop(): number;
22
- canShowPremiumTop(): boolean;
23
- /**
24
- * Short hand premium type (sp, p, lp, slp, sslp, b).
25
- *
26
- * @return string
27
- */
28
- getPremiumType(): string;
29
- /**
30
- * Premium weight value used in Cloudsearch commercial sorting.
31
- *
32
- * @return number
33
- */
34
- getPremiumValue(): number;
35
- }
1
+ export interface IPremiumValues {
2
+ /**
3
+ * Bottom of the premium probability range (between 0.0 asn 1.0).
4
+ *
5
+ * @return number
6
+ */
7
+ getPremiumBottom(): number;
8
+ canShowPremiumBottom(): boolean;
9
+ /**
10
+ * CPM value attached to the premium listing.
11
+ *
12
+ * @return number
13
+ */
14
+ getPremiumCpm(): number;
15
+ canShowPremiumCpm(): boolean;
16
+ /**
17
+ * Top of the premium probability range (between 0.0 asn 1.0).
18
+ *
19
+ * @return number
20
+ */
21
+ getPremiumTop(): number;
22
+ canShowPremiumTop(): boolean;
23
+ /**
24
+ * Short hand premium type (sp, p, lp, slp, sslp, b).
25
+ *
26
+ * @return string
27
+ */
28
+ getPremiumType(): string;
29
+ /**
30
+ * Premium weight value used in Cloudsearch commercial sorting.
31
+ *
32
+ * @return number
33
+ */
34
+ getPremiumValue(): number;
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-premium-values.js.map