@robotical/appv2-warranty-service-lib/dist/types/types.d.ts

A tool that gathers data from the Apps and sends it to the Analytics server

import { LoginToken, RegisteredReport, RegisteredSerialNumber, RegisteredUser, RegisteredUserSerialNumberGetResponse, ZohoTicketComment, ZohoTicketStatus } from "./serviceProgramDatabase";
export declare enum FirestoreWarrantyServiceCollectionsEnum {
    REGISTERED_SERIAL_NUMBERS = "registered-serial-numbers",
    REGISTERED_USERS = "registered-users",
    ALTERNATIVE_TO_PRIMARY_EMAILS_MAP = "alternative-to-primary-emails",
    PRIMARY_TO_ALTERNATIVE_EMAILS_MAP = "primary-to-alternative-emails"
}
export declare enum ServerEndpoints {
    IS_SERIAL_NUMBER_REGISTERED = "is-serial-number-registered",
    REGISTER_SERIAL_NUMBER = "register-serial-number",
    GET_SERIAL_NUMBER = "get-serial-number",
    UPDATE_EMAIL_OF_SERIAL_NUMBER = "update-email-of-serial-number",
    REMOVE_SERIAL_NUMBER = "remove-serial-number",
    GET_USER_BY_EMAIL = "get-user-by-email",
    REGISTER_USER = "register-user",
    ADD_USER_OBJECT = "add-user-object",
    REMOVE_USER = "remove-user",
    ADD_SERIAL_NUMBER_TO_USER = "add-serial-number-to-user",
    ADD_ROBOT_NAME_TO_SERIAL_NUMBER = "add-robot-name-to-user",
    SET_ANALYTICS_CONSENT = "set-analytics-consent",
    SET_AUTOMATED_FAULT_REPORTING_CONSENT = "set-automated-fault-reporting-consent",
    ADD_LOGIN_TOKEN_TO_USER = "add-login-token-to-user",
    GET_LOGIN_TOKEN = "get-login-token",
    GET_ALTERNATIVE_EMAILS_OF_REGISTERED_USER = "get-alternative-emails-of-registered-user",
    ADD_ALTERNATIVE_EMAIL_TO_REGISTERED_USER = "add-alternative-email-to-registered-user",
    REMOVE_ALTERNATIVE_EMAIL_FROM_REGISTERED_USER = "remove-alternative-email-from-registered-user",
    ADD_REPORT_TO_USER = "add-report-to-user",
    REMOVE_REPORT_FROM_USER = "remove-report-from-user",
    GET_REPORT_FROM_USER = "get-report-from-user",
    GET_PRIMARY_EMAIL_GIVEN_ALTERNATIVE_EMAIL = "get-primary-email-given-alternative-email",
    ADD_ALTERNATIVE_TO_PRIMARY_ENTRY = "add-alternative-to-primary-entry",
    REMOVE_ALTERNATIVE_TO_PRIMARY_ENTRY = "remove-alternative-to-primary-entry",
    GET_ALTERNATIVE_EMAILS_GIVEN_PRIMARY_EMAIL = "get-alternative-emails-given-primary-email",
    ADD_ALTERNATIVE_EMAIL_TO_PRIMARY_EMAIL = "add-alternative-email-to-primary-email",
    REMOVE_ALTERNATIVE_EMAIL_FROM_PRIMARY_TO_ALTERNATIVE_MAP = "remove-alternative-email-from-primary-to-alternative-map",
    REMOVE_PRIMARY_TO_ALTERNATIVE_ENTRY = "remove-primary-to-alternative-entry",
    ZOHO_CREATE_TICKET = "zoho-create-ticket",
    ZOHO_GET_TICKET = "zoho-get-ticket",
    ZOHO_UPDATE_TICKET_STATUS = "zoho-update-ticket-status",
    ZOHO_GET_TICKET_BY_SN = "zoho-get-ticket-by-sn",
    ZOHO_ADD_COMMENT_TO_TICKET = "zoho-add-comment-to-ticket",
    ZOHO_GET_COMMENTS_FROM_TICKET = "zoho-get-comments-from-ticket",
    ZOHO_GET_COMMENT_FROM_TICKET = "zoho-get-comment-from-ticket",
    ZOHO_DELETE_COMMENT_FROM_TICKET = "zoho-delete-comment-from-ticket"
}
export type ServerEndpointsData = {
    [ServerEndpoints.IS_SERIAL_NUMBER_REGISTERED]: {
        serialNumber: string;
    };
    [ServerEndpoints.REGISTER_SERIAL_NUMBER]: {
        serialNumber: string;
        email: string;
    };
    [ServerEndpoints.GET_SERIAL_NUMBER]: {
        serialNumber: string;
    };
    [ServerEndpoints.UPDATE_EMAIL_OF_SERIAL_NUMBER]: {
        serialNumber: string;
        email: string;
    };
    [ServerEndpoints.REMOVE_SERIAL_NUMBER]: {
        serialNumber: string;
    };
    [ServerEndpoints.GET_USER_BY_EMAIL]: {
        email: string;
    };
    [ServerEndpoints.REGISTER_USER]: {
        email: string;
        establishment: string;
        serialNumbers: RegisteredUserSerialNumberGetResponse;
        analyticsConsent: boolean;
        automatedFaultReportingConsent: boolean;
        date: string;
    };
    [ServerEndpoints.ADD_USER_OBJECT]: {
        user: RegisteredUser;
    };
    [ServerEndpoints.REMOVE_USER]: {
        email: string;
    };
    [ServerEndpoints.ADD_SERIAL_NUMBER_TO_USER]: {
        email: string;
        serialNumber: string;
    };
    [ServerEndpoints.ADD_ROBOT_NAME_TO_SERIAL_NUMBER]: {
        email: string;
        serialNumber: string;
        robotName: string;
    };
    [ServerEndpoints.SET_ANALYTICS_CONSENT]: {
        email: string;
        analyticsConsent: boolean;
    };
    [ServerEndpoints.SET_AUTOMATED_FAULT_REPORTING_CONSENT]: {
        email: string;
        automatedFaultReportingConsent: boolean;
    };
    [ServerEndpoints.ADD_LOGIN_TOKEN_TO_USER]: {
        email: string;
    };
    [ServerEndpoints.GET_LOGIN_TOKEN]: {
        email: string;
    };
    [ServerEndpoints.GET_ALTERNATIVE_EMAILS_OF_REGISTERED_USER]: {
        primaryEmail: string;
    };
    [ServerEndpoints.ADD_ALTERNATIVE_EMAIL_TO_REGISTERED_USER]: {
        primaryEmail: string;
        alternativeEmail: string;
    };
    [ServerEndpoints.REMOVE_ALTERNATIVE_EMAIL_FROM_REGISTERED_USER]: {
        primaryEmail: string;
        alternativeEmail: string;
    };
    [ServerEndpoints.ADD_REPORT_TO_USER]: {
        email: string;
        serialNumber: string;
        report: RegisteredReport;
    };
    [ServerEndpoints.REMOVE_REPORT_FROM_USER]: {
        email: string;
        serialNumber: string;
        reportId: string;
    };
    [ServerEndpoints.GET_REPORT_FROM_USER]: {
        email: string;
        serialNumber: string;
        reportId: string;
    };
    [ServerEndpoints.GET_PRIMARY_EMAIL_GIVEN_ALTERNATIVE_EMAIL]: {
        alternativeEmail: string;
    };
    [ServerEndpoints.ADD_ALTERNATIVE_TO_PRIMARY_ENTRY]: {
        primaryEmail: string;
        alternativeEmail: string;
    };
    [ServerEndpoints.REMOVE_ALTERNATIVE_TO_PRIMARY_ENTRY]: {
        alternativeEmail: string;
    };
    [ServerEndpoints.GET_ALTERNATIVE_EMAILS_GIVEN_PRIMARY_EMAIL]: {
        primaryEmail: string;
    };
    [ServerEndpoints.ADD_ALTERNATIVE_EMAIL_TO_PRIMARY_EMAIL]: {
        primaryEmail: string;
        alternativeEmail: string;
    };
    [ServerEndpoints.REMOVE_ALTERNATIVE_EMAIL_FROM_PRIMARY_TO_ALTERNATIVE_MAP]: {
        primaryEmail: string;
        alternativeEmail: string;
    };
    [ServerEndpoints.REMOVE_PRIMARY_TO_ALTERNATIVE_ENTRY]: {
        primaryEmail: string;
    };
    [ServerEndpoints.ZOHO_CREATE_TICKET]: {
        subject: string;
        description: string;
        email: string;
        serialNumber: string;
        dbReportId: string;
        robotName: string;
        robotType: string;
    };
    [ServerEndpoints.ZOHO_UPDATE_TICKET_STATUS]: {
        ticketId: string;
        status: ZohoTicketStatus;
    };
    [ServerEndpoints.ZOHO_GET_TICKET]: {
        ticketId: string;
    };
    [ServerEndpoints.ZOHO_GET_TICKET_BY_SN]: {
        serialNumber: string;
    };
    [ServerEndpoints.ZOHO_ADD_COMMENT_TO_TICKET]: {
        ticketId: string;
        content: string;
    };
    [ServerEndpoints.ZOHO_GET_COMMENTS_FROM_TICKET]: {
        ticketId: string;
    };
    [ServerEndpoints.ZOHO_GET_COMMENT_FROM_TICKET]: {
        ticketId: string;
        commentId: string;
    };
    [ServerEndpoints.ZOHO_DELETE_COMMENT_FROM_TICKET]: {
        ticketId: string;
        commentId: string;
    };
};
export type ServerEndpointsResponseGeneric = {
    message?: string;
    success: boolean;
};
export type ServerEndpointsResponse = {
    [ServerEndpoints.IS_SERIAL_NUMBER_REGISTERED]: {
        exists?: boolean;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.REGISTER_SERIAL_NUMBER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.GET_SERIAL_NUMBER]: {
        serialNumberObj?: RegisteredSerialNumber;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.UPDATE_EMAIL_OF_SERIAL_NUMBER]: {
        serialNumberObj?: RegisteredSerialNumber;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.REMOVE_SERIAL_NUMBER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.GET_USER_BY_EMAIL]: {
        user?: RegisteredUser;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.REGISTER_USER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ADD_USER_OBJECT]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.REMOVE_USER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ADD_SERIAL_NUMBER_TO_USER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ADD_ROBOT_NAME_TO_SERIAL_NUMBER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.SET_ANALYTICS_CONSENT]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.SET_AUTOMATED_FAULT_REPORTING_CONSENT]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ADD_LOGIN_TOKEN_TO_USER]: {
        loginToken?: LoginToken;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.GET_LOGIN_TOKEN]: {
        loginToken?: LoginToken;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.GET_ALTERNATIVE_EMAILS_OF_REGISTERED_USER]: {
        alternativeEmails?: string[];
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ADD_ALTERNATIVE_EMAIL_TO_REGISTERED_USER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.REMOVE_ALTERNATIVE_EMAIL_FROM_REGISTERED_USER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ADD_REPORT_TO_USER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.REMOVE_REPORT_FROM_USER]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.GET_REPORT_FROM_USER]: {
        report?: RegisteredReport;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.GET_PRIMARY_EMAIL_GIVEN_ALTERNATIVE_EMAIL]: {
        primaryEmail?: string;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ADD_ALTERNATIVE_TO_PRIMARY_ENTRY]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.REMOVE_ALTERNATIVE_TO_PRIMARY_ENTRY]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.GET_ALTERNATIVE_EMAILS_GIVEN_PRIMARY_EMAIL]: {
        alternativeEmails?: string[];
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ADD_ALTERNATIVE_EMAIL_TO_PRIMARY_EMAIL]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.REMOVE_ALTERNATIVE_EMAIL_FROM_PRIMARY_TO_ALTERNATIVE_MAP]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.REMOVE_PRIMARY_TO_ALTERNATIVE_ENTRY]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ZOHO_CREATE_TICKET]: {
        ticketId?: string;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ZOHO_UPDATE_TICKET_STATUS]: {} & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ZOHO_GET_TICKET]: {
        ticket?: any;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ZOHO_GET_TICKET_BY_SN]: {
        ticket?: any;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ZOHO_ADD_COMMENT_TO_TICKET]: {
        commentId?: string;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ZOHO_GET_COMMENTS_FROM_TICKET]: {
        comments?: ZohoTicketComment[];
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ZOHO_GET_COMMENT_FROM_TICKET]: {
        comment?: ZohoTicketComment;
    } & ServerEndpointsResponseGeneric;
    [ServerEndpoints.ZOHO_DELETE_COMMENT_FROM_TICKET]: {} & ServerEndpointsResponseGeneric;
};