Class Connectors

Hierarchy

TagoIOModule<GenericModuleParams>
- Connectors

Index

Constructors

constructor

Methods

Constructors

constructor

new Connectors(params: GenericModuleParams): Connectors

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

Methods

create

create(connectorObj: ConnectorCreateInfo): Promise<{ connector: string }>

- Defined in src/modules/Account/Integration.Connectors.ts:62
Generates and retrieves a new connector from the account

Parameters
- connectorObj: ConnectorCreateInfo
  
  Object data to create new Connector
Returns Promise<{ connector: string }>

edit

edit(connectorID: string, connectorObj: Partial<ConnectorCreateInfo>): Promise<string>

- Defined in src/modules/Account/Integration.Connectors.ts:79
Modify any property of the connector

Parameters
- connectorID: string
  
  Connector identification
- connectorObj: Partial<ConnectorCreateInfo>
  
  Object data to create new Connector
Returns Promise<string>

info

info(connectorID: string, fields?: string[]): Promise<ConnectorInfo>

- Defined in src/modules/Account/Integration.Connectors.ts:44
Get Info of the Connector

Parameters
- connectorID: string
  
  Connector identification
- Optional fields: string[]
  
  Fields to fetch.
Returns Promise<ConnectorInfo>

list

list(queryObj?: ConnectorQuery): Promise<ConnectorInfo[]>

- Defined in src/modules/Account/Integration.Connectors.ts:21
Retrieves a list with all connectors from account
default
```
queryObj: {
  page: 1,
  fields: ["id", "name"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
}
```
Parameters
- Optional queryObj: ConnectorQuery
  
  Search query params
Returns Promise<ConnectorInfo[]>