@sendbird/sendbird-platform-sdk-typescript 2.0.0

package/models/ViewPushPreferencesResponse.ts

@@ -0,0 +1,127 @@
+/**
+ * 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 { SendbirdPushTriggerOption } from './SendbirdPushTriggerOption';
+import { HttpFile } from '../http/http';
+
+export class ViewPushPreferencesResponse {
+    'blockPushFromBots'?: boolean;
+    'doNotDisturb'?: boolean;
+    'enablePushForReplies'?: boolean;
+    'endHour'?: number;
+    'endMin'?: number;
+    'pushBlockedBotIds'?: Array<string>;
+    'pushSound'?: string;
+    'pushTriggerOption'?: SendbirdPushTriggerOption;
+    'snoozeEnabled'?: boolean;
+    'snoozeEndTs'?: number;
+    'snoozeStartTs'?: number;
+    'startHour'?: number;
+    'startMin'?: number;
+    'timezone'?: string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "blockPushFromBots",
+            "baseName": "block_push_from_bots",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "doNotDisturb",
+            "baseName": "do_not_disturb",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "enablePushForReplies",
+            "baseName": "enable_push_for_replies",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "endHour",
+            "baseName": "end_hour",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "endMin",
+            "baseName": "end_min",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "pushBlockedBotIds",
+            "baseName": "push_blocked_bot_ids",
+            "type": "Array<string>",
+            "format": ""
+        },
+        {
+            "name": "pushSound",
+            "baseName": "push_sound",
+            "type": "string",
+            "format": ""
+        },
+        {
+            "name": "pushTriggerOption",
+            "baseName": "push_trigger_option",
+            "type": "SendbirdPushTriggerOption",
+            "format": ""
+        },
+        {
+            "name": "snoozeEnabled",
+            "baseName": "snooze_enabled",
+            "type": "boolean",
+            "format": ""
+        },
+        {
+            "name": "snoozeEndTs",
+            "baseName": "snooze_end_ts",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "snoozeStartTs",
+            "baseName": "snooze_start_ts",
+            "type": "number",
+            "format": "int64"
+        },
+        {
+            "name": "startHour",
+            "baseName": "start_hour",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "startMin",
+            "baseName": "start_min",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "timezone",
+            "baseName": "timezone",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ViewPushPreferencesResponse.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/ViewWhoOwnsARegistrationOrDeviceTokenResponseInner.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 ViewWhoOwnsARegistrationOrDeviceTokenResponseInner {
+    'userId'?: string;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "userId",
+            "baseName": "user_id",
+            "type": "string",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return ViewWhoOwnsARegistrationOrDeviceTokenResponseInner.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/all.ts

@@ -0,0 +1,119 @@
+export * from './AcceptAnInvitationRequest'
+export * from './AddARegistrationOrDeviceTokenRequest'
+export * from './AddARegistrationOrDeviceTokenResponse'
+export * from './AddExtraDataToAMessageRequest'
+export * from './AddExtraDataToAMessageResponse'
+export * from './BlockAUserRequest'
+export * from './BlockAUserResponse'
+export * from './CheckIfMemberResponse'
+export * from './ChooseAPushNotificationContentTemplateRequest'
+export * from './ChooseAPushNotificationContentTemplateResponse'
+export * from './CreateABotRequest'
+export * from './CreateABotResponse'
+export * from './CreateABotResponseBot'
+export * from './CreateABotResponseBotStyle'
+export * from './CreateAChannelMetadataRequest'
+export * from './CreateAChannelMetadataResponse'
+export * from './CreateAGroupChannelRequest'
+export * from './CreateAUserRequest'
+export * from './CreateAnOpenChannelRequest'
+export * from './CreateUserTokenRequest'
+export * from './CreateUserTokenResponse'
+export * from './FreezeAGroupChannelRequest'
+export * from './FreezeAnOpenChannelRequest'
+export * from './GetAGroupChannelResponse'
+export * from './GetAGroupChannelResponseAllOf'
+export * from './GetChannelInvitationPreferenceResponse'
+export * from './GetTotalNumberOfMessagesInAChannelResponse'
+export * from './GroupChannelListMembersResponse'
+export * from './GroupChatListChannelsResponse'
+export * from './HideAChannelRequest'
+export * from './InviteAsMembersRequest'
+export * from './InviteAsMembersResponse'
+export * from './InviteAsMembersResponseAllOf'
+export * from './JoinAChannelRequest'
+export * from './JoinChannelsRequest'
+export * from './LeaveAChannelRequest'
+export * from './LeaveMyGroupChannelsRequest'
+export * from './ListBlockedUsersResponse'
+export * from './ListBotsResponse'
+export * from './ListBotsResponseBotsInner'
+export * from './ListBotsResponseBotsInnerAi'
+export * from './ListBotsResponseBotsInnerBot'
+export * from './ListBotsResponseBotsInnerBotStyle'
+export * from './ListBotsResponseBotsInnerBotStyleColor'
+export * from './ListBotsResponseBotsInnerFirstMessagesInner'
+export * from './ListBotsResponseBotsInnerFirstMessagesInnerData'
+export * from './ListBotsResponseBotsInnerSafeguard'
+export * from './ListMessagesResponse'
+export * from './ListMyGroupChannelsResponse'
+export * from './ListOpenChannelsResponse'
+export * from './ListOperatorsResponse'
+export * from './ListRegistrationOrDeviceTokensResponse'
+export * from './ListUsersResponse'
+export * from './MarkAllMessagesAsReadRequest'
+export * from './MarkChannelMessagesAsReadRequest'
+export * from './MigrateMessagesAdminMessageRequest'
+export * from './MigrateMessagesFileMessageRequest'
+export * from './MigrateMessagesFileMessageRequestThumbnailsInner'
+export * from './MigrateMessagesRequest'
+export * from './MigrateMessagesRequestMessagesInner'
+export * from './MigrateMessagesTextMessageRequest'
+export * from './RegisterOperatorsToAGroupChannelRequest'
+export * from './RemoveARegistrationOrDeviceTokenResponse'
+export * from './RemoveAllRegistrationOrDeviceTokenResponse'
+export * from './ResetChatHistoryRequest'
+export * from './ResetChatHistoryResponse'
+export * from './ScheduleAnAnnouncementRequest'
+export * from './ScheduleAnAnnouncementRequestCreateChannelOptions'
+export * from './ScheduleAnAnnouncementRequestMessage'
+export * from './ScheduleAnAnnouncementResponse'
+export * from './ScheduleAnAnnouncementResponseMessage'
+export * from './SendABotMessageRequest'
+export * from './SendAMessageRequest'
+export * from './SendAdminMessageRequestBody'
+export * from './SendFileMessageRequestBody'
+export * from './SendTextMessageRequestBody'
+export * from './SendTextMessageRequestBodyPushMessageTemplate'
+export * from './SendTextMessageRequestBodyPushMessageTemplateOneOf'
+export * from './SendbirdBasicUserInfo'
+export * from './SendbirdDisappearingMessage'
+export * from './SendbirdExtendedMessagePayload'
+export * from './SendbirdFile'
+export * from './SendbirdGroupChannel'
+export * from './SendbirdGroupChannelDetail'
+export * from './SendbirdGroupChannelDetailChannel'
+export * from './SendbirdMember'
+export * from './SendbirdMessageResponse'
+export * from './SendbirdMessageResponseMessageEvents'
+export * from './SendbirdOpenChannel'
+export * from './SendbirdParentMessageInfo'
+export * from './SendbirdPushTriggerOption'
+export * from './SendbirdReaction'
+export * from './SendbirdSmsFallback'
+export * from './SendbirdSortedMetaarrayInner'
+export * from './SendbirdThumbnail'
+export * from './SendbirdUser'
+export * from './StartTypingIndicatorsRequest'
+export * from './UpdateAChannelMetadataRequest'
+export * from './UpdateAGroupChannelRequest'
+export * from './UpdateAMessageRequest'
+export * from './UpdateAUserRequest'
+export * from './UpdateAnOpenChannelRequest'
+export * from './UpdateChannelInvitationPreferenceRequest'
+export * from './UpdateChannelInvitationPreferenceResponse'
+export * from './UpdateCountPreferenceOfAChannelRequest'
+export * from './UpdateCountPreferenceOfChannelByUrlResponse'
+export * from './UpdateExtraDataInAMessageRequest'
+export * from './UpdateExtraDataInAMessageResponse'
+export * from './UpdatePushPreferencesForAChannelRequest'
+export * from './UpdatePushPreferencesForAChannelResponse'
+export * from './UpdatePushPreferencesRequest'
+export * from './UpdatePushPreferencesResponse'
+export * from './ViewCountPreferenceOfAChannelResponse'
+export * from './ViewNumberOfChannelsWithUnreadMessagesResponse'
+export * from './ViewNumberOfDailyActiveUsersResponse'
+export * from './ViewNumberOfMonthlyActiveUsersResponse'
+export * from './ViewNumberOfUnreadMessagesResponse'
+export * from './ViewPushPreferencesForAChannelResponse'
+export * from './ViewPushPreferencesResponse'

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@sendbird/sendbird-platform-sdk-typescript",
+  "version": "2.0.0",
+  "description": "OpenAPI client for sendbird-platform-sdk-typescript",
+  "author": "OpenAPI-Generator Contributors",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sendbird/sendbird-platform-sdk-typescript.git"
+  },
+  "keywords": [
+    "fetch",
+    "typescript",
+    "openapi-client",
+    "openapi-generator"
+  ],
+  "license": "Unlicense",
+  "main": "./dist/index.js",
+  "type": "commonjs",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "typings": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test:integration": "jest"
+  },
+  "dependencies": {
+    "@types/node-fetch": "^2.5.7",
+    "btoa": "^1.2.1",
+    "es6-promise": "^4.2.4",
+    "form-data": "^2.5.0",
+    "node-fetch": "^2.6.0",
+    "url-parse": "^1.4.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.14.0",
+    "@types/url-parse": "1.4.4",
+    "axios-mock-adapter": "^2.1.0",
+    "dotenv": "^16.5.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.3.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^4.9.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/rxjsStub.ts

@@ -0,0 +1,27 @@
+export class Observable<T> {
+  constructor(private promise: Promise<T>) {}
+
+  toPromise() {
+    return this.promise;
+  }
+
+  pipe<S>(callback: (value: T) => S | Promise<S>): Observable<S> {
+    return new Observable(this.promise.then(callback));
+  }
+}
+
+export function from<T>(promise: Promise<any>) {
+  return new Observable(promise);
+}
+
+export function of<T>(value: T) {
+  return new Observable<T>(Promise.resolve(value));
+}
+
+export function mergeMap<T, S>(callback: (value: T) => Observable<S>) {
+  return (value: T) => callback(value).toPromise();
+}
+
+export function map(callback: any) {
+  return callback;
+}

package/servers.ts

@@ -0,0 +1,53 @@
+import { RequestContext, HttpMethod } from "./http/http";
+
+export interface BaseServerConfiguration {
+    makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext;
+}
+
+/**
+ *
+ * Represents the configuration of a server including its
+ * url template and variable configuration based on the url.
+ *
+ */
+export class ServerConfiguration<T extends { [key: string]: string }> implements BaseServerConfiguration {
+    public constructor(private url: string, private variableConfiguration: T) {}
+
+    /**
+     * Sets the value of the variables of this server.
+     *
+     * @param variableConfiguration a partial variable configuration for the variables contained in the url
+     */
+    public setVariables(variableConfiguration: Partial<T>) {
+        Object.assign(this.variableConfiguration, variableConfiguration);
+    }
+
+    public getConfiguration(): T {
+        return this.variableConfiguration
+    }
+
+    private getUrl() {
+        let replacedUrl = this.url;
+        for (const key in this.variableConfiguration) {
+            var re = new RegExp("{" + key + "}","g");
+            replacedUrl = replacedUrl.replace(re, this.variableConfiguration[key]);
+        }
+        return replacedUrl
+    }
+
+    /**
+     * Creates a new request context for this server using the url with variables
+     * replaced with their respective values and the endpoint of the request appended.
+     *
+     * @param endpoint the endpoint to be queried on the server
+     * @param httpMethod httpMethod to be used
+     *
+     */
+    public makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext {
+        return new RequestContext(this.getUrl() + endpoint, httpMethod);
+    }
+}
+
+export const server1 = new ServerConfiguration<{  "app_id": string  }>("https://api-{app_id}.sendbird.com", {  "app_id": "APP_ID"  })
+
+export const servers = [server1];

package/tests/integration/bot.test.ts

@@ -0,0 +1,186 @@
+import { CreateAnOpenChannelRequest } from "./../../models/CreateAnOpenChannelRequest";
+import { ServerConfiguration } from "../../servers";
+import { createConfiguration } from "../../configuration";
+import {
+  BotApi,
+  CreateABotRequest,
+  CreateAGroupChannelRequest,
+  GroupChannelApi,
+} from "../../index";
+import { hasValidField } from "./helper";
+import {
+  GLOBAL_GROUP_CHANNEL_ACCESS_CODE,
+  MASTER_USER_ID,
+  USERS,
+} from "./constants";
+
+describe("Bot API", () => {
+  const APP_ID = process.env.APP_ID || "";
+  const API_TOKEN = process.env.API_TOKEN || "";
+  let botApi: BotApi;
+  let groupChannelApi: GroupChannelApi;
+
+  beforeEach(() => {
+    const serverConfig = new ServerConfiguration(
+      `https://api-${APP_ID}.sendbird.com`,
+      { app_id: APP_ID }
+    );
+    const configuration = createConfiguration({
+      baseServer: serverConfig,
+    });
+    botApi = new BotApi(configuration);
+    groupChannelApi = new GroupChannelApi(configuration);
+  });
+
+  it("call listBots, createABot, joinChannels, and leaveAGroupChannel", async () => {
+    const CHANNEL_URL = "test-bot-channel-url";
+    // Cleanup first
+    try {
+      await groupChannelApi.deleteAGroupChannel({
+        channelUrl: CHANNEL_URL,
+        apiToken: API_TOKEN,
+      });
+    } catch (e) {
+      console.warn("Failed to delete channel:", e);
+    }
+
+    await new Promise((resolve) => setTimeout(resolve, 500));
+
+    const request: CreateAGroupChannelRequest = {
+      accessCode: GLOBAL_GROUP_CHANNEL_ACCESS_CODE,
+      blockSdkUserChannelJoin: true,
+      channelUrl: CHANNEL_URL,
+      coverUrl: "empty",
+      customType: "data",
+      data: "data",
+      /**
+       * Specifies one or more key-value pair items which set the invitation status of each user invited to the channel. The key should be a user_id and the value should be their joining status. Acceptable values are joined, invited_by_friend, and invited_by_non_friend. (Default: joined)
+       */
+      invitationStatus: {
+        MASTER_USER_ID: "joined",
+      },
+      inviterId: MASTER_USER_ID,
+      isDistinct: false,
+      isEphemeral: true,
+      isPublic: true,
+      isSuper: true,
+      name: "test",
+      operatorIds: [],
+      strict: true,
+      users: USERS.map((id) => ({ userId: id })),
+    };
+
+    const createGroupChannelresponse =
+      await groupChannelApi.createAGroupChannel({
+        apiToken: API_TOKEN,
+        createAGroupChannelRequest: request,
+      });
+
+    expect(createGroupChannelresponse).toHaveProperty("channelUrl");
+    expect(createGroupChannelresponse.channelUrl).toBe(CHANNEL_URL);
+
+    await new Promise((resolve) => setTimeout(resolve, 100));
+
+    const listBotsResponse = await botApi.listBots({
+      apiToken: API_TOKEN,
+    });
+
+    let botUserId: string | undefined;
+
+    expect(listBotsResponse).toHaveProperty("bots");
+    if ((listBotsResponse.bots?.length || 0) > 0) {
+      botUserId = listBotsResponse.bots?.[0].bot?.botUserid;
+      listBotsResponse.bots?.forEach((bot) => {
+        if (hasValidField(bot, "botCallbackUrl")) {
+          expect(typeof bot.botCallbackUrl).toBe("string");
+        }
+
+        if (hasValidField(bot, "channelInvitationPreference")) {
+          expect(typeof bot.channelInvitationPreference).toBe("number");
+        }
+
+        if (hasValidField(bot, "createdAt")) {
+          expect(typeof bot.createdAt).toBe("number");
+        }
+
+        if (hasValidField(bot, "enableMarkAsRead")) {
+          expect(typeof bot.enableMarkAsRead).toBe("boolean");
+        }
+
+        if (hasValidField(bot, "isPrivacyMode")) {
+          expect(typeof bot.isPrivacyMode).toBe("boolean");
+        }
+
+        if (hasValidField(bot, "showMember")) {
+          expect(typeof bot.showMember).toBe("boolean");
+        }
+      });
+    } else {
+      const BOT_NICKNAME = "test-integration-bot-nickname";
+      const BOT_USER_ID = "test-integration-bot-user-id";
+      const request: CreateABotRequest = {
+        botCallbackUrl: "callbacn-url",
+        botNickname: BOT_NICKNAME,
+        botProfileUrl: "string",
+        botType: "CUSTOMIZED_BOT",
+        /**
+         * Specifies the unique ID of a bot. The length is limited to 80 characters.
+         */
+        botUserid: BOT_USER_ID,
+        /**
+         * Determines whether to forward all or specific messages to the bot in channels where the bot is a member. If set to true, only messages starting with a \"/\" or mentioning the bot_userid are forwarded to the bot. If set to false, all messages are forwarded. This property can help protect the privacy of users' chat logs by configuring the bot to only receive messages addressed to the bot.
+         */
+        isPrivacyMode: true,
+        channelInvitationPreference: 0,
+        enableMarkAsRead: true,
+        showMember: true,
+      };
+      botUserId = BOT_USER_ID;
+      const createABotResponse = await botApi.createABot({
+        createABotRequest: request,
+        apiToken: API_TOKEN,
+      });
+
+      expect(createABotResponse).toHaveProperty("bot");
+      expect(createABotResponse.bot).toHaveProperty("botUserid");
+      expect(createABotResponse.bot.botUserid).toBe(BOT_USER_ID);
+
+      if (!botUserId) return;
+      await botApi.joinChannels({
+        botUserid: botUserId,
+        joinChannelsRequest: {
+          channelUrls: [CHANNEL_URL],
+        },
+        apiToken: API_TOKEN,
+      });
+
+      const groupChannelResponse = await groupChannelApi.getAGroupChannel({
+        channelUrl: CHANNEL_URL,
+        apiToken: API_TOKEN,
+      });
+
+      expect(groupChannelResponse).toHaveProperty("channelUrl");
+      expect(groupChannelResponse.channelUrl).toBe(CHANNEL_URL);
+
+      expect(groupChannelResponse).toHaveProperty("hasBot");
+      expect(groupChannelResponse.hasBot).toBe(true);
+
+      const leaveAGroupChannelResponse = await botApi.leaveAGroupChannel({
+        botUserid: botUserId,
+        channelUrl: CHANNEL_URL,
+        apiToken: API_TOKEN,
+      });
+
+      expect(leaveAGroupChannelResponse).toBeDefined();
+    }
+    // Cleanup last
+    try {
+      await groupChannelApi.deleteAGroupChannel({
+        channelUrl: CHANNEL_URL,
+        apiToken: API_TOKEN,
+      });
+    } catch (e) {
+      console.warn("ignore error in cleanup", e);
+    }
+  });
+});

package/tests/integration/constants.ts

@@ -0,0 +1,10 @@
+export const GLOBAL_GROUP_CHANNEL_ACCESS_CODE = "integration";
+// Please make sure we have a couple of users
+export const USERS = [
+  "ttsYcp4M5USFbhDxPqM2ETwM1vB2",
+  "lK7U9lvxcZWVNa5SgZnLv81DG2R2",
+];
+
+export const MASTER_USER_ID = USERS[0];
+export const SECOND_USER_ID = USERS[1];
+export const TEST_USER_ID = 'test-user-integration-id';