@sendbird/sendbird-platform-sdk-typescript 2.1.2 → 2.1.5

package/.openapi-generator/FILES

@@ -133,6 +133,8 @@ models/UpdateExtraDataInAMessageResponse.ts
 models/UpdatePushPreferencesForAChannelRequest.ts
 models/UpdatePushPreferencesForAChannelResponse.ts
 models/UpdatePushPreferencesRequest.ts
+models/UpdatePushPreferencesRequestDndSchedulesInner.ts
+models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner.ts
 models/UpdatePushPreferencesResponse.ts
 models/UpdateSpecificUserMetadataRequest.ts
 models/UpdateUserMetadataRequest.ts

package/models/ObjectSerializer.ts

@@ -114,6 +114,8 @@ export * from './UpdateExtraDataInAMessageResponse';
 export * from './UpdatePushPreferencesForAChannelRequest';
 export * from './UpdatePushPreferencesForAChannelResponse';
 export * from './UpdatePushPreferencesRequest';
+export * from './UpdatePushPreferencesRequestDndSchedulesInner';
+export * from './UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner';
 export * from './UpdatePushPreferencesResponse';
 export * from './UpdateSpecificUserMetadataRequest';
 export * from './UpdateUserMetadataRequest';
@@ -243,6 +245,8 @@ import { UpdateExtraDataInAMessageResponse } from './UpdateExtraDataInAMessageRe
 import { UpdatePushPreferencesForAChannelRequest, UpdatePushPreferencesForAChannelRequestPushTriggerOptionEnum    } from './UpdatePushPreferencesForAChannelRequest';
 import { UpdatePushPreferencesForAChannelResponse } from './UpdatePushPreferencesForAChannelResponse';
 import { UpdatePushPreferencesRequest } from './UpdatePushPreferencesRequest';
+import { UpdatePushPreferencesRequestDndSchedulesInner, UpdatePushPreferencesRequestDndSchedulesInnerDayOfWeekEnum    } from './UpdatePushPreferencesRequestDndSchedulesInner';
+import { UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner } from './UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner';
 import { UpdatePushPreferencesResponse } from './UpdatePushPreferencesResponse';
 import { UpdateSpecificUserMetadataRequest } from './UpdateSpecificUserMetadataRequest';
 import { UpdateUserMetadataRequest } from './UpdateUserMetadataRequest';
@@ -314,6 +318,7 @@ let enumsMap: Set<string> = new Set<string>([
     "UpdateCountPreferenceOfAChannelRequestCountPreferenceEnum",
     "UpdateCountPreferenceOfChannelByUrlResponseCountPreferenceEnum",
     "UpdatePushPreferencesForAChannelRequestPushTriggerOptionEnum",
+    "UpdatePushPreferencesRequestDndSchedulesInnerDayOfWeekEnum",
     "ViewCountPreferenceOfAChannelResponseCountPreferenceEnum",
 ]);
 
@@ -433,6 +438,8 @@ let typeMap: {[index: string]: any} = {
     "UpdatePushPreferencesForAChannelRequest": UpdatePushPreferencesForAChannelRequest,
     "UpdatePushPreferencesForAChannelResponse": UpdatePushPreferencesForAChannelResponse,
     "UpdatePushPreferencesRequest": UpdatePushPreferencesRequest,
+    "UpdatePushPreferencesRequestDndSchedulesInner": UpdatePushPreferencesRequestDndSchedulesInner,
+    "UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner": UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner,
     "UpdatePushPreferencesResponse": UpdatePushPreferencesResponse,
     "UpdateSpecificUserMetadataRequest": UpdateSpecificUserMetadataRequest,
     "UpdateUserMetadataRequest": UpdateUserMetadataRequest,

package/models/UpdatePushPreferencesRequest.ts

@@ -11,6 +11,7 @@
  */
 
 import { SendbirdPushTriggerOption } from './SendbirdPushTriggerOption';
+import { UpdatePushPreferencesRequestDndSchedulesInner } from './UpdatePushPreferencesRequestDndSchedulesInner';
 import { HttpFile } from '../http/http';
 
 export class UpdatePushPreferencesRequest {
@@ -28,6 +29,7 @@ export class UpdatePushPreferencesRequest {
     'startHour'?: number;
     'startMin'?: number;
     'timezone'?: string;
+    'dndSchedules'?: Array<UpdatePushPreferencesRequestDndSchedulesInner>;
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -115,6 +117,12 @@ export class UpdatePushPreferencesRequest {
             "baseName": "timezone",
             "type": "string",
             "format": ""
+        },
+        {
+            "name": "dndSchedules",
+            "baseName": "dnd_schedules",
+            "type": "Array<UpdatePushPreferencesRequestDndSchedulesInner>",
+            "format": ""
         }    ];
 
     static getAttributeTypeMap() {

package/models/UpdatePushPreferencesRequestDndSchedulesInner.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 { UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner } from './UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner';
+import { HttpFile } from '../http/http';
+
+export class UpdatePushPreferencesRequestDndSchedulesInner {
+    'dayOfWeek'?: UpdatePushPreferencesRequestDndSchedulesInnerDayOfWeekEnum;
+    'timeWindows'?: Array<UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner>;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "dayOfWeek",
+            "baseName": "day_of_week",
+            "type": "UpdatePushPreferencesRequestDndSchedulesInnerDayOfWeekEnum",
+            "format": ""
+        },
+        {
+            "name": "timeWindows",
+            "baseName": "time_windows",
+            "type": "Array<UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner>",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdatePushPreferencesRequestDndSchedulesInner.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+
+
+export type UpdatePushPreferencesRequestDndSchedulesInnerDayOfWeekEnum = "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday" | "sunday" ;
+

package/models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner {
+    'startHour'?: number;
+    'startMin'?: number;
+    'endHour'?: number;
+    'endMin'?: number;
+
+    static readonly discriminator: string | undefined = undefined;
+
+    static readonly attributeTypeMap: Array<{name: string, baseName: string, type: string, format: string}> = [
+        {
+            "name": "startHour",
+            "baseName": "start_hour",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "startMin",
+            "baseName": "start_min",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "endHour",
+            "baseName": "end_hour",
+            "type": "number",
+            "format": ""
+        },
+        {
+            "name": "endMin",
+            "baseName": "end_min",
+            "type": "number",
+            "format": ""
+        }    ];
+
+    static getAttributeTypeMap() {
+        return UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner.attributeTypeMap;
+    }
+
+    public constructor() {
+    }
+}
+

package/models/UpdatePushPreferencesResponse.ts

@@ -11,6 +11,7 @@
  */
 
 import { SendbirdPushTriggerOption } from './SendbirdPushTriggerOption';
+import { UpdatePushPreferencesRequestDndSchedulesInner } from './UpdatePushPreferencesRequestDndSchedulesInner';
 import { HttpFile } from '../http/http';
 
 export class UpdatePushPreferencesResponse {
@@ -28,6 +29,7 @@ export class UpdatePushPreferencesResponse {
     'startHour'?: number;
     'startMin'?: number;
     'timezone'?: string;
+    'dndSchedules'?: Array<UpdatePushPreferencesRequestDndSchedulesInner>;
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -115,6 +117,12 @@ export class UpdatePushPreferencesResponse {
             "baseName": "timezone",
             "type": "string",
             "format": ""
+        },
+        {
+            "name": "dndSchedules",
+            "baseName": "dnd_schedules",
+            "type": "Array<UpdatePushPreferencesRequestDndSchedulesInner>",
+            "format": ""
         }    ];
 
     static getAttributeTypeMap() {

package/models/ViewPushPreferencesResponse.ts

@@ -11,6 +11,7 @@
  */
 
 import { SendbirdPushTriggerOption } from './SendbirdPushTriggerOption';
+import { UpdatePushPreferencesRequestDndSchedulesInner } from './UpdatePushPreferencesRequestDndSchedulesInner';
 import { HttpFile } from '../http/http';
 
 export class ViewPushPreferencesResponse {
@@ -28,6 +29,7 @@ export class ViewPushPreferencesResponse {
     'startHour'?: number;
     'startMin'?: number;
     'timezone'?: string;
+    'dndSchedules'?: Array<UpdatePushPreferencesRequestDndSchedulesInner>;
 
     static readonly discriminator: string | undefined = undefined;
 
@@ -115,6 +117,12 @@ export class ViewPushPreferencesResponse {
             "baseName": "timezone",
             "type": "string",
             "format": ""
+        },
+        {
+            "name": "dndSchedules",
+            "baseName": "dnd_schedules",
+            "type": "Array<UpdatePushPreferencesRequestDndSchedulesInner>",
+            "format": ""
         }    ];
 
     static getAttributeTypeMap() {

package/models/all.ts

@@ -114,6 +114,8 @@ export * from './UpdateExtraDataInAMessageResponse'
 export * from './UpdatePushPreferencesForAChannelRequest'
 export * from './UpdatePushPreferencesForAChannelResponse'
 export * from './UpdatePushPreferencesRequest'
+export * from './UpdatePushPreferencesRequestDndSchedulesInner'
+export * from './UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner'
 export * from './UpdatePushPreferencesResponse'
 export * from './UpdateSpecificUserMetadataRequest'
 export * from './UpdateUserMetadataRequest'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sendbird/sendbird-platform-sdk-typescript",
-  "version": "2.1.2",
+  "version": "2.1.5",
   "description": "OpenAPI client for sendbird-platform-sdk-typescript",
   "author": "OpenAPI-Generator Contributors",
   "repository": {

package/tests/integration/user.test.ts

@@ -110,6 +110,155 @@ describe("User API", () => {
     expect(typeof response.timezone).toBe("string");
   });
 
+  it("call updatePushPreferences with dndSchedules and verify response", async () => {
+    // 1) 사전 초기화
+    await userApi.updatePushPreferences({
+      apiToken: API_TOKEN,
+      userId: MASTER_USER_ID,
+      updatePushPreferencesRequest: { dndSchedules: [] },
+    });
+
+    // 2) dndSchedules 설정 (자정을 넘기는 윈도우 포함)
+    // 서버는 자정 넘는 윈도우를 자동 분할:
+    //   monday 22:00~07:00 → monday 22:00~23:59 + tuesday 00:00~07:00
+    //   friday 23:30~06:00 → friday 23:30~23:59 + saturday 00:00~06:00
+    const response = await userApi.updatePushPreferences({
+      apiToken: API_TOKEN,
+      userId: MASTER_USER_ID,
+      updatePushPreferencesRequest: {
+        dndSchedules: [
+          {
+            dayOfWeek: "monday",
+            timeWindows: [
+              { startHour: 22, startMin: 0, endHour: 7, endMin: 0 },
+            ],
+          },
+          {
+            dayOfWeek: "friday",
+            timeWindows: [
+              { startHour: 23, startMin: 30, endHour: 6, endMin: 0 },
+              { startHour: 12, startMin: 0, endHour: 13, endMin: 0 },
+            ],
+          },
+        ],
+      },
+    });
+
+    // 3) 응답 검증 - 서버가 자정 넘는 윈도우를 분할하므로 4개 스케줄 반환
+    expect(response).toHaveProperty("dndSchedules");
+    expect(Array.isArray(response.dndSchedules)).toBe(true);
+    expect(response.dndSchedules!.length).toBe(4);
+
+    // monday: 22:00~23:59 (분할된 앞부분)
+    const monday = response.dndSchedules!.find((s) => s.dayOfWeek === "monday");
+    expect(monday).toBeDefined();
+    expect(monday!.timeWindows![0].startHour).toBe(22);
+    expect(monday!.timeWindows![0].endHour).toBe(23);
+    expect(monday!.timeWindows![0].endMin).toBe(59);
+
+    // tuesday: 00:00~07:00 (분할된 뒷부분)
+    const tuesday = response.dndSchedules!.find((s) => s.dayOfWeek === "tuesday");
+    expect(tuesday).toBeDefined();
+    expect(tuesday!.timeWindows![0].startHour).toBe(0);
+    expect(tuesday!.timeWindows![0].endHour).toBe(7);
+
+    // friday: 23:30~23:59 (분할), 12:00~13:00 (그대로)
+    const friday = response.dndSchedules!.find((s) => s.dayOfWeek === "friday");
+    expect(friday).toBeDefined();
+    expect(friday!.timeWindows!.length).toBe(2);
+
+    // saturday: 00:00~06:00 (friday 23:30~06:00의 분할된 뒷부분)
+    const saturday = response.dndSchedules!.find((s) => s.dayOfWeek === "saturday");
+    expect(saturday).toBeDefined();
+    expect(saturday!.timeWindows![0].startHour).toBe(0);
+    expect(saturday!.timeWindows![0].endHour).toBe(6);
+
+    // 4) GET으로 재확인
+    const view = await userApi.viewPushPreferences({
+      apiToken: API_TOKEN,
+      userId: MASTER_USER_ID,
+    });
+    expect(view).toHaveProperty("dndSchedules");
+    expect(Array.isArray(view.dndSchedules)).toBe(true);
+    expect(view.dndSchedules!.length).toBe(4);
+
+    // 5) 원상 복원
+    await userApi.updatePushPreferences({
+      apiToken: API_TOKEN,
+      userId: MASTER_USER_ID,
+      updatePushPreferencesRequest: {
+        dndSchedules: [],
+      },
+    });
+  });
+
+  it("call updatePushPreferences with single day dndSchedule", async () => {
+    // 단일 요일 설정
+    const response = await userApi.updatePushPreferences({
+      apiToken: API_TOKEN,
+      userId: MASTER_USER_ID,
+      updatePushPreferencesRequest: {
+        dndSchedules: [
+          {
+            dayOfWeek: "wednesday",
+            timeWindows: [
+              { startHour: 0, startMin: 0, endHour: 6, endMin: 30 },
+            ],
+          },
+        ],
+      },
+    });
+
+    expect(response).toHaveProperty("dndSchedules");
+    expect(response.dndSchedules!.length).toBe(1);
+    expect(response.dndSchedules![0].dayOfWeek).toBe("wednesday");
+    expect(response.dndSchedules![0].timeWindows!.length).toBe(1);
+    expect(response.dndSchedules![0].timeWindows![0].startHour).toBe(0);
+    expect(response.dndSchedules![0].timeWindows![0].startMin).toBe(0);
+    expect(response.dndSchedules![0].timeWindows![0].endHour).toBe(6);
+    expect(response.dndSchedules![0].timeWindows![0].endMin).toBe(30);
+
+    // 정리
+    await userApi.updatePushPreferences({
+      apiToken: API_TOKEN,
+      userId: MASTER_USER_ID,
+      updatePushPreferencesRequest: {
+        dndSchedules: [],
+      },
+    });
+  });
+
+  it("call updatePushPreferences with empty dndSchedules to clear", async () => {
+    // 먼저 스케줄 설정
+    await userApi.updatePushPreferences({
+      apiToken: API_TOKEN,
+      userId: MASTER_USER_ID,
+      updatePushPreferencesRequest: {
+        dndSchedules: [
+          {
+            dayOfWeek: "sunday",
+            timeWindows: [
+              { startHour: 22, startMin: 0, endHour: 8, endMin: 0 },
+            ],
+          },
+        ],
+      },
+    });
+
+    // 빈 배열로 초기화
+    const response = await userApi.updatePushPreferences({
+      apiToken: API_TOKEN,
+      userId: MASTER_USER_ID,
+      updatePushPreferencesRequest: {
+        dndSchedules: [],
+      },
+    });
+
+    expect(response).toHaveProperty("dndSchedules");
+    expect(Array.isArray(response.dndSchedules)).toBe(true);
+    expect(response.dndSchedules!.length).toBe(0);
+  });
+
   it("call removeARegistrationOrDeviceTokenWhenUnregisteringASpecificToken after addARegistrationOrDeviceToken", async () => {
     const TOKEN_TYPE = "GCM";
     const TEST_GCM_TOKEN = "dummy-token-123";

package/types/ObjectParamAPI.ts

@@ -118,6 +118,8 @@ import { UpdateExtraDataInAMessageResponse } from '../models/UpdateExtraDataInAM
 import { UpdatePushPreferencesForAChannelRequest } from '../models/UpdatePushPreferencesForAChannelRequest';
 import { UpdatePushPreferencesForAChannelResponse } from '../models/UpdatePushPreferencesForAChannelResponse';
 import { UpdatePushPreferencesRequest } from '../models/UpdatePushPreferencesRequest';
+import { UpdatePushPreferencesRequestDndSchedulesInner } from '../models/UpdatePushPreferencesRequestDndSchedulesInner';
+import { UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner } from '../models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner';
 import { UpdatePushPreferencesResponse } from '../models/UpdatePushPreferencesResponse';
 import { UpdateSpecificUserMetadataRequest } from '../models/UpdateSpecificUserMetadataRequest';
 import { UpdateUserMetadataRequest } from '../models/UpdateUserMetadataRequest';

package/types/ObservableAPI.ts

@@ -119,6 +119,8 @@ import { UpdateExtraDataInAMessageResponse } from '../models/UpdateExtraDataInAM
 import { UpdatePushPreferencesForAChannelRequest } from '../models/UpdatePushPreferencesForAChannelRequest';
 import { UpdatePushPreferencesForAChannelResponse } from '../models/UpdatePushPreferencesForAChannelResponse';
 import { UpdatePushPreferencesRequest } from '../models/UpdatePushPreferencesRequest';
+import { UpdatePushPreferencesRequestDndSchedulesInner } from '../models/UpdatePushPreferencesRequestDndSchedulesInner';
+import { UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner } from '../models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner';
 import { UpdatePushPreferencesResponse } from '../models/UpdatePushPreferencesResponse';
 import { UpdateSpecificUserMetadataRequest } from '../models/UpdateSpecificUserMetadataRequest';
 import { UpdateUserMetadataRequest } from '../models/UpdateUserMetadataRequest';

package/types/PromiseAPI.ts

@@ -118,6 +118,8 @@ import { UpdateExtraDataInAMessageResponse } from '../models/UpdateExtraDataInAM
 import { UpdatePushPreferencesForAChannelRequest } from '../models/UpdatePushPreferencesForAChannelRequest';
 import { UpdatePushPreferencesForAChannelResponse } from '../models/UpdatePushPreferencesForAChannelResponse';
 import { UpdatePushPreferencesRequest } from '../models/UpdatePushPreferencesRequest';
+import { UpdatePushPreferencesRequestDndSchedulesInner } from '../models/UpdatePushPreferencesRequestDndSchedulesInner';
+import { UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner } from '../models/UpdatePushPreferencesRequestDndSchedulesInnerTimeWindowsInner';
 import { UpdatePushPreferencesResponse } from '../models/UpdatePushPreferencesResponse';
 import { UpdateSpecificUserMetadataRequest } from '../models/UpdateSpecificUserMetadataRequest';
 import { UpdateUserMetadataRequest } from '../models/UpdateUserMetadataRequest';