Hierarchy

Constructors

Methods

  • Create a new analyze

    Parameters

    Returns Promise<{
        id: string;
        token: string;
    }>

  • Deletes an analyze from the account

    Parameters

    • analysisID: string

      Analyze identification

    Returns Promise<string>

  • Get a url to download the analysis. If version is specified in options, downloads a specific version.

    Parameters

    • analysisID: string

      Analysis identification

    • Optional options: {
          version?: number;
      }

      Options for the Analysis script to download

      • Optional version?: number

    Returns Promise<{
        expire_at: Date;
        size: number;
        size_unit: string;
        url: string;
    }>

  • Modify any property of the analyze.

    Parameters

    • analysisID: string

      Analyze identification

    • analysisObj: Partial<AnalysisInfo>

      Analyze Object with data to replace

    Returns Promise<string>

  • Retrieves a list with all analyses from the account

    Type Parameters

    • T extends Query<AnalysisInfo, "active" | "name" | "created_at" | "updated_at" | "run_on" | "last_run", T>

    Parameters

    • Optional queryObj: T

      Search query params

    Returns Promise<AnalysisListItem<T["fields"] extends (keyof AnalysisInfo)[]
        ? any[any][number]
        : "id" | "name">[]>

    Default

    queryObj: {
    page: 1,
    fields: ["id", "name"],
    filter: {},
    amount: 20,
    orderBy: "name,asc",
    }
    ```json
  • Force analyze to run

    Parameters

    • analysisID: string

      Analyze identification

    • Optional scopeObj: any

      simulate scope for analysis

    Returns Promise<{
        analysis_token: string;
    }>

  • Generate a new token for the analysis

    Parameters

    • analysisID: string

      Analyze identification

    Returns Promise<{
        analysis_token: string;
    }>

  • Upload a file (base64) to Analysis. Automatically erase the old one

    Parameters

    • analysisID: string

      Analyze identification

    • fileObj: ScriptFile

      Object with name, language and content of the file

    Returns Promise<string>