Function ConnectorsApiFactory

ConnectorsApi - factory interface export

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

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

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

    • apiConnectorsItemsGet:function
      • apiConnectorsItemsGet(connectorName?, keywords?, channelId?, limit?, page?, userId?, options?): 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 AxiosPromise<PortfolioItemListResponse>

        Throws

    • connectorAuthenticate:function
      • connectorAuthenticate(connectorName?, code?, isSmartAuth?, options?): AxiosPromise<ConnectorAuthListResponse>

      • summary Authentication with connector and store access info.

        Parameters

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

          Override http request option.

        Returns AxiosPromise<ConnectorAuthListResponse>

        Throws

    • connectorAuthUrl:function
      • connectorAuthUrl(connectorName?, isSmartAuth?, options?): AxiosPromise<ConnectorAuthUrl>

      • summary Connector auth url for authentication.

        Parameters

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

          Override http request option.

        Returns AxiosPromise<ConnectorAuthUrl>

        Throws

    • connectorCheckAuth:function
    • connectorRevokeAccess:function
      • connectorRevokeAccess(connectorName?, options?): AxiosPromise<void>

      • summary Revoke access

        Parameters

        • OptionalconnectorName: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • connectorSmartAuthenticationCallback:function
      • connectorSmartAuthenticationCallback(options?): AxiosPromise<void>

      • summary Smart auth callback to store token.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • connectorsPOST:function
      • connectorsPOST(connectorDeet?, options?): AxiosPromise<Connector>

      • summary Create a connector

        Parameters

        • OptionalconnectorDeet: ConnectorDeet
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<Connector>

        Throws

    • getConnectors:function
      • getConnectors(limit?, page?, userId?, options?): 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 AxiosPromise<ConnectorListResponse>

        Throws

Settings

Member Visibility