Function UsersApiFactory

Returns {
    usersDestroy(
        requestParameters: UsersApiUsersDestroyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    usersList(
        requestParameters?: UsersApiUsersListRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PaginatedMetaUserList>;
    usersPartialUpdate(
        requestParameters: UsersApiUsersPartialUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MetaUser>;
    usersRetrieve(
        requestParameters: UsersApiUsersRetrieveRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MetaUser>;
    usersRetrieveSelf(options?: RawAxiosRequestConfig): AxiosPromise<MetaUser>;
}

• usersDestroy:function

  • usersDestroy(
        requestParameters: UsersApiUsersDestroyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>

    Parameters

    • requestParameters: UsersApiUsersDestroyRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Throws

• usersList:function

  • usersList(
        requestParameters?: UsersApiUsersListRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PaginatedMetaUserList>

    Parameters

    • requestParameters: UsersApiUsersListRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PaginatedMetaUserList>

    Throws

• usersPartialUpdate:function

  • usersPartialUpdate(
        requestParameters: UsersApiUsersPartialUpdateRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MetaUser>

    Parameters

    • requestParameters: UsersApiUsersPartialUpdateRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MetaUser>

    Throws

• usersRetrieve:function

  • usersRetrieve(
        requestParameters: UsersApiUsersRetrieveRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<MetaUser>

    Parameters

    • requestParameters: UsersApiUsersRetrieveRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MetaUser>

    Throws

• usersRetrieveSelf:function

  • usersRetrieveSelf(options?: RawAxiosRequestConfig): AxiosPromise<MetaUser>

    Method returns an instance of a user who is currently authenticated

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<MetaUser>

    Throws