@sendbird/sendbird-platform-sdk-typescript 2.0.0

package/models/ScheduleAnAnnouncementResponse.ts

@@ -0,0 +1,198 @@
+/**
+ * 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 { ScheduleAnAnnouncementRequestCreateChannelOptions } from './ScheduleAnAnnouncementRequestCreateChannelOptions';
+import { ScheduleAnAnnouncementResponseMessage } from './ScheduleAnAnnouncementResponseMessage';
+import { HttpFile } from '../http/http';
+
+export class ScheduleAnAnnouncementResponse {
+    'announcementGroup'?: string;
+    'ceaseAt'?: string;
+    'completedAt'?: number;
+    'createChannel'?: boolean;
+    'createChannelOptions'?: ScheduleAnAnnouncementRequestCreateChannelOptions;
+    'enablePush'?: boolean;
+    'endAt'?: number;
+    'markAsRead'?: boolean;
+    'message'?: ScheduleAnAnnouncementResponseMessage;
+    'openCount'?: number;
+    'openRate'?: number;
+    'priority'?: string;
+    'resumeAt'?: string;
+    'scheduledAt'?: number;
+    'sendToFrozenChannels'?: boolean;
+    'sentChannelCount'?: number;
+    'sentUserCount'?: number;
+    'status'?: string;
+    'targetAt'?: string;
+    'targetChannelCount'?: number;
+    'targetChannelType'?: string;
+    'targetCustomType'?: string;
+    'targetUserCount'?: number;
+    'uniqueId'?: string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "announcementGroup",
+            "baseName": "announcement_group",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "ceaseAt",
+            "baseName": "cease_at",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "completedAt",
+            "baseName": "completed_at",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "createChannel",
+            "baseName": "create_channel",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "createChannelOptions",
+            "baseName": "create_channel_options",
+            "type": "ScheduleAnAnnouncementRequestCreateChannelOptions",
+            "format": ""
+        },
+        {
+            "name": "enablePush",
+            "baseName": "enable_push",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "endAt",
+            "baseName": "end_at",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "markAsRead",
+            "baseName": "mark_as_read",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "ScheduleAnAnnouncementResponseMessage",
+            "format": ""
+        },
+        {
+            "name": "openCount",
+            "baseName": "open_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "openRate",
+            "baseName": "open_rate",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "priority",
+            "baseName": "priority",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "resumeAt",
+            "baseName": "resume_at",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "scheduledAt",
+            "baseName": "scheduled_at",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "sendToFrozenChannels",
+            "baseName": "send_to_frozen_channels",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "sentChannelCount",
+            "baseName": "sent_channel_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "sentUserCount",
+            "baseName": "sent_user_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "status",
+            "baseName": "status",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "targetAt",
+            "baseName": "target_at",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "targetChannelCount",
+            "baseName": "target_channel_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "targetChannelType",
+            "baseName": "target_channel_type",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "targetCustomType",
+            "baseName": "target_custom_type",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "targetUserCount",
+            "baseName": "target_user_count",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "uniqueId",
+            "baseName": "unique_id",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ScheduleAnAnnouncementResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/ScheduleAnAnnouncementResponseMessage.ts

@@ -0,0 +1,70 @@
+/**
+ * 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 ScheduleAnAnnouncementResponseMessage {
+    'content'?: string;
+    'customType'?: string;
+    'data'?: string;
+    'messageRetentionHour'?: number;
+    'type'?: string;
+    'userId'?: string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "content",
+            "baseName": "content",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "customType",
+            "baseName": "custom_type",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "data",
+            "baseName": "data",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "messageRetentionHour",
+            "baseName": "message_retention_hour",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "type",
+            "baseName": "type",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "userId",
+            "baseName": "user_id",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ScheduleAnAnnouncementResponseMessage.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/SendABotMessageRequest.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 { SendbirdExtendedMessagePayload } from './SendbirdExtendedMessagePayload';
+import { HttpFile } from '../http/http';
+
+export class SendABotMessageRequest {
+    'channelUrl': string;
+    'createdAt'?: number;
+    'customType'?: string;
+    'data'?: string;
+    'dedupId'?: string;
+    'extendedMessagePayload'?: SendbirdExtendedMessagePayload;
+    'markAsRead'?: boolean;
+    'mentioned'?: Array<string>;
+    'message': string;
+    'sendPush'?: boolean;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "channelUrl",
+            "baseName": "channel_url",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "created_at",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "customType",
+            "baseName": "custom_type",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "data",
+            "baseName": "data",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "dedupId",
+            "baseName": "dedup_id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "extendedMessagePayload",
+            "baseName": "extended_message_payload",
+            "type": "SendbirdExtendedMessagePayload",
+            "format": ""
+        },
+        {
+            "name": "markAsRead",
+            "baseName": "mark_as_read",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "mentioned",
+            "baseName": "mentioned",
+            "type": "Array<string>",
+            "format": ""
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "sendPush",
+            "baseName": "send_push",
+            "type": "boolean",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendABotMessageRequest.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/SendAMessageRequest.ts

@@ -0,0 +1,219 @@
+/**
+ * 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 { SendAdminMessageRequestBody } from './SendAdminMessageRequestBody';
+import { SendFileMessageRequestBody } from './SendFileMessageRequestBody';
+import { SendTextMessageRequestBody } from './SendTextMessageRequestBody';
+import { SendTextMessageRequestBodyPushMessageTemplate } from './SendTextMessageRequestBodyPushMessageTemplate';
+import { SendbirdFile } from './SendbirdFile';
+import { SendbirdSortedMetaarrayInner } from './SendbirdSortedMetaarrayInner';
+import { HttpFile } from '../http/http';
+
+export class SendAMessageRequest {
+    'apnsBundleId'?: string;
+    'appleCriticalAlertOptions'?: any;
+    'createdAt'?: number;
+    'customType'?: string;
+    'data'?: string;
+    'dedupId'?: string;
+    'includePollDetails'?: boolean;
+    'isSilent'?: boolean;
+    'markAsRead'?: boolean;
+    'mentionType'?: SendAMessageRequestMentionTypeEnum;
+    'mentionedUserIds'?: Array<string>;
+    'message': string;
+    /**
+    * Specifies the type of the message. The value of ADMM represents an admin message.
+    */
+    'messageType': SendAMessageRequestMessageTypeEnum;
+    'pollId'?: number;
+    'pushMessageTemplate'?: SendTextMessageRequestBodyPushMessageTemplate;
+    'sendPush'?: boolean;
+    'sortedMetaarray'?: Array<SendbirdSortedMetaarrayInner>;
+    'sound'?: string;
+    'volume'?: number;
+    'files': SendbirdFile;
+    /**
+    * Determines whether to require an authentication key to verify if the file is being properly accessed. Only the user who uploaded the file or users who are in the channel where the file was uploaded should have access. The authentication key managed internally by the Sendbird system is generated every time a user logs in to the Sendbird server and is valid for three days starting from the last login. If set to false, Sendbird tries to access a file without any key. To access encrypted files, such as the files in the Sendbird server which are by default encrypted, the property must be set to true. (Default: false) The require_auth parameter only works if the file or URL is managed by Sendbird, which means that when you upload files using multipart format or provide URLs that point to the files hosted on the Sendbird server. However, if the file is hosted on a server or service that is not managed by Sendbird, access control and authentication for the file should be handled by the respective server or service hosting the file.
+    */
+    'requireAuth'?: boolean;
+    'thumbnail1'?: string;
+    'thumbnail2'?: string;
+    'thumbnail3'?: string;
+    'thumbnails'?: Array<string>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "apnsBundleId",
+            "baseName": "apns_bundle_id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "appleCriticalAlertOptions",
+            "baseName": "apple_critical_alert_options",
+            "type": "any",
+            "format": ""
+        },
+        {
+            "name": "createdAt",
+            "baseName": "created_at",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "customType",
+            "baseName": "custom_type",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "data",
+            "baseName": "data",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "dedupId",
+            "baseName": "dedup_id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "includePollDetails",
+            "baseName": "include_poll_details",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isSilent",
+            "baseName": "is_silent",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "markAsRead",
+            "baseName": "mark_as_read",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "mentionType",
+            "baseName": "mention_type",
+            "type": "SendAMessageRequestMentionTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "mentionedUserIds",
+            "baseName": "mentioned_user_ids",
+            "type": "Array<string>",
+            "format": ""
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "messageType",
+            "baseName": "message_type",
+            "type": "SendAMessageRequestMessageTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "pollId",
+            "baseName": "poll_id",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "pushMessageTemplate",
+            "baseName": "push_message_template",
+            "type": "SendTextMessageRequestBodyPushMessageTemplate",
+            "format": ""
+        },
+        {
+            "name": "sendPush",
+            "baseName": "send_push",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "sortedMetaarray",
+            "baseName": "sorted_metaarray",
+            "type": "Array<SendbirdSortedMetaarrayInner>",
+            "format": ""
+        },
+        {
+            "name": "sound",
+            "baseName": "sound",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "volume",
+            "baseName": "volume",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "files",
+            "baseName": "files",
+            "type": "SendbirdFile",
+            "format": ""
+        },
+        {
+            "name": "requireAuth",
+            "baseName": "require_auth",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "thumbnail1",
+            "baseName": "thumbnail1",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "thumbnail2",
+            "baseName": "thumbnail2",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "thumbnail3",
+            "baseName": "thumbnail3",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "thumbnails",
+            "baseName": "thumbnails",
+            "type": "Array<string>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendAMessageRequest.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export type SendAMessageRequestMentionTypeEnum = "users" | "channel" ;
+export type SendAMessageRequestMessageTypeEnum = "ADMM" ;
+