Class Analyses

Hierarchy

Constructors

constructor

Methods

create delete downloadScript edit info list run tokenGenerate uploadScript

Constructors

constructor

Methods

create

  • create(analysisObj): Promise<{
        id: string;
        token: string;
    }>

  • Create a new analyze

    Parameters

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

delete

  • delete(analysisID): Promise<string>

  • Deletes an analyze from the account

    Parameters

    • analysisID: string

      Analyze identification

    Returns Promise<string>

downloadScript

  • downloadScript(analysisID, options?): Promise<{
        expire_at: Date;
        size: number;
        size_unit: string;
        url: 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;
    }>

edit

  • edit(analysisID, analysisObj): Promise<string>

  • Modify any property of the analyze.

    Parameters

    • analysisID: string

      Analyze identification

    • analysisObj: Partial<AnalysisInfo>

      Analyze Object with data to replace

    Returns Promise<string>

info

list

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

  • Retrieves a list with all analyses from the account

    Type Parameters

    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

run

  • run(analysisID, scopeObj?): Promise<{
        analysis_token: string;
    }>

  • Force analyze to run

    Parameters

    • analysisID: string

      Analyze identification

    • Optional scopeObj: any

      simulate scope for analysis

    Returns Promise<{
        analysis_token: string;
    }>

tokenGenerate

  • tokenGenerate(analysisID): Promise<{
        analysis_token: string;
    }>

  • Generate a new token for the analysis

    Parameters

    • analysisID: string

      Analyze identification

    Returns Promise<{
        analysis_token: string;
    }>

uploadScript

  • uploadScript(analysisID, fileObj): Promise<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>

Settings

Member Visibility

Theme

On This Page

constructorcreatedeletedownloadScripteditinfolistruntokenGenerateuploadScript