chatkitty

# ChannelsApi All URIs are relative to *https://api.chatkitty.com* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**addChannelMember**](#addchannelmember) | **POST** /channels/{id}/members | Add a channel member| |[**addChannelModerator**](#addchannelmoderator) | **POST** /channels/{id}/moderators | Add a channel moderator| |[**createChannel**](#createchannel) | **POST** /channels | Create a channel| |[**deleteChannel**](#deletechannel) | **DELETE** /channels/{id} | Delete a channel| |[**listChannelInvites**](#listchannelinvites) | **GET** /channels/{id}/invites | List channel invites| |[**listChannelMembers**](#listchannelmembers) | **GET** /channels/{id}/members | List a channel\'s members| |[**listChannelMemberships**](#listchannelmemberships) | **GET** /channels/{id}/memberships | List channel memberships| |[**listChannelMessages**](#listchannelmessages) | **GET** /channels/{id}/messages | List channel messages| |[**listChannelModerators**](#listchannelmoderators) | **GET** /channels/{id}/moderators | Lists a channel\'s moderators| |[**listChannelParticipants**](#listchannelparticipants) | **GET** /channels/{id}/participants | List channel participants| |[**listChannelReportedMessages**](#listchannelreportedmessages) | **GET** /channels/{id}/reported-messages | List channel reported messages| |[**listChannels**](#listchannels) | **GET** /channels | List channels| |[**removeChannelMember**](#removechannelmember) | **DELETE** /channels/{id}/members/{user_id} | Remove a channel member| |[**removeChannelModerator**](#removechannelmoderator) | **DELETE** /channels/{id}/moderators/{user_id} | Remove a channel moderator| |[**retrieveChannel**](#retrievechannel) | **GET** /channels/{id} | Retrieve a channel| |[**sendChannelEvent**](#sendchannelevent) | **POST** /channels/{id}/events | Send a channel event| |[**sendChannelInvite**](#sendchannelinvite) | **POST** /channels/{id}/invites | Send a channel invite| |[**sendChannelKeystrokes**](#sendchannelkeystrokes) | **POST** /channels/{id}/keystrokes | Send channel keystrokes| |[**sendChannelMessage**](#sendchannelmessage) | **POST** /channels/{id}/messages | Send a channel message| |[**updateChannel**](#updatechannel) | **PATCH** /channels/{id} | Update a channel| # **addChannelMember** > ChannelResource addChannelMember(body) Makes a user a group channel member ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let body: object; // const { status, data } = await apiInstance.addChannelMember( id, body ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **body** | **object**| | | | **id** | [**number**] | Channel ID | defaults to undefined| ### Return type **ChannelResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: application/vnd.chatkitty+json - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **addChannelModerator** > ChatUserResource addChannelModerator(body) Makes a user a group channel moderator ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let body: object; // const { status, data } = await apiInstance.addChannelModerator( id, body ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **body** | **object**| | | | **id** | [**number**] | Channel ID | defaults to undefined| ### Return type **ChatUserResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: application/vnd.chatkitty+json - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **createChannel** > ChannelResource createChannel(createChannelResource) Creates a new channel or returns an equivalent existing channel ### Example ```typescript import { ChannelsApi, Configuration, CreateChannelResource } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let createChannelResource: CreateChannelResource; // const { status, data } = await apiInstance.createChannel( createChannelResource ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **createChannelResource** | **CreateChannelResource**| | | ### Return type **ChannelResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: application/vnd.chatkitty+json - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **deleteChannel** > ApplicationResource deleteChannel() Deletes a channel by ID ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) const { status, data } = await apiInstance.deleteChannel( id ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| ### Return type **ApplicationResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **listChannelInvites** > PagedModelChannelInviteResource listChannelInvites() Returns a page of invites sent to join this channel ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let page: number; //Zero-based page index (0..N) (optional) (default to 0) let size: number; //The size of the page to be returned (optional) (default to 25) let sort: Array<string>; //Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) (default to undefined) const { status, data } = await apiInstance.listChannelInvites( id, page, size, sort ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| | **page** | [**number**] | Zero-based page index (0..N) | (optional) defaults to 0| | **size** | [**number**] | The size of the page to be returned | (optional) defaults to 25| | **sort** | **Array<string>** | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | (optional) defaults to undefined| ### Return type **PagedModelChannelInviteResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **listChannelMembers** > PagedModelChatUserResource listChannelMembers() Returns a page of channel members ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let page: number; //Zero-based page index (0..N) (optional) (default to 0) let size: number; //The size of the page to be returned (optional) (default to 25) let sort: Array<string>; //Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) (default to undefined) const { status, data } = await apiInstance.listChannelMembers( id, page, size, sort ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| | **page** | [**number**] | Zero-based page index (0..N) | (optional) defaults to 0| | **size** | [**number**] | The size of the page to be returned | (optional) defaults to 25| | **sort** | **Array<string>** | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | (optional) defaults to undefined| ### Return type **PagedModelChatUserResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **listChannelMemberships** > PagedModelChannelMembershipResource listChannelMemberships() Returns a page of channel membership info for this channel ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let page: number; //Zero-based page index (0..N) (optional) (default to 0) let size: number; //The size of the page to be returned (optional) (default to 25) let sort: Array<string>; //Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) (default to undefined) const { status, data } = await apiInstance.listChannelMemberships( id, page, size, sort ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| | **page** | [**number**] | Zero-based page index (0..N) | (optional) defaults to 0| | **size** | [**number**] | The size of the page to be returned | (optional) defaults to 25| | **sort** | **Array<string>** | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | (optional) defaults to undefined| ### Return type **PagedModelChannelMembershipResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **listChannelMessages** > CursorPagedModelMessageResource listChannelMessages() Returns a page of messages sent in this channel ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let size: number; //The size of the page to be returned (optional) (default to undefined) let start: number; //Start cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages (optional) (default to undefined) let next: number; //Next page cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch subsequent pages (optional) (default to undefined) let relation: 'SELF' | 'PREVIOUS' | 'NEXT'; //Page cursor relation. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages (optional) (default to undefined) let username: string; // (optional) (default to undefined) let query: string; // (optional) (default to undefined) const { status, data } = await apiInstance.listChannelMessages( id, size, start, next, relation, username, query ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| | **size** | [**number**] | The size of the page to be returned | (optional) defaults to undefined| | **start** | [**number**] | Start cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages | (optional) defaults to undefined| | **next** | [**number**] | Next page cursor value. Do not set manually. Provided by the Platform API pagination engine to fetch subsequent pages | (optional) defaults to undefined| | **relation** | [**'SELF' | 'PREVIOUS' | 'NEXT'**]**Array<'SELF' | 'PREVIOUS' | 'NEXT'>** | Page cursor relation. Do not set manually. Provided by the Platform API pagination engine to fetch previous or next pages | (optional) defaults to undefined| | **username** | [**string**] | | (optional) defaults to undefined| | **query** | [**string**] | | (optional) defaults to undefined| ### Return type **CursorPagedModelMessageResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **listChannelModerators** > PagedModelChatUserResource listChannelModerators() Returns a page of channel moderators ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let page: number; //Zero-based page index (0..N) (optional) (default to 0) let size: number; //The size of the page to be returned (optional) (default to 25) let sort: Array<string>; //Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) (default to undefined) const { status, data } = await apiInstance.listChannelModerators( id, page, size, sort ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| | **page** | [**number**] | Zero-based page index (0..N) | (optional) defaults to 0| | **size** | [**number**] | The size of the page to be returned | (optional) defaults to 25| | **sort** | **Array<string>** | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | (optional) defaults to undefined| ### Return type **PagedModelChatUserResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **listChannelParticipants** > PagedModelChatUserResource listChannelParticipants() Returns a page of channel active participants: members that currently online ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let page: number; //Zero-based page index (0..N) (optional) (default to 0) let size: number; //The size of the page to be returned (optional) (default to 25) let sort: Array<string>; //Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) (default to undefined) const { status, data } = await apiInstance.listChannelParticipants( id, page, size, sort ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| | **page** | [**number**] | Zero-based page index (0..N) | (optional) defaults to 0| | **size** | [**number**] | The size of the page to be returned | (optional) defaults to 25| | **sort** | **Array<string>** | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | (optional) defaults to undefined| ### Return type **PagedModelChatUserResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **listChannelReportedMessages** > PagedModelMessageResource listChannelReportedMessages() Returns a page of reported messages in this channel ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let page: number; //Zero-based page index (0..N) (optional) (default to 0) let size: number; //The size of the page to be returned (optional) (default to 25) let sort: Array<string>; //Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) (default to undefined) const { status, data } = await apiInstance.listChannelReportedMessages( id, page, size, sort ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| | **page** | [**number**] | Zero-based page index (0..N) | (optional) defaults to 0| | **size** | [**number**] | The size of the page to be returned | (optional) defaults to 25| | **sort** | **Array<string>** | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | (optional) defaults to undefined| ### Return type **PagedModelMessageResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **listChannels** > PagedModelChannelResource listChannels() Returns a page of channels belonging to this application ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let page: number; //Zero-based page index (0..N) (optional) (default to 0) let size: number; //The size of the page to be returned (optional) (default to 25) let sort: Array<string>; //Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional) (default to undefined) let type: 'DIRECT' | 'PUBLIC' | 'PRIVATE'; //Filters by channel type (optional) (default to undefined) let members: Set<string>; //Filters by channel members using their usernames (optional) (default to undefined) let startTime: string; //Filters for channels created within a time range: start time (optional) (default to undefined) let endTime: string; //Filters for channels created within a time range: end time (optional) (default to undefined) let properties: string; //Filters by channel custom properties (optional) (default to undefined) const { status, data } = await apiInstance.listChannels( page, size, sort, type, members, startTime, endTime, properties ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **page** | [**number**] | Zero-based page index (0..N) | (optional) defaults to 0| | **size** | [**number**] | The size of the page to be returned | (optional) defaults to 25| | **sort** | **Array<string>** | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. | (optional) defaults to undefined| | **type** | [**'DIRECT' | 'PUBLIC' | 'PRIVATE'**]**Array<'DIRECT' | 'PUBLIC' | 'PRIVATE'>** | Filters by channel type | (optional) defaults to undefined| | **members** | **Set<string>** | Filters by channel members using their usernames | (optional) defaults to undefined| | **startTime** | [**string**] | Filters for channels created within a time range: start time | (optional) defaults to undefined| | **endTime** | [**string**] | Filters for channels created within a time range: end time | (optional) defaults to undefined| | **properties** | [**string**] | Filters by channel custom properties | (optional) defaults to undefined| ### Return type **PagedModelChannelResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **removeChannelMember** > ChannelResource removeChannelMember() Removes a member from a group channel ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let userId: number; //User ID of member to be removed (default to undefined) const { status, data } = await apiInstance.removeChannelMember( id, userId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| | **userId** | [**number**] | User ID of member to be removed | defaults to undefined| ### Return type **ChannelResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **removeChannelModerator** > ChannelResource removeChannelModerator() Removes a moderator from a group channel ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let userId: number; //User ID of moderator to be removed (default to undefined) const { status, data } = await apiInstance.removeChannelModerator( id, userId ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| | **userId** | [**number**] | User ID of moderator to be removed | defaults to undefined| ### Return type **ChannelResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **retrieveChannel** > ChannelResource retrieveChannel() Returns a channel by ID ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) const { status, data } = await apiInstance.retrieveChannel( id ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **id** | [**number**] | Channel ID | defaults to undefined| ### Return type **ChannelResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **sendChannelEvent** > ChannelGenericEventResource sendChannelEvent(createChannelGenericEventResource) Sends a custom channel event ### Example ```typescript import { ChannelsApi, Configuration, CreateChannelGenericEventResource } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let createChannelGenericEventResource: CreateChannelGenericEventResource; // const { status, data } = await apiInstance.sendChannelEvent( id, createChannelGenericEventResource ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **createChannelGenericEventResource** | **CreateChannelGenericEventResource**| | | | **id** | [**number**] | Channel ID | defaults to undefined| ### Return type **ChannelGenericEventResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: application/vnd.chatkitty+json - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **sendChannelInvite** > ChannelInviteResource sendChannelInvite(createChannelInviteResource) Sends a channel invite to user ### Example ```typescript import { ChannelsApi, Configuration, CreateChannelInviteResource } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let createChannelInviteResource: CreateChannelInviteResource; // const { status, data } = await apiInstance.sendChannelInvite( id, createChannelInviteResource ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **createChannelInviteResource** | **CreateChannelInviteResource**| | | | **id** | [**number**] | Channel ID | defaults to undefined| ### Return type **ChannelInviteResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: application/vnd.chatkitty+json - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **sendChannelKeystrokes** > ReplyThreadKeystrokesResource sendChannelKeystrokes(createDelegatedReplyThreadKeystrokesResource) Sends keystrokes in this channel on behalf of a user ### Example ```typescript import { ChannelsApi, Configuration, CreateDelegatedReplyThreadKeystrokesResource } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; // (default to undefined) let createDelegatedReplyThreadKeystrokesResource: CreateDelegatedReplyThreadKeystrokesResource; // const { status, data } = await apiInstance.sendChannelKeystrokes( id, createDelegatedReplyThreadKeystrokesResource ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **createDelegatedReplyThreadKeystrokesResource** | **CreateDelegatedReplyThreadKeystrokesResource**| | | | **id** | [**number**] | | defaults to undefined| ### Return type **ReplyThreadKeystrokesResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **sendChannelMessage** > MessageResource sendChannelMessage(createMessageResource) Sends a message in this channel as the system or on behalf of a user ### Example ```typescript import { ChannelsApi, Configuration, CreateMessageResource } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let createMessageResource: CreateMessageResource; // const { status, data } = await apiInstance.sendChannelMessage( id, createMessageResource ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **createMessageResource** | **CreateMessageResource**| | | | **id** | [**number**] | Channel ID | defaults to undefined| ### Return type **MessageResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: application/json, multipart/form-data - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **updateChannel** > ChannelResource updateChannel() Updates a channel properties ### Example ```typescript import { ChannelsApi, Configuration } from 'chatkitty'; const configuration = new Configuration(); const apiInstance = new ChannelsApi(configuration); let id: number; //Channel ID (default to undefined) let body: object; // (optional) const { status, data } = await apiInstance.updateChannel( id, body ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **body** | **object**| | | | **id** | [**number**] | Channel ID | defaults to undefined| ### Return type **ChannelResource** ### Authorization [application_authorization](../README.md#application_authorization) ### HTTP request headers - **Content-Type**: application/json+merge-patch - **Accept**: application/json, application/vnd.chatkitty+json, application/vnd.chatkitty.v1+json, application/vnd.hal+json, application/hal+json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**404** | Resource not found | - | |**403** | Access is denied | - | |**400** | Client error | - | |**401** | Unauthorized: Full authentication is required to access this resource | - | |**200** | OK | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)