Function ConnectorsApiAxiosParamCreator

ConnectorsApi - axios parameter creator export

  • ConnectorsApiAxiosParamCreator(configuration?): {
        apiConnectorsItemsGet: ((connectorName?: string, keywords?: string, channelId?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorAuthenticate: ((connectorName?: string, code?: string, isSmartAuth?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorAuthUrl: ((connectorName?: string, isSmartAuth?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorCheckAuth: ((connectorName?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorRevokeAccess: ((connectorName?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorSmartAuthenticationCallback: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorsPOST: ((connectorDeet?: ConnectorDeet, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getConnectors: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        apiConnectorsItemsGet: ((connectorName?: string, keywords?: string, channelId?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorAuthenticate: ((connectorName?: string, code?: string, isSmartAuth?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorAuthUrl: ((connectorName?: string, isSmartAuth?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorCheckAuth: ((connectorName?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorRevokeAccess: ((connectorName?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorSmartAuthenticationCallback: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        connectorsPOST: ((connectorDeet?: ConnectorDeet, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getConnectors: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • apiConnectorsItemsGet: ((connectorName?: string, keywords?: string, channelId?: string, limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retreive portfolio items.

      Throws

        • (connectorName?, keywords?, channelId?, limit?, page?, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

    • connectorAuthenticate: ((connectorName?: string, code?: string, isSmartAuth?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Authentication with connector and store access info.

      Throws

        • (connectorName?, code?, isSmartAuth?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalconnectorName: string
          • Optionalcode: string
          • OptionalisSmartAuth: boolean
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • connectorAuthUrl: ((connectorName?: string, isSmartAuth?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Connector auth url for authentication.

      Throws

        • (connectorName?, isSmartAuth?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalconnectorName: string
          • OptionalisSmartAuth: boolean
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • connectorCheckAuth: ((connectorName?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Check if already authenticated for connector

      Throws

        • (connectorName?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalconnectorName: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • connectorRevokeAccess: ((connectorName?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Revoke access

      Throws

        • (connectorName?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalconnectorName: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • connectorSmartAuthenticationCallback: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Smart auth callback to store token.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • connectorsPOST: ((connectorDeet?: ConnectorDeet, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Create a connector

      Throws

        • (connectorDeet?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalconnectorDeet: ConnectorDeet
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getConnectors: ((limit?: number, page?: number, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      summary Retrieve a List all connectors.

      Throws

        • (limit?, page?, userId?, options?): Promise<RequestArgs>

        • 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<RequestArgs>

Settings

Member Visibility