@lilaquadrat/studio 9.15.2 → 9.15.3

package/lib/cjs/src/services/listParticipants.service.d.ts

@@ -0,0 +1,242 @@
+import { ObjectId, UnorderedBulkOperation, WithId } from 'mongodb';
+import Immutable from '../Immutable.class';
+import { QueueClient, QueueServiceClient } from '@azure/storage-queue';
+import { Agreement, AgreementResponse, BasicData, CustomerPersonWithEmail, EmailsContent, History, HistoryReason, HistoryWithType, List, ListParticipants, ListParticipantWithCustomerAndPayment, ObjectIdString, Options, SkipLimitSort, UserAppWithOptions } from '@lilaquadrat/interfaces';
+import { ValidateFunction } from 'ajv';
+export declare class ListParticipantsService extends Immutable<ListParticipants> {
+    model: import("../classes/modelv2.class").default<ListParticipants, string>;
+    customerLookup: ({
+        $lookup: {
+            from: string;
+            as: string;
+            let: {
+                userid: string;
+            };
+            pipeline: {
+                $match: {
+                    $and: {
+                        $expr: {
+                            $eq: string[];
+                        };
+                    }[];
+                };
+            }[];
+        };
+        $unwind?: undefined;
+        $addFields?: undefined;
+        $project?: undefined;
+    } | {
+        $unwind: {
+            path: string;
+            preserveNullAndEmptyArrays: boolean;
+        };
+        $lookup?: undefined;
+        $addFields?: undefined;
+        $project?: undefined;
+    } | {
+        $addFields: {
+            user: {
+                name: {
+                    $concat: string[];
+                };
+                email: string;
+                id: string;
+                _id: string;
+            };
+        };
+        $lookup?: undefined;
+        $unwind?: undefined;
+        $project?: undefined;
+    } | {
+        $project: {
+            userData: number;
+        };
+        $lookup?: undefined;
+        $unwind?: undefined;
+        $addFields?: undefined;
+    })[];
+    paymentLookup: ({
+        $lookup: {
+            from: string;
+            as: string;
+            let: {
+                paymentid: string;
+            };
+            pipeline: {
+                $match: {
+                    $and: {
+                        $expr: {
+                            $eq: string[];
+                        };
+                    }[];
+                };
+            }[];
+        };
+        $unwind?: undefined;
+        $addFields?: undefined;
+        $project?: undefined;
+    } | {
+        $unwind: {
+            path: string;
+            preserveNullAndEmptyArrays: boolean;
+        };
+        $lookup?: undefined;
+        $addFields?: undefined;
+        $project?: undefined;
+    } | {
+        $addFields: {
+            payment: {
+                _id: string;
+                amount: string;
+                currency: string;
+                provider: string;
+                items: string;
+                state: string;
+            };
+        };
+        $lookup?: undefined;
+        $unwind?: undefined;
+        $project?: undefined;
+    } | {
+        $project: {
+            paymentData: number;
+        };
+        $lookup?: undefined;
+        $unwind?: undefined;
+        $addFields?: undefined;
+    })[];
+    paymentLookupList: ({
+        $lookup: {
+            from: string;
+            as: string;
+            let: {
+                paymentid: string;
+            };
+            pipeline: {
+                $match: {
+                    $and: {
+                        $expr: {
+                            $eq: string[];
+                        };
+                    }[];
+                };
+            }[];
+        };
+        $unwind?: undefined;
+        $addFields?: undefined;
+        $project?: undefined;
+    } | {
+        $unwind: {
+            path: string;
+            preserveNullAndEmptyArrays: boolean;
+        };
+        $lookup?: undefined;
+        $addFields?: undefined;
+        $project?: undefined;
+    } | {
+        $addFields: {
+            payment: {
+                amount: string;
+            };
+        };
+        $lookup?: undefined;
+        $unwind?: undefined;
+        $project?: undefined;
+    } | {
+        $project: {
+            paymentData: number;
+        };
+        $lookup?: undefined;
+        $unwind?: undefined;
+        $addFields?: undefined;
+    })[];
+    service: QueueServiceClient;
+    queue: string;
+    client: QueueClient;
+    constructor(connectionString: string | undefined, accountName: string | undefined, queue: string);
+    getCustomerLookup(search?: string): any;
+    single(list: ObjectId, internalId: ObjectId, options: Required<UserAppWithOptions>): Promise<ListParticipantWithCustomerAndPayment>;
+    /**
+     * get state of the provided account for this list
+     */
+    stateForAccount(list: ObjectId, account: string, options: Required<UserAppWithOptions>): Promise<ListParticipants>;
+    updateAfterCheck(useful: boolean, explanation: string | undefined, partiticpantInternalId: ObjectId, listInternalId: ObjectId, options: Required<UserAppWithOptions>): Promise<import("mongodb").UpdateResult<BasicData<ListParticipants>>>;
+    private getValidatorForStructures;
+    createParticipantsObject(list: ObjectId, mode: List['mode'], user: ObjectId, state: ListParticipants['state'], message: string | undefined, category: string | undefined, payment: ObjectId | undefined, structureInput: Record<string, string | boolean | number> | undefined, agreements: AgreementResponse[], options: Required<UserAppWithOptions>): ListParticipants;
+    /**
+     * join a list from customer perspective
+     */
+    join(listInternalId: ObjectId, person: CustomerPersonWithEmail, message: string | undefined, category: string | undefined, agreements: AgreementResponse[], structureInput: Record<string, string>, options: Required<UserAppWithOptions & {
+        uuid: string;
+        parentId: ObjectIdString;
+    }>): Promise<{
+        _id: ObjectId;
+        id: string;
+    }>;
+    joinManually(listInternalId: ObjectId, customerId: ObjectId, category: string, state: ListParticipants['state'], note: string | undefined, options: Required<UserAppWithOptions>): Promise<import("@lilaquadrat/interfaces").CreateResult<BasicData<ListParticipants>>>;
+    /**
+     * join a list through payment
+     */
+    joinViaPayment(listInternalId: ObjectId, customerId: ObjectId, message: string | undefined, category: string, payment: ObjectId, agreements: AgreementResponse[], options: Required<UserAppWithOptions>): Promise<ObjectId>;
+    /**
+     * join a list from members perspective
+     */
+    membersJoin(listInternalId: ObjectId, account: string, message: string | undefined, category: string | undefined, agreements: AgreementResponse[], structureInput: Record<string, string>, options: Required<UserAppWithOptions & {
+        uuid: string;
+        parentId: ObjectIdString;
+    }>): Promise<ObjectId>;
+    /**
+     * Sends an email based on participant state and audience criteria.
+     * if the options for disableEmailConfirmedCheck is set to true, the email will be sent regardless of the email confirmation status.
+     */
+    sendStateAndAudienceAwareEmail(listId: ObjectId, customerId: ObjectId, state: ListParticipants['state'], audience: EmailsContent['audience'], options: Required<UserAppWithOptions> & {
+        disableEmailConfirmedCheck?: boolean;
+    }): Promise<void | import("@lilaquadrat/interfaces").CreateResult<BasicData<import("@lilaquadrat/interfaces").Publish>>>;
+    remove(list: ObjectId, participationId: ObjectId, options: Required<UserAppWithOptions>): Promise<import("mongodb").DeleteResult>;
+    /**
+     * Updates the state of a participant in a list
+     */
+    state(list: ObjectId, participationId: ObjectId, state: ListParticipants['state'], options: Required<UserAppWithOptions>): Promise<void>;
+    note(list: ObjectId, participationId: ObjectId, note: ListParticipants['note'] | undefined, options: Required<UserAppWithOptions>): Promise<import("mongodb").UpdateResult<BasicData<ListParticipants>>>;
+    participantInList(list: ObjectId, user: ObjectId, options: Required<UserAppWithOptions>): Promise<boolean>;
+    singleWithoutLookup(list: ObjectId, user: ObjectId, options: Required<UserAppWithOptions>): Promise<WithId<ListParticipants> | null>;
+    viaPayment(listId: ObjectId, paymentId: ObjectId, options: Required<UserAppWithOptions>): Promise<ListParticipantWithCustomerAndPayment>;
+    byInternalId(internalId: ObjectId): Promise<WithId<ListParticipants>>;
+    byInternalId(internalId: ObjectId, customerLookup: true): Promise<Omit<ListParticipants, 'user'> & {
+        user: CustomerPersonWithEmail;
+    }>;
+    addParticipant(list: ObjectId, mode: List['mode'], user: ObjectId, state: ListParticipants['state'], message: string | undefined, category: string | undefined, payment: ObjectId | undefined, structureInput: Record<string, string | boolean | number> | undefined, agreements: AgreementResponse[], options: Required<UserAppWithOptions> & {
+        validator?: ValidateFunction;
+    }): Promise<import("@lilaquadrat/interfaces").CreateResult<BasicData<ListParticipants>>>;
+    addParticipantViaObject(participant: ListParticipants, mode: List['mode'], options: Required<UserAppWithOptions> & {
+        validator?: ValidateFunction;
+    }): Promise<import("@lilaquadrat/interfaces").CreateResult<BasicData<ListParticipants>>>;
+    removeParticipant(list: ObjectId, user: string, options: Required<UserAppWithOptions>): void;
+    listHistory(list: ObjectId, reason: HistoryReason | undefined, options: Required<UserAppWithOptions>): Promise<{
+        all: number;
+        data: HistoryWithType<ListParticipants>[];
+        count: number;
+    }>;
+    agreementsMissing(listAgreements: Agreement[], providedAgreements: AgreementResponse[]): string[];
+    listParticipants(list: ObjectId, state: ListParticipants['state'][] | undefined, category: string[] | undefined, lastname: string | undefined, options: UserAppWithOptions & SkipLimitSort): Promise<{
+        all: number;
+        data: ListParticipants[] | undefined;
+        count: number | undefined;
+    }>;
+    getMyListsQuery(customerInternalId: ObjectId, filter: {
+        name?: string;
+        state?: List['state'];
+        mode?: List['mode'];
+    }, options: UserAppWithOptions & SkipLimitSort): Promise<{
+        all: any;
+        data: any;
+        count: any;
+    }>;
+    updateImportIds(importData: BasicData<ListParticipants>[], options: Required<Options>): Record<string, ObjectId>;
+    export(options: Options): Promise<WithId<ListParticipants>[]>;
+    import(importData: BasicData<ListParticipants>[], importHistoryData: BasicData<ListParticipants & History>[], idMapping: Record<string, ObjectId>, bulkHistory: UnorderedBulkOperation, options: Required<Options>): Promise<{
+        bulk: UnorderedBulkOperation;
+    }>;
+}
+declare const _default: ListParticipantsService;
+export default _default;