@studyportals/domain-client 6.0.0-6 → 6.0.0-8

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 (81) hide show
  1. package/index.d.ts +4 -1
  2. package/package.json +3 -3
  3. package/src/domain-client.d.ts +2 -3
  4. package/src/domain-client.js +15 -1
  5. package/src/i-api-response.d.ts +1 -1
  6. package/src/models/bestfit-programme/i-english-requirements.d.ts +51 -0
  7. package/src/models/bestfit-programme/i-english-requirements.js +1 -0
  8. package/src/models/bestfit-programme/i-g-p-a-requirement.d.ts +20 -0
  9. package/src/models/bestfit-programme/i-g-p-a-requirement.js +1 -0
  10. package/src/models/bestfit-programme/i-tuition-fee.d.ts +50 -0
  11. package/src/models/bestfit-programme/i-tuition-fee.js +1 -0
  12. package/src/models/common/i-review-rating.d.ts +26 -0
  13. package/src/models/common/i-review-rating.js +1 -0
  14. package/src/models/compare-programme/i-english-requirements.d.ts +51 -0
  15. package/src/models/compare-programme/i-english-requirements.js +1 -0
  16. package/src/models/compare-programme/i-g-p-a-requirement.d.ts +20 -0
  17. package/src/models/compare-programme/i-g-p-a-requirement.js +1 -0
  18. package/src/models/compare-programme/i-living-cost.d.ts +20 -0
  19. package/src/models/compare-programme/i-living-cost.js +1 -0
  20. package/src/models/copilot-programme/i-deadline.d.ts +20 -0
  21. package/src/models/copilot-programme/i-deadline.js +1 -0
  22. package/src/models/copilot-programme/i-english-requirements.d.ts +51 -0
  23. package/src/models/copilot-programme/i-english-requirements.js +1 -0
  24. package/src/models/copilot-programme/i-g-p-a-requirement.d.ts +20 -0
  25. package/src/models/copilot-programme/i-g-p-a-requirement.js +1 -0
  26. package/src/models/copilot-programme/i-geo-targeting-configuration.d.ts +38 -0
  27. package/src/models/copilot-programme/i-geo-targeting-configuration.js +1 -0
  28. package/src/models/copilot-programme/i-geo-targeting-values.d.ts +30 -0
  29. package/src/models/copilot-programme/i-geo-targeting-values.js +1 -0
  30. package/src/models/copilot-programme/i-internal-link.d.ts +28 -0
  31. package/src/models/copilot-programme/i-internal-link.js +1 -0
  32. package/src/models/copilot-programme/i-link.d.ts +22 -0
  33. package/src/models/copilot-programme/i-link.js +1 -0
  34. package/src/models/copilot-programme/i-living-cost.d.ts +20 -0
  35. package/src/models/copilot-programme/i-living-cost.js +1 -0
  36. package/src/models/copilot-programme/i-start-date.d.ts +33 -0
  37. package/src/models/copilot-programme/i-start-date.js +1 -0
  38. package/src/models/copilot-programme/i-timing.d.ts +45 -0
  39. package/src/models/copilot-programme/i-timing.js +1 -0
  40. package/src/models/copilot-programme/i-tuition-values.d.ts +50 -0
  41. package/src/models/copilot-programme/i-tuition-values.js +1 -0
  42. package/src/models/customerio-organisation/i-city.d.ts +14 -0
  43. package/src/models/customerio-organisation/i-city.js +1 -0
  44. package/src/models/customerio-organisation/i-country.d.ts +20 -0
  45. package/src/models/customerio-organisation/i-country.js +1 -0
  46. package/src/models/customerio-organisation/i-customer-i-o-organisation.d.ts +35 -0
  47. package/src/models/customerio-organisation/i-customer-i-o-organisation.js +1 -0
  48. package/src/models/customerio-programme/i-country.d.ts +20 -0
  49. package/src/models/customerio-programme/i-country.js +1 -0
  50. package/src/models/customerio-programme/i-customer-i-o-programme.d.ts +107 -0
  51. package/src/models/customerio-programme/i-customer-i-o-programme.js +1 -0
  52. package/src/models/customerio-programme/i-deadline.d.ts +20 -0
  53. package/src/models/customerio-programme/i-deadline.js +1 -0
  54. package/src/models/customerio-programme/i-english-requirements.d.ts +51 -0
  55. package/src/models/customerio-programme/i-english-requirements.js +1 -0
  56. package/src/models/customerio-programme/i-logo.d.ts +14 -0
  57. package/src/models/customerio-programme/i-logo.js +1 -0
  58. package/src/models/customerio-programme/i-start-date.d.ts +33 -0
  59. package/src/models/customerio-programme/i-start-date.js +1 -0
  60. package/src/models/customerio-programme/i-timing.d.ts +45 -0
  61. package/src/models/customerio-programme/i-timing.js +1 -0
  62. package/src/models/customerio-programme/i-tuition-fee.d.ts +50 -0
  63. package/src/models/customerio-programme/i-tuition-fee.js +1 -0
  64. package/src/models/organisation-card/i-organisation-card.d.ts +2 -0
  65. package/src/models/organisation-card/i-review-rating-domain.d.ts +6 -0
  66. package/src/models/organisation-card/i-review-rating-domain.js +1 -0
  67. package/src/models/programme-card/i-english-requirements.d.ts +51 -0
  68. package/src/models/programme-card/i-english-requirements.js +1 -0
  69. package/src/models/programme-card/i-g-p-a-requirement.d.ts +20 -0
  70. package/src/models/programme-card/i-g-p-a-requirement.js +1 -0
  71. package/src/models/programme-card/i-living-cost.d.ts +20 -0
  72. package/src/models/programme-card/i-living-cost.js +1 -0
  73. package/src/models/programme-card/i-programme-card.d.ts +7 -0
  74. package/src/models/programme-card/i-review-rating-domain.d.ts +6 -0
  75. package/src/models/programme-card/i-review-rating-domain.js +1 -0
  76. package/src/models/scholarship-card-v2/i-scholarship-card.d.ts +15 -0
  77. package/src/models/scholarship-card-v2/i-scholarship-card.js +1 -0
  78. package/src/models/scholarship-card-v2/scholarship-card-v2-client.d.ts +7 -0
  79. package/src/models/scholarship-card-v2/scholarship-card-v2-client.js +12 -0
  80. package/test.d.ts +1 -0
  81. package/test.js +5 -0
@@ -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 @@
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 {};
@@ -1,4 +1,5 @@
1
1
  import { ICover, IDuration, IEnglishRequirements, IGPARequirement, IInternalLink, ILink, ILivingCost, ILocation, ILogo, ITiming, ITrackedLink, ITracking, ITuitionFee } from "../../..";
2
+ import { IReviewRating } from "../common/i-review-rating";
2
3
  export interface IProgrammeCard {
3
4
  /**
4
5
  * ISO code of the country the programme is taught.
@@ -202,4 +203,10 @@ export interface IProgrammeCard {
202
203
  * @return number
203
204
  */
204
205
  getCampaignType(): number | null;
206
+ /**
207
+ * Get the review rating of the programme.
208
+ *
209
+ * @return IReviewRating | null
210
+ */
211
+ getReviewRating(): IReviewRating | null;
205
212
  }
@@ -0,0 +1,6 @@
1
+ export interface IReviewRatingDomain {
2
+ getAverage(): number;
3
+ getAverageStarRating(): number;
4
+ getQuantity(): number;
5
+ hasEnoughQuantity(): boolean;
6
+ }
@@ -0,0 +1,15 @@
1
+ export interface IScholarshipCard {
2
+ getDescriptionOfApplicationBasis(): string | null;
3
+ getDescriptionOfBenefits(): string | null;
4
+ getDescriptionOfDeadline(): string;
5
+ getDescriptionOfDestinationCountryRestrictions(): string;
6
+ getDescriptionOfProviderLocation(): string | null;
7
+ getIsNotSpecifiedDeadline(): boolean;
8
+ getProviderId(): string | null;
9
+ getProviderIsUniversity(): boolean;
10
+ getProviderLogoSquareCdn(): string | null;
11
+ getProviderName(): string;
12
+ getScholarshipId(): string;
13
+ getScholarshipTitle(): string;
14
+ getScholarshipVirtualName(): string;
15
+ }
@@ -0,0 +1,7 @@
1
+ import { IScholarshipCard } from "../../..";
2
+ import { ModelClient } from "../../model-client";
3
+ export declare class ScholarshipCardV2Client extends ModelClient<IScholarshipCard> {
4
+ protected getModelName(): string;
5
+ protected getVersion(): string;
6
+ isPublic(): boolean;
7
+ }
@@ -0,0 +1,12 @@
1
+ import { ModelClient } from "../../model-client";
2
+ export class ScholarshipCardV2Client extends ModelClient {
3
+ getModelName() {
4
+ return 'scholarship-card-v2';
5
+ }
6
+ getVersion() {
7
+ return 'v1';
8
+ }
9
+ isPublic() {
10
+ return false;
11
+ }
12
+ }
package/test.d.ts ADDED
@@ -0,0 +1 @@
1
+ export {};
package/test.js ADDED
@@ -0,0 +1,5 @@
1
+ import { PublicMiniProgrammeCardClient } from "./";
2
+ const client = new PublicMiniProgrammeCardClient('https://681.domain-api.tst.prtl.co', 1, undefined, new Map());
3
+ (async () => {
4
+ console.log(await client.fetch(70942));
5
+ })();