Function UsersApiFactory

Returns {
    usersDestroy(requestParameters, options?) => AxiosPromise<void>;
    usersList(requestParameters?, options?) => AxiosPromise<PaginatedMetaUserList>;
    usersPartialUpdate(requestParameters, options?) => AxiosPromise<MetaUser>;
    usersRetrieve(requestParameters, options?) => AxiosPromise<MetaUser>;
    usersRetrieveSelf(options?) => AxiosPromise<MetaUser>;
}

• usersDestroy:function

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

  • Parameters

    • requestParameters: UsersApiUsersDestroyRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Method deletes a specific user from the server

    Throws

• usersList:function

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

  • Parameters

    • requestParameters: UsersApiUsersListRequest = {}

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<PaginatedMetaUserList>

    Summary

    Method returns a paginated list of users

    Throws

• usersPartialUpdate:function

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

  • Parameters

    • requestParameters: UsersApiUsersPartialUpdateRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MetaUser>

    Summary

    Method updates chosen fields of a user

    Throws

• usersRetrieve:function

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

  • Parameters

    • requestParameters: UsersApiUsersRetrieveRequest

      Request parameters.

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MetaUser>

    Summary

    Method provides information of a specific user

    Throws

• usersRetrieveSelf:function

  • usersRetrieveSelf(options?): AxiosPromise<MetaUser>

  • Method returns an instance of a user who is currently authorized

    Parameters

    • Optional options: AxiosRequestConfig<any>

      Override http request option.

    Returns AxiosPromise<MetaUser>

    Summary

    Method returns an instance of a user who is currently authorized

    Throws