Class AutomationsService

Automations service

Hierarchy

AutomationsService

Index

Constructors

Properties

httpClient namespace namespace_workers namespace_workflows

Methods

createWorkflow deleteAutomation deleteWorkflow getAutomations getWorkflows lookupContributors toggleAutomation toggleWorkflow updateWorkflow

Constructors

constructor

new AutomationsService(httpClient): AutomationsService
Parameters
- httpClient: HttpClient
Returns AutomationsService

Properties

`Private` `Readonly` httpClient

httpClient: HttpClient

`Private` namespace

namespace: string = '/automations-backend/v1/'

`Private` namespace_workers

namespace_workers: string = '/automations-backend/v1/workers'

`Private` namespace_workflows

namespace_workflows: string = '/automations-backend/v1/processes'

Methods

createWorkflow

createWorkflow(data): Promise<AxiosResponse<IWorkflow, any, {}>>
Create workflow
Parameters
- data: Partial<IWorkflow>
  
  workflow data
Returns Promise<AxiosResponse<IWorkflow, any, {}>>

deleteAutomation

deleteAutomation(id): Promise<AxiosResponse<number, any, {}>>
Delete automation
Parameters
- id: number
  
  automation id
Returns Promise<AxiosResponse<number, any, {}>>

deleteWorkflow

deleteWorkflow(id): Promise<AxiosResponse<number, any, {}>>
Delete workflow
Parameters
- id: number
  
  workflow id
Returns Promise<AxiosResponse<number, any, {}>>

getAutomations

getAutomations(page?, list?, search?, sortBy?, sortOrder?): Promise<AxiosResponse<IResponseWithMeta<IApp[]>, any, {}>>
Get automations list
Parameters
- Optional page: number
  
  page number
- Optional list: number
  
  page count
- Optional search: string
  
  search query
- Optional sortBy: string
  
  field to sort by
- Optional sortOrder: "asc" | "desc"
  
  sort direction
Returns Promise<AxiosResponse<IResponseWithMeta<IApp[]>, any, {}>>

getWorkflows

getWorkflows(page?, list?, search?, sortBy?, sortOrder?): Promise<AxiosResponse<IWorkflowsResponse, any, {}>>
Get processes list
Parameters
- Optional page: number
  
  page number
- Optional list: number
  
  page count
- Optional search: string
  
  search query
- Optional sortBy: string
  
  field to sort by
- Optional sortOrder: "asc" | "desc"
  
  sort direction
Returns Promise<AxiosResponse<IWorkflowsResponse, any, {}>>

lookupContributors

lookupContributors(body): Promise<AxiosResponse<IContributorsLookupResponse, any, {}>>
Get titles of processes and workers by their ids
Parameters
- body: IContributorsLookupRequest
  
  ids grouped by contributor type
Returns Promise<AxiosResponse<IContributorsLookupResponse, any, {}>>

toggleAutomation

toggleAutomation(id, body): Promise<AxiosResponse<any, any, {}>>
Toggle automation
Parameters
- id: number
  
  automation id
- body: IAutomation
  
  request body
Returns Promise<AxiosResponse<any, any, {}>>

toggleWorkflow

toggleWorkflow(id, body): Promise<AxiosResponse<any, any, {}>>
Toggle workflow
Parameters
- id: number
  
  workflow id
- body: IAutomation
  
  request body
Returns Promise<AxiosResponse<any, any, {}>>

updateWorkflow

updateWorkflow(data): Promise<AxiosResponse<IWorkflow, any, {}>>
Update workflow
Parameters
- data: Partial<IWorkflow>
  
  workflow data
Returns Promise<AxiosResponse<IWorkflow, any, {}>>

Generated using TypeDoc