Function ConnectorsApiFp

Returns {
    apiConnectorsItemsGet(connectorName?: string, keywords?: string, channelId?: string, limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioItemListResponse>)>;
    connectorAuthenticate(connectorName?: string, code?: string, isSmartAuth?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorAuthListResponse>)>;
    connectorAuthUrl(connectorName?: string, isSmartAuth?: boolean, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorAuthUrl>)>;
    connectorCheckAuth(connectorName?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorAuthListResponse>)>;
    connectorRevokeAccess(connectorName?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    connectorSmartAuthenticationCallback(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    connectorsPOST(connectorDeet?: ConnectorDeet, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connector>)>;
    getConnectors(limit?: number, page?: number, userId?: string, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorListResponse>)>;
}

• apiConnectorsItemsGet:function

  • apiConnectorsItemsGet(connectorName?, keywords?, channelId?, limit?, page?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioItemListResponse>)>

  • 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<PortfolioItemListResponse>)>

    Throws

• connectorAuthenticate:function

  • connectorAuthenticate(connectorName?, code?, isSmartAuth?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorAuthListResponse>)>

  • summary Authentication with connector and store access info.

    Parameters

    • OptionalconnectorName: string
    • Optionalcode: string
    • OptionalisSmartAuth: boolean
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorAuthListResponse>)>

    Throws

• connectorAuthUrl:function

  • connectorAuthUrl(connectorName?, isSmartAuth?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorAuthUrl>)>

  • summary Connector auth url for authentication.

    Parameters

    • OptionalconnectorName: string
    • OptionalisSmartAuth: boolean
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorAuthUrl>)>

    Throws

• connectorCheckAuth:function

  • connectorCheckAuth(connectorName?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorAuthListResponse>)>

  • summary Check if already authenticated for connector

    Parameters

    • OptionalconnectorName: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorAuthListResponse>)>

    Throws

• connectorRevokeAccess:function

  • connectorRevokeAccess(connectorName?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • summary Revoke access

    Parameters

    • OptionalconnectorName: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Throws

• connectorSmartAuthenticationCallback:function

  • connectorSmartAuthenticationCallback(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

  • summary Smart auth callback to store token.

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

    Throws

• connectorsPOST:function

  • connectorsPOST(connectorDeet?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connector>)>

  • summary Create a connector

    Parameters

    • OptionalconnectorDeet: ConnectorDeet
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<Connector>)>

    Throws

• getConnectors:function

  • getConnectors(limit?, page?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorListResponse>)>

  • 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<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConnectorListResponse>)>

    Throws