Class Analyses

Hierarchy

TagoIOModule<GenericModuleParams>
- Analyses

Index

Constructors

constructor

Methods

Constructors

constructor

new Analyses(params: GenericModuleParams): Analyses

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Analyses

Methods

create

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

- Defined in src/modules/Account/Analyses.ts:43
Create a new analyze

Parameters
- analysisObj: AnalysisCreateInfo
  
  data object to create new TagoIO Analyze
Returns Promise<{ id: string; token: string }>

delete

delete(analysisID: string): Promise<string>

- Defined in src/modules/Account/Analyses.ts:75
Deletes an analyze from the account

Parameters
- analysisID: string
  
  Analyze identification
Returns Promise<string>

downloadScript

downloadScript(analysisID: string, options?: { version?: number }): Promise<{ expire_at: Date; size: number; size_unit: string; url: string }>

- Defined in src/modules/Account/Analyses.ts:154
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: string, analysisObj: Partial<AnalysisInfo>): Promise<string>

- Defined in src/modules/Account/Analyses.ts:60
Modify any property of the analyze.

Parameters
- analysisID: string
  
  Analyze identification
- analysisObj: Partial<AnalysisInfo>
  
  Analyze Object with data to replace
Returns Promise<string>

info

info(analysisID: string): Promise<AnalysisInfo>

- Defined in src/modules/Account/Analyses.ts:87
Gets information about the analyze

Parameters
- analysisID: string
  
  Analyze identification
Returns Promise<AnalysisInfo>

list

list(queryObj?: AnalysisQuery): Promise<AnalysisInfo[]>

- Defined in src/modules/Account/Analyses.ts:21
Retrieves a list with all analyses from the account

default
json queryObj: { page: 1, fields: ["id", "name"], filter: {}, amount: 20, orderBy: "name,asc", } json

Parameters
- Optional queryObj: AnalysisQuery
  
  Search query params
Returns Promise<AnalysisInfo[]>

run

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

- Defined in src/modules/Account/Analyses.ts:103
Force analyze to run

Parameters
- analysisID: string
  
  Analyze identification
- Optional scopeObj: any
  
  simulate scope for analysis
Returns Promise<{ analysis_token: string }>

tokenGenerate

tokenGenerate(analysisID: string): Promise<string>

- Defined in src/modules/Account/Analyses.ts:119
Generate a new token for the analysis

Parameters
- analysisID: string
  
  Analyze identification
Returns Promise<string>

uploadScript

uploadScript(analysisID: string, fileObj: ScriptFile): Promise<string>

- Defined in src/modules/Account/Analyses.ts:133
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>