@quesmed/types 2.6.302 → 2.6.305

package/dist/cjs/models/StudyGroup.d.ts

@@ -0,0 +1,138 @@
+import { EProductType } from './Product';
+export declare enum EStudyGroupStatus {
+    OPEN = "OPEN",
+    CLOSED = "CLOSED"
+}
+export declare enum EStudyGroupInviteState {
+    OPEN = "OPEN",
+    FULL = "FULL",
+    CLOSED = "CLOSED"
+}
+export declare enum EStudyGroupViewerState {
+    ANONYMOUS = "ANONYMOUS",
+    ELIGIBLE = "ELIGIBLE",
+    HAS_PRODUCT = "HAS_PRODUCT",
+    ALREADY_MEMBER = "ALREADY_MEMBER",
+    IN_OTHER_GROUP = "IN_OTHER_GROUP"
+}
+export declare enum EStudyGroupStartBlocker {
+    NOT_ENABLED = "NOT_ENABLED",
+    NO_ACTIVE_SUBSCRIPTION = "NO_ACTIVE_SUBSCRIPTION",
+    APP_STORE_SUBSCRIPTION = "APP_STORE_SUBSCRIPTION",
+    UNREFUNDABLE_SUBSCRIPTION = "UNREFUNDABLE_SUBSCRIPTION",
+    ALREADY_IN_GROUP = "ALREADY_IN_GROUP"
+}
+export declare enum EStudyGroupRefundStatus {
+    NONE = "NONE",
+    PENDING = "PENDING",
+    SUCCEEDED = "SUCCEEDED",
+    FAILED = "FAILED",
+    MANUAL = "MANUAL"
+}
+export declare enum EStudyGroupRefundType {
+    REFUND = "REFUND",
+    CREDIT = "CREDIT"
+}
+export declare enum EStudyGroupMemberRole {
+    ORGANISER = "ORGANISER",
+    MEMBER = "MEMBER"
+}
+export interface IGroupDiscountTier {
+    minMembers: number;
+    percent: number;
+}
+export interface IStudyGroupProduct {
+    id: number;
+    typeId: EProductType;
+    name: string;
+    duration: number;
+    interval: string;
+    price: number;
+    stripePriceId: string;
+}
+export interface IGroupDiscountOffer {
+    productTypeId: EProductType;
+    /** Product type name, e.g. "MRCP PACES Video Course" */
+    productName: string;
+    /** Every public plan of the product, cheapest first; joiners can buy any of them */
+    plans: IStudyGroupProduct[];
+    tiers: IGroupDiscountTier[];
+    maxMembers: number;
+    windowDays: number;
+    maxPercent: number;
+}
+export interface IStudyGroupInviteMember {
+    firstName: string;
+    initials: string;
+    isOrganiser: boolean;
+}
+export interface IStudyGroupInvite {
+    code: string;
+    organiserFirstName: string;
+    members: IStudyGroupInviteMember[];
+    memberCount: number;
+    maxMembers: number;
+    tiers: IGroupDiscountTier[];
+    currentPercent: number;
+    percentIfJoin: number;
+    refundIfJoin: number;
+    opensAt: number | Date;
+    closesAt: number | Date;
+    state: EStudyGroupInviteState;
+    viewerState: EStudyGroupViewerState;
+    productTypeId: EProductType;
+    /** Product type name, e.g. "MRCP PACES Video Course" */
+    productName: string;
+    /** Every public plan of the product, cheapest first; joiners can buy any of them */
+    plans: IStudyGroupProduct[];
+}
+export interface IStudyGroupMember {
+    id: number;
+    firstName: string;
+    initials: string;
+    role: EStudyGroupMemberRole;
+    isMe: boolean;
+    joinedAt: number | Date;
+    amountPaid: number;
+    refundEstimate: number;
+}
+export interface IStudyGroupMyMembership {
+    role: EStudyGroupMemberRole;
+    amountPaid: number;
+    currency: string;
+    paidAt: number | Date | null;
+    refundType: EStudyGroupRefundType;
+    refundEstimate: number;
+    refundStatus: EStudyGroupRefundStatus;
+    refundAmount: number | null;
+    refundedAt: number | Date | null;
+    /** Stripe-hosted receipt (payment + refund, with PDF download); set once the refund succeeds */
+    receiptUrl: string | null;
+}
+export interface IStudyGroup {
+    id: number;
+    code: string;
+    status: EStudyGroupStatus;
+    isFinalised: boolean;
+    opensAt: number | Date;
+    closesAt: number | Date;
+    closedAt: number | Date | null;
+    productTypeId: EProductType;
+    /** Product type name, e.g. "MRCP PACES Video Course" */
+    productName: string;
+    /** Every public plan of the product, cheapest first; joiners can buy any of them */
+    plans: IStudyGroupProduct[];
+    tiers: IGroupDiscountTier[];
+    maxMembers: number;
+    memberCount: number;
+    currentPercent: number;
+    finalPercent: number | null;
+    isOrganiser: boolean;
+    members: IStudyGroupMember[];
+    me: IStudyGroupMyMembership;
+}
+export interface IStudyGroupStartEligibility {
+    canStart: boolean;
+    blocker: EStudyGroupStartBlocker | null;
+    offer: IGroupDiscountOffer | null;
+}

package/dist/cjs/models/StudyGroup.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EStudyGroupMemberRole = exports.EStudyGroupRefundType = exports.EStudyGroupRefundStatus = exports.EStudyGroupStartBlocker = exports.EStudyGroupViewerState = exports.EStudyGroupInviteState = exports.EStudyGroupStatus = void 0;
+// Group discount ("study groups"). All money fields are in pence.
+var EStudyGroupStatus;
+(function (EStudyGroupStatus) {
+    EStudyGroupStatus["OPEN"] = "OPEN";
+    EStudyGroupStatus["CLOSED"] = "CLOSED";
+})(EStudyGroupStatus = exports.EStudyGroupStatus || (exports.EStudyGroupStatus = {}));
+var EStudyGroupInviteState;
+(function (EStudyGroupInviteState) {
+    EStudyGroupInviteState["OPEN"] = "OPEN";
+    EStudyGroupInviteState["FULL"] = "FULL";
+    EStudyGroupInviteState["CLOSED"] = "CLOSED";
+})(EStudyGroupInviteState = exports.EStudyGroupInviteState || (exports.EStudyGroupInviteState = {}));
+var EStudyGroupViewerState;
+(function (EStudyGroupViewerState) {
+    EStudyGroupViewerState["ANONYMOUS"] = "ANONYMOUS";
+    EStudyGroupViewerState["ELIGIBLE"] = "ELIGIBLE";
+    EStudyGroupViewerState["HAS_PRODUCT"] = "HAS_PRODUCT";
+    EStudyGroupViewerState["ALREADY_MEMBER"] = "ALREADY_MEMBER";
+    EStudyGroupViewerState["IN_OTHER_GROUP"] = "IN_OTHER_GROUP";
+})(EStudyGroupViewerState = exports.EStudyGroupViewerState || (exports.EStudyGroupViewerState = {}));
+var EStudyGroupStartBlocker;
+(function (EStudyGroupStartBlocker) {
+    EStudyGroupStartBlocker["NOT_ENABLED"] = "NOT_ENABLED";
+    EStudyGroupStartBlocker["NO_ACTIVE_SUBSCRIPTION"] = "NO_ACTIVE_SUBSCRIPTION";
+    EStudyGroupStartBlocker["APP_STORE_SUBSCRIPTION"] = "APP_STORE_SUBSCRIPTION";
+    EStudyGroupStartBlocker["UNREFUNDABLE_SUBSCRIPTION"] = "UNREFUNDABLE_SUBSCRIPTION";
+    EStudyGroupStartBlocker["ALREADY_IN_GROUP"] = "ALREADY_IN_GROUP";
+})(EStudyGroupStartBlocker = exports.EStudyGroupStartBlocker || (exports.EStudyGroupStartBlocker = {}));
+var EStudyGroupRefundStatus;
+(function (EStudyGroupRefundStatus) {
+    EStudyGroupRefundStatus["NONE"] = "NONE";
+    EStudyGroupRefundStatus["PENDING"] = "PENDING";
+    EStudyGroupRefundStatus["SUCCEEDED"] = "SUCCEEDED";
+    EStudyGroupRefundStatus["FAILED"] = "FAILED";
+    EStudyGroupRefundStatus["MANUAL"] = "MANUAL";
+})(EStudyGroupRefundStatus = exports.EStudyGroupRefundStatus || (exports.EStudyGroupRefundStatus = {}));
+var EStudyGroupRefundType;
+(function (EStudyGroupRefundType) {
+    EStudyGroupRefundType["REFUND"] = "REFUND";
+    // reserved for app-store subscribers; not issued yet
+    EStudyGroupRefundType["CREDIT"] = "CREDIT";
+})(EStudyGroupRefundType = exports.EStudyGroupRefundType || (exports.EStudyGroupRefundType = {}));
+var EStudyGroupMemberRole;
+(function (EStudyGroupMemberRole) {
+    EStudyGroupMemberRole["ORGANISER"] = "ORGANISER";
+    EStudyGroupMemberRole["MEMBER"] = "MEMBER";
+})(EStudyGroupMemberRole = exports.EStudyGroupMemberRole || (exports.EStudyGroupMemberRole = {}));

package/dist/cjs/models/index.d.ts

@@ -31,6 +31,7 @@ export * from './Question';
 export * from './SampleQuizReport';
 export * from './Referrals';
 export * from './Subscription';
+export * from './StudyGroup';
 export * from './Todo';
 export * from './Token';
 export * from './Topic';

package/dist/cjs/models/index.js

@@ -47,6 +47,7 @@ __exportStar(require("./Question"), exports);
 __exportStar(require("./SampleQuizReport"), exports);
 __exportStar(require("./Referrals"), exports);
 __exportStar(require("./Subscription"), exports);
+__exportStar(require("./StudyGroup"), exports);
 __exportStar(require("./Todo"), exports);
 __exportStar(require("./Token"), exports);
 __exportStar(require("./Topic"), exports);

package/dist/cjs/resolvers/fragments/index.d.ts

@@ -8,6 +8,7 @@ export * from './mockTest';
 export * from './osce';
 export * from './picture';
 export * from './question';
+export * from './studyGroup';
 export * from './topic';
 export * from './tutor';
 export * from './user';

package/dist/cjs/resolvers/fragments/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./mockTest"), exports);
 __exportStar(require("./osce"), exports);
 __exportStar(require("./picture"), exports);
 __exportStar(require("./question"), exports);
+__exportStar(require("./studyGroup"), exports);
 __exportStar(require("./topic"), exports);
 __exportStar(require("./tutor"), exports);
 __exportStar(require("./user"), exports);

package/dist/cjs/resolvers/fragments/studyGroup.d.ts

@@ -0,0 +1,3 @@
+export declare const STUDY_GROUP_PRODUCT_FIELDS: import("@apollo/client").DocumentNode;
+export declare const GROUP_DISCOUNT_OFFER_FIELDS: import("@apollo/client").DocumentNode;
+export declare const STUDY_GROUP_FIELDS: import("@apollo/client").DocumentNode;

package/dist/cjs/resolvers/fragments/studyGroup.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STUDY_GROUP_FIELDS = exports.GROUP_DISCOUNT_OFFER_FIELDS = exports.STUDY_GROUP_PRODUCT_FIELDS = void 0;
+const client_1 = require("@apollo/client");
+exports.STUDY_GROUP_PRODUCT_FIELDS = (0, client_1.gql) `
+  fragment StudyGroupProductFields on StudyGroupProduct {
+    id
+    typeId
+    name
+    duration
+    interval
+    price
+    stripePriceId
+  }
+`;
+exports.GROUP_DISCOUNT_OFFER_FIELDS = (0, client_1.gql) `
+  ${exports.STUDY_GROUP_PRODUCT_FIELDS}
+  fragment GroupDiscountOfferFields on GroupDiscountOffer {
+    productTypeId
+    productName
+    plans {
+      ...StudyGroupProductFields
+    }
+    tiers {
+      minMembers
+      percent
+    }
+    maxMembers
+    windowDays
+    maxPercent
+  }
+`;
+exports.STUDY_GROUP_FIELDS = (0, client_1.gql) `
+  ${exports.STUDY_GROUP_PRODUCT_FIELDS}
+  fragment StudyGroupFields on StudyGroup {
+    id
+    code
+    status
+    isFinalised
+    opensAt
+    closesAt
+    closedAt
+    productTypeId
+    productName
+    plans {
+      ...StudyGroupProductFields
+    }
+    tiers {
+      minMembers
+      percent
+    }
+    maxMembers
+    memberCount
+    currentPercent
+    finalPercent
+    isOrganiser
+    members {
+      id
+      firstName
+      initials
+      role
+      isMe
+      joinedAt
+      amountPaid
+      refundEstimate
+    }
+    me {
+      role
+      amountPaid
+      currency
+      paidAt
+      refundType
+      refundEstimate
+      refundStatus
+      refundAmount
+      refundedAt
+      receiptUrl
+    }
+  }
+`;

package/dist/cjs/resolvers/mutation/restricted/index.d.ts

@@ -12,6 +12,7 @@ export * from './preset';
 export * from './questionDiscussion';
 export * from './station';
 export * from './stripe';
+export * from './studyGroup';
 export * from './todo';
 export * from './token';
 export * from './tutor';

package/dist/cjs/resolvers/mutation/restricted/index.js

@@ -28,6 +28,7 @@ __exportStar(require("./preset"), exports);
 __exportStar(require("./questionDiscussion"), exports);
 __exportStar(require("./station"), exports);
 __exportStar(require("./stripe"), exports);
+__exportStar(require("./studyGroup"), exports);
 __exportStar(require("./todo"), exports);
 __exportStar(require("./token"), exports);
 __exportStar(require("./tutor"), exports);

package/dist/cjs/resolvers/mutation/restricted/studyGroup.d.ts

@@ -0,0 +1,7 @@
+import { EProductType, IStudyGroup } from '../../../models';
+import { RestrictedData, graphqlNormalize } from '../../types';
+export type IStartStudyGroupData = RestrictedData<graphqlNormalize & IStudyGroup, 'startStudyGroup'>;
+export interface IStartStudyGroupVar {
+    productTypeId: EProductType;
+}
+export declare const START_STUDY_GROUP: import("@apollo/client").DocumentNode;

package/dist/cjs/resolvers/mutation/restricted/studyGroup.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.START_STUDY_GROUP = void 0;
+const client_1 = require("@apollo/client");
+const fragments_1 = require("../../fragments");
+exports.START_STUDY_GROUP = (0, client_1.gql) `
+  ${fragments_1.STUDY_GROUP_FIELDS}
+  mutation StartStudyGroup($productTypeId: Int!) {
+    restricted {
+      startStudyGroup(productTypeId: $productTypeId) {
+        ...StudyGroupFields
+      }
+    }
+  }
+`;

package/dist/cjs/resolvers/mutation/validUserToken/index.d.ts

@@ -1 +1,2 @@
 export * from './user';
+export * from './studyGroup';

package/dist/cjs/resolvers/mutation/validUserToken/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./user"), exports);
+__exportStar(require("./studyGroup"), exports);

package/dist/cjs/resolvers/mutation/validUserToken/studyGroup.d.ts

@@ -0,0 +1,12 @@
+export declare const CREATE_STUDY_GROUP_CHECKOUT_SESSION: import("@apollo/client").DocumentNode;
+export interface ICreateStudyGroupCheckoutSessionVar {
+    code: string;
+    productId: number;
+    successUrl?: string;
+    cancelUrl?: string;
+}
+export type ICreateStudyGroupCheckoutSessionData = {
+    validUserToken: {
+        createStudyGroupCheckoutSession: string | null;
+    };
+};

package/dist/cjs/resolvers/mutation/validUserToken/studyGroup.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CREATE_STUDY_GROUP_CHECKOUT_SESSION = void 0;
+const client_1 = require("@apollo/client");
+// Returns the Stripe Checkout session id (same as CREATE_NEW_SUBSCRIPTION_CHECKOUT_SESSION).
+// productId is any plan from the group's `plans`. Promo codes are disabled on this session.
+exports.CREATE_STUDY_GROUP_CHECKOUT_SESSION = (0, client_1.gql) `
+  mutation CreateStudyGroupCheckoutSession(
+    $code: String!
+    $productId: Int!
+    $successUrl: String
+    $cancelUrl: String
+  ) {
+    validUserToken {
+      createStudyGroupCheckoutSession(
+        code: $code
+        productId: $productId
+        successUrl: $successUrl
+        cancelUrl: $cancelUrl
+      )
+    }
+  }
+`;

package/dist/cjs/resolvers/query/index.d.ts

@@ -6,6 +6,7 @@ export * from './feedback';
 export * from './product';
 export * as restricted from './restricted';
 export * from './sample';
+export * from './studyGroup';
 export * from './university';
 export * from './user';
 export * from './video';

package/dist/cjs/resolvers/query/index.js

@@ -35,6 +35,7 @@ __exportStar(require("./feedback"), exports);
 __exportStar(require("./product"), exports);
 exports.restricted = __importStar(require("./restricted"));
 __exportStar(require("./sample"), exports);
+__exportStar(require("./studyGroup"), exports);
 __exportStar(require("./university"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./video"), exports);

package/dist/cjs/resolvers/query/restricted/index.d.ts

@@ -16,6 +16,7 @@ export * from './quesBook';
 export * from './question';
 export * from './replication';
 export * from './station';
+export * from './studyGroup';
 export * from './todos';
 export * from './topics';
 export * from './tutor';

package/dist/cjs/resolvers/query/restricted/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./quesBook"), exports);
 __exportStar(require("./question"), exports);
 __exportStar(require("./replication"), exports);
 __exportStar(require("./station"), exports);
+__exportStar(require("./studyGroup"), exports);
 __exportStar(require("./todos"), exports);
 __exportStar(require("./topics"), exports);
 __exportStar(require("./tutor"), exports);

package/dist/cjs/resolvers/query/restricted/studyGroup.d.ts

@@ -0,0 +1,12 @@
+import { EProductType, IStudyGroup, IStudyGroupStartEligibility } from '../../../models';
+import { RestrictedData, graphqlNormalize } from '../../types';
+export type IMyStudyGroupData = RestrictedData<(graphqlNormalize & IStudyGroup) | null, 'myStudyGroup'>;
+export interface IMyStudyGroupVar {
+    productTypeId: EProductType;
+}
+export declare const MY_STUDY_GROUP: import("@apollo/client").DocumentNode;
+export type IStudyGroupStartEligibilityData = RestrictedData<graphqlNormalize & IStudyGroupStartEligibility, 'studyGroupStartEligibility'>;
+export interface IStudyGroupStartEligibilityVar {
+    productTypeId: EProductType;
+}
+export declare const STUDY_GROUP_START_ELIGIBILITY: import("@apollo/client").DocumentNode;

package/dist/cjs/resolvers/query/restricted/studyGroup.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STUDY_GROUP_START_ELIGIBILITY = exports.MY_STUDY_GROUP = void 0;
+const client_1 = require("@apollo/client");
+const fragments_1 = require("../../fragments");
+exports.MY_STUDY_GROUP = (0, client_1.gql) `
+  ${fragments_1.STUDY_GROUP_FIELDS}
+  query MyStudyGroup($productTypeId: Int!) {
+    restricted {
+      myStudyGroup(productTypeId: $productTypeId) {
+        ...StudyGroupFields
+      }
+    }
+  }
+`;
+exports.STUDY_GROUP_START_ELIGIBILITY = (0, client_1.gql) `
+  ${fragments_1.GROUP_DISCOUNT_OFFER_FIELDS}
+  query StudyGroupStartEligibility($productTypeId: Int!) {
+    restricted {
+      studyGroupStartEligibility(productTypeId: $productTypeId) {
+        canStart
+        blocker
+        offer {
+          ...GroupDiscountOfferFields
+        }
+      }
+    }
+  }
+`;

package/dist/cjs/resolvers/query/studyGroup.d.ts

@@ -0,0 +1,12 @@
+import { EProductType, IGroupDiscountOffer, IStudyGroupInvite } from '../../models';
+import { RootData, graphqlNormalize } from '../types';
+export type IGroupDiscountOfferData = RootData<(graphqlNormalize & IGroupDiscountOffer) | null, 'groupDiscountOffer'>;
+export interface IGroupDiscountOfferVar {
+    productTypeId: EProductType;
+}
+export declare const GROUP_DISCOUNT_OFFER: import("@apollo/client").DocumentNode;
+export type IStudyGroupInviteData = RootData<(graphqlNormalize & IStudyGroupInvite) | null, 'studyGroupInvite'>;
+export interface IStudyGroupInviteVar {
+    code: string;
+}
+export declare const STUDY_GROUP_INVITE: import("@apollo/client").DocumentNode;

package/dist/cjs/resolvers/query/studyGroup.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.STUDY_GROUP_INVITE = exports.GROUP_DISCOUNT_OFFER = void 0;
+const client_1 = require("@apollo/client");
+const fragments_1 = require("../fragments");
+exports.GROUP_DISCOUNT_OFFER = (0, client_1.gql) `
+  ${fragments_1.GROUP_DISCOUNT_OFFER_FIELDS}
+  query GroupDiscountOffer($productTypeId: Int!) {
+    groupDiscountOffer(productTypeId: $productTypeId) {
+      ...GroupDiscountOfferFields
+    }
+  }
+`;
+exports.STUDY_GROUP_INVITE = (0, client_1.gql) `
+  ${fragments_1.STUDY_GROUP_PRODUCT_FIELDS}
+  query StudyGroupInvite($code: String!) {
+    studyGroupInvite(code: $code) {
+      code
+      organiserFirstName
+      members {
+        firstName
+        initials
+        isOrganiser
+      }
+      memberCount
+      maxMembers
+      tiers {
+        minMembers
+        percent
+      }
+      currentPercent
+      percentIfJoin
+      refundIfJoin
+      opensAt
+      closesAt
+      state
+      viewerState
+      productTypeId
+      productName
+      plans {
+        ...StudyGroupProductFields
+      }
+    }
+  }
+`;

package/dist/mjs/models/StudyGroup.d.ts

@@ -0,0 +1,138 @@
+import { EProductType } from './Product';
+export declare enum EStudyGroupStatus {
+    OPEN = "OPEN",
+    CLOSED = "CLOSED"
+}
+export declare enum EStudyGroupInviteState {
+    OPEN = "OPEN",
+    FULL = "FULL",
+    CLOSED = "CLOSED"
+}
+export declare enum EStudyGroupViewerState {
+    ANONYMOUS = "ANONYMOUS",
+    ELIGIBLE = "ELIGIBLE",
+    HAS_PRODUCT = "HAS_PRODUCT",
+    ALREADY_MEMBER = "ALREADY_MEMBER",
+    IN_OTHER_GROUP = "IN_OTHER_GROUP"
+}
+export declare enum EStudyGroupStartBlocker {
+    NOT_ENABLED = "NOT_ENABLED",
+    NO_ACTIVE_SUBSCRIPTION = "NO_ACTIVE_SUBSCRIPTION",
+    APP_STORE_SUBSCRIPTION = "APP_STORE_SUBSCRIPTION",
+    UNREFUNDABLE_SUBSCRIPTION = "UNREFUNDABLE_SUBSCRIPTION",
+    ALREADY_IN_GROUP = "ALREADY_IN_GROUP"
+}
+export declare enum EStudyGroupRefundStatus {
+    NONE = "NONE",
+    PENDING = "PENDING",
+    SUCCEEDED = "SUCCEEDED",
+    FAILED = "FAILED",
+    MANUAL = "MANUAL"
+}
+export declare enum EStudyGroupRefundType {
+    REFUND = "REFUND",
+    CREDIT = "CREDIT"
+}
+export declare enum EStudyGroupMemberRole {
+    ORGANISER = "ORGANISER",
+    MEMBER = "MEMBER"
+}
+export interface IGroupDiscountTier {
+    minMembers: number;
+    percent: number;
+}
+export interface IStudyGroupProduct {
+    id: number;
+    typeId: EProductType;
+    name: string;
+    duration: number;
+    interval: string;
+    price: number;
+    stripePriceId: string;
+}
+export interface IGroupDiscountOffer {
+    productTypeId: EProductType;
+    /** Product type name, e.g. "MRCP PACES Video Course" */
+    productName: string;
+    /** Every public plan of the product, cheapest first; joiners can buy any of them */
+    plans: IStudyGroupProduct[];
+    tiers: IGroupDiscountTier[];
+    maxMembers: number;
+    windowDays: number;
+    maxPercent: number;
+}
+export interface IStudyGroupInviteMember {
+    firstName: string;
+    initials: string;
+    isOrganiser: boolean;
+}
+export interface IStudyGroupInvite {
+    code: string;
+    organiserFirstName: string;
+    members: IStudyGroupInviteMember[];
+    memberCount: number;
+    maxMembers: number;
+    tiers: IGroupDiscountTier[];
+    currentPercent: number;
+    percentIfJoin: number;
+    refundIfJoin: number;
+    opensAt: number | Date;
+    closesAt: number | Date;
+    state: EStudyGroupInviteState;
+    viewerState: EStudyGroupViewerState;
+    productTypeId: EProductType;
+    /** Product type name, e.g. "MRCP PACES Video Course" */
+    productName: string;
+    /** Every public plan of the product, cheapest first; joiners can buy any of them */
+    plans: IStudyGroupProduct[];
+}
+export interface IStudyGroupMember {
+    id: number;
+    firstName: string;
+    initials: string;
+    role: EStudyGroupMemberRole;
+    isMe: boolean;
+    joinedAt: number | Date;
+    amountPaid: number;
+    refundEstimate: number;
+}
+export interface IStudyGroupMyMembership {
+    role: EStudyGroupMemberRole;
+    amountPaid: number;
+    currency: string;
+    paidAt: number | Date | null;
+    refundType: EStudyGroupRefundType;
+    refundEstimate: number;
+    refundStatus: EStudyGroupRefundStatus;
+    refundAmount: number | null;
+    refundedAt: number | Date | null;
+    /** Stripe-hosted receipt (payment + refund, with PDF download); set once the refund succeeds */
+    receiptUrl: string | null;
+}
+export interface IStudyGroup {
+    id: number;
+    code: string;
+    status: EStudyGroupStatus;
+    isFinalised: boolean;
+    opensAt: number | Date;
+    closesAt: number | Date;
+    closedAt: number | Date | null;
+    productTypeId: EProductType;
+    /** Product type name, e.g. "MRCP PACES Video Course" */
+    productName: string;
+    /** Every public plan of the product, cheapest first; joiners can buy any of them */
+    plans: IStudyGroupProduct[];
+    tiers: IGroupDiscountTier[];
+    maxMembers: number;
+    memberCount: number;
+    currentPercent: number;
+    finalPercent: number | null;
+    isOrganiser: boolean;
+    members: IStudyGroupMember[];
+    me: IStudyGroupMyMembership;
+}
+export interface IStudyGroupStartEligibility {
+    canStart: boolean;
+    blocker: EStudyGroupStartBlocker | null;
+    offer: IGroupDiscountOffer | null;
+}

package/dist/mjs/models/StudyGroup.js

@@ -0,0 +1,47 @@
+// Group discount ("study groups"). All money fields are in pence.
+export var EStudyGroupStatus;
+(function (EStudyGroupStatus) {
+    EStudyGroupStatus["OPEN"] = "OPEN";
+    EStudyGroupStatus["CLOSED"] = "CLOSED";
+})(EStudyGroupStatus || (EStudyGroupStatus = {}));
+export var EStudyGroupInviteState;
+(function (EStudyGroupInviteState) {
+    EStudyGroupInviteState["OPEN"] = "OPEN";
+    EStudyGroupInviteState["FULL"] = "FULL";
+    EStudyGroupInviteState["CLOSED"] = "CLOSED";
+})(EStudyGroupInviteState || (EStudyGroupInviteState = {}));
+export var EStudyGroupViewerState;
+(function (EStudyGroupViewerState) {
+    EStudyGroupViewerState["ANONYMOUS"] = "ANONYMOUS";
+    EStudyGroupViewerState["ELIGIBLE"] = "ELIGIBLE";
+    EStudyGroupViewerState["HAS_PRODUCT"] = "HAS_PRODUCT";
+    EStudyGroupViewerState["ALREADY_MEMBER"] = "ALREADY_MEMBER";
+    EStudyGroupViewerState["IN_OTHER_GROUP"] = "IN_OTHER_GROUP";
+})(EStudyGroupViewerState || (EStudyGroupViewerState = {}));
+export var EStudyGroupStartBlocker;
+(function (EStudyGroupStartBlocker) {
+    EStudyGroupStartBlocker["NOT_ENABLED"] = "NOT_ENABLED";
+    EStudyGroupStartBlocker["NO_ACTIVE_SUBSCRIPTION"] = "NO_ACTIVE_SUBSCRIPTION";
+    EStudyGroupStartBlocker["APP_STORE_SUBSCRIPTION"] = "APP_STORE_SUBSCRIPTION";
+    EStudyGroupStartBlocker["UNREFUNDABLE_SUBSCRIPTION"] = "UNREFUNDABLE_SUBSCRIPTION";
+    EStudyGroupStartBlocker["ALREADY_IN_GROUP"] = "ALREADY_IN_GROUP";
+})(EStudyGroupStartBlocker || (EStudyGroupStartBlocker = {}));
+export var EStudyGroupRefundStatus;
+(function (EStudyGroupRefundStatus) {
+    EStudyGroupRefundStatus["NONE"] = "NONE";
+    EStudyGroupRefundStatus["PENDING"] = "PENDING";
+    EStudyGroupRefundStatus["SUCCEEDED"] = "SUCCEEDED";
+    EStudyGroupRefundStatus["FAILED"] = "FAILED";
+    EStudyGroupRefundStatus["MANUAL"] = "MANUAL";
+})(EStudyGroupRefundStatus || (EStudyGroupRefundStatus = {}));
+export var EStudyGroupRefundType;
+(function (EStudyGroupRefundType) {
+    EStudyGroupRefundType["REFUND"] = "REFUND";
+    // reserved for app-store subscribers; not issued yet
+    EStudyGroupRefundType["CREDIT"] = "CREDIT";
+})(EStudyGroupRefundType || (EStudyGroupRefundType = {}));
+export var EStudyGroupMemberRole;
+(function (EStudyGroupMemberRole) {
+    EStudyGroupMemberRole["ORGANISER"] = "ORGANISER";
+    EStudyGroupMemberRole["MEMBER"] = "MEMBER";
+})(EStudyGroupMemberRole || (EStudyGroupMemberRole = {}));

package/dist/mjs/models/index.d.ts

@@ -31,6 +31,7 @@ export * from './Question';
 export * from './SampleQuizReport';
 export * from './Referrals';
 export * from './Subscription';
+export * from './StudyGroup';
 export * from './Todo';
 export * from './Token';
 export * from './Topic';

package/dist/mjs/models/index.js

@@ -31,6 +31,7 @@ export * from './Question';
 export * from './SampleQuizReport';
 export * from './Referrals';
 export * from './Subscription';
+export * from './StudyGroup';
 export * from './Todo';
 export * from './Token';
 export * from './Topic';

package/dist/mjs/resolvers/fragments/index.d.ts

@@ -8,6 +8,7 @@ export * from './mockTest';
 export * from './osce';
 export * from './picture';
 export * from './question';
+export * from './studyGroup';
 export * from './topic';
 export * from './tutor';
 export * from './user';

package/dist/mjs/resolvers/fragments/index.js

@@ -8,6 +8,7 @@ export * from './mockTest';
 export * from './osce';
 export * from './picture';
 export * from './question';
+export * from './studyGroup';
 export * from './topic';
 export * from './tutor';
 export * from './user';

package/dist/mjs/resolvers/fragments/studyGroup.d.ts

@@ -0,0 +1,3 @@
+export declare const STUDY_GROUP_PRODUCT_FIELDS: import("@apollo/client").DocumentNode;
+export declare const GROUP_DISCOUNT_OFFER_FIELDS: import("@apollo/client").DocumentNode;
+export declare const STUDY_GROUP_FIELDS: import("@apollo/client").DocumentNode;

package/dist/mjs/resolvers/fragments/studyGroup.js

@@ -0,0 +1,77 @@
+import { gql } from '@apollo/client';
+export const STUDY_GROUP_PRODUCT_FIELDS = gql `
+  fragment StudyGroupProductFields on StudyGroupProduct {
+    id
+    typeId
+    name
+    duration
+    interval
+    price
+    stripePriceId
+  }
+`;
+export const GROUP_DISCOUNT_OFFER_FIELDS = gql `
+  ${STUDY_GROUP_PRODUCT_FIELDS}
+  fragment GroupDiscountOfferFields on GroupDiscountOffer {
+    productTypeId
+    productName
+    plans {
+      ...StudyGroupProductFields
+    }
+    tiers {
+      minMembers
+      percent
+    }
+    maxMembers
+    windowDays
+    maxPercent
+  }
+`;
+export const STUDY_GROUP_FIELDS = gql `
+  ${STUDY_GROUP_PRODUCT_FIELDS}
+  fragment StudyGroupFields on StudyGroup {
+    id
+    code
+    status
+    isFinalised
+    opensAt
+    closesAt
+    closedAt
+    productTypeId
+    productName
+    plans {
+      ...StudyGroupProductFields
+    }
+    tiers {
+      minMembers
+      percent
+    }
+    maxMembers
+    memberCount
+    currentPercent
+    finalPercent
+    isOrganiser
+    members {
+      id
+      firstName
+      initials
+      role
+      isMe
+      joinedAt
+      amountPaid
+      refundEstimate
+    }
+    me {
+      role
+      amountPaid
+      currency
+      paidAt
+      refundType
+      refundEstimate
+      refundStatus
+      refundAmount
+      refundedAt
+      receiptUrl
+    }
+  }
+`;

package/dist/mjs/resolvers/mutation/restricted/index.d.ts

@@ -12,6 +12,7 @@ export * from './preset';
 export * from './questionDiscussion';
 export * from './station';
 export * from './stripe';
+export * from './studyGroup';
 export * from './todo';
 export * from './token';
 export * from './tutor';

package/dist/mjs/resolvers/mutation/restricted/index.js

@@ -12,6 +12,7 @@ export * from './preset';
 export * from './questionDiscussion';
 export * from './station';
 export * from './stripe';
+export * from './studyGroup';
 export * from './todo';
 export * from './token';
 export * from './tutor';

package/dist/mjs/resolvers/mutation/restricted/studyGroup.d.ts

@@ -0,0 +1,7 @@
+import { EProductType, IStudyGroup } from '../../../models';
+import { RestrictedData, graphqlNormalize } from '../../types';
+export type IStartStudyGroupData = RestrictedData<graphqlNormalize & IStudyGroup, 'startStudyGroup'>;
+export interface IStartStudyGroupVar {
+    productTypeId: EProductType;
+}
+export declare const START_STUDY_GROUP: import("@apollo/client").DocumentNode;

package/dist/mjs/resolvers/mutation/restricted/studyGroup.js

@@ -0,0 +1,12 @@
+import { gql } from '@apollo/client';
+import { STUDY_GROUP_FIELDS } from '../../fragments';
+export const START_STUDY_GROUP = gql `
+  ${STUDY_GROUP_FIELDS}
+  mutation StartStudyGroup($productTypeId: Int!) {
+    restricted {
+      startStudyGroup(productTypeId: $productTypeId) {
+        ...StudyGroupFields
+      }
+    }
+  }
+`;

package/dist/mjs/resolvers/mutation/validUserToken/index.d.ts

@@ -1 +1,2 @@
 export * from './user';
+export * from './studyGroup';

package/dist/mjs/resolvers/mutation/validUserToken/index.js

@@ -1 +1,2 @@
 export * from './user';
+export * from './studyGroup';

package/dist/mjs/resolvers/mutation/validUserToken/studyGroup.d.ts

@@ -0,0 +1,12 @@
+export declare const CREATE_STUDY_GROUP_CHECKOUT_SESSION: import("@apollo/client").DocumentNode;
+export interface ICreateStudyGroupCheckoutSessionVar {
+    code: string;
+    productId: number;
+    successUrl?: string;
+    cancelUrl?: string;
+}
+export type ICreateStudyGroupCheckoutSessionData = {
+    validUserToken: {
+        createStudyGroupCheckoutSession: string | null;
+    };
+};

package/dist/mjs/resolvers/mutation/validUserToken/studyGroup.js

@@ -0,0 +1,20 @@
+import { gql } from '@apollo/client';
+// Returns the Stripe Checkout session id (same as CREATE_NEW_SUBSCRIPTION_CHECKOUT_SESSION).
+// productId is any plan from the group's `plans`. Promo codes are disabled on this session.
+export const CREATE_STUDY_GROUP_CHECKOUT_SESSION = gql `
+  mutation CreateStudyGroupCheckoutSession(
+    $code: String!
+    $productId: Int!
+    $successUrl: String
+    $cancelUrl: String
+  ) {
+    validUserToken {
+      createStudyGroupCheckoutSession(
+        code: $code
+        productId: $productId
+        successUrl: $successUrl
+        cancelUrl: $cancelUrl
+      )
+    }
+  }
+`;

package/dist/mjs/resolvers/query/index.d.ts

@@ -6,6 +6,7 @@ export * from './feedback';
 export * from './product';
 export * as restricted from './restricted';
 export * from './sample';
+export * from './studyGroup';
 export * from './university';
 export * from './user';
 export * from './video';

package/dist/mjs/resolvers/query/index.js

@@ -6,6 +6,7 @@ export * from './feedback';
 export * from './product';
 export * as restricted from './restricted';
 export * from './sample';
+export * from './studyGroup';
 export * from './university';
 export * from './user';
 export * from './video';

package/dist/mjs/resolvers/query/restricted/index.d.ts

@@ -16,6 +16,7 @@ export * from './quesBook';
 export * from './question';
 export * from './replication';
 export * from './station';
+export * from './studyGroup';
 export * from './todos';
 export * from './topics';
 export * from './tutor';

package/dist/mjs/resolvers/query/restricted/index.js

@@ -16,6 +16,7 @@ export * from './quesBook';
 export * from './question';
 export * from './replication';
 export * from './station';
+export * from './studyGroup';
 export * from './todos';
 export * from './topics';
 export * from './tutor';

package/dist/mjs/resolvers/query/restricted/studyGroup.d.ts

@@ -0,0 +1,12 @@
+import { EProductType, IStudyGroup, IStudyGroupStartEligibility } from '../../../models';
+import { RestrictedData, graphqlNormalize } from '../../types';
+export type IMyStudyGroupData = RestrictedData<(graphqlNormalize & IStudyGroup) | null, 'myStudyGroup'>;
+export interface IMyStudyGroupVar {
+    productTypeId: EProductType;
+}
+export declare const MY_STUDY_GROUP: import("@apollo/client").DocumentNode;
+export type IStudyGroupStartEligibilityData = RestrictedData<graphqlNormalize & IStudyGroupStartEligibility, 'studyGroupStartEligibility'>;
+export interface IStudyGroupStartEligibilityVar {
+    productTypeId: EProductType;
+}
+export declare const STUDY_GROUP_START_ELIGIBILITY: import("@apollo/client").DocumentNode;

package/dist/mjs/resolvers/query/restricted/studyGroup.js

@@ -0,0 +1,26 @@
+import { gql } from '@apollo/client';
+import { GROUP_DISCOUNT_OFFER_FIELDS, STUDY_GROUP_FIELDS, } from '../../fragments';
+export const MY_STUDY_GROUP = gql `
+  ${STUDY_GROUP_FIELDS}
+  query MyStudyGroup($productTypeId: Int!) {
+    restricted {
+      myStudyGroup(productTypeId: $productTypeId) {
+        ...StudyGroupFields
+      }
+    }
+  }
+`;
+export const STUDY_GROUP_START_ELIGIBILITY = gql `
+  ${GROUP_DISCOUNT_OFFER_FIELDS}
+  query StudyGroupStartEligibility($productTypeId: Int!) {
+    restricted {
+      studyGroupStartEligibility(productTypeId: $productTypeId) {
+        canStart
+        blocker
+        offer {
+          ...GroupDiscountOfferFields
+        }
+      }
+    }
+  }
+`;

package/dist/mjs/resolvers/query/studyGroup.d.ts

@@ -0,0 +1,12 @@
+import { EProductType, IGroupDiscountOffer, IStudyGroupInvite } from '../../models';
+import { RootData, graphqlNormalize } from '../types';
+export type IGroupDiscountOfferData = RootData<(graphqlNormalize & IGroupDiscountOffer) | null, 'groupDiscountOffer'>;
+export interface IGroupDiscountOfferVar {
+    productTypeId: EProductType;
+}
+export declare const GROUP_DISCOUNT_OFFER: import("@apollo/client").DocumentNode;
+export type IStudyGroupInviteData = RootData<(graphqlNormalize & IStudyGroupInvite) | null, 'studyGroupInvite'>;
+export interface IStudyGroupInviteVar {
+    code: string;
+}
+export declare const STUDY_GROUP_INVITE: import("@apollo/client").DocumentNode;

package/dist/mjs/resolvers/query/studyGroup.js

@@ -0,0 +1,42 @@
+import { gql } from '@apollo/client';
+import { GROUP_DISCOUNT_OFFER_FIELDS, STUDY_GROUP_PRODUCT_FIELDS, } from '../fragments';
+export const GROUP_DISCOUNT_OFFER = gql `
+  ${GROUP_DISCOUNT_OFFER_FIELDS}
+  query GroupDiscountOffer($productTypeId: Int!) {
+    groupDiscountOffer(productTypeId: $productTypeId) {
+      ...GroupDiscountOfferFields
+    }
+  }
+`;
+export const STUDY_GROUP_INVITE = gql `
+  ${STUDY_GROUP_PRODUCT_FIELDS}
+  query StudyGroupInvite($code: String!) {
+    studyGroupInvite(code: $code) {
+      code
+      organiserFirstName
+      members {
+        firstName
+        initials
+        isOrganiser
+      }
+      memberCount
+      maxMembers
+      tiers {
+        minMembers
+        percent
+      }
+      currentPercent
+      percentIfJoin
+      refundIfJoin
+      opensAt
+      closesAt
+      state
+      viewerState
+      productTypeId
+      productName
+      plans {
+        ...StudyGroupProductFields
+      }
+    }
+  }
+`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quesmed/types",
-  "version": "2.6.302",
+  "version": "2.6.305",
   "description": "Typescript types for Quesmed",
   "keywords": [
     "quesmed",