Skip to content

Latest commit

 

History

History
177 lines (165 loc) · 32.3 KB

chat.md

File metadata and controls

177 lines (165 loc) · 32.3 KB

Chat Service Index

 

Operations

topic Wrapper: Topic

Endpoint Method ID Class Wrapper Example
/chat/admin/namespaces/{namespace}/chat/filter POST AdminFilterChatMessageShort AdminFilterChatMessageShort AdminFilterChatMessageShort AdminFilterChatMessageShort
/chat/admin/namespaces/{namespace}/chats GET AdminChatHistoryShort AdminChatHistoryShort AdminChatHistoryShort AdminChatHistoryShort
/chat/admin/namespaces/{namespace}/namespace-topic POST AdminCreateNamespaceTopicShort AdminCreateNamespaceTopicShort AdminCreateNamespaceTopicShort AdminCreateNamespaceTopicShort
/chat/admin/namespaces/{namespace}/topic GET AdminTopicListShort AdminTopicListShort AdminTopicListShort AdminTopicListShort
/chat/admin/namespaces/{namespace}/topic POST AdminCreateTopicShort AdminCreateTopicShort AdminCreateTopicShort AdminCreateTopicShort
/chat/admin/namespaces/{namespace}/topic/channel GET AdminChannelTopicListShort AdminChannelTopicListShort AdminChannelTopicListShort AdminChannelTopicListShort
/chat/admin/namespaces/{namespace}/topic/channel/summary GET AdminChannelTopicSummaryShort AdminChannelTopicSummaryShort AdminChannelTopicSummaryShort AdminChannelTopicSummaryShort
/chat/admin/namespaces/{namespace}/topic/log GET AdminQueryTopicLogShort AdminQueryTopicLogShort AdminQueryTopicLogShort AdminQueryTopicLogShort
/chat/admin/namespaces/{namespace}/topic/{topic} PUT AdminUpdateTopicShort AdminUpdateTopicShort AdminUpdateTopicShort AdminUpdateTopicShort
/chat/admin/namespaces/{namespace}/topic/{topic} DELETE AdminDeleteTopicShort AdminDeleteTopicShort AdminDeleteTopicShort AdminDeleteTopicShort
/chat/admin/namespaces/{namespace}/topic/{topic}/ban-members POST AdminBanTopicMembersShort AdminBanTopicMembersShort AdminBanTopicMembersShort AdminBanTopicMembersShort
/chat/admin/namespaces/{namespace}/topic/{topic}/channel GET AdminChannelTopicInfoShort AdminChannelTopicInfoShort AdminChannelTopicInfoShort AdminChannelTopicInfoShort
[DEPRECATED] /chat/admin/namespaces/{namespace}/topic/{topic}/chats GET AdminTopicChatHistoryShort AdminTopicChatHistoryShort AdminTopicChatHistoryShort AdminTopicChatHistoryShort
/chat/admin/namespaces/{namespace}/topic/{topic}/chats POST AdminSendChatShort AdminSendChatShort AdminSendChatShort AdminSendChatShort
/chat/admin/namespaces/{namespace}/topic/{topic}/chats/{chatId} DELETE AdminDeleteChatShort AdminDeleteChatShort AdminDeleteChatShort AdminDeleteChatShort
/chat/admin/namespaces/{namespace}/topic/{topic}/members GET AdminTopicMembersShort AdminTopicMembersShort AdminTopicMembersShort AdminTopicMembersShort
/chat/admin/namespaces/{namespace}/topic/{topic}/shards GET AdminTopicShardsShort AdminTopicShardsShort AdminTopicShardsShort AdminTopicShardsShort
/chat/admin/namespaces/{namespace}/topic/{topic}/unban-members POST AdminUnbanTopicMembersShort AdminUnbanTopicMembersShort AdminUnbanTopicMembersShort AdminUnbanTopicMembersShort
/chat/admin/namespaces/{namespace}/topic/{topic}/user/{userId} POST AdminAddTopicMemberShort AdminAddTopicMemberShort AdminAddTopicMemberShort AdminAddTopicMemberShort
/chat/admin/namespaces/{namespace}/topic/{topic}/user/{userId} DELETE AdminRemoveTopicMemberShort AdminRemoveTopicMemberShort AdminRemoveTopicMemberShort AdminRemoveTopicMemberShort
/chat/admin/namespaces/{namespace}/topics GET AdminQueryTopicShort AdminQueryTopicShort AdminQueryTopicShort AdminQueryTopicShort
/chat/admin/namespaces/{namespace}/users/{userId}/topics GET AdminQueryUsersTopicShort AdminQueryUsersTopicShort AdminQueryUsersTopicShort AdminQueryUsersTopicShort
/chat/public/namespaces/{namespace}/muted GET PublicGetMutedTopicsShort PublicGetMutedTopicsShort PublicGetMutedTopicsShort PublicGetMutedTopicsShort
/chat/public/namespaces/{namespace}/topic GET PublicTopicListShort PublicTopicListShort PublicTopicListShort PublicTopicListShort
/chat/public/namespaces/{namespace}/topic/{topic}/ban-members POST PublicBanTopicMembersShort PublicBanTopicMembersShort PublicBanTopicMembersShort PublicBanTopicMembersShort
/chat/public/namespaces/{namespace}/topic/{topic}/chats GET PublicChatHistoryShort PublicChatHistoryShort PublicChatHistoryShort PublicChatHistoryShort
/chat/public/namespaces/{namespace}/topic/{topic}/chats/{chatId} DELETE PublicDeleteChatShort PublicDeleteChatShort PublicDeleteChatShort PublicDeleteChatShort
/chat/public/namespaces/{namespace}/topic/{topic}/mute PUT PublicMuteUserShort PublicMuteUserShort PublicMuteUserShort PublicMuteUserShort
/chat/public/namespaces/{namespace}/topic/{topic}/unban-members POST PublicUnbanTopicMembersShort PublicUnbanTopicMembersShort PublicUnbanTopicMembersShort PublicUnbanTopicMembersShort
/chat/public/namespaces/{namespace}/topic/{topic}/unmute PUT PublicUnmuteUserShort PublicUnmuteUserShort PublicUnmuteUserShort PublicUnmuteUserShort

config Wrapper: Config

Endpoint Method ID Class Wrapper Example
/chat/v1/admin/config GET AdminGetAllConfigV1Short AdminGetAllConfigV1Short AdminGetAllConfigV1Short AdminGetAllConfigV1Short
/chat/v1/admin/config/log GET AdminGetLogConfigShort AdminGetLogConfigShort AdminGetLogConfigShort AdminGetLogConfigShort
/chat/v1/admin/config/log PATCH AdminPatchUpdateLogConfigShort AdminPatchUpdateLogConfigShort AdminPatchUpdateLogConfigShort AdminPatchUpdateLogConfigShort
/chat/v1/admin/config/namespaces/{namespace} GET AdminGetConfigV1Short AdminGetConfigV1Short AdminGetConfigV1Short AdminGetConfigV1Short
/chat/v1/admin/config/namespaces/{namespace} PUT AdminUpdateConfigV1Short AdminUpdateConfigV1Short AdminUpdateConfigV1Short AdminUpdateConfigV1Short
/chat/v1/admin/config/namespaces/{namespace}/export GET ExportConfigShort ExportConfigShort ExportConfigShort ExportConfigShort
/chat/v1/admin/config/namespaces/{namespace}/import POST ImportConfigShort ImportConfigShort ImportConfigShort ImportConfigShort
/chat/v1/public/config/namespaces/{namespace} GET PublicGetConfigV1Short PublicGetConfigV1Short PublicGetConfigV1Short PublicGetConfigV1Short

inbox Wrapper: Inbox

Endpoint Method ID Class Wrapper Example
/chat/v1/admin/inbox/namespaces/{namespace}/categories GET AdminGetInboxCategoriesShort AdminGetInboxCategoriesShort AdminGetInboxCategoriesShort AdminGetInboxCategoriesShort
/chat/v1/admin/inbox/namespaces/{namespace}/categories POST AdminAddInboxCategoryShort AdminAddInboxCategoryShort AdminAddInboxCategoryShort AdminAddInboxCategoryShort
/chat/v1/admin/inbox/namespaces/{namespace}/categories/{category} DELETE AdminDeleteInboxCategoryShort AdminDeleteInboxCategoryShort AdminDeleteInboxCategoryShort AdminDeleteInboxCategoryShort
/chat/v1/admin/inbox/namespaces/{namespace}/categories/{category} PATCH AdminUpdateInboxCategoryShort AdminUpdateInboxCategoryShort AdminUpdateInboxCategoryShort AdminUpdateInboxCategoryShort
/chat/v1/admin/inbox/namespaces/{namespace}/categories/{category}/schema.json GET AdminGetCategorySchemaShort AdminGetCategorySchemaShort AdminGetCategorySchemaShort AdminGetCategorySchemaShort
/chat/v1/admin/inbox/namespaces/{namespace}/message/{messageId} DELETE AdminDeleteInboxMessageShort AdminDeleteInboxMessageShort AdminDeleteInboxMessageShort AdminDeleteInboxMessageShort
/chat/v1/admin/inbox/namespaces/{namespace}/messages GET AdminGetInboxMessagesShort AdminGetInboxMessagesShort AdminGetInboxMessagesShort AdminGetInboxMessagesShort
/chat/v1/admin/inbox/namespaces/{namespace}/messages POST AdminSaveInboxMessageShort AdminSaveInboxMessageShort AdminSaveInboxMessageShort AdminSaveInboxMessageShort
/chat/v1/admin/inbox/namespaces/{namespace}/messages/{inbox}/unsend POST AdminUnsendInboxMessageShort AdminUnsendInboxMessageShort AdminUnsendInboxMessageShort AdminUnsendInboxMessageShort
/chat/v1/admin/inbox/namespaces/{namespace}/messages/{inbox}/users GET AdminGetInboxUsersShort AdminGetInboxUsersShort AdminGetInboxUsersShort AdminGetInboxUsersShort
/chat/v1/admin/inbox/namespaces/{namespace}/messages/{messageId} PATCH AdminUpdateInboxMessageShort AdminUpdateInboxMessageShort AdminUpdateInboxMessageShort AdminUpdateInboxMessageShort
/chat/v1/admin/inbox/namespaces/{namespace}/messages/{messageId}/send POST AdminSendInboxMessageShort AdminSendInboxMessageShort AdminSendInboxMessageShort AdminSendInboxMessageShort
/chat/v1/admin/inbox/namespaces/{namespace}/stats GET AdminGetInboxStatsShort AdminGetInboxStatsShort AdminGetInboxStatsShort AdminGetInboxStatsShort

moderation Wrapper: Moderation

Endpoint Method ID Class Wrapper Example
/chat/v1/admin/namespaces/{namespace}/snapshot/{chatId} GET AdminGetChatSnapshotShort AdminGetChatSnapshotShort AdminGetChatSnapshotShort AdminGetChatSnapshotShort
/chat/v1/admin/namespaces/{namespace}/snapshot/{chatId} DELETE AdminDeleteChatSnapshotShort AdminDeleteChatSnapshotShort AdminDeleteChatSnapshotShort AdminDeleteChatSnapshotShort
/chat/v1/public/namespaces/{namespace}/topic/{topic}/snapshot/{chatId} GET PublicGetChatSnapshotShort PublicGetChatSnapshotShort PublicGetChatSnapshotShort PublicGetChatSnapshotShort

profanity Wrapper: Profanity

Endpoint Method ID Class Wrapper Example
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary GET AdminProfanityQueryShort AdminProfanityQueryShort AdminProfanityQueryShort AdminProfanityQueryShort
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary POST AdminProfanityCreateShort AdminProfanityCreateShort AdminProfanityCreateShort AdminProfanityCreateShort
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/bulk POST AdminProfanityCreateBulkShort AdminProfanityCreateBulkShort AdminProfanityCreateBulkShort AdminProfanityCreateBulkShort
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/export GET AdminProfanityExportShort AdminProfanityExportShort AdminProfanityExportShort AdminProfanityExportShort
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/group GET AdminProfanityGroupShort AdminProfanityGroupShort AdminProfanityGroupShort AdminProfanityGroupShort
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/import POST AdminProfanityImportShort AdminProfanityImportShort AdminProfanityImportShort AdminProfanityImportShort
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/{id} PUT AdminProfanityUpdateShort AdminProfanityUpdateShort AdminProfanityUpdateShort AdminProfanityUpdateShort
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/{id} DELETE AdminProfanityDeleteShort AdminProfanityDeleteShort AdminProfanityDeleteShort AdminProfanityDeleteShort

Operations Wrapper: Operations

Endpoint Method ID Class Wrapper Example
/chat/v1/messages GET PublicGetMessagesShort PublicGetMessagesShort PublicGetMessagesShort PublicGetMessagesShort

 

Models

Model Struct Class
api.AddMemberParams ApiAddMemberParams
api.CreateNamespaceTopicParams ApiCreateNamespaceTopicParams
api.CreateTopicParams ApiCreateTopicParams
api.CreateTopicResponse ApiCreateTopicResponse
api.MuteUserRequest ApiMuteUserRequest
api.MutedTopicResponse ApiMutedTopicResponse
api.SendChatParams ApiSendChatParams
api.UnmuteUserRequest ApiUnmuteUserRequest
api.UpdateTopicParams ApiUpdateTopicParams
log.AppMessageDeclaration LogAppMessageDeclaration
logconfig.Configuration LogconfigConfiguration
message.ActionAddUserToTopicResult MessageActionAddUserToTopicResult
message.ActionDeleteTopicResult MessageActionDeleteTopicResult
models.AddInboxCategoryRequest ModelsAddInboxCategoryRequest
models.AddInboxCategoryResponse ModelsAddInboxCategoryResponse
models.BanTopicMemberParam ModelsBanTopicMemberParam
models.BanTopicMemberResult ModelsBanTopicMemberResult
models.CategoryHook ModelsCategoryHook
models.ChannelTopicResponse ModelsChannelTopicResponse
models.ChannelTopicSummaryResponse ModelsChannelTopicSummaryResponse
models.ChannelTopicWithPaginationResponse ModelsChannelTopicWithPaginationResponse
models.ChatMessageResponse ModelsChatMessageResponse
models.ChatMessageWithPaginationResponse ModelsChatMessageWithPaginationResponse
models.ChatSnapshotMessage ModelsChatSnapshotMessage
models.ChatSnapshots ModelsChatSnapshots
models.Config ModelsConfig
models.ConfigExport ModelsConfigExport
models.ConfigList ModelsConfigList
models.ConfigResponse ModelsConfigResponse
models.Dictionary ModelsDictionary
models.DictionaryChild ModelsDictionaryChild
models.DictionaryExport ModelsDictionaryExport
models.DictionaryExportItem ModelsDictionaryExportItem
models.DictionaryGroup ModelsDictionaryGroup
models.DictionaryImportResult ModelsDictionaryImportResult
models.DictionaryInsertBulkRequest ModelsDictionaryInsertBulkRequest
models.DictionaryInsertRequest ModelsDictionaryInsertRequest
models.DictionaryQueryResult ModelsDictionaryQueryResult
models.DictionaryUpdateRequest ModelsDictionaryUpdateRequest
models.DictionaryWithChildren ModelsDictionaryWithChildren
models.DictionaryWordChanges ModelsDictionaryWordChanges
models.GetInboxCategoriesResponseItem ModelsGetInboxCategoriesResponseItem
models.GetInboxMessagesResponse ModelsGetInboxMessagesResponse
models.GetInboxMessagesResponseData ModelsGetInboxMessagesResponseData
models.GetInboxStatsResponse ModelsGetInboxStatsResponse
models.GetInboxUsersResponse ModelsGetInboxUsersResponse
models.ImportConfigResponse ModelsImportConfigResponse
models.JSONSchemaType ModelsJSONSchemaType
models.MessageRequest ModelsMessageRequest
models.MessageResultWithAttributes ModelsMessageResultWithAttributes
models.MessageStats ModelsMessageStats
models.Pagination ModelsPagination
models.PublicBanTopicMembersRequest ModelsPublicBanTopicMembersRequest
models.PublicBanTopicMembersResponse ModelsPublicBanTopicMembersResponse
models.PublicConfigResponse ModelsPublicConfigResponse
models.PublicUnbanTopicMembersRequest ModelsPublicUnbanTopicMembersRequest
models.PublicUnbanTopicMembersResponse ModelsPublicUnbanTopicMembersResponse
models.SaveInboxMessageRequest ModelsSaveInboxMessageRequest
models.SaveInboxMessageResponse ModelsSaveInboxMessageResponse
models.SendInboxMessageRequest ModelsSendInboxMessageRequest
models.SendInboxMessageResponse ModelsSendInboxMessageResponse
models.TopicInfo ModelsTopicInfo
models.TopicLogItem ModelsTopicLogItem
models.TopicLogWithPaginationResponse ModelsTopicLogWithPaginationResponse
models.TopicMemberResponse ModelsTopicMemberResponse
models.TopicMemberWithPaginationResponse ModelsTopicMemberWithPaginationResponse
models.TopicResponse ModelsTopicResponse
models.UnbanTopicMemberParam ModelsUnbanTopicMemberParam
models.UnbanTopicMemberResult ModelsUnbanTopicMemberResult
models.UnsendInboxMessageRequest ModelsUnsendInboxMessageRequest
models.UnsendInboxMessageResponse ModelsUnsendInboxMessageResponse
models.UpdateInboxCategoryRequest ModelsUpdateInboxCategoryRequest
models.UpdateInboxMessageRequest ModelsUpdateInboxMessageRequest
models.UserInbox ModelsUserInbox
response.Error ResponseError
restapi.ErrorResponseBody RestapiErrorResponseBody
topic.InfoMember TopicInfoMember