Skip to content

Latest commit

 

History

History
177 lines (165 loc) · 32.5 KB

File metadata and controls

177 lines (165 loc) · 32.5 KB

Chat Service Index

 

Operations

topic Wrapper: Topic

Endpoint Method ID Class Example
/chat/admin/namespaces/{namespace}/chat/filter POST AdminFilterChatMessage AdminFilterChatMessage AdminFilterChatMessage
/chat/admin/namespaces/{namespace}/chats GET AdminChatHistory AdminChatHistory AdminChatHistory
/chat/admin/namespaces/{namespace}/namespace-topic POST AdminCreateNamespaceTopic AdminCreateNamespaceTopic AdminCreateNamespaceTopic
/chat/admin/namespaces/{namespace}/topic GET AdminTopicList AdminTopicList AdminTopicList
/chat/admin/namespaces/{namespace}/topic POST AdminCreateTopic AdminCreateTopic AdminCreateTopic
/chat/admin/namespaces/{namespace}/topic/channel GET AdminChannelTopicList AdminChannelTopicList AdminChannelTopicList
/chat/admin/namespaces/{namespace}/topic/channel/summary GET AdminChannelTopicSummary AdminChannelTopicSummary AdminChannelTopicSummary
/chat/admin/namespaces/{namespace}/topic/log GET AdminQueryTopicLog AdminQueryTopicLog AdminQueryTopicLog
/chat/admin/namespaces/{namespace}/topic/{topic} PUT AdminUpdateTopic AdminUpdateTopic AdminUpdateTopic
/chat/admin/namespaces/{namespace}/topic/{topic} DELETE AdminDeleteTopic AdminDeleteTopic AdminDeleteTopic
/chat/admin/namespaces/{namespace}/topic/{topic}/ban-members POST AdminBanTopicMembers AdminBanTopicMembers AdminBanTopicMembers
/chat/admin/namespaces/{namespace}/topic/{topic}/channel GET AdminChannelTopicInfo AdminChannelTopicInfo AdminChannelTopicInfo
[DEPRECATED] /chat/admin/namespaces/{namespace}/topic/{topic}/chats GET AdminTopicChatHistory AdminTopicChatHistory AdminTopicChatHistory
/chat/admin/namespaces/{namespace}/topic/{topic}/chats POST AdminSendChat AdminSendChat AdminSendChat
/chat/admin/namespaces/{namespace}/topic/{topic}/chats/{chatId} DELETE AdminDeleteChat AdminDeleteChat AdminDeleteChat
/chat/admin/namespaces/{namespace}/topic/{topic}/members GET AdminTopicMembers AdminTopicMembers AdminTopicMembers
/chat/admin/namespaces/{namespace}/topic/{topic}/shards GET AdminTopicShards AdminTopicShards AdminTopicShards
/chat/admin/namespaces/{namespace}/topic/{topic}/unban-members POST AdminUnbanTopicMembers AdminUnbanTopicMembers AdminUnbanTopicMembers
/chat/admin/namespaces/{namespace}/topic/{topic}/user/{userId} POST AdminAddTopicMember AdminAddTopicMember AdminAddTopicMember
/chat/admin/namespaces/{namespace}/topic/{topic}/user/{userId} DELETE AdminRemoveTopicMember AdminRemoveTopicMember AdminRemoveTopicMember
/chat/admin/namespaces/{namespace}/topics GET AdminQueryTopic AdminQueryTopic AdminQueryTopic
/chat/admin/namespaces/{namespace}/users/{userId}/topics GET AdminQueryUsersTopic AdminQueryUsersTopic AdminQueryUsersTopic
/chat/public/namespaces/{namespace}/muted GET PublicGetMutedTopics PublicGetMutedTopics PublicGetMutedTopics
/chat/public/namespaces/{namespace}/topic GET PublicTopicList PublicTopicList PublicTopicList
/chat/public/namespaces/{namespace}/topic/{topic}/ban-members POST PublicBanTopicMembers PublicBanTopicMembers PublicBanTopicMembers
/chat/public/namespaces/{namespace}/topic/{topic}/chats GET PublicChatHistory PublicChatHistory PublicChatHistory
/chat/public/namespaces/{namespace}/topic/{topic}/chats/{chatId} DELETE PublicDeleteChat PublicDeleteChat PublicDeleteChat
/chat/public/namespaces/{namespace}/topic/{topic}/mute PUT PublicMuteUser PublicMuteUser PublicMuteUser
/chat/public/namespaces/{namespace}/topic/{topic}/unban-members POST PublicUnbanTopicMembers PublicUnbanTopicMembers PublicUnbanTopicMembers
/chat/public/namespaces/{namespace}/topic/{topic}/unmute PUT PublicUnmuteUser PublicUnmuteUser PublicUnmuteUser

config Wrapper: Config

Endpoint Method ID Class Example
/chat/v1/admin/config GET AdminGetAllConfigV1 AdminGetAllConfigV1 AdminGetAllConfigV1
/chat/v1/admin/config/log GET AdminGetLogConfig AdminGetLogConfig AdminGetLogConfig
/chat/v1/admin/config/log PATCH AdminPatchUpdateLogConfig AdminPatchUpdateLogConfig AdminPatchUpdateLogConfig
/chat/v1/admin/config/namespaces/{namespace} GET AdminGetConfigV1 AdminGetConfigV1 AdminGetConfigV1
/chat/v1/admin/config/namespaces/{namespace} PUT AdminUpdateConfigV1 AdminUpdateConfigV1 AdminUpdateConfigV1
/chat/v1/admin/config/namespaces/{namespace}/export GET ExportConfig ExportConfig ExportConfig
/chat/v1/admin/config/namespaces/{namespace}/import POST ImportConfig ImportConfig ImportConfig
/chat/v1/public/config/namespaces/{namespace} GET PublicGetConfigV1 PublicGetConfigV1 PublicGetConfigV1

inbox Wrapper: Inbox

Endpoint Method ID Class Example
/chat/v1/admin/inbox/namespaces/{namespace}/categories GET AdminGetInboxCategories AdminGetInboxCategories AdminGetInboxCategories
/chat/v1/admin/inbox/namespaces/{namespace}/categories POST AdminAddInboxCategory AdminAddInboxCategory AdminAddInboxCategory
/chat/v1/admin/inbox/namespaces/{namespace}/categories/{category} DELETE AdminDeleteInboxCategory AdminDeleteInboxCategory AdminDeleteInboxCategory
/chat/v1/admin/inbox/namespaces/{namespace}/categories/{category} PATCH AdminUpdateInboxCategory AdminUpdateInboxCategory AdminUpdateInboxCategory
/chat/v1/admin/inbox/namespaces/{namespace}/categories/{category}/schema.json GET AdminGetCategorySchema AdminGetCategorySchema AdminGetCategorySchema
/chat/v1/admin/inbox/namespaces/{namespace}/message/{messageId} DELETE AdminDeleteInboxMessage AdminDeleteInboxMessage AdminDeleteInboxMessage
/chat/v1/admin/inbox/namespaces/{namespace}/messages GET AdminGetInboxMessages AdminGetInboxMessages AdminGetInboxMessages
/chat/v1/admin/inbox/namespaces/{namespace}/messages POST AdminSaveInboxMessage AdminSaveInboxMessage AdminSaveInboxMessage
/chat/v1/admin/inbox/namespaces/{namespace}/messages/{inbox}/unsend POST AdminUnsendInboxMessage AdminUnsendInboxMessage AdminUnsendInboxMessage
/chat/v1/admin/inbox/namespaces/{namespace}/messages/{inbox}/users GET AdminGetInboxUsers AdminGetInboxUsers AdminGetInboxUsers
/chat/v1/admin/inbox/namespaces/{namespace}/messages/{messageId} PATCH AdminUpdateInboxMessage AdminUpdateInboxMessage AdminUpdateInboxMessage
/chat/v1/admin/inbox/namespaces/{namespace}/messages/{messageId}/send POST AdminSendInboxMessage AdminSendInboxMessage AdminSendInboxMessage
/chat/v1/admin/inbox/namespaces/{namespace}/stats GET AdminGetInboxStats AdminGetInboxStats AdminGetInboxStats

moderation Wrapper: Moderation

Endpoint Method ID Class Example
/chat/v1/admin/namespaces/{namespace}/snapshot/{chatId} GET AdminGetChatSnapshot AdminGetChatSnapshot AdminGetChatSnapshot
/chat/v1/admin/namespaces/{namespace}/snapshot/{chatId} DELETE AdminDeleteChatSnapshot AdminDeleteChatSnapshot AdminDeleteChatSnapshot
/chat/v1/public/namespaces/{namespace}/topic/{topic}/snapshot/{chatId} GET PublicGetChatSnapshot PublicGetChatSnapshot PublicGetChatSnapshot

profanity Wrapper: Profanity

Endpoint Method ID Class Example
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary GET AdminProfanityQuery AdminProfanityQuery AdminProfanityQuery
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary POST AdminProfanityCreate AdminProfanityCreate AdminProfanityCreate
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/bulk POST AdminProfanityCreateBulk AdminProfanityCreateBulk AdminProfanityCreateBulk
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/export GET AdminProfanityExport AdminProfanityExport AdminProfanityExport
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/group GET AdminProfanityGroup AdminProfanityGroup AdminProfanityGroup
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/import POST AdminProfanityImport AdminProfanityImport AdminProfanityImport
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/{id} PUT AdminProfanityUpdate AdminProfanityUpdate AdminProfanityUpdate
/chat/v1/admin/profanity/namespaces/{namespace}/dictionary/{id} DELETE AdminProfanityDelete AdminProfanityDelete AdminProfanityDelete

Operations Wrapper: Operations

Endpoint Method ID Class Example
/chat/v1/messages GET PublicGetMessages PublicGetMessages PublicGetMessages

 

Models

Model 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