@sendbird/sendbird-platform-sdk-typescript 2.0.0

package/models/GetAGroupChannelResponse.ts

@@ -0,0 +1,365 @@
+/**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK  [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)  Contact Support:   Name: Sendbird   Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { GetAGroupChannelResponseAllOf } from './GetAGroupChannelResponseAllOf';
+import { SendbirdBasicUserInfo } from './SendbirdBasicUserInfo';
+import { SendbirdDisappearingMessage } from './SendbirdDisappearingMessage';
+import { SendbirdGroupChannel } from './SendbirdGroupChannel';
+import { SendbirdGroupChannelDetailChannel } from './SendbirdGroupChannelDetailChannel';
+import { SendbirdMember } from './SendbirdMember';
+import { SendbirdMessageResponse } from './SendbirdMessageResponse';
+import { SendbirdPushTriggerOption } from './SendbirdPushTriggerOption';
+import { SendbirdSmsFallback } from './SendbirdSmsFallback';
+import { HttpFile } from '../http/http';
+
+export class GetAGroupChannelResponse {
+    'channel'?: SendbirdGroupChannelDetailChannel;
+    'channelUrl': string;
+    'countPreference'?: GetAGroupChannelResponseCountPreferenceEnum;
+    'coverUrl'?: string;
+    'createdAt'?: number;
+    'createdBy'?: SendbirdBasicUserInfo;
+    'customType'?: string;
+    'data'?: string;
+    'deliveryReceipt'?: any;
+    'disappearingMessage'?: SendbirdDisappearingMessage;
+    'freeze'?: boolean;
+    'hasAiBot'?: boolean;
+    'hasBot'?: boolean;
+    'hiddenState'?: GetAGroupChannelResponseHiddenStateEnum;
+    'ignoreProfanityFilter'?: boolean;
+    'invitedAt'?: number;
+    'inviter'?: SendbirdBasicUserInfo;
+    'isAccessCodeRequired'?: boolean;
+    'isBroadcast'?: boolean;
+    'isDiscoverable'?: boolean;
+    'isDistinct'?: boolean;
+    'isEphemeral'?: boolean;
+    'isExclusive'?: boolean;
+    'isHidden'?: boolean;
+    'isMuted'?: boolean;
+    'isPublic'?: boolean;
+    'isPushEnabled'?: boolean;
+    'isSuper'?: boolean;
+    'joinedMemberCount'?: number;
+    'joinedTs'?: number;
+    'lastMessage'?: SendbirdMessageResponse;
+    'maxLengthMessage'?: number;
+    'memberCount'?: number;
+    'memberState'?: GetAGroupChannelResponseMemberStateEnum;
+    'members'?: Array<SendbirdMember>;
+    'messageSurvivalSeconds'?: number;
+    'metadata'?: any;
+    'myRole'?: GetAGroupChannelResponseMyRoleEnum;
+    'name'?: string;
+    'pushTriggerOption'?: SendbirdPushTriggerOption;
+    'readReceipt'?: { [key: string]: number; };
+    'smsFallback'?: SendbirdSmsFallback;
+    'tsMessageOffset'?: number;
+    'unreadMentionCount'?: number;
+    'unreadMessageCount'?: number;
+    'userLastRead'?: number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "channel",
+            "baseName": "channel",
+            "type": "SendbirdGroupChannelDetailChannel",
+            "format": ""
+        },
+        {
+            "name": "channelUrl",
+            "baseName": "channel_url",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "countPreference",
+            "baseName": "count_preference",
+            "type": "GetAGroupChannelResponseCountPreferenceEnum",
+            "format": ""
+        },
+        {
+            "name": "coverUrl",
+            "baseName": "cover_url",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "created_at",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "createdBy",
+            "baseName": "created_by",
+            "type": "SendbirdBasicUserInfo",
+            "format": ""
+        },
+        {
+            "name": "customType",
+            "baseName": "custom_type",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "data",
+            "baseName": "data",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "deliveryReceipt",
+            "baseName": "delivery_receipt",
+            "type": "any",
+            "format": ""
+        },
+        {
+            "name": "disappearingMessage",
+            "baseName": "disappearing_message",
+            "type": "SendbirdDisappearingMessage",
+            "format": ""
+        },
+        {
+            "name": "freeze",
+            "baseName": "freeze",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "hasAiBot",
+            "baseName": "has_ai_bot",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "hasBot",
+            "baseName": "has_bot",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "hiddenState",
+            "baseName": "hidden_state",
+            "type": "GetAGroupChannelResponseHiddenStateEnum",
+            "format": ""
+        },
+        {
+            "name": "ignoreProfanityFilter",
+            "baseName": "ignore_profanity_filter",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "invitedAt",
+            "baseName": "invited_at",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "inviter",
+            "baseName": "inviter",
+            "type": "SendbirdBasicUserInfo",
+            "format": ""
+        },
+        {
+            "name": "isAccessCodeRequired",
+            "baseName": "is_access_code_required",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isBroadcast",
+            "baseName": "is_broadcast",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isDiscoverable",
+            "baseName": "is_discoverable",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isDistinct",
+            "baseName": "is_distinct",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isEphemeral",
+            "baseName": "is_ephemeral",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isExclusive",
+            "baseName": "is_exclusive",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isHidden",
+            "baseName": "is_hidden",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isMuted",
+            "baseName": "is_muted",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isPublic",
+            "baseName": "is_public",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isPushEnabled",
+            "baseName": "is_push_enabled",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isSuper",
+            "baseName": "is_super",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "joinedMemberCount",
+            "baseName": "joined_member_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "joinedTs",
+            "baseName": "joined_ts",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "lastMessage",
+            "baseName": "last_message",
+            "type": "SendbirdMessageResponse",
+            "format": ""
+        },
+        {
+            "name": "maxLengthMessage",
+            "baseName": "max_length_message",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "memberCount",
+            "baseName": "member_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "memberState",
+            "baseName": "member_state",
+            "type": "GetAGroupChannelResponseMemberStateEnum",
+            "format": ""
+        },
+        {
+            "name": "members",
+            "baseName": "members",
+            "type": "Array<SendbirdMember>",
+            "format": ""
+        },
+        {
+            "name": "messageSurvivalSeconds",
+            "baseName": "message_survival_seconds",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "any",
+            "format": ""
+        },
+        {
+            "name": "myRole",
+            "baseName": "my_role",
+            "type": "GetAGroupChannelResponseMyRoleEnum",
+            "format": ""
+        },
+        {
+            "name": "name",
+            "baseName": "name",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "pushTriggerOption",
+            "baseName": "push_trigger_option",
+            "type": "SendbirdPushTriggerOption",
+            "format": ""
+        },
+        {
+            "name": "readReceipt",
+            "baseName": "read_receipt",
+            "type": "{ [key: string]: number; }",
+            "format": "int64"
+        },
+        {
+            "name": "smsFallback",
+            "baseName": "sms_fallback",
+            "type": "SendbirdSmsFallback",
+            "format": ""
+        },
+        {
+            "name": "tsMessageOffset",
+            "baseName": "ts_message_offset",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "unreadMentionCount",
+            "baseName": "unread_mention_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "unreadMessageCount",
+            "baseName": "unread_message_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "userLastRead",
+            "baseName": "user_last_read",
+            "type": "number",
+            "format": "int64"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetAGroupChannelResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export type GetAGroupChannelResponseCountPreferenceEnum = "false" | "all" | "unread_message_count_only" | "unread_mentioned_count_only" ;
+export type GetAGroupChannelResponseHiddenStateEnum = "hidden_allow_auto_unhide" | "hidden_prevent_auto_unhide" | "unhidden" ;
+export type GetAGroupChannelResponseMemberStateEnum = "invited" | "joined" | "none" ;
+export type GetAGroupChannelResponseMyRoleEnum = "" | "none" | "operator" ;
+

package/models/GetAGroupChannelResponseAllOf.ts

@@ -0,0 +1,36 @@
+/**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK  [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)  Contact Support:   Name: Sendbird   Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { SendbirdGroupChannelDetailChannel } from './SendbirdGroupChannelDetailChannel';
+import { HttpFile } from '../http/http';
+
+export class GetAGroupChannelResponseAllOf {
+    'channel'?: SendbirdGroupChannelDetailChannel;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "channel",
+            "baseName": "channel",
+            "type": "SendbirdGroupChannelDetailChannel",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetAGroupChannelResponseAllOf.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/GetChannelInvitationPreferenceResponse.ts

@@ -0,0 +1,35 @@
+/**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK  [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)  Contact Support:   Name: Sendbird   Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { HttpFile } from '../http/http';
+
+export class GetChannelInvitationPreferenceResponse {
+    'autoAccept'?: boolean;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "autoAccept",
+            "baseName": "auto_accept",
+            "type": "boolean",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetChannelInvitationPreferenceResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/GetTotalNumberOfMessagesInAChannelResponse.ts

@@ -0,0 +1,35 @@
+/**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK  [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)  Contact Support:   Name: Sendbird   Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { HttpFile } from '../http/http';
+
+export class GetTotalNumberOfMessagesInAChannelResponse {
+    'total'?: number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "total",
+            "baseName": "total",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GetTotalNumberOfMessagesInAChannelResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/GroupChannelListMembersResponse.ts

@@ -0,0 +1,43 @@
+/**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK  [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)  Contact Support:   Name: Sendbird   Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { SendbirdMember } from './SendbirdMember';
+import { HttpFile } from '../http/http';
+
+export class GroupChannelListMembersResponse {
+    'members': Array<SendbirdMember>;
+    'next'?: string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "members",
+            "baseName": "members",
+            "type": "Array<SendbirdMember>",
+            "format": ""
+        },
+        {
+            "name": "next",
+            "baseName": "next",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GroupChannelListMembersResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/GroupChatListChannelsResponse.ts

@@ -0,0 +1,50 @@
+/**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK  [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)  Contact Support:   Name: Sendbird   Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { SendbirdGroupChannel } from './SendbirdGroupChannel';
+import { HttpFile } from '../http/http';
+
+export class GroupChatListChannelsResponse {
+    'channels'?: Array<SendbirdGroupChannel>;
+    'next'?: string;
+    'ts'?: number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "channels",
+            "baseName": "channels",
+            "type": "Array<SendbirdGroupChannel>",
+            "format": ""
+        },
+        {
+            "name": "next",
+            "baseName": "next",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "ts",
+            "baseName": "ts",
+            "type": "number",
+            "format": "int64"
+        }    ];
+
+    static getAttributeTypeMap() {
+        return GroupChatListChannelsResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/HideAChannelRequest.ts

@@ -0,0 +1,68 @@
+/**
+ * Sendbird Platform SDK
+ * Sendbird Platform API SDK  [https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api](https://sendbird.com/docs/chat/v3/platform-api/getting-started/prepare-to-use-api)  Contact Support:   Name: Sendbird   Email: [support@sendbird.com](https://mailto:support@sendbird.com)
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: support@sendbird.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { HttpFile } from '../http/http';
+
+export class HideAChannelRequest {
+    /**
+    * Determines the state and operating behavior of the channel in a channel list. If set to true, the channel is hidden from a user's channel list but it will reappear when there is a new message. If set to false, the channel is hidden from a user's channel list and it will remain hidden unless the value of the property changes to true through [unarchiving](#2-unhide-or-unarchive-a-channel). (Default: true)<br /><br /> When a user who has hidden the channel sends a message in that channel through the [Platform API](/docs/chat/v3/platform-api/guides/messages#2-send-a-message), the `allow_auto_unhide` property is changed to true, making the channel reappear in the channel list.
+    */
+    'allowAutoUnhide'?: boolean;
+    /**
+    * When the channel gets appeared back in either the list of the user in the user_id property or the lists of all channel members (should_hide_all = true), determines whether to conceal the messages sent and received before hiding or archiving the channel. (Default: false)<br /><br /> This property is effective only when the value of the [global application settings resource](/docs/chat/v3/platform-api/guides/global-application-settings#-3-resource-representation)'s display_past_message property is false.
+    */
+    'hidePreviousMessages'?: boolean;
+    /**
+    * Determines whether to make the specified channel disappear from the channel list of all channel members. When this is set to true, the user_id property isn't effective and doesn't need to be specified in the request. (Default: false)
+    */
+    'shouldHideAll'?: boolean;
+    /**
+    * Specifies the unique ID of the user whose channel will be hidden or archived from the list. This property is required when should_hide_all is set to false, which is the default value. However, when should_hide_all is set to true, this property isn't effective.
+    */
+    'userId': string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "allowAutoUnhide",
+            "baseName": "allow_auto_unhide",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "hidePreviousMessages",
+            "baseName": "hide_previous_messages",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "shouldHideAll",
+            "baseName": "should_hide_all",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "userId",
+            "baseName": "user_id",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return HideAChannelRequest.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+