@stream-io/node-sdk 0.1.0

package/dist/src/gen/chat/apis/UsersApi.d.ts

@@ -0,0 +1,313 @@
+/**
+ * Stream Chat API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v89.9.2
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { BanRequest, ConnectRequest, DeactivateUserRequest, DeactivateUserResponse, DeactivateUsersRequest, DeactivateUsersResponse, DeleteUserResponse, DeleteUsersRequest, DeleteUsersResponse, ExportUserResponse, ExportUsersRequest, ExportUsersResponse, FlagRequest, FlagResponse, GuestRequest, GuestResponse, MuteUserRequest, MuteUserResponse, QueryBannedUsersRequest, QueryBannedUsersResponse, QueryUsersRequest, ReactivateUserRequest, ReactivateUserResponse, ReactivateUsersRequest, ReactivateUsersResponse, Response, RestoreUsersRequest, UnmuteResponse, UnmuteUserRequest, UpdateUserPartialRequest, UpdateUsersRequest, UpdateUsersResponse, UsersResponse } from '../models';
+export interface BanOperationRequest {
+    banRequest: BanRequest | null;
+}
+export interface ConnectOperationRequest {
+    json?: ConnectRequest;
+}
+export interface CreateGuestRequest {
+    guestRequest: GuestRequest | null;
+}
+export interface DeactivateUserOperationRequest {
+    userId: string;
+    deactivateUserRequest: DeactivateUserRequest | null;
+}
+export interface DeactivateUsersOperationRequest {
+    deactivateUsersRequest: DeactivateUsersRequest | null;
+}
+export interface DeleteUserRequest {
+    userId: string;
+    markMessagesDeleted?: boolean;
+    hardDelete?: boolean;
+    deleteConversationChannels?: boolean;
+}
+export interface DeleteUsersOperationRequest {
+    deleteUsersRequest: DeleteUsersRequest | null;
+}
+export interface ExportUserRequest {
+    userId: string;
+}
+export interface ExportUsersOperationRequest {
+    exportUsersRequest: ExportUsersRequest | null;
+}
+export interface FlagOperationRequest {
+    flagRequest: FlagRequest | null;
+}
+export interface LongPollRequest {
+    json?: ConnectRequest;
+    connectionId?: string;
+}
+export interface MuteUserOperationRequest {
+    muteUserRequest: MuteUserRequest | null;
+}
+export interface QueryBannedUsersOperationRequest {
+    payload?: QueryBannedUsersRequest;
+}
+export interface QueryUsersOperationRequest {
+    payload?: QueryUsersRequest;
+}
+export interface ReactivateUserOperationRequest {
+    userId: string;
+    reactivateUserRequest: ReactivateUserRequest | null;
+}
+export interface ReactivateUsersOperationRequest {
+    reactivateUsersRequest: ReactivateUsersRequest | null;
+}
+export interface RestoreUsersOperationRequest {
+    restoreUsersRequest: RestoreUsersRequest | null;
+}
+export interface UnbanRequest {
+    targetUserId?: string;
+    type?: string;
+    id?: string;
+    createdBy?: string;
+}
+export interface UnflagRequest {
+    flagRequest: FlagRequest | null;
+}
+export interface UnmuteUserOperationRequest {
+    unmuteUserRequest: UnmuteUserRequest | null;
+}
+export interface UpdateUsersOperationRequest {
+    updateUsersRequest: UpdateUsersRequest | null;
+}
+export interface UpdateUsersPartialRequest {
+    updateUserPartialRequest: UpdateUserPartialRequest | null;
+}
+/**
+ *
+ */
+export declare class UsersApi extends runtime.BaseAPI {
+    /**
+     * Restricts user activity either in specific channel or globally  Sends events: - user.banned  Required permissions: - BanChannelMember - BanUser
+     * Ban user
+     */
+    banRaw(requestParameters: BanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
+    /**
+     * Restricts user activity either in specific channel or globally  Sends events: - user.banned  Required permissions: - BanChannelMember - BanUser
+     * Ban user
+     */
+    ban(requestParameters: BanOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
+    /**
+     * Establishes WebSocket connection for user  Sends events: - user.updated
+     * Connect (WebSocket)
+     */
+    connectRaw(requestParameters: ConnectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Establishes WebSocket connection for user  Sends events: - user.updated
+     * Connect (WebSocket)
+     */
+    connect(requestParameters?: ConnectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates guest user
+     * Create guest
+     */
+    createGuestRaw(requestParameters: CreateGuestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GuestResponse>>;
+    /**
+     * Creates guest user
+     * Create guest
+     */
+    createGuest(requestParameters: CreateGuestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GuestResponse>;
+    /**
+     * Deactivates user with possibility to activate it back  Sends events: - user.deactivated
+     * Deactivate user
+     */
+    deactivateUserRaw(requestParameters: DeactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeactivateUserResponse>>;
+    /**
+     * Deactivates user with possibility to activate it back  Sends events: - user.deactivated
+     * Deactivate user
+     */
+    deactivateUser(requestParameters: DeactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeactivateUserResponse>;
+    /**
+     * Deactivate users in batches  Sends events: - user.deactivated
+     * Deactivate users
+     */
+    deactivateUsersRaw(requestParameters: DeactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeactivateUsersResponse>>;
+    /**
+     * Deactivate users in batches  Sends events: - user.deactivated
+     * Deactivate users
+     */
+    deactivateUsers(requestParameters: DeactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeactivateUsersResponse>;
+    /**
+     * Deletes user and optionally all their belongings. The Endpoint is deprecated, please use \'Delete Users\' endpoint instead  Sends events: - channel.deleted - message.deleted - user.deleted
+     * Delete user
+     */
+    deleteUserRaw(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteUserResponse>>;
+    /**
+     * Deletes user and optionally all their belongings. The Endpoint is deprecated, please use \'Delete Users\' endpoint instead  Sends events: - channel.deleted - message.deleted - user.deleted
+     * Delete user
+     */
+    deleteUser(requestParameters: DeleteUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteUserResponse>;
+    /**
+     * Deletes users and optionally all their belongings asynchronously.  Sends events: - channel.deleted - user.deleted
+     * Delete Users
+     */
+    deleteUsersRaw(requestParameters: DeleteUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteUsersResponse>>;
+    /**
+     * Deletes users and optionally all their belongings asynchronously.  Sends events: - channel.deleted - user.deleted
+     * Delete Users
+     */
+    deleteUsers(requestParameters: DeleteUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteUsersResponse>;
+    /**
+     * Exports the user\'s profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions
+     * Export user
+     */
+    exportUserRaw(requestParameters: ExportUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExportUserResponse>>;
+    /**
+     * Exports the user\'s profile, reactions and messages. Raises an error if a user has more than 10k messages or reactions
+     * Export user
+     */
+    exportUser(requestParameters: ExportUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExportUserResponse>;
+    /**
+     * Exports user profile, reactions and messages for list of given users
+     * Export users
+     */
+    exportUsersRaw(requestParameters: ExportUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExportUsersResponse>>;
+    /**
+     * Exports user profile, reactions and messages for list of given users
+     * Export users
+     */
+    exportUsers(requestParameters: ExportUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExportUsersResponse>;
+    /**
+     * Reports message or user for review by moderators  Sends events: - message.flagged - user.flagged  Required permissions: - FlagMessage - FlagUser
+     * Flag
+     */
+    flagRaw(requestParameters: FlagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlagResponse>>;
+    /**
+     * Reports message or user for review by moderators  Sends events: - message.flagged - user.flagged  Required permissions: - FlagMessage - FlagUser
+     * Flag
+     */
+    flag(requestParameters: FlagOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlagResponse>;
+    /**
+     * WebSocket fallback transport endpoint  Sends events: - user.updated
+     * Long Poll (Transport)
+     */
+    longPollRaw(requestParameters: LongPollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * WebSocket fallback transport endpoint  Sends events: - user.updated
+     * Long Poll (Transport)
+     */
+    longPoll(requestParameters?: LongPollRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Mutes one or several users  Sends events: - user.muted  Required permissions: - MuteUser
+     * Mute user
+     */
+    muteUserRaw(requestParameters: MuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MuteUserResponse>>;
+    /**
+     * Mutes one or several users  Sends events: - user.muted  Required permissions: - MuteUser
+     * Mute user
+     */
+    muteUser(requestParameters: MuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MuteUserResponse>;
+    /**
+     * Find and filter channel scoped or global user bans  Required permissions: - ReadChannel
+     * Query Banned Users
+     */
+    queryBannedUsersRaw(requestParameters: QueryBannedUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<QueryBannedUsersResponse>>;
+    /**
+     * Find and filter channel scoped or global user bans  Required permissions: - ReadChannel
+     * Query Banned Users
+     */
+    queryBannedUsers(requestParameters?: QueryBannedUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<QueryBannedUsersResponse>;
+    /**
+     * Find and filter users  Required permissions: - SearchUser
+     * Query users
+     */
+    queryUsersRaw(requestParameters: QueryUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UsersResponse>>;
+    /**
+     * Find and filter users  Required permissions: - SearchUser
+     * Query users
+     */
+    queryUsers(requestParameters?: QueryUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UsersResponse>;
+    /**
+     * Activates user who\'s been deactivated previously  Sends events: - user.reactivated
+     * Reactivate user
+     */
+    reactivateUserRaw(requestParameters: ReactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReactivateUserResponse>>;
+    /**
+     * Activates user who\'s been deactivated previously  Sends events: - user.reactivated
+     * Reactivate user
+     */
+    reactivateUser(requestParameters: ReactivateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReactivateUserResponse>;
+    /**
+     * Reactivate users in batches  Sends events: - user.reactivated
+     * Reactivate users
+     */
+    reactivateUsersRaw(requestParameters: ReactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReactivateUsersResponse>>;
+    /**
+     * Reactivate users in batches  Sends events: - user.reactivated
+     * Reactivate users
+     */
+    reactivateUsers(requestParameters: ReactivateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReactivateUsersResponse>;
+    /**
+     * Restore soft deleted users
+     * Restore users
+     */
+    restoreUsersRaw(requestParameters: RestoreUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
+    /**
+     * Restore soft deleted users
+     * Restore users
+     */
+    restoreUsers(requestParameters: RestoreUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
+    /**
+     * Removes previously applied ban  Sends events: - user.unbanned  Required permissions: - BanChannelMember - BanUser
+     * Unban user
+     */
+    unbanRaw(requestParameters: UnbanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Response>>;
+    /**
+     * Removes previously applied ban  Sends events: - user.unbanned  Required permissions: - BanChannelMember - BanUser
+     * Unban user
+     */
+    unban(requestParameters?: UnbanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Response>;
+    /**
+     * Removes previously created user or message flag  Required permissions: - FlagMessage - FlagUser
+     * Unflag
+     */
+    unflagRaw(requestParameters: UnflagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FlagResponse>>;
+    /**
+     * Removes previously created user or message flag  Required permissions: - FlagMessage - FlagUser
+     * Unflag
+     */
+    unflag(requestParameters: UnflagRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FlagResponse>;
+    /**
+     * Unmutes previously muted user  Sends events: - user.unmuted  Required permissions: - MuteUser
+     * Unmute user
+     */
+    unmuteUserRaw(requestParameters: UnmuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UnmuteResponse>>;
+    /**
+     * Unmutes previously muted user  Sends events: - user.unmuted  Required permissions: - MuteUser
+     * Unmute user
+     */
+    unmuteUser(requestParameters: UnmuteUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UnmuteResponse>;
+    /**
+     * Update or create users in bulk  Sends events: - user.updated
+     * Upsert users
+     */
+    updateUsersRaw(requestParameters: UpdateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateUsersResponse>>;
+    /**
+     * Update or create users in bulk  Sends events: - user.updated
+     * Upsert users
+     */
+    updateUsers(requestParameters: UpdateUsersOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateUsersResponse>;
+    /**
+     * Updates certain fields of the user  Sends events: - user.presence.changed - user.updated
+     * Partially update user
+     */
+    updateUsersPartialRaw(requestParameters: UpdateUsersPartialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateUsersResponse>>;
+    /**
+     * Updates certain fields of the user  Sends events: - user.presence.changed - user.updated
+     * Partially update user
+     */
+    updateUsersPartial(requestParameters: UpdateUsersPartialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateUsersResponse>;
+}

package/dist/src/gen/chat/apis/index.d.ts

@@ -0,0 +1,19 @@
+export * from './ChannelTypesApi';
+export * from './ChannelsApi';
+export * from './CustomCommandsApi';
+export * from './DefaultApi';
+export * from './DevicesApi';
+export * from './EventsApi';
+export * from './FilesApi';
+export * from './GDPRApi';
+export * from './ImportsApi';
+export * from './MessagesApi';
+export * from './ModerationApi';
+export * from './PermissionsV2Api';
+export * from './PushApi';
+export * from './ReactionsApi';
+export * from './ServerSideApi';
+export * from './SettingsApi';
+export * from './TasksApi';
+export * from './TestingApi';
+export * from './UsersApi';

package/dist/src/gen/chat/index.d.ts

@@ -0,0 +1,3 @@
+export * from './runtime';
+export * from './apis';
+export * from './models';