bantr-api-client 1.6.0 → 11.0.2

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

@@ -0,0 +1,175 @@
+import { Model, RelationMappings } from 'objection';
+import { DayOfWeek, Gender, TLeaguePayments, TMatchDayProgress, LeagueType } from '../types/league';
+import { LeagueTemplate } from './league_template';
+import { LeagueSchedule } from './league_schedule';
+import { Organization } from './organization';
+import { Organizer } from './organizer';
+import { Team } from './team';
+import { Season } from './season';
+import { OrgWorkspace } from './organization_workspace';
+import { DynamicStage } from './dynamic_stage';
+import { DynamicGroup } from './dynamic_group';
+import { OrgFreeAgent } from './organization_free_agent';
+export declare const enum LeagueStatus {
+    UNKNOWN = "unknown",
+    FUTURE = "future",
+    CURRENT = "current",
+    PAST = "past"
+}
+export declare const enum LeagueStatusUpdated {
+    unknown = "UNKNOWN",
+    future = "UPCOMING",
+    current = "IN PROGRESS",
+    past = "COMPLETED"
+}
+declare const League_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class League extends League_base {
+    id: number;
+    name: string;
+    teamLimit: number;
+    minGamesPerTeam: number;
+    format: string;
+    gender: Gender;
+    startDate: Date | string;
+    completedAt: Date | null;
+    skillLevel: number;
+    price: number;
+    heroImage: string | null;
+    paymentLink: string | null;
+    description: string | null;
+    dayOfWeek: DayOfWeek | null | string;
+    creatorId: number | null;
+    organizationId: number;
+    baseLeagueId: number | null;
+    seasonId: number | null;
+    isLatest: boolean | null;
+    deposit: number | null;
+    coordinatorId: number | null;
+    orgWorkspaceId: number | null;
+    leagueType: LeagueType | string;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    deletedAt: Date | null;
+    organization?: Organization | null;
+    orgWorkspace?: OrgWorkspace | null;
+    orgFreeAgent?: OrgFreeAgent | null;
+    scheduleTemplate?: LeagueTemplate | null;
+    status?: LeagueStatus | LeagueStatusUpdated;
+    isEndOfSeason?: boolean;
+    isFull?: boolean;
+    isHalfFull?: boolean;
+    isPaymentRequired?: boolean;
+    allGamesPlayed?: boolean;
+    creator?: Organizer | null;
+    daysToKickoff?: number;
+    teamCount?: number;
+    minNumMatchdays?: number;
+    memberTeamsRegistered?: Team[] | null;
+    formattedStartDate?: string;
+    matchDays?: LeagueSchedule[];
+    currentMatchDay?: number;
+    season?: Season;
+    locations?: string[] | null;
+    startTimes?: string[] | null;
+    coordinator?: Organizer;
+    leaguePayments?: TLeaguePayments;
+    matchDayProgress?: TMatchDayProgress[];
+    reigningChampion?: Team;
+    leagueSchedules?: LeagueSchedule[];
+    teams?: Team[];
+    currentMatchDayQuery?: any;
+    stages?: DynamicStage[] | null;
+    groups?: DynamicGroup[];
+    stripeVersion: number;
+    static tableName: string;
+    static get idColumn(): string;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            name: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            teamLimit: {
+                type: string;
+            };
+            minGamesPerTeam: {
+                type: string;
+            };
+            format: {
+                type: string;
+                minLength: number;
+                maxLength: number;
+            };
+            gender: {
+                type: string;
+                enum: Gender[];
+                minLength: number;
+                maxLength: number;
+            };
+            startDate: {
+                type: string;
+            };
+            completedAt: {
+                type: string;
+            };
+            skillLevel: {
+                type: string;
+            };
+            price: {
+                type: string;
+            };
+            heroImage: {
+                type: string[];
+            };
+            paymentLink: {
+                type: string[];
+            };
+            description: {
+                type: string[];
+                minLength: number;
+                maxLength: number;
+            };
+            dayOfWeek: {
+                type: string;
+                enum: DayOfWeek[];
+                minLength: number;
+                maxLength: number;
+            };
+            organizationId: {
+                type: string;
+            };
+            orgWorkspaceId: {
+                type: string[];
+            };
+            baseLeagueId: {
+                type: string[];
+            };
+            seasonId: {
+                type: string[];
+            };
+            isLatest: {
+                type: string[];
+            };
+            leagueType: {
+                type: string;
+                enum: LeagueType[];
+                default: LeagueType;
+            };
+            stripeVersion: {
+                type: string;
+                default: number;
+            };
+        };
+    };
+    isOrganizer(organizerId: number): Promise<boolean>;
+    checkVacancyForDynamicLeague(groupId?: number): Promise<boolean>;
+    hasVacancy(groupId?: number): Promise<boolean>;
+}
+export {};

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

@@ -0,0 +1,38 @@
+import { Model, RelationMappings } from 'objection';
+declare const LeagueGroupTeam_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class LeagueGroupTeam extends LeagueGroupTeam_base {
+    id: number;
+    leagueId: number;
+    teamId: number;
+    dynamicGroupId: number;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    deletedAt: Date | null;
+    teamName?: string;
+    position?: number;
+    gamesPlayed?: number;
+    gamesScheduled?: number;
+    static tableName: string;
+    static get idColumn(): string;
+    static get modifiers(): Record<string, (builder: any) => void>;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            leagueId: {
+                type: string;
+            };
+            teamId: {
+                type: string;
+            };
+            dynamicGroupId: {
+                type: string;
+            };
+        };
+    };
+}
+export {};

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

@@ -0,0 +1,57 @@
+import { Model, RelationMappings } from 'objection';
+import { TEmojiInteractions } from '../types/league_media';
+export declare const enum MEDIA_TYPE {
+    image = "image",
+    video = "video",
+    gif = "gif"
+}
+export declare const enum USER_TYPE {
+    member = "member",
+    organizer = "organizer"
+}
+export declare class LeagueMedia extends Model {
+    id: number;
+    leagueId: number;
+    url: string;
+    type: MEDIA_TYPE;
+    isHighlighted: boolean;
+    isFlagged: boolean;
+    creatorId: number | null;
+    creatorType: USER_TYPE | null;
+    updatedAt: Date;
+    createdAt: Date;
+    interactions?: TEmojiInteractions[];
+    totalInteractions?: number;
+    feedType?: string;
+    static tableName: string;
+    static get relationMappings(): RelationMappings;
+    static get idColumn(): string;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            leagueId: {
+                type: string;
+            };
+            isHighlighted: {
+                type: string;
+                default: boolean;
+            };
+            isFlagged: {
+                type: string;
+                default: boolean;
+            };
+            creatorId: {
+                type: string[];
+            };
+            creatorType: {
+                type: string[];
+            };
+        };
+    };
+    IsTeamMemberOfLeague(memberId: number): Promise<boolean>;
+}
+export default LeagueMedia;

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

@@ -0,0 +1,93 @@
+import { Model, RelationMappings } from 'objection';
+import { LeaguePaymentSchema } from '../modules/league_payments/league_payments.schema';
+import { League } from './league';
+import { LeaguePrice } from './league_price';
+import { LeagueRegistration } from './league_registration';
+import { Member } from './member';
+import { Team } from './team';
+import { Refund } from './refund';
+import { DiscountCode } from '../modules/discount_code/discount_code.model';
+import { Transaction } from './transaction';
+export declare class LeaguePayment extends Model {
+    id: number;
+    leagueId: number;
+    teamId: number;
+    leaguePriceId: number;
+    leagueRegistrationId: number | null;
+    payerId: number;
+    stripeCheckoutSessionId: string | null;
+    stripeIdempotencyKey: string | null;
+    stripePaymentIntentId: string | null;
+    status: LeaguePaymentSchema['status'];
+    orgFreeAgentId: number | null;
+    amountApplied: number | null;
+    originalLeagueId: number | null;
+    offlineMethod: LeaguePaymentSchema['offlineMethod'] | null;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    deletedAt: Date | null;
+    league?: League;
+    leaguePrice?: LeaguePrice;
+    leagueRegistration?: LeagueRegistration;
+    team?: Team;
+    payer?: Member;
+    isRegistrationPayment?: boolean;
+    refunds?: Refund[];
+    originalLeague?: League;
+    discountCodeId: number | null;
+    discountCode?: DiscountCode;
+    appliedDiscountValue: number;
+    transactions?: Transaction[];
+    static tableName: string;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            leagueId: {
+                type: string;
+            };
+            leaguePriceId: {
+                type: string;
+            };
+            leagueRegistrationId: {
+                type: string[];
+            };
+            payerId: {
+                type: string;
+            };
+            stripeCheckoutSessionId: {
+                type: string[];
+            };
+            stripeIdempotencyKey: {
+                type: string[];
+            };
+            stripePaymentIntentId: {
+                type: string[];
+            };
+            offlineMethod: {
+                type: string[];
+                enum: ["STRIPE", "CASH", "CHECK", "VENMO", "ZELLE", "ONLINE", "BANK", "Other"];
+            };
+            status: {
+                type: string;
+                enum: [import("../types/common").StripePaymentStatus.CREATED, import("../types/common").StripePaymentStatus.PENDING, import("../types/common").StripePaymentStatus.PAID, import("../types/common").StripePaymentStatus.FAILED, import("../types/common").StripePaymentStatus.REFUNDED, import("../types/common").StripePaymentStatus.REFUND_INITIATED, import("../types/common").StripePaymentStatus.PARTIALLY_REFUNDED];
+            };
+            teamId: {
+                type: string;
+            };
+            originalLeagueId: {
+                type: string[];
+            };
+            discountCodeId: {
+                type: string[];
+            };
+            appliedDiscountValue: {
+                type: string;
+            };
+        };
+    };
+}

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

@@ -0,0 +1,52 @@
+import { Model, QueryBuilder } from 'objection';
+import { VALID_CURRENCY_CODES } from '../constants';
+export declare const enum LeaguePriceType {
+    TOTAL_PRICE = "total_price",
+    DEPOSIT_PRICE = "deposit_price",
+    BALANCE_PRICE = "balance_price",
+    CUSTOM_PRICE = "custom_price",
+    OFF_PLATFORM = "off_platform"
+}
+declare const LeaguePrice_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class LeaguePrice extends LeaguePrice_base {
+    id: number;
+    price: number;
+    type: LeaguePriceType;
+    leagueId: number;
+    stripePriceId: string | null;
+    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<LeaguePrice>): void;
+    };
+    static jsonSchema: {
+        type: string;
+        required: never[];
+        properties: {
+            id: {
+                type: string;
+            };
+            price: {
+                type: string;
+            };
+            type: {
+                type: string;
+            };
+            leagueId: {
+                type: string;
+            };
+            stripePriceId: {
+                type: string[];
+            };
+            currency: {
+                type: string;
+                enum: VALID_CURRENCY_CODES[];
+            };
+        };
+    };
+}
+export {};

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

@@ -0,0 +1,41 @@
+import { Model } from 'objection';
+export declare const enum LeagueRegistrationStatus {
+    PAYMENT_PENDING = "payment_pending",
+    PAID_IN_FULL = "paid_in_full"
+}
+declare const LeagueRegistration_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class LeagueRegistration extends LeagueRegistration_base {
+    id: number;
+    teamId: number;
+    leagueId: number;
+    originalLeagueId: number | null;
+    status: LeagueRegistrationStatus | 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: {
+            registrantId: {
+                type: string[];
+            };
+            teamId: {
+                type: string;
+            };
+            leagueId: {
+                type: string;
+            };
+            status: {
+                type: string[];
+            };
+            originalLeagueId: {
+                type: string[];
+            };
+        };
+    };
+}
+export {};

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

@@ -0,0 +1,116 @@
+import { Model, RelationMappings } from 'objection';
+import { GameStatTypes } from '../types/game_stats';
+import { League } from './league';
+import { ScheduleEvent } from './schedule_event';
+import { Team } from './team';
+import { DynamicGroup } from './dynamic_group';
+import { DynamicStage } from './dynamic_stage';
+import { MatchNotes } from './match_notes';
+import { Referee } from './referees';
+import { Organizer } from './organizer';
+export declare const enum Status {
+    preview = "preview",
+    saved = "saved",
+    saved_incomplete = "saved_incomplete",
+    saved_complete = "saved_complete",
+    published = "published",
+    conflict = "conflict",
+    canceled = "canceled"
+}
+export declare const TimeDelimiter = ":";
+export declare class LeagueSchedule extends Model {
+    id: number;
+    templateId?: number;
+    leagueId: number;
+    team1Id: number | null;
+    team2Id: number | null;
+    date?: string | null;
+    location?: string | null;
+    time?: string | null;
+    status: Status;
+    matchDay: number;
+    label?: string | null;
+    gameLabel?: string | null;
+    gameScoresId?: number | null;
+    localizedDatetime: Date | null;
+    dynamicGroupId: number | null;
+    dynamicStageId: number | null;
+    ignoreFromStandings: boolean;
+    cancellationMessage?: null | string;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    league?: League;
+    gameScores?: ScheduleEvent | null;
+    team1?: Team;
+    team2?: Team;
+    statsStep?: GameStatTypes;
+    feedType?: string;
+    totalGames?: number;
+    confirmedGames?: number;
+    confirmedByOrganizer?: boolean;
+    group?: DynamicGroup;
+    stage?: DynamicStage;
+    stageId?: number;
+    matchNotes?: MatchNotes[];
+    noteLabels?: string[];
+    referees?: Referee[];
+    organizersAsReferee?: Organizer[];
+    static tableName: string;
+    static get idColumn(): string;
+    static get modifiers(): Record<string, (builder: any) => void>;
+    static get relationMappings(): RelationMappings;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            templateId: {
+                type: string;
+            };
+            leagueId: {
+                type: string;
+            };
+            team1Id: {
+                type: string[];
+            };
+            team2Id: {
+                type: string[];
+            };
+            date: {
+                type: string[];
+            };
+            location: {
+                type: string[];
+                maxLength: number;
+            };
+            time: {
+                type: string[];
+                maxLength: number;
+            };
+            status: {
+                type: string;
+                enum: Status[];
+                minLength: number;
+                maxLength: number;
+            };
+            matchDay: {
+                type: string;
+            };
+            gameScoresId: {
+                type: string;
+            };
+            localizedDatetime: {
+                type: string;
+            };
+            dynamicGroupId: {
+                type: string[];
+            };
+            ignoreFromStandings: {
+                type: string;
+                default: boolean;
+            };
+        };
+    };
+}

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

@@ -0,0 +1,29 @@
+import { Model } from 'objection';
+export declare class LeagueScheduleReferee extends Model {
+    id: number;
+    leagueScheduleId: number;
+    organizerId: number | null;
+    refereeId: number | null;
+    static tableName: string;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            leagueScheduleId: {
+                type: string;
+            };
+            organizerId: {
+                type: string[];
+                default: null;
+            };
+            refereeId: {
+                type: string[];
+                default: null;
+            };
+        };
+    };
+}
+export default LeagueScheduleReferee;

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

@@ -0,0 +1,83 @@
+import { Model, RelationMappings, TransactionOrKnex } from 'objection';
+import { League } from './league';
+import { OrgWorkspace } from '@bantr/api/models/organization_workspace';
+import { Team } from './team';
+declare const LeagueStanding_base: Omit<typeof Model, "new"> & import("objection-js-soft-delete").SoftDeleteStatic<typeof Model>;
+export declare class LeagueStanding extends LeagueStanding_base {
+    id: number;
+    leagueId: number;
+    teamId: number;
+    position: number | null;
+    finalPosition: number | null;
+    points: number;
+    wins: number;
+    losses: number;
+    draws: number;
+    goalsFor: number;
+    goalsAgainst: number;
+    gamesPlayed: number;
+    goalsDiff: number;
+    dynamicGroupId: number | null;
+    isPublished: boolean;
+    updatedAt: Date | string;
+    createdAt: Date | string;
+    deletedAt: Date | null;
+    team?: Team;
+    league?: League;
+    feedType?: string;
+    orgWorkspace?: OrgWorkspace;
+    constructor(opts?: {
+        leagueId?: number;
+        teamId?: number;
+        dynamicGroupId?: number | null;
+        isPublished?: boolean;
+    });
+    static tableName: string;
+    static get relationMappings(): RelationMappings;
+    static get idColumn(): string;
+    static jsonSchema: {
+        type: string;
+        required: string[];
+        properties: {
+            id: {
+                type: string;
+            };
+            leagueId: {
+                type: string;
+            };
+            teamId: {
+                type: string;
+            };
+            position: {
+                type: string[];
+            };
+            finalPosition: {
+                type: string[];
+            };
+            points: {
+                type: string;
+            };
+            wins: {
+                type: string;
+            };
+            losses: {
+                type: string;
+            };
+            draws: {
+                type: string;
+            };
+            goalsFor: {
+                type: string;
+            };
+            goalsAgainst: {
+                type: string;
+            };
+            dynamicGroupId: {
+                type: string[];
+            };
+        };
+    };
+    static recalculateLeagueStandings(leagueId: number, trx?: TransactionOrKnex): Promise<void>;
+    private static _addScores;
+}
+export {};