Class Connectors

Hierarchy

TagoIOModule<GenericModuleParams>
- Connectors

Index

Constructors

Methods

create edit info list

Constructors

constructor

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

Methods

create

create(connectorObj): Promise<{
connector: string;
}>
Generates and retrieves a new connector from the account
Parameters
- connectorObj: ConnectorCreateInfo
  
  Object data to create new Connector
Returns Promise<{
connector: string;
}>
- Defined in modules/Resources/Integration.Connectors.ts:62

edit

edit(connectorID, connectorObj): Promise<string>
Modify any property of the connector
Parameters
- connectorID: string
  
  Connector identification
- connectorObj: Partial<ConnectorCreateInfo>
  
  Object data to create new Connector
Returns Promise<string>
- Defined in modules/Resources/Integration.Connectors.ts:79

info

info(connectorID, fields?): Promise<ConnectorInfo>
Get Info of the Connector
Parameters
- connectorID: string
  
  Connector identification
- Optional fields: string[]
  
  Fields to fetch.
Returns Promise<ConnectorInfo>
- Defined in modules/Resources/Integration.Connectors.ts:44

list

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