@sendbird/sendbird-platform-sdk-typescript 2.0.0

package/models/SendFileMessageRequestBody.ts

@@ -0,0 +1,187 @@
+/**
+ * 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 { SendbirdFile } from './SendbirdFile';
+import { SendbirdSortedMetaarrayInner } from './SendbirdSortedMetaarrayInner';
+import { HttpFile } from '../http/http';
+
+export class SendFileMessageRequestBody {
+    'apnsBundleId'?: string;
+    'appleCriticalAlertOptions'?: any;
+    'createdAt'?: number;
+    'customType'?: string;
+    'data'?: string;
+    'dedupId'?: string;
+    'files': SendbirdFile;
+    'isSilent'?: boolean;
+    'markAsRead'?: boolean;
+    'mentionType'?: SendFileMessageRequestBodyMentionTypeEnum;
+    'mentionedUserIds'?: Array<string>;
+    /**
+    * Specifies the type of the message. The value of FILE represents a file message.
+    */
+    'messageType': SendFileMessageRequestBodyMessageTypeEnum;
+    /**
+    * 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;
+    'sendPush'?: boolean;
+    'sortedMetaarray'?: Array<SendbirdSortedMetaarrayInner>;
+    'sound'?: string;
+    'thumbnail1'?: string;
+    'thumbnail2'?: string;
+    'thumbnail3'?: string;
+    'thumbnails'?: Array<string>;
+    'volume'?: number;
+
+    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": "files",
+            "baseName": "files",
+            "type": "SendbirdFile",
+            "format": ""
+        },
+        {
+            "name": "isSilent",
+            "baseName": "is_silent",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "markAsRead",
+            "baseName": "mark_as_read",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "mentionType",
+            "baseName": "mention_type",
+            "type": "SendFileMessageRequestBodyMentionTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "mentionedUserIds",
+            "baseName": "mentioned_user_ids",
+            "type": "Array<string>",
+            "format": ""
+        },
+        {
+            "name": "messageType",
+            "baseName": "message_type",
+            "type": "SendFileMessageRequestBodyMessageTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "requireAuth",
+            "baseName": "require_auth",
+            "type": "boolean",
+            "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": "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": ""
+        },
+        {
+            "name": "volume",
+            "baseName": "volume",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendFileMessageRequestBody.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export type SendFileMessageRequestBodyMentionTypeEnum = "users" | "channel" ;
+export type SendFileMessageRequestBodyMessageTypeEnum = "FILE" ;
+

package/models/SendTextMessageRequestBody.ts

@@ -0,0 +1,170 @@
+/**
+ * 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 { SendTextMessageRequestBodyPushMessageTemplate } from './SendTextMessageRequestBodyPushMessageTemplate';
+import { SendbirdSortedMetaarrayInner } from './SendbirdSortedMetaarrayInner';
+import { HttpFile } from '../http/http';
+
+export class SendTextMessageRequestBody {
+    'apnsBundleId'?: string;
+    'appleCriticalAlertOptions'?: any;
+    'createdAt'?: number;
+    'customType'?: string;
+    'data'?: string;
+    'dedupId'?: string;
+    'includePollDetails'?: boolean;
+    'isSilent'?: boolean;
+    'markAsRead'?: boolean;
+    'mentionType'?: SendTextMessageRequestBodyMentionTypeEnum;
+    'mentionedUserIds'?: Array<string>;
+    'message': string;
+    /**
+    * Specifies the type of the message. The value of MESG represents a text message.
+    */
+    'messageType': SendTextMessageRequestBodyMessageTypeEnum;
+    'pollId'?: number;
+    'pushMessageTemplate'?: SendTextMessageRequestBodyPushMessageTemplate;
+    'sendPush'?: boolean;
+    'sortedMetaarray'?: Array<SendbirdSortedMetaarrayInner>;
+    'sound'?: string;
+    'volume'?: number;
+
+    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": "SendTextMessageRequestBodyMentionTypeEnum",
+            "format": ""
+        },
+        {
+            "name": "mentionedUserIds",
+            "baseName": "mentioned_user_ids",
+            "type": "Array<string>",
+            "format": ""
+        },
+        {
+            "name": "message",
+            "baseName": "message",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "messageType",
+            "baseName": "message_type",
+            "type": "SendTextMessageRequestBodyMessageTypeEnum",
+            "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": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendTextMessageRequestBody.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export type SendTextMessageRequestBodyMentionTypeEnum = "users" | "channel" ;
+export type SendTextMessageRequestBodyMessageTypeEnum = "MESG" ;
+

package/models/SendTextMessageRequestBodyPushMessageTemplate.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { SendTextMessageRequestBodyPushMessageTemplateOneOf } from './SendTextMessageRequestBodyPushMessageTemplateOneOf';
+import { HttpFile } from '../http/http';
+
+/**
+* Specifies the content of a push notification customized for the message. This property only applies to group channels. To choose from a push notification content template within your Sendbird application, specify a string value of default or alternative. To create a new push notification content tailored to the message being sent, use the properties listed below to specify its title and body in a nested object format. * This property overrides the application's default push notification content template or the preference chosen by the user.
+*/
+export class SendTextMessageRequestBodyPushMessageTemplate {
+    /**
+    * Specifies the title of the custom push notification template. You can customize the title using the variables sender_name and message, which can be later replaced with corresponding real values when the template is sent out as a notification request to FCM, HMS, or APNs.
+    */
+    'title'?: string;
+    /**
+    * Specifies the body of the custom push notification template. You can customize the body using the variables sender_name and message, which can be later replaced with corresponding real values when the template is sent out as a notification request to FCM, HMS, or APNs. If not specified, the body by default contains the message content inside the message property.
+    */
+    'body'?: string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "title",
+            "baseName": "title",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "body",
+            "baseName": "body",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendTextMessageRequestBodyPushMessageTemplate.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/SendTextMessageRequestBodyPushMessageTemplateOneOf.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 SendTextMessageRequestBodyPushMessageTemplateOneOf {
+    /**
+    * Specifies the title of the custom push notification template. You can customize the title using the variables sender_name and message, which can be later replaced with corresponding real values when the template is sent out as a notification request to FCM, HMS, or APNs.
+    */
+    'title'?: string;
+    /**
+    * Specifies the body of the custom push notification template. You can customize the body using the variables sender_name and message, which can be later replaced with corresponding real values when the template is sent out as a notification request to FCM, HMS, or APNs. If not specified, the body by default contains the message content inside the message property.
+    */
+    'body'?: string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "title",
+            "baseName": "title",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "body",
+            "baseName": "body",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendTextMessageRequestBodyPushMessageTemplateOneOf.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/SendbirdBasicUserInfo.ts

@@ -0,0 +1,87 @@
+/**
+ * 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 SendbirdBasicUserInfo {
+    'requireAuthForProfileImage'?: boolean;
+    'isActive'?: boolean;
+    'isBlockedByMe'?: boolean;
+    'role'?: SendbirdBasicUserInfoRoleEnum;
+    'nickname'?: string;
+    'userId': string;
+    'profileUrl'?: string;
+    'metadata'?: any;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "requireAuthForProfileImage",
+            "baseName": "require_auth_for_profile_image",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isActive",
+            "baseName": "is_active",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "isBlockedByMe",
+            "baseName": "is_blocked_by_me",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "role",
+            "baseName": "role",
+            "type": "SendbirdBasicUserInfoRoleEnum",
+            "format": ""
+        },
+        {
+            "name": "nickname",
+            "baseName": "nickname",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "userId",
+            "baseName": "user_id",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "profileUrl",
+            "baseName": "profile_url",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "metadata",
+            "baseName": "metadata",
+            "type": "any",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendbirdBasicUserInfo.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export type SendbirdBasicUserInfoRoleEnum = "" | "none" | "operator" ;
+

package/models/SendbirdDisappearingMessage.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 SendbirdDisappearingMessage {
+    'messageSurvivalSeconds'?: number;
+    'isTriggeredByMessageRead'?: boolean;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "messageSurvivalSeconds",
+            "baseName": "message_survival_seconds",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "isTriggeredByMessageRead",
+            "baseName": "is_triggered_by_message_read",
+            "type": "boolean",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendbirdDisappearingMessage.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/SendbirdExtendedMessagePayload.ts

@@ -0,0 +1,51 @@
+/**
+ * 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';
+
+/**
+* Specifies the extended message payload which is used to send a message with a custom message type.
+*/
+export class SendbirdExtendedMessagePayload {
+    /**
+    * JSON format you want to embed in message, eq : {\"title\": \"title\", \"image\": \"https://link.to/image.jpg\"}
+    */
+    'customView'?: any;
+    /**
+    * Specifies an array of suggested replies to be sent with the message.
+    */
+    'suggestedReplies'?: Array<string>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "customView",
+            "baseName": "custom_view",
+            "type": "any",
+            "format": ""
+        },
+        {
+            "name": "suggestedReplies",
+            "baseName": "suggested_replies",
+            "type": "Array<string>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return SendbirdExtendedMessagePayload.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+