@studyportals/domain-client 6.0.0 → 6.1.0-beta.0

package/protobuf/ReviewRating.ts

@@ -0,0 +1,51 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: ReviewRating.proto
+
+/* eslint-disable */
+
+export interface ReviewRating {
+  average: number;
+  quantity: number;
+  averageStarRating: number;
+  hasEnoughQuantity: boolean;
+}
+
+export const ReviewRating: MessageFns<ReviewRating> = {
+  fromJSON(object: any): ReviewRating {
+    return {
+      average: isSet(object.average) ? globalThis.Number(object.average) : 0,
+      quantity: isSet(object.quantity) ? globalThis.Number(object.quantity) : 0,
+      averageStarRating: isSet(object.averageStarRating) ? globalThis.Number(object.averageStarRating) : 0,
+      hasEnoughQuantity: isSet(object.hasEnoughQuantity) ? globalThis.Boolean(object.hasEnoughQuantity) : false,
+    };
+  },
+
+  toJSON(message: ReviewRating): unknown {
+    const obj: any = {};
+    if (message.average !== 0) {
+      obj.average = message.average;
+    }
+    if (message.quantity !== 0) {
+      obj.quantity = Math.round(message.quantity);
+    }
+    if (message.averageStarRating !== 0) {
+      obj.averageStarRating = message.averageStarRating;
+    }
+    if (message.hasEnoughQuantity !== false) {
+      obj.hasEnoughQuantity = message.hasEnoughQuantity;
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/RichText.ts

@@ -0,0 +1,43 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: RichText.proto
+
+/* eslint-disable */
+
+export interface RichText {
+  contents: string;
+  isRenderedAsWhitespace: boolean;
+}
+
+export const RichText: MessageFns<RichText> = {
+  fromJSON(object: any): RichText {
+    return {
+      contents: isSet(object.contents) ? globalThis.String(object.contents) : "",
+      isRenderedAsWhitespace: isSet(object.isRenderedAsWhitespace)
+        ? globalThis.Boolean(object.isRenderedAsWhitespace)
+        : false,
+    };
+  },
+
+  toJSON(message: RichText): unknown {
+    const obj: any = {};
+    if (message.contents !== "") {
+      obj.contents = message.contents;
+    }
+    if (message.isRenderedAsWhitespace !== false) {
+      obj.isRenderedAsWhitespace = message.isRenderedAsWhitespace;
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/SocialLink.ts

@@ -0,0 +1,96 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: SocialLink.proto
+
+/* eslint-disable */
+
+export interface SocialLink {
+  id: number;
+  description?: string | undefined;
+  name?: string | undefined;
+  url: string;
+  trackedUrl: string;
+  isHomepage: boolean;
+  isFacebook: boolean;
+  isTwitter: boolean;
+  isYoutube: boolean;
+  isInstagram: boolean;
+  isLinkedIn: boolean;
+  isSocial: boolean;
+  isMedia: boolean;
+}
+
+export const SocialLink: MessageFns<SocialLink> = {
+  fromJSON(object: any): SocialLink {
+    return {
+      id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+      description: isSet(object.description) ? globalThis.String(object.description) : undefined,
+      name: isSet(object.name) ? globalThis.String(object.name) : undefined,
+      url: isSet(object.url) ? globalThis.String(object.url) : "",
+      trackedUrl: isSet(object.trackedUrl) ? globalThis.String(object.trackedUrl) : "",
+      isHomepage: isSet(object.isHomepage) ? globalThis.Boolean(object.isHomepage) : false,
+      isFacebook: isSet(object.isFacebook) ? globalThis.Boolean(object.isFacebook) : false,
+      isTwitter: isSet(object.isTwitter) ? globalThis.Boolean(object.isTwitter) : false,
+      isYoutube: isSet(object.isYoutube) ? globalThis.Boolean(object.isYoutube) : false,
+      isInstagram: isSet(object.isInstagram) ? globalThis.Boolean(object.isInstagram) : false,
+      isLinkedIn: isSet(object.isLinkedIn) ? globalThis.Boolean(object.isLinkedIn) : false,
+      isSocial: isSet(object.isSocial) ? globalThis.Boolean(object.isSocial) : false,
+      isMedia: isSet(object.isMedia) ? globalThis.Boolean(object.isMedia) : false,
+    };
+  },
+
+  toJSON(message: SocialLink): unknown {
+    const obj: any = {};
+    if (message.id !== 0) {
+      obj.id = Math.round(message.id);
+    }
+    if (message.description !== undefined) {
+      obj.description = message.description;
+    }
+    if (message.name !== undefined) {
+      obj.name = message.name;
+    }
+    if (message.url !== "") {
+      obj.url = message.url;
+    }
+    if (message.trackedUrl !== "") {
+      obj.trackedUrl = message.trackedUrl;
+    }
+    if (message.isHomepage !== false) {
+      obj.isHomepage = message.isHomepage;
+    }
+    if (message.isFacebook !== false) {
+      obj.isFacebook = message.isFacebook;
+    }
+    if (message.isTwitter !== false) {
+      obj.isTwitter = message.isTwitter;
+    }
+    if (message.isYoutube !== false) {
+      obj.isYoutube = message.isYoutube;
+    }
+    if (message.isInstagram !== false) {
+      obj.isInstagram = message.isInstagram;
+    }
+    if (message.isLinkedIn !== false) {
+      obj.isLinkedIn = message.isLinkedIn;
+    }
+    if (message.isSocial !== false) {
+      obj.isSocial = message.isSocial;
+    }
+    if (message.isMedia !== false) {
+      obj.isMedia = message.isMedia;
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/StartDate.ts

@@ -0,0 +1,54 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: StartDate.proto
+
+/* eslint-disable */
+import { Deadline } from "./Deadline";
+
+export interface StartDate {
+  isPassed: boolean;
+  date: string;
+  isApplyingAnytime: boolean;
+  deadlines: Deadline[];
+}
+
+export const StartDate: MessageFns<StartDate> = {
+  fromJSON(object: any): StartDate {
+    return {
+      isPassed: isSet(object.isPassed) ? globalThis.Boolean(object.isPassed) : false,
+      date: isSet(object.date) ? globalThis.String(object.date) : "",
+      isApplyingAnytime: isSet(object.isApplyingAnytime) ? globalThis.Boolean(object.isApplyingAnytime) : false,
+      deadlines: globalThis.Array.isArray(object?.deadlines)
+        ? object.deadlines.map((e: any) => Deadline.fromJSON(e))
+        : [],
+    };
+  },
+
+  toJSON(message: StartDate): unknown {
+    const obj: any = {};
+    if (message.isPassed !== false) {
+      obj.isPassed = message.isPassed;
+    }
+    if (message.date !== "") {
+      obj.date = message.date;
+    }
+    if (message.isApplyingAnytime !== false) {
+      obj.isApplyingAnytime = message.isApplyingAnytime;
+    }
+    if (message.deadlines?.length) {
+      obj.deadlines = message.deadlines.map((e) => Deadline.toJSON(e));
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/Timing.ts

@@ -0,0 +1,68 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: Timing.proto
+
+/* eslint-disable */
+import { Deadline } from "./Deadline";
+import { StartDate } from "./StartDate";
+
+export interface Timing {
+  type: string;
+  isStartingAnytime: boolean;
+  startDate: StartDate | undefined;
+  canShowStartDate: boolean;
+  isApplyingAnytime: boolean;
+  deadline: Deadline | undefined;
+  canShowDeadline: boolean;
+}
+
+export const Timing: MessageFns<Timing> = {
+  fromJSON(object: any): Timing {
+    return {
+      type: isSet(object.type) ? globalThis.String(object.type) : "",
+      isStartingAnytime: isSet(object.isStartingAnytime) ? globalThis.Boolean(object.isStartingAnytime) : false,
+      startDate: isSet(object.startDate) ? StartDate.fromJSON(object.startDate) : undefined,
+      canShowStartDate: isSet(object.canShowStartDate) ? globalThis.Boolean(object.canShowStartDate) : false,
+      isApplyingAnytime: isSet(object.isApplyingAnytime) ? globalThis.Boolean(object.isApplyingAnytime) : false,
+      deadline: isSet(object.deadline) ? Deadline.fromJSON(object.deadline) : undefined,
+      canShowDeadline: isSet(object.canShowDeadline) ? globalThis.Boolean(object.canShowDeadline) : false,
+    };
+  },
+
+  toJSON(message: Timing): unknown {
+    const obj: any = {};
+    if (message.type !== "") {
+      obj.type = message.type;
+    }
+    if (message.isStartingAnytime !== false) {
+      obj.isStartingAnytime = message.isStartingAnytime;
+    }
+    if (message.startDate !== undefined) {
+      obj.startDate = StartDate.toJSON(message.startDate);
+    }
+    if (message.canShowStartDate !== false) {
+      obj.canShowStartDate = message.canShowStartDate;
+    }
+    if (message.isApplyingAnytime !== false) {
+      obj.isApplyingAnytime = message.isApplyingAnytime;
+    }
+    if (message.deadline !== undefined) {
+      obj.deadline = Deadline.toJSON(message.deadline);
+    }
+    if (message.canShowDeadline !== false) {
+      obj.canShowDeadline = message.canShowDeadline;
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/Topic.ts

@@ -0,0 +1,41 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: Topic.proto
+
+/* eslint-disable */
+
+export interface Topic {
+  id: number;
+  name: string;
+}
+
+export const Topic: MessageFns<Topic> = {
+  fromJSON(object: any): Topic {
+    return {
+      id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+      name: isSet(object.name) ? globalThis.String(object.name) : "",
+    };
+  },
+
+  toJSON(message: Topic): unknown {
+    const obj: any = {};
+    if (message.id !== 0) {
+      obj.id = Math.round(message.id);
+    }
+    if (message.name !== "") {
+      obj.name = message.name;
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/TrackedLink.ts

@@ -0,0 +1,52 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: TrackedLink.proto
+
+/* eslint-disable */
+import { Tracking } from "./Tracking";
+
+export interface TrackedLink {
+  url: string;
+  description: string;
+  canShowDescription: boolean;
+  tracking: Tracking | undefined;
+}
+
+export const TrackedLink: MessageFns<TrackedLink> = {
+  fromJSON(object: any): TrackedLink {
+    return {
+      url: isSet(object.url) ? globalThis.String(object.url) : "",
+      description: isSet(object.description) ? globalThis.String(object.description) : "",
+      canShowDescription: isSet(object.canShowDescription) ? globalThis.Boolean(object.canShowDescription) : false,
+      tracking: isSet(object.tracking) ? Tracking.fromJSON(object.tracking) : undefined,
+    };
+  },
+
+  toJSON(message: TrackedLink): unknown {
+    const obj: any = {};
+    if (message.url !== "") {
+      obj.url = message.url;
+    }
+    if (message.description !== "") {
+      obj.description = message.description;
+    }
+    if (message.canShowDescription !== false) {
+      obj.canShowDescription = message.canShowDescription;
+    }
+    if (message.tracking !== undefined) {
+      obj.tracking = Tracking.toJSON(message.tracking);
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/Tracking.ts

@@ -0,0 +1,79 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: Tracking.proto
+
+/* eslint-disable */
+import { ClickTracking } from "./ClickTracking";
+
+export interface Tracking {
+  id: number;
+  clickTracking: ClickTracking | undefined;
+  canShowClickTracking: boolean;
+  action: string;
+  type: string;
+  description: string;
+  label: string;
+  extra: string;
+  pgl: boolean;
+}
+
+export const Tracking: MessageFns<Tracking> = {
+  fromJSON(object: any): Tracking {
+    return {
+      id: isSet(object.id) ? globalThis.Number(object.id) : 0,
+      clickTracking: isSet(object.clickTracking) ? ClickTracking.fromJSON(object.clickTracking) : undefined,
+      canShowClickTracking: isSet(object.canShowClickTracking)
+        ? globalThis.Boolean(object.canShowClickTracking)
+        : false,
+      action: isSet(object.action) ? globalThis.String(object.action) : "",
+      type: isSet(object.type) ? globalThis.String(object.type) : "",
+      description: isSet(object.description) ? globalThis.String(object.description) : "",
+      label: isSet(object.label) ? globalThis.String(object.label) : "",
+      extra: isSet(object.extra) ? globalThis.String(object.extra) : "",
+      pgl: isSet(object.pgl) ? globalThis.Boolean(object.pgl) : false,
+    };
+  },
+
+  toJSON(message: Tracking): unknown {
+    const obj: any = {};
+    if (message.id !== 0) {
+      obj.id = Math.round(message.id);
+    }
+    if (message.clickTracking !== undefined) {
+      obj.clickTracking = ClickTracking.toJSON(message.clickTracking);
+    }
+    if (message.canShowClickTracking !== false) {
+      obj.canShowClickTracking = message.canShowClickTracking;
+    }
+    if (message.action !== "") {
+      obj.action = message.action;
+    }
+    if (message.type !== "") {
+      obj.type = message.type;
+    }
+    if (message.description !== "") {
+      obj.description = message.description;
+    }
+    if (message.label !== "") {
+      obj.label = message.label;
+    }
+    if (message.extra !== "") {
+      obj.extra = message.extra;
+    }
+    if (message.pgl !== false) {
+      obj.pgl = message.pgl;
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/TuitionFee.ts

@@ -0,0 +1,56 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: TuitionFee.proto
+
+/* eslint-disable */
+
+export interface TuitionFee {
+  amount: number;
+  currency: string;
+  unit: string;
+  originalAmount: number;
+  originalUnit: string;
+}
+
+export const TuitionFee: MessageFns<TuitionFee> = {
+  fromJSON(object: any): TuitionFee {
+    return {
+      amount: isSet(object.amount) ? globalThis.Number(object.amount) : 0,
+      currency: isSet(object.currency) ? globalThis.String(object.currency) : "",
+      unit: isSet(object.unit) ? globalThis.String(object.unit) : "",
+      originalAmount: isSet(object.originalAmount) ? globalThis.Number(object.originalAmount) : 0,
+      originalUnit: isSet(object.originalUnit) ? globalThis.String(object.originalUnit) : "",
+    };
+  },
+
+  toJSON(message: TuitionFee): unknown {
+    const obj: any = {};
+    if (message.amount !== 0) {
+      obj.amount = Math.round(message.amount);
+    }
+    if (message.currency !== "") {
+      obj.currency = message.currency;
+    }
+    if (message.unit !== "") {
+      obj.unit = message.unit;
+    }
+    if (message.originalAmount !== 0) {
+      obj.originalAmount = Math.round(message.originalAmount);
+    }
+    if (message.originalUnit !== "") {
+      obj.originalUnit = message.originalUnit;
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/Unibuddy.ts

@@ -0,0 +1,41 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.5
+//   protoc               v3.12.4
+// source: Unibuddy.proto
+
+/* eslint-disable */
+
+export interface Unibuddy {
+  id: string;
+  isEnabled: boolean;
+}
+
+export const Unibuddy: MessageFns<Unibuddy> = {
+  fromJSON(object: any): Unibuddy {
+    return {
+      id: isSet(object.id) ? globalThis.String(object.id) : "",
+      isEnabled: isSet(object.isEnabled) ? globalThis.Boolean(object.isEnabled) : false,
+    };
+  },
+
+  toJSON(message: Unibuddy): unknown {
+    const obj: any = {};
+    if (message.id !== "") {
+      obj.id = message.id;
+    }
+    if (message.isEnabled !== false) {
+      obj.isEnabled = message.isEnabled;
+    }
+    return obj;
+  },
+};
+
+function isSet(value: any): boolean {
+  return value !== null && value !== undefined;
+}
+
+interface MessageFns<T> {
+  fromJSON(object: any): T;
+  toJSON(message: T): unknown;
+}

package/protobuf/index.ts

@@ -0,0 +1,46 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+
+export * from "./Area";
+export * from "./Article";
+export * from "./Body";
+export * from "./CampaignInformation";
+export * from "./ClickTracking";
+export * from "./CommercialEntity";
+export * from "./Cover";
+export * from "./Deadline";
+export * from "./Degree";
+export * from "./Description";
+export * from "./Discipline";
+export * from "./Duration";
+export * from "./EnglishRequirement";
+export * from "./EssentialInformation";
+export * from "./File";
+export * from "./GPARequirement";
+export * from "./InternalLink";
+export * from "./Link";
+export * from "./LivingCost";
+export * from "./Location";
+export * from "./Logo";
+export * from "./MiniProgrammeCard";
+export * from "./OptionalLink";
+export * from "./Organisation";
+export * from "./OrganisationInformation";
+export * from "./OrganisationRanking";
+export * from "./Person";
+export * from "./ProgrammeCard";
+export * from "./ProgrammeGrid";
+export * from "./Ranking";
+export * from "./RankingInstitute";
+export * from "./Review";
+export * from "./ReviewRating";
+export * from "./RichText";
+export * from "./SocialLink";
+export * from "./StartDate";
+export * from "./Timing";
+export * from "./Topic";
+export * from "./TrackedLink";
+export * from "./Tracking";
+export * from "./TuitionFee";
+export * from "./Unibuddy";

package/src/clients/article-detail-page-client.ts

@@ -0,0 +1,20 @@
+import { Article } from "../../protobuf";
+import { ProtobufClient } from "./protobuf-client";
+
+export class ArticleDetailPageClient extends ProtobufClient<Article> {
+	protected constructModel(data: Record<string, any>): Article {
+		return Article.fromJSON(data);
+	}
+
+	protected getModelName(): string {
+		return 'article-detail-page';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}

package/src/clients/index.ts

@@ -0,0 +1,8 @@
+/**
+ * @file Automatically generated by barrelsby.
+ */
+
+export * from "./article-detail-page-client";
+export * from "./organisation-page-client";
+export * from "./protobuf-client";
+export * from "./public-mini-programme-card-client";

package/src/clients/organisation-page-client.ts

@@ -0,0 +1,20 @@
+import { Organisation } from "../../protobuf";
+import { ProtobufClient } from "./protobuf-client";
+
+export class OrganisationPageClient extends ProtobufClient<Organisation> {
+	protected constructModel(data: Record<string, any>): Organisation {
+		return Organisation.fromJSON(data);
+	}
+
+	protected getModelName(): string {
+		return 'organisation-page';
+	}
+
+	protected getVersion(): string {
+		return 'v1';
+	}
+
+	public isPublic(): boolean {
+		return false;
+	}
+}