Class ConnectorsApi

ConnectorsApi - object-oriented interface export ConnectorsApi

Hierarchy (view full)

BaseAPI
- ConnectorsApi

Index

Constructors

constructor

new ConnectorsApi(configuration?, basePath?, axios?): ConnectorsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ConnectorsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiConnectorsItemsGet

apiConnectorsItemsGet(connectorName?, keywords?, channelId?, limit?, page?, userId?, options?): Promise<AxiosResponse<PortfolioItemListResponse, any>>
summary Retreive portfolio items.
Parameters
- OptionalconnectorName: string
- Optionalkeywords: string
- OptionalchannelId: string
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PortfolioItemListResponse, any>>
Throws
memberof ConnectorsApi
- Defined in src/api/api.ts:13279

connectorAuthenticate

connectorAuthenticate(connectorName?, code?, isSmartAuth?, options?): Promise<AxiosResponse<ConnectorAuthListResponse, any>>
summary Authentication with connector and store access info.
Parameters
- OptionalconnectorName: string
- Optionalcode: string
- OptionalisSmartAuth: boolean
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ConnectorAuthListResponse, any>>
Throws
memberof ConnectorsApi
- Defined in src/api/api.ts:13306

connectorAuthUrl

connectorAuthUrl(connectorName?, isSmartAuth?, options?): Promise<AxiosResponse<ConnectorAuthUrl, any>>
summary Connector auth url for authentication.
Parameters
- OptionalconnectorName: string
- OptionalisSmartAuth: boolean
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ConnectorAuthUrl, any>>
Throws
memberof ConnectorsApi
- Defined in src/api/api.ts:13292

connectorCheckAuth

connectorCheckAuth(connectorName?, options?): Promise<AxiosResponse<ConnectorAuthListResponse, any>>
summary Check if already authenticated for connector
Parameters
- OptionalconnectorName: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ConnectorAuthListResponse, any>>
Throws
memberof ConnectorsApi
- Defined in src/api/api.ts:13318

connectorRevokeAccess

connectorRevokeAccess(connectorName?, options?): Promise<AxiosResponse<void, any>>
summary Revoke access
Parameters
- OptionalconnectorName: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof ConnectorsApi
- Defined in src/api/api.ts:13330

connectorSmartAuthenticationCallback

connectorSmartAuthenticationCallback(options?): Promise<AxiosResponse<void, any>>
summary Smart auth callback to store token.
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof ConnectorsApi
- Defined in src/api/api.ts:13341

connectorsPOST

connectorsPOST(connectorDeet?, options?): Promise<AxiosResponse<Connector, any>>
summary Create a connector
Parameters
- OptionalconnectorDeet: ConnectorDeet
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<Connector, any>>
Throws
memberof ConnectorsApi
- Defined in src/api/api.ts:13353

getConnectors

getConnectors(limit?, page?, userId?, options?): Promise<AxiosResponse<ConnectorListResponse, any>>
summary Retrieve a List all connectors.
Parameters
- Optionallimit: number
  A limit of the number of objects to be returned for the next page, between 1 and 100. The default is 25
- Optionalpage: number
  1-based page index for paginated results
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ConnectorListResponse, any>>
Throws
memberof ConnectorsApi
- Defined in src/api/api.ts:13367

Class ConnectorsApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConnectorsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

apiConnectorsItemsGet

Parameters

Returns Promise<AxiosResponse<PortfolioItemListResponse, any>>

Throws

connectorAuthenticate

Parameters

Returns Promise<AxiosResponse<ConnectorAuthListResponse, any>>

Throws

connectorAuthUrl

Parameters

Returns Promise<AxiosResponse<ConnectorAuthUrl, any>>

Throws

connectorCheckAuth

Parameters

Returns Promise<AxiosResponse<ConnectorAuthListResponse, any>>

Throws

connectorRevokeAccess

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

connectorSmartAuthenticationCallback

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

connectorsPOST

Parameters

Returns Promise<AxiosResponse<Connector, any>>

Throws

getConnectors

Parameters

Returns Promise<AxiosResponse<ConnectorListResponse, any>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration