bantr-api-client 1.6.0 → 11.0.2

package/api-type/src/models/organizer.d.ts

@@ -0,0 +1,70 @@
+import { AnyQueryBuilder, Model, RelationMappings } from 'objection';
+import { TPublicInfo } from '../types/organizer';
+import { BantrUserRole, Role } from './role';
+declare const Organizer_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class Organizer extends Organizer_base {
+    id: number;
+    firstName: string;
+    lastName: string;
+    email: string;
+    password: string;
+    avatar?: string;
+    phone?: string;
+    approved: boolean;
+    organizationId: number;
+    roles?: BantrUserRole[];
+    rolesObjection?: Role[];
+    deletedAt: Date | null;
+    static tableName: string;
+    static get idColumn(): string;
+    static get modifiers(): Record<string, (builder: AnyQueryBuilder) => void>;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            firstName: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            lastName: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            email: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            password: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            phone: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            avatar: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            organizationId: {
+                type: string;
+            };
+            approved: {
+                type: string;
+            };
+        };
+    };
+    static isEmailTaken(email: string): Promise<boolean>;
+    getPublicInfo(): TPublicInfo;
+}
+export {};

package/api-type/src/models/organizer_roles.d.ts

@@ -0,0 +1,26 @@
+import { Model, RelationMappings } from 'objection';
+import { BantrUserRole } from './role';
+declare const OrganizerRoles_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class OrganizerRoles extends OrganizerRoles_base {
+    id: number;
+    organizerId: number;
+    roleId: number;
+    deletedAt: Date | null;
+    role?: BantrUserRole;
+    static tableName: string;
+    static get idColumn(): string;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            organizerId: {
+                type: string;
+            };
+            roleId: {
+                type: string;
+            };
+        };
+    };
+}
+export {};

package/api-type/src/models/pickup.d.ts

@@ -0,0 +1,163 @@
+import { Model, RelationMappings } from 'objection';
+import { Gender } from '../types/league';
+import { PickupGroup } from './pickup_group';
+import { PickupRoster } from './pickup_roster';
+import { Organizer } from './organizer';
+import { Member } from './member';
+import { Organization } from './organization';
+import { OrgWorkspace } from './organization_workspace';
+import { PickupWaitlist } from './pickup_waitlist';
+import { PickupConfig } from './pickup_config';
+export declare const pickupUpdatePref: {
+    thisEvent: number;
+    thisAndFollowing: number;
+    allEvent: number;
+};
+export declare const pickupDeletePref: {
+    thisEvent: number;
+    thisAndFollowing: number;
+};
+declare const Pickup_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class Pickup extends Pickup_base {
+    id: number;
+    name: string;
+    gender: Gender;
+    playerLimit: number;
+    date: string;
+    startTime: string;
+    dateAndTime: Date | null;
+    location: string;
+    duration: number;
+    price: number;
+    image: string;
+    description: string | null;
+    canceledAt: Date | string;
+    pickupGroupId: number;
+    orgCreatorId: number | null;
+    memberCreatorId: number | null;
+    organizationId: number | null;
+    orgWorkspaceId: number | null;
+    orgCoordinatorId: number | null;
+    memberCoordinatorId: number | null;
+    isRepeated: boolean;
+    pickupConfigId?: number | null;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    pickupGroup?: PickupGroup;
+    organizerCreator?: Organizer;
+    memberCreator?: Member;
+    organization?: Organization;
+    orgWorkspace?: OrgWorkspace;
+    orgCoordinator?: Organizer;
+    memberCoordinator?: Member;
+    waitlistCount?: number;
+    rosterCount?: number;
+    groupFollowerCount?: number;
+    isRegistered?: boolean;
+    count?: number;
+    inWaitlist?: boolean;
+    registeredPlayersCount?: number;
+    registeredPlayers?: PickupRoster[];
+    waitlistPlayers?: PickupWaitlist[];
+    pickupConfig?: PickupConfig;
+    stripeVersion: number;
+    deletedAt: Date | null;
+    static tableName: string;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            pickupGroupId: {
+                type: string;
+            };
+            orgCreatorId: {
+                type: string[];
+                default: null;
+            };
+            memberCreatorId: {
+                type: string[];
+                default: null;
+            };
+            organizationId: {
+                type: string[];
+                default: null;
+            };
+            orgWorkspaceId: {
+                type: string[];
+                default: null;
+            };
+            name: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            gender: {
+                type: string;
+                enum: Gender[];
+                minLength: number;
+                maxLength: number;
+            };
+            playerLimit: {
+                type: string;
+                minimum: number;
+            };
+            dateAndTime: {
+                type: string;
+            };
+            date: {
+                type: string[];
+            };
+            location: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            startTime: {
+                type: string;
+                maxLength: number;
+            };
+            duration: {
+                type: string;
+            };
+            price: {
+                type: string;
+                minimum: number;
+            };
+            image: {
+                type: string[];
+                default: string;
+            };
+            description: {
+                type: string[];
+                minLength: number;
+                maxLength: number;
+            };
+            orgCoordinatorId: {
+                type: string[];
+                default: null;
+            };
+            memberCoordinatorId: {
+                type: string[];
+                default: null;
+            };
+            isRepeated: {
+                type: string[];
+                default: boolean;
+            };
+            pickupConfigId: {
+                type: string[];
+                default: null;
+            };
+            stripeVersion: {
+                type: string;
+                default: number;
+            };
+        };
+    };
+    hasVacancy(): Promise<boolean>;
+}
+export default Pickup;

package/api-type/src/models/pickup_config.d.ts

@@ -0,0 +1,34 @@
+import { Model } from 'objection';
+import { RepeatFrequency } from '../types/pickup';
+export declare class PickupConfig extends Model {
+    id: number;
+    repeatFrequency: RepeatFrequency;
+    repeatOn?: string | null;
+    endsOn?: string | null;
+    endsAfterOccurances?: number | null;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    static tableName: string;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            repeatFrequency: {
+                type: string;
+                enum: RepeatFrequency[];
+            };
+            repeatOn: {
+                type: string[];
+            };
+            endsOn: {
+                type: string[];
+            };
+            endsAfterOccurances: {
+                type: string[];
+            };
+        };
+    };
+}

package/api-type/src/models/pickup_group.d.ts

@@ -0,0 +1,83 @@
+import { Model, RelationMappings } from 'objection';
+import { Member } from './member';
+import { Organizer } from './organizer';
+declare const PickupGroup_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class PickupGroup extends PickupGroup_base {
+    id: number;
+    name: string;
+    acronym: string | null;
+    location: string;
+    established: string | null;
+    banner: string;
+    badge: string;
+    timezone: string;
+    orgCreatorId: number | null;
+    memberCreatorId: number | null;
+    organizationId: number | null;
+    orgWorkspaceId?: number | null;
+    createdAt: Date | string;
+    updatedAt: Date | string;
+    deletedAt: Date | null;
+    memberCount?: number;
+    memberCreator?: Member;
+    organizerCreator?: Organizer;
+    static tableName: string;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            name: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            acronym: {
+                type: string[];
+                minLength: number;
+                maxLength: number;
+                default: null;
+            };
+            location: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            established: {
+                type: string[];
+                minLength: number;
+                maxLength: number;
+                default: null;
+            };
+            banner: {
+                type: string;
+            };
+            badge: {
+                type: string;
+            };
+            timezone: {
+                type: string;
+            };
+            orgCreatorId: {
+                type: string[];
+                default: null;
+            };
+            memberCreatorId: {
+                type: string[];
+                default: null;
+            };
+            organizationId: {
+                type: string[];
+                default: null;
+            };
+            orgWorkspaceId: {
+                type: string[];
+                default: null;
+            };
+        };
+    };
+}
+export default PickupGroup;

package/api-type/src/models/pickup_group_members.d.ts

@@ -0,0 +1,42 @@
+import { Model, RelationMappings } from 'objection';
+import { Member } from './member';
+declare const PickupGrpMember_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class PickupGrpMember extends PickupGrpMember_base {
+    id: number;
+    pickupGroupId: number;
+    memberId: number;
+    isBlocked: boolean;
+    isAdmin: boolean;
+    createdAt: Date | string;
+    updatedAt: Date | string;
+    deletedAt: Date | null;
+    member?: Member;
+    count?: number;
+    static tableName: string;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            pickupGroupId: {
+                type: string;
+            };
+            memberId: {
+                type: string;
+            };
+            isBlocked: {
+                type: string;
+                default: boolean;
+            };
+            isAdmin: {
+                type: string;
+                default: boolean;
+            };
+        };
+    };
+    $afterInsert(): Promise<void>;
+}
+export default PickupGrpMember;

package/api-type/src/models/pickup_payments.d.ts

@@ -0,0 +1,79 @@
+import { Model, RelationMappings } from 'objection';
+import { StripePaymentStatus } from '../types/common';
+import { Pickup } from './pickup';
+import { PickupPrice } from './pickup_price';
+import { PickupRegistration } from './pickup_registration';
+import { Member } from './member';
+import { DiscountCode } from '../modules/discount_code/discount_code.model';
+import { Refund } from './refund';
+import { Transaction } from './transaction';
+export declare class PickupPayment extends Model {
+    id: number;
+    pickupId: number;
+    memberId: number;
+    pickupPriceId: number;
+    pickupRegistrationId: number | null;
+    payerId: number;
+    stripeCheckoutSessionId: string | null;
+    stripeIdempotencyKey: string;
+    stripePaymentIntentId: string | null;
+    status: StripePaymentStatus;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    pickup?: Pickup;
+    pickupPrice?: PickupPrice;
+    pickupRegistration?: PickupRegistration;
+    member?: Member;
+    payer?: Member;
+    isRegistrationPayment?: boolean;
+    refunds?: Refund[];
+    discountCodeId: number | null;
+    discountCode?: DiscountCode;
+    appliedDiscountValue: number;
+    transactions?: Transaction[];
+    static tableName: string;
+    static get idColumn(): string;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            pickupId: {
+                type: string;
+            };
+            memberId: {
+                type: string;
+            };
+            pickupPriceId: {
+                type: string;
+            };
+            pickupRegistrationId: {
+                type: string[];
+            };
+            payerId: {
+                type: string;
+            };
+            stripeIdempotencyKey: {
+                type: string;
+            };
+            stripePaymentIntentId: {
+                type: string[];
+            };
+            stripeCheckoutSessionId: {
+                type: string[];
+            };
+            status: {
+                type: string;
+            };
+            discountCodeId: {
+                type: string[];
+            };
+            appliedDiscountValue: {
+                type: string;
+            };
+        };
+    };
+}

package/api-type/src/models/pickup_price.d.ts

@@ -0,0 +1,41 @@
+import { Model, QueryBuilder } from 'objection';
+import { VALID_CURRENCY_CODES } from '../constants';
+declare const PickupPrice_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class PickupPrice extends PickupPrice_base {
+    id: number;
+    price: number;
+    pickupId: number;
+    stripePriceId: string;
+    currency: VALID_CURRENCY_CODES;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    deletedAt: Date | string | null;
+    static tableName: string;
+    static get idColumn(): string;
+    static modifiers: {
+        filterStripe(query: QueryBuilder<PickupPrice>): void;
+    };
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            price: {
+                type: string;
+            };
+            pickupId: {
+                type: string;
+            };
+            stripePriceId: {
+                type: string;
+            };
+            currency: {
+                type: string;
+                enum: VALID_CURRENCY_CODES[];
+            };
+        };
+    };
+}
+export {};

package/api-type/src/models/pickup_registration.d.ts

@@ -0,0 +1,38 @@
+import { Model } from 'objection';
+export declare const enum PickupRegistrationStatus {
+    PAID_IN_FULL = "paid_in_full"
+}
+declare const PickupRegistration_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class PickupRegistration extends PickupRegistration_base {
+    id: number;
+    memberId: number;
+    pickupId: number;
+    status: PickupRegistrationStatus | null;
+    registrantId: number | null;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    deletedAt: Date | null;
+    static tableName: string;
+    static get idColumn(): string;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            memberId: {
+                type: string;
+            };
+            pickupId: {
+                type: string;
+            };
+            status: {
+                type: string[];
+                default: null;
+            };
+            registrantId: {
+                type: string[];
+                default: null;
+            };
+        };
+    };
+}
+export {};

package/api-type/src/models/pickup_roster.d.ts

@@ -0,0 +1,41 @@
+import { Model, RelationMappings } from 'objection';
+import { Pickup } from './pickup';
+import { Member } from './member';
+import { StripePaymentStatus } from '../types/common';
+export declare class PickupRoster extends Model {
+    id: number;
+    pickupId: number;
+    memberId: number;
+    hasPaid: boolean;
+    createdAt: Date | string;
+    updatedAt: Date | string;
+    static tableName: string;
+    pickup?: Pickup;
+    member?: Member;
+    count?: number;
+    isRegistered?: boolean;
+    isAdmin?: boolean;
+    refundedAmount?: number;
+    remainingBalance?: number;
+    paymentStatus?: StripePaymentStatus;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            pickupId: {
+                type: string;
+            };
+            memberId: {
+                type: string;
+            };
+            hasPaid: {
+                type: string;
+                default: boolean;
+            };
+        };
+    };
+}

package/api-type/src/models/pickup_stripe.d.ts

@@ -0,0 +1,23 @@
+import { Model } from 'objection';
+export declare class PickupStripe extends Model {
+    id: number;
+    pickupId: number;
+    stripeProductId: string;
+    static tableName: string;
+    static get idColumn(): string;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            pickupId: {
+                type: string;
+            };
+            stripeProductId: {
+                type: string;
+            };
+        };
+    };
+}

package/api-type/src/models/pickup_waitlist.d.ts

@@ -0,0 +1,33 @@
+import { Model, RelationMappings } from 'objection';
+import { Pickup } from './pickup';
+import { Member } from './member';
+export declare class PickupWaitlist extends Model {
+    id: number;
+    pickupId: number;
+    memberId: number;
+    createdAt: Date | string;
+    updatedAt: Date | string;
+    static tableName: string;
+    pickup?: Pickup;
+    member?: Member;
+    count?: number;
+    inWaitlist?: boolean;
+    memberEmail?: string;
+    memberPushToken?: string;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            pickupId: {
+                type: string;
+            };
+            memberId: {
+                type: string;
+            };
+        };
+    };
+}