@studyportals/domain-client 8.3.0 → 8.4.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 (65) hide show
  1. package/index.d.ts +2 -1
  2. package/package.json +1 -1
  3. package/protobuf/Organisation/OrganisationCard.d.ts +42 -0
  4. package/protobuf/Organisation/OrganisationCard.js +164 -0
  5. package/protobuf/index.d.ts +1 -0
  6. package/protobuf/index.js +1 -0
  7. package/src/clients/index.d.ts +1 -0
  8. package/src/clients/index.js +1 -0
  9. package/src/clients/organisation-card-v2-client.d.ts +8 -0
  10. package/src/clients/organisation-card-v2-client.js +16 -0
  11. package/src/models/copilot-programme/i-deadline.d.ts +20 -0
  12. package/src/models/copilot-programme/i-deadline.js +1 -0
  13. package/src/models/copilot-programme/i-english-requirements.d.ts +51 -0
  14. package/src/models/copilot-programme/i-english-requirements.js +1 -0
  15. package/src/models/copilot-programme/i-g-p-a-requirement.d.ts +20 -0
  16. package/src/models/copilot-programme/i-g-p-a-requirement.js +1 -0
  17. package/src/models/copilot-programme/i-geo-targeting-configuration.d.ts +38 -0
  18. package/src/models/copilot-programme/i-geo-targeting-configuration.js +1 -0
  19. package/src/models/copilot-programme/i-geo-targeting-values.d.ts +30 -0
  20. package/src/models/copilot-programme/i-geo-targeting-values.js +1 -0
  21. package/src/models/copilot-programme/i-internal-link.d.ts +28 -0
  22. package/src/models/copilot-programme/i-internal-link.js +1 -0
  23. package/src/models/copilot-programme/i-link.d.ts +22 -0
  24. package/src/models/copilot-programme/i-link.js +1 -0
  25. package/src/models/copilot-programme/i-living-cost.d.ts +20 -0
  26. package/src/models/copilot-programme/i-living-cost.js +1 -0
  27. package/src/models/copilot-programme/i-start-date.d.ts +33 -0
  28. package/src/models/copilot-programme/i-start-date.js +1 -0
  29. package/src/models/copilot-programme/i-timing.d.ts +45 -0
  30. package/src/models/copilot-programme/i-timing.js +1 -0
  31. package/src/models/copilot-programme/i-tuition-values.d.ts +50 -0
  32. package/src/models/copilot-programme/i-tuition-values.js +1 -0
  33. package/src/models/customerio-organisation/i-city.d.ts +14 -0
  34. package/src/models/customerio-organisation/i-city.js +1 -0
  35. package/src/models/customerio-organisation/i-country.d.ts +20 -0
  36. package/src/models/customerio-organisation/i-country.js +1 -0
  37. package/src/models/customerio-organisation/i-customer-i-o-organisation.d.ts +35 -0
  38. package/src/models/customerio-organisation/i-customer-i-o-organisation.js +1 -0
  39. package/src/models/customerio-programme/i-country.d.ts +20 -0
  40. package/src/models/customerio-programme/i-country.js +1 -0
  41. package/src/models/customerio-programme/i-customer-i-o-programme.d.ts +107 -0
  42. package/src/models/customerio-programme/i-customer-i-o-programme.js +1 -0
  43. package/src/models/customerio-programme/i-deadline.d.ts +20 -0
  44. package/src/models/customerio-programme/i-deadline.js +1 -0
  45. package/src/models/customerio-programme/i-english-requirements.d.ts +51 -0
  46. package/src/models/customerio-programme/i-english-requirements.js +1 -0
  47. package/src/models/customerio-programme/i-logo.d.ts +14 -0
  48. package/src/models/customerio-programme/i-logo.js +1 -0
  49. package/src/models/customerio-programme/i-start-date.d.ts +33 -0
  50. package/src/models/customerio-programme/i-start-date.js +1 -0
  51. package/src/models/customerio-programme/i-timing.d.ts +45 -0
  52. package/src/models/customerio-programme/i-timing.js +1 -0
  53. package/src/models/customerio-programme/i-tuition-fee.d.ts +64 -0
  54. package/src/models/customerio-programme/i-tuition-fee.js +1 -0
  55. package/src/models/organisation-card/i-organisation-card.d.ts +3 -0
  56. package/src/models/organisation-card/i-ranking-discipline.d.ts +4 -0
  57. package/src/models/organisation-card/i-ranking-discipline.js +1 -0
  58. package/src/models/programme-card/i-english-requirements.d.ts +51 -0
  59. package/src/models/programme-card/i-english-requirements.js +1 -0
  60. package/src/models/programme-card/i-g-p-a-requirement.d.ts +20 -0
  61. package/src/models/programme-card/i-g-p-a-requirement.js +1 -0
  62. package/src/models/programme-card/i-living-cost.d.ts +20 -0
  63. package/src/models/programme-card/i-living-cost.js +1 -0
  64. package/src/models/programme-card/i-review-rating-domain.d.ts +6 -0
  65. package/src/models/programme-card/i-review-rating-domain.js +1 -0
package/index.d.ts CHANGED
@@ -83,6 +83,7 @@ import { CopilotCountryClient } from "./src/models/copilot-country/copilot-count
83
83
  import { ICopilotRankingCard } from "./src/models/copilot-country/i-copilot-ranking-card.js";
84
84
  import { IReviewRating } from "./src/models/common/i-review-rating.js";
85
85
  import { IScholarshipCard } from "./src/models/scholarship-card/i-scholarship-card.js";
86
- export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, ICustomerIOProgramme, CustomerIOProgrammeClient, IFaqStaticContent, PublicFaqStaticContentClient, IFaq, IStaticContentUrl, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, ScholarshipCardV2Client, IScholarshipCard, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, ICitySearchDocument, CitySearchDocumentClient, IRanking, PortalType, PortalMap, ModelClient, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard, IReviewRating };
86
+ import { IRankingDiscipline } from './src/models/organisation-card/i-ranking-discipline.js';
87
+ export { BadRequestException, ClientException, InternalServerException, NotFoundException, PropertyNotAvailableException, ICover, ILink, IOptionalLink, ILocation, IClickTrackingData, ITracking, IDuration, IDeadline, IStartDate, ITiming, ITrackedLink, IProgrammeCard, ProgrammeCardClient, ITuitionValues, IPremiumValues, IOrganisationValues, IGeoTargetingConfiguration, IGeoTargetingValues, ISearchProjection, SearchProjectionClient, ILivingCost, IGPARequirement, IBestFitProgramme, BestfitProgrammeClient, ILogo, ITuitionFee, IEnglishRequirements, IInternalLink, ICustomerIOProgramme, CustomerIOProgrammeClient, IFaqStaticContent, PublicFaqStaticContentClient, IFaq, IStaticContentUrl, ISitemapProgrammeInfo, SitemapProgrammeInfoClient, ISitemapCountryInfo, SitemapCountriesInfoClient, IDegreeInfo, ISitemapCountryDegreeInfo, SitemapCountryDegreeInfoClient, ISearchDiscipline, PublicSearchDisciplineClient, ISitemapDisciplineInfo, SitemapDisciplinesInfoClient, ICountry, ICity, IReview, ICustomerIOOrganisation, CustomerIOOrganisationClient, ISitemapOrganisationInfo, SitemapOrganisationsInfoClient, IOrganisationSearchDocument, OrganisationSearchDocumentClient, ISitemapRankingsInfo, SitemapRankingsInfoClient, ISitemapArticleInfo, SitemapArticlesInfoClient, ISitemapCityInfo, SitemapCitiesInfoClient, ScholarshipCardV2Client, IScholarshipCard, IScholarshipSearchDocument, ScholarshipSearchDocumentClient, ICitySearchDocument, CitySearchDocumentClient, IRanking, PortalType, PortalMap, ModelClient, IRankingDiscipline, IOrganisationForSearch, PublicOrganisationForSearchClient, IOrganisationCard, OrganisationCardClient, ICopilotProgramme, ICopilotCountry, CopilotProgrammeClient, CopilotCountryClient, ICopilotRankingCard, IReviewRating };
87
88
  export * from './src/clients/index.js';
88
89
  export * from './protobuf/index.js';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@studyportals/domain-client",
3
- "version": "8.3.0",
3
+ "version": "8.4.0",
4
4
  "description": "Responsible for fetching data from the Domain API",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -0,0 +1,42 @@
1
+ import { Location } from "../Location.js";
2
+ import { ReviewRating } from "../ReviewRating.js";
3
+ export interface OrganisationCard {
4
+ id: number;
5
+ name: string;
6
+ summary?: string | undefined;
7
+ relativeUrlPath: string;
8
+ logoUrl?: string | undefined;
9
+ locations: Location[];
10
+ hasAttendanceOnline: boolean;
11
+ hasAttendanceOnCampus: boolean;
12
+ hasAttendanceBlended: boolean;
13
+ venueCount: number;
14
+ globalRankingPositionPercentage?: string | undefined;
15
+ globalRankingPosition?: number | undefined;
16
+ programmeCountByLevel: {
17
+ [key: string]: number;
18
+ };
19
+ scholarshipCountByLevel: {
20
+ [key: string]: number;
21
+ };
22
+ isPublicFunding: boolean;
23
+ isNonProfitFunding: boolean;
24
+ isForProfitFunding: boolean;
25
+ reviewRating?: ReviewRating | undefined;
26
+ }
27
+ export interface OrganisationCard_ProgrammeCountByLevelEntry {
28
+ key: string;
29
+ value: number;
30
+ }
31
+ export interface OrganisationCard_ScholarshipCountByLevelEntry {
32
+ key: string;
33
+ value: number;
34
+ }
35
+ export declare const OrganisationCard: MessageFns<OrganisationCard>;
36
+ export declare const OrganisationCard_ProgrammeCountByLevelEntry: MessageFns<OrganisationCard_ProgrammeCountByLevelEntry>;
37
+ export declare const OrganisationCard_ScholarshipCountByLevelEntry: MessageFns<OrganisationCard_ScholarshipCountByLevelEntry>;
38
+ interface MessageFns<T> {
39
+ fromJSON(object: any): T;
40
+ toJSON(message: T): unknown;
41
+ }
42
+ export {};
@@ -0,0 +1,164 @@
1
+ // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
2
+ // versions:
3
+ // protoc-gen-ts_proto v2.7.7
4
+ // protoc v6.33.2
5
+ // source: Organisation/OrganisationCard.proto
6
+ /* eslint-disable */
7
+ import { Location } from "../Location.js";
8
+ import { ReviewRating } from "../ReviewRating.js";
9
+ export const OrganisationCard = {
10
+ fromJSON(object) {
11
+ return {
12
+ id: isSet(object.id) ? globalThis.Number(object.id) : 0,
13
+ name: isSet(object.name) ? globalThis.String(object.name) : "",
14
+ summary: isSet(object.summary) ? globalThis.String(object.summary) : undefined,
15
+ relativeUrlPath: isSet(object.relativeUrlPath) ? globalThis.String(object.relativeUrlPath) : "",
16
+ logoUrl: isSet(object.logoUrl) ? globalThis.String(object.logoUrl) : undefined,
17
+ locations: globalThis.Array.isArray(object?.locations)
18
+ ? object.locations.map((e) => Location.fromJSON(e))
19
+ : [],
20
+ hasAttendanceOnline: isSet(object.hasAttendanceOnline) ? globalThis.Boolean(object.hasAttendanceOnline) : false,
21
+ hasAttendanceOnCampus: isSet(object.hasAttendanceOnCampus)
22
+ ? globalThis.Boolean(object.hasAttendanceOnCampus)
23
+ : false,
24
+ hasAttendanceBlended: isSet(object.hasAttendanceBlended)
25
+ ? globalThis.Boolean(object.hasAttendanceBlended)
26
+ : false,
27
+ venueCount: isSet(object.venueCount) ? globalThis.Number(object.venueCount) : 0,
28
+ globalRankingPositionPercentage: isSet(object.globalRankingPositionPercentage)
29
+ ? globalThis.String(object.globalRankingPositionPercentage)
30
+ : undefined,
31
+ globalRankingPosition: isSet(object.globalRankingPosition)
32
+ ? globalThis.Number(object.globalRankingPosition)
33
+ : undefined,
34
+ programmeCountByLevel: isObject(object.programmeCountByLevel)
35
+ ? Object.entries(object.programmeCountByLevel).reduce((acc, [key, value]) => {
36
+ acc[key] = Number(value);
37
+ return acc;
38
+ }, {})
39
+ : {},
40
+ scholarshipCountByLevel: isObject(object.scholarshipCountByLevel)
41
+ ? Object.entries(object.scholarshipCountByLevel).reduce((acc, [key, value]) => {
42
+ acc[key] = Number(value);
43
+ return acc;
44
+ }, {})
45
+ : {},
46
+ isPublicFunding: isSet(object.isPublicFunding) ? globalThis.Boolean(object.isPublicFunding) : false,
47
+ isNonProfitFunding: isSet(object.isNonProfitFunding) ? globalThis.Boolean(object.isNonProfitFunding) : false,
48
+ isForProfitFunding: isSet(object.isForProfitFunding) ? globalThis.Boolean(object.isForProfitFunding) : false,
49
+ reviewRating: isSet(object.reviewRating) ? ReviewRating.fromJSON(object.reviewRating) : undefined,
50
+ };
51
+ },
52
+ toJSON(message) {
53
+ const obj = {};
54
+ if (message.id !== 0) {
55
+ obj.id = Math.round(message.id);
56
+ }
57
+ if (message.name !== "") {
58
+ obj.name = message.name;
59
+ }
60
+ if (message.summary !== undefined) {
61
+ obj.summary = message.summary;
62
+ }
63
+ if (message.relativeUrlPath !== "") {
64
+ obj.relativeUrlPath = message.relativeUrlPath;
65
+ }
66
+ if (message.logoUrl !== undefined) {
67
+ obj.logoUrl = message.logoUrl;
68
+ }
69
+ if (message.locations?.length) {
70
+ obj.locations = message.locations.map((e) => Location.toJSON(e));
71
+ }
72
+ if (message.hasAttendanceOnline !== false) {
73
+ obj.hasAttendanceOnline = message.hasAttendanceOnline;
74
+ }
75
+ if (message.hasAttendanceOnCampus !== false) {
76
+ obj.hasAttendanceOnCampus = message.hasAttendanceOnCampus;
77
+ }
78
+ if (message.hasAttendanceBlended !== false) {
79
+ obj.hasAttendanceBlended = message.hasAttendanceBlended;
80
+ }
81
+ if (message.venueCount !== 0) {
82
+ obj.venueCount = Math.round(message.venueCount);
83
+ }
84
+ if (message.globalRankingPositionPercentage !== undefined) {
85
+ obj.globalRankingPositionPercentage = message.globalRankingPositionPercentage;
86
+ }
87
+ if (message.globalRankingPosition !== undefined) {
88
+ obj.globalRankingPosition = Math.round(message.globalRankingPosition);
89
+ }
90
+ if (message.programmeCountByLevel) {
91
+ const entries = Object.entries(message.programmeCountByLevel);
92
+ if (entries.length > 0) {
93
+ obj.programmeCountByLevel = {};
94
+ entries.forEach(([k, v]) => {
95
+ obj.programmeCountByLevel[k] = Math.round(v);
96
+ });
97
+ }
98
+ }
99
+ if (message.scholarshipCountByLevel) {
100
+ const entries = Object.entries(message.scholarshipCountByLevel);
101
+ if (entries.length > 0) {
102
+ obj.scholarshipCountByLevel = {};
103
+ entries.forEach(([k, v]) => {
104
+ obj.scholarshipCountByLevel[k] = Math.round(v);
105
+ });
106
+ }
107
+ }
108
+ if (message.isPublicFunding !== false) {
109
+ obj.isPublicFunding = message.isPublicFunding;
110
+ }
111
+ if (message.isNonProfitFunding !== false) {
112
+ obj.isNonProfitFunding = message.isNonProfitFunding;
113
+ }
114
+ if (message.isForProfitFunding !== false) {
115
+ obj.isForProfitFunding = message.isForProfitFunding;
116
+ }
117
+ if (message.reviewRating !== undefined) {
118
+ obj.reviewRating = ReviewRating.toJSON(message.reviewRating);
119
+ }
120
+ return obj;
121
+ },
122
+ };
123
+ export const OrganisationCard_ProgrammeCountByLevelEntry = {
124
+ fromJSON(object) {
125
+ return {
126
+ key: isSet(object.key) ? globalThis.String(object.key) : "",
127
+ value: isSet(object.value) ? globalThis.Number(object.value) : 0,
128
+ };
129
+ },
130
+ toJSON(message) {
131
+ const obj = {};
132
+ if (message.key !== "") {
133
+ obj.key = message.key;
134
+ }
135
+ if (message.value !== 0) {
136
+ obj.value = Math.round(message.value);
137
+ }
138
+ return obj;
139
+ },
140
+ };
141
+ export const OrganisationCard_ScholarshipCountByLevelEntry = {
142
+ fromJSON(object) {
143
+ return {
144
+ key: isSet(object.key) ? globalThis.String(object.key) : "",
145
+ value: isSet(object.value) ? globalThis.Number(object.value) : 0,
146
+ };
147
+ },
148
+ toJSON(message) {
149
+ const obj = {};
150
+ if (message.key !== "") {
151
+ obj.key = message.key;
152
+ }
153
+ if (message.value !== 0) {
154
+ obj.value = Math.round(message.value);
155
+ }
156
+ return obj;
157
+ },
158
+ };
159
+ function isObject(value) {
160
+ return typeof value === "object" && value !== null;
161
+ }
162
+ function isSet(value) {
163
+ return value !== null && value !== undefined;
164
+ }
@@ -44,4 +44,5 @@ export * from "./TrackedLink.js";
44
44
  export * from "./Tracking.js";
45
45
  export * from "./TuitionFee.js";
46
46
  export * from "./Unibuddy.js";
47
+ export * from "./Organisation/OrganisationCard.js";
47
48
  export * from "./google/protobuf/timestamp.js";
package/protobuf/index.js CHANGED
@@ -44,4 +44,5 @@ export * from "./TrackedLink.js";
44
44
  export * from "./Tracking.js";
45
45
  export * from "./TuitionFee.js";
46
46
  export * from "./Unibuddy.js";
47
+ export * from "./Organisation/OrganisationCard.js";
47
48
  export * from "./google/protobuf/timestamp.js";
@@ -2,6 +2,7 @@
2
2
  * @file Automatically generated by barrelsby.
3
3
  */
4
4
  export * from "./article-detail-page-client.js";
5
+ export * from "./organisation-card-v2-client.js";
5
6
  export * from "./organisation-page-client.js";
6
7
  export * from "./programme-card-v2-client.js";
7
8
  export * from "./protobuf-client.js";
@@ -2,6 +2,7 @@
2
2
  * @file Automatically generated by barrelsby.
3
3
  */
4
4
  export * from "./article-detail-page-client.js";
5
+ export * from "./organisation-card-v2-client.js";
5
6
  export * from "./organisation-page-client.js";
6
7
  export * from "./programme-card-v2-client.js";
7
8
  export * from "./protobuf-client.js";
@@ -0,0 +1,8 @@
1
+ import { OrganisationCard } from "../../protobuf/index.js";
2
+ import { ProtobufClient } from "./protobuf-client.js";
3
+ export declare class OrganisationCardV2Client extends ProtobufClient<OrganisationCard> {
4
+ protected constructModel(data: Record<string, any>): OrganisationCard;
5
+ protected getModelName(): string;
6
+ protected getVersion(): string;
7
+ isPublic(): boolean;
8
+ }
@@ -0,0 +1,16 @@
1
+ import { OrganisationCard } from "../../protobuf/index.js";
2
+ import { ProtobufClient } from "./protobuf-client.js";
3
+ export class OrganisationCardV2Client extends ProtobufClient {
4
+ constructModel(data) {
5
+ return OrganisationCard.fromJSON(data);
6
+ }
7
+ getModelName() {
8
+ return 'organisation-card-v2';
9
+ }
10
+ getVersion() {
11
+ return 'v1';
12
+ }
13
+ isPublic() {
14
+ return false;
15
+ }
16
+ }
@@ -0,0 +1,20 @@
1
+ export interface IDeadline {
2
+ /**
3
+ * Get the date this deadline expires on.
4
+ *
5
+ * @return Date
6
+ */
7
+ getDate(): Date;
8
+ /**
9
+ * Get the deadline type (e.g. general, national, eea, etc).
10
+ *
11
+ * @return string
12
+ */
13
+ getType(): string;
14
+ /**
15
+ * True if the deadline has passed (e.g. you can't apply anymore).
16
+ *
17
+ * @return boolean
18
+ */
19
+ isPassed(): boolean;
20
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +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 OTE
25
+ *
26
+ * @return number
27
+ */
28
+ getOte(): number;
29
+ canShowOte(): boolean;
30
+ /**
31
+ * Required score for PTE
32
+ *
33
+ * @return number
34
+ */
35
+ getPTE(): number;
36
+ canShowPTE(): boolean;
37
+ /**
38
+ * Required score for TOEFL internet
39
+ *
40
+ * @return number
41
+ */
42
+ getTOEFLInternet(): number;
43
+ canShowTOEFLInternet(): boolean;
44
+ /**
45
+ * Required score for TOEFL paper
46
+ *
47
+ * @return number
48
+ */
49
+ getTOEFLPaper(): number;
50
+ canShowTOEFLPaper(): boolean;
51
+ }
@@ -0,0 +1,20 @@
1
+ export interface IGPARequirement {
2
+ /**
3
+ * The used GPA scale for this requirement
4
+ *
5
+ * @return string
6
+ */
7
+ getScale(): string;
8
+ /**
9
+ * Required minimum score.
10
+ *
11
+ * @return string
12
+ */
13
+ getScore(): string;
14
+ /**
15
+ * Is GPA recommended or required.
16
+ *
17
+ * @return boolean
18
+ */
19
+ isRequired(): boolean;
20
+ }
@@ -0,0 +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
+ }
@@ -0,0 +1,30 @@
1
+ import { IGeoTargetingConfiguration } from "../../../index.js";
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
+ }
@@ -0,0 +1,28 @@
1
+ export interface IInternalLink {
2
+ /**
3
+ * Get an optional text describing the link (typically <a>-tags contents).
4
+ *
5
+ * @return string
6
+ * @throws PropertyNotAvailableException
7
+ */
8
+ getDescription(): string;
9
+ canShowDescription(): boolean;
10
+ /**
11
+ * Returns on which portal a this link should link towards.
12
+ *
13
+ * @return string
14
+ */
15
+ getPortalType(): string;
16
+ /**
17
+ * Get the url to refer to.
18
+ *
19
+ * Note that the url provided is always a relative URL. A base URL is needed
20
+ * to make it a full valid path.
21
+ * The only exception is when an external link is provided (meaning, outside
22
+ * of StudyPortals-maintained domains). In this case a full url will be
23
+ * provided.
24
+ *
25
+ * @return string
26
+ */
27
+ getUrl(): string;
28
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,22 @@
1
+ export interface ILink {
2
+ /**
3
+ * Get an optional text describing the link (typically <a>-tags contents).
4
+ *
5
+ * @return string
6
+ * @throws PropertyNotAvailableException
7
+ */
8
+ getDescription(): string;
9
+ canShowDescription(): boolean;
10
+ /**
11
+ * Get the url to refer to.
12
+ *
13
+ * Note that the url provided is always a relative URL. A base URL is needed
14
+ * to make it a full valid path.
15
+ * The only exception is when an external link is provided (meaning, outside
16
+ * of StudyPortals-maintained domains). In this case a full url will be
17
+ * provided.
18
+ *
19
+ * @return string
20
+ */
21
+ getUrl(): string;
22
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +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
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,33 @@
1
+ import { IDeadline } from "../../../index.js";
2
+ export interface IStartDate {
3
+ /**
4
+ * Get the date the programme starts on.
5
+ *
6
+ * @return Date
7
+ */
8
+ getDate(): Date;
9
+ /**
10
+ * Get a list of deadlines that apply to this start date.
11
+ *
12
+ * Note: In case of extendable start dates, all information in the
13
+ * Deadline objects has already been extended to the first available start
14
+ * date.
15
+ *
16
+ * @return IDeadline[]
17
+ * @throws PropertyNotAvailableException
18
+ */
19
+ getDeadlines(): IDeadline[];
20
+ canShowDeadlines(): boolean;
21
+ /**
22
+ * True if you can apply at any time for this programme (rolling admission)
23
+ *
24
+ * @return boolean
25
+ */
26
+ isApplyingAnytime(): boolean;
27
+ /**
28
+ * True if the start date has passed (you can't start at this date anymore).
29
+ *
30
+ * @return boolean
31
+ */
32
+ isPassed(): boolean;
33
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,45 @@
1
+ import { IDeadline, IStartDate } from "../../../index.js";
2
+ export interface ITiming {
3
+ /**
4
+ * Get the IDeadline applicable for this type and programme.
5
+ *
6
+ * Note: In case of extendable start dates, all information in the
7
+ * Deadline object has already been extended to the first available start
8
+ * date.
9
+ *
10
+ * @return IDeadline
11
+ * @throws PropertyNotAvailableException
12
+ */
13
+ getDeadline(): IDeadline;
14
+ canShowDeadline(): boolean;
15
+ /**
16
+ * Get the IStartDate applicable for this type and programme.
17
+ *
18
+ * Note: In case of extendable start dates, all information in the
19
+ * StartDate objects has already been extended to the first available start
20
+ * date.
21
+ *
22
+ * @return IStartDate
23
+ * @throws PropertyNotAvailableException
24
+ */
25
+ getStartDate(): IStartDate;
26
+ canShowStartDate(): boolean;
27
+ /**
28
+ * Type of user the timing is applicable to (e.g. general, eea, national).
29
+ *
30
+ * @return string
31
+ */
32
+ getType(): string;
33
+ /**
34
+ * True if the programme allows to apply at any time (rolling application).
35
+ *
36
+ * @return boolean
37
+ */
38
+ isApplyingAnytime(): boolean;
39
+ /**
40
+ * True if the programme can start at any time (rolling admission).
41
+ *
42
+ * @return boolean
43
+ */
44
+ isStartingAnytime(): boolean;
45
+ }
@@ -0,0 +1 @@
1
+ export {};