Function UsersApiAxiosParamCreator

UsersApi - axios parameter creator

Export

  • UsersApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        usersDestroy: (
            id: number,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        usersList: (
            xOrganization?: string,
            filter?: string,
            firstName?: string,
            isActive?: boolean,
            lastName?: string,
            org?: string,
            orgId?: number,
            page?: number,
            pageSize?: number,
            search?: string,
            sort?: string,
            username?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        usersPartialUpdate: (
            id: number,
            patchedUserRequest?: PatchedUserRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        usersRetrieve: (
            id: number,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        usersRetrieveSelf: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    Parameters

    Returns {
        usersDestroy: (
            id: number,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        usersList: (
            xOrganization?: string,
            filter?: string,
            firstName?: string,
            isActive?: boolean,
            lastName?: string,
            org?: string,
            orgId?: number,
            page?: number,
            pageSize?: number,
            search?: string,
            sort?: string,
            username?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        usersPartialUpdate: (
            id: number,
            patchedUserRequest?: PatchedUserRequest,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        usersRetrieve: (
            id: number,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        usersRetrieveSelf: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • usersDestroy: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

    • usersList: (
          xOrganization?: string,
          filter?: string,
          firstName?: string,
          isActive?: boolean,
          lastName?: string,
          org?: string,
          orgId?: number,
          page?: number,
          pageSize?: number,
          search?: string,
          sort?: string,
          username?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • usersPartialUpdate: (
          id: number,
          patchedUserRequest?: PatchedUserRequest,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

    • usersRetrieve: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

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

      Method returns an instance of a user who is currently authenticated

      Throws

Settings

Member Visibility