Function EndUsersApiFactory

EndUsersApi - factory interface export

  • EndUsersApiFactory(configuration?, basePath?, axios?): {
        apiEndUsersBulkFilePost(file?: File, options?: RawAxiosRequestConfig): AxiosPromise<EndUser[]>;
        apiEndUsersInvitePost(endUserReadDeets?: EndUserReadDeets, options?: RawAxiosRequestConfig): AxiosPromise<string>;
        apiEndUsersPost(endUserCreateDeets?: EndUserCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<EndUser>;
    }

  • Parameters

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

    Returns {
        apiEndUsersBulkFilePost(file?: File, options?: RawAxiosRequestConfig): AxiosPromise<EndUser[]>;
        apiEndUsersInvitePost(endUserReadDeets?: EndUserReadDeets, options?: RawAxiosRequestConfig): AxiosPromise<string>;
        apiEndUsersPost(endUserCreateDeets?: EndUserCreateDeets, options?: RawAxiosRequestConfig): AxiosPromise<EndUser>;
    }

    • apiEndUsersBulkFilePost:function
      • apiEndUsersBulkFilePost(file?, options?): AxiosPromise<EndUser[]>

      • Parameters

        • Optionalfile: File
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<EndUser[]>

        Throws

    • apiEndUsersInvitePost:function
      • apiEndUsersInvitePost(endUserReadDeets?, options?): AxiosPromise<string>

      • Parameters

        • OptionalendUserReadDeets: EndUserReadDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<string>

        Throws

    • apiEndUsersPost:function
      • apiEndUsersPost(endUserCreateDeets?, options?): AxiosPromise<EndUser>

      • summary Create an end user for a tenant

        Parameters

        • OptionalendUserCreateDeets: EndUserCreateDeets
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<EndUser>

        Throws

Settings

Member Visibility