Documentation
    Preparing search index...

    Interface Client

    interface Client {
        admin: () => ClientAdminMethods;
        analytics: Analytics;
        applications: Pick<ClientObjectMethods<Application>, "get" | "list">;
        auth: Auth;
        bundles: ClientObjectMethods<ProductBundle>;
        carriers: ClientObjectMethods<Carrier>;
        classCodes: ClientObjectMethods<ClassCode>;
        comments: ClientObjectMethods<Comment>;
        environment: AUTHENTIC_ENVIRONMENT;
        funnel: ClientFunnel;
        organization: Organization;
        policies: Pick<ClientObjectMethods<Policy>, "get" | "list">;
        products: ClientObjectMethods<Product>;
        proxy: () => ClientProxyMethods;
        raters: ClientObjectMethods<Rater>;
        submissions: Pick<
            ClientObjectMethods<Submission>,
            "create" | "get" | "list",
        > & {
            deleteDocument: (
                submissionId: string,
                documentId: string,
            ) => Promise<false | ApiError>;
            getDocumentUrl: (
                submissionId: string,
                documentId: string,
            ) => Promise<string | ApiError | null>;
            listClaims: (
                submissionId: string,
            ) => Promise<ApiError | SubmissionClaim[]>;
            listDocuments: (
                submissionId: string,
            ) => Promise<ApiError | SubmissionDocument[]>;
            listSovLocations: (
                submissionId: string,
                sovId: string,
            ) => Promise<ApiError | SubmissionSovLocation[]>;
            listSovs: (submissionId: string) => Promise<ApiError | SubmissionSov[]>;
            uploadDocuments: (
                submissionId: string,
                files: File[],
            ) => Promise<false | ApiError>;
        };
    }

    Hierarchy

    • ClientObjectsMethods
      • Client
    Index
    admin analytics applications auth bundles carriers classCodes comments environment funnel organization policies products proxy raters submissions
    admin: () => ClientAdminMethods

    Returns ClientAdminMethods | methods only accessible to non-policyholders.

    analytics: Analytics
    applications: Pick<ClientObjectMethods<Application>, "get" | "list">
    auth: Auth
    bundles: ClientObjectMethods<ProductBundle>
    carriers: ClientObjectMethods<Carrier>
    classCodes: ClientObjectMethods<ClassCode>
    comments: ClientObjectMethods<Comment>
    environment: AUTHENTIC_ENVIRONMENT
    funnel: ClientFunnel

    A "rate, quote, bind" engine self-contained within the client.

    organization: Organization
    policies: Pick<ClientObjectMethods<Policy>, "get" | "list">
    products: ClientObjectMethods<Product>
    proxy: () => ClientProxyMethods

    Returns ClientProxyMethods | methods for accessing endpoints on the configured proxy server.

    raters: ClientObjectMethods<Rater>
    submissions: Pick<ClientObjectMethods<Submission>, "create" | "get" | "list"> & {
        deleteDocument: (
            submissionId: string,
            documentId: string,
        ) => Promise<false | ApiError>;
        getDocumentUrl: (
            submissionId: string,
            documentId: string,
        ) => Promise<string | ApiError | null>;
        listClaims: (submissionId: string) => Promise<ApiError | SubmissionClaim[]>;
        listDocuments: (
            submissionId: string,
        ) => Promise<ApiError | SubmissionDocument[]>;
        listSovLocations: (
            submissionId: string,
            sovId: string,
        ) => Promise<ApiError | SubmissionSovLocation[]>;
        listSovs: (submissionId: string) => Promise<ApiError | SubmissionSov[]>;
        uploadDocuments: (
            submissionId: string,
            files: File[],
        ) => Promise<false | ApiError>;
    }

    Type Declaration

    • deleteDocument: (submissionId: string, documentId: string) => Promise<false | ApiError>

      Drops the given document from its submission, along with every row extracted from it.

    • getDocumentUrl: (submissionId: string, documentId: string) => Promise<string | ApiError | null>

      Returns a short-lived URL for the bytes of the given document, or null while it holds none.

    • listClaims: (submissionId: string) => Promise<ApiError | SubmissionClaim[]>

      Returns every claim extracted from the loss runs on the submission associated with the given ID.

    • listDocuments: (submissionId: string) => Promise<ApiError | SubmissionDocument[]>

      Returns every document attached to the submission associated with the given ID, newest first.

    • listSovLocations: (
          submissionId: string,
          sovId: string,
      ) => Promise<ApiError | SubmissionSovLocation[]>

      Returns every location on the statement of values associated with the given ID.

    • listSovs: (submissionId: string) => Promise<ApiError | SubmissionSov[]>

      Returns every statement of values extracted from the submission associated with the given ID.

    • uploadDocuments: (submissionId: string, files: File[]) => Promise<false | ApiError>

      Attaches the given files to the submission associated with the given ID.

    Settings
    Member Visibility

    On This Page
    Properties