@ject-4-vs-team/api-client 2026.501.3 → 2026.501.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,269 @@
1
+ /**
2
+ * VS Server API
3
+ * JECT 4기 2팀 VS Server API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { ChatListResponse } from '../models';
16
+ import type { ChatRoomResponse } from '../models';
17
+ import type { GaugeResponse } from '../models';
18
+ import type { MarkAsReadRequest } from '../models';
19
+ import type { MessagePageResponse } from '../models';
20
+ import type { MessageResponse } from '../models';
21
+ import type { SendMessageRequest } from '../models';
22
+ /**
23
+ * ChatApi - axios parameter creator
24
+ * @export
25
+ */
26
+ export declare const ChatApiAxiosParamCreator: (configuration?: Configuration) => {
27
+ /**
28
+ * 로그인 사용자가 참여한 채팅방을 투표 진행 상태별로 조회합니다.
29
+ * @summary 채팅방 목록 조회
30
+ * @param {GetChatListStatusEnum} status 조회할 투표 상태
31
+ * @param {*} [options] Override http request option.
32
+ * @throws {RequiredError}
33
+ */
34
+ getChatList: (status: GetChatListStatusEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
35
+ /**
36
+ * 채팅방 상단에 표시할 투표 제목, 진행 상태, 선택지, 참여자 수, 종료 시간을 조회합니다.
37
+ * @summary 채팅방 상세 조회
38
+ * @param {number} voteId 채팅방이 연결된 투표 ID
39
+ * @param {*} [options] Override http request option.
40
+ * @throws {RequiredError}
41
+ */
42
+ getChatRoom: (voteId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
43
+ /**
44
+ * 채팅방에서 표시할 A/B 선택지 투표 비율과 참여자 수를 조회합니다. 비율 값은 0부터 100까지의 정수입니다.
45
+ * @summary 투표 게이지 조회
46
+ * @param {number} voteId 게이지를 조회할 투표 ID
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ getGauge: (voteId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
51
+ /**
52
+ * 채팅방 메시지를 커서 기반으로 조회합니다. cursor가 없으면 최신 메시지 기준으로 조회하고, nextCursor와 hasNext로 다음 페이지 요청 여부를 판단합니다.
53
+ * @summary 채팅 메시지 목록 조회
54
+ * @param {number} voteId 메시지를 조회할 투표 ID
55
+ * @param {number} [cursor] 이전 페이지의 nextCursor. 첫 조회 시 생략합니다.
56
+ * @param {number} [size] 조회할 메시지 수
57
+ * @param {*} [options] Override http request option.
58
+ * @throws {RequiredError}
59
+ */
60
+ getMessages: (voteId: number, cursor?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
61
+ /**
62
+ * 사용자가 마지막으로 읽은 메시지 ID를 저장해 이후 채팅방 목록의 unreadCount 계산에 사용합니다.
63
+ * @summary 채팅방 읽음 처리
64
+ * @param {number} voteId 읽음 처리할 투표 ID
65
+ * @param {MarkAsReadRequest} markAsReadRequest 마지막으로 읽은 메시지 ID
66
+ * @param {*} [options] Override http request option.
67
+ * @throws {RequiredError}
68
+ */
69
+ markAsRead: (voteId: number, markAsReadRequest: MarkAsReadRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
70
+ /**
71
+ * 채팅방에 새 메시지를 전송하고 저장된 메시지 정보를 반환합니다.
72
+ * @summary 채팅 메시지 전송
73
+ * @param {number} voteId 메시지를 전송할 투표 ID
74
+ * @param {SendMessageRequest} sendMessageRequest 전송할 메시지 내용
75
+ * @param {*} [options] Override http request option.
76
+ * @throws {RequiredError}
77
+ */
78
+ sendMessage: (voteId: number, sendMessageRequest: SendMessageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
79
+ };
80
+ /**
81
+ * ChatApi - functional programming interface
82
+ * @export
83
+ */
84
+ export declare const ChatApiFp: (configuration?: Configuration) => {
85
+ /**
86
+ * 로그인 사용자가 참여한 채팅방을 투표 진행 상태별로 조회합니다.
87
+ * @summary 채팅방 목록 조회
88
+ * @param {GetChatListStatusEnum} status 조회할 투표 상태
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ getChatList(status: GetChatListStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatListResponse>>;
93
+ /**
94
+ * 채팅방 상단에 표시할 투표 제목, 진행 상태, 선택지, 참여자 수, 종료 시간을 조회합니다.
95
+ * @summary 채팅방 상세 조회
96
+ * @param {number} voteId 채팅방이 연결된 투표 ID
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ getChatRoom(voteId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatRoomResponse>>;
101
+ /**
102
+ * 채팅방에서 표시할 A/B 선택지 투표 비율과 참여자 수를 조회합니다. 비율 값은 0부터 100까지의 정수입니다.
103
+ * @summary 투표 게이지 조회
104
+ * @param {number} voteId 게이지를 조회할 투표 ID
105
+ * @param {*} [options] Override http request option.
106
+ * @throws {RequiredError}
107
+ */
108
+ getGauge(voteId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GaugeResponse>>;
109
+ /**
110
+ * 채팅방 메시지를 커서 기반으로 조회합니다. cursor가 없으면 최신 메시지 기준으로 조회하고, nextCursor와 hasNext로 다음 페이지 요청 여부를 판단합니다.
111
+ * @summary 채팅 메시지 목록 조회
112
+ * @param {number} voteId 메시지를 조회할 투표 ID
113
+ * @param {number} [cursor] 이전 페이지의 nextCursor. 첫 조회 시 생략합니다.
114
+ * @param {number} [size] 조회할 메시지 수
115
+ * @param {*} [options] Override http request option.
116
+ * @throws {RequiredError}
117
+ */
118
+ getMessages(voteId: number, cursor?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessagePageResponse>>;
119
+ /**
120
+ * 사용자가 마지막으로 읽은 메시지 ID를 저장해 이후 채팅방 목록의 unreadCount 계산에 사용합니다.
121
+ * @summary 채팅방 읽음 처리
122
+ * @param {number} voteId 읽음 처리할 투표 ID
123
+ * @param {MarkAsReadRequest} markAsReadRequest 마지막으로 읽은 메시지 ID
124
+ * @param {*} [options] Override http request option.
125
+ * @throws {RequiredError}
126
+ */
127
+ markAsRead(voteId: number, markAsReadRequest: MarkAsReadRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
128
+ /**
129
+ * 채팅방에 새 메시지를 전송하고 저장된 메시지 정보를 반환합니다.
130
+ * @summary 채팅 메시지 전송
131
+ * @param {number} voteId 메시지를 전송할 투표 ID
132
+ * @param {SendMessageRequest} sendMessageRequest 전송할 메시지 내용
133
+ * @param {*} [options] Override http request option.
134
+ * @throws {RequiredError}
135
+ */
136
+ sendMessage(voteId: number, sendMessageRequest: SendMessageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
137
+ };
138
+ /**
139
+ * ChatApi - factory interface
140
+ * @export
141
+ */
142
+ export declare const ChatApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
143
+ /**
144
+ * 로그인 사용자가 참여한 채팅방을 투표 진행 상태별로 조회합니다.
145
+ * @summary 채팅방 목록 조회
146
+ * @param {GetChatListStatusEnum} status 조회할 투표 상태
147
+ * @param {*} [options] Override http request option.
148
+ * @throws {RequiredError}
149
+ */
150
+ getChatList(status: GetChatListStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<ChatListResponse>;
151
+ /**
152
+ * 채팅방 상단에 표시할 투표 제목, 진행 상태, 선택지, 참여자 수, 종료 시간을 조회합니다.
153
+ * @summary 채팅방 상세 조회
154
+ * @param {number} voteId 채팅방이 연결된 투표 ID
155
+ * @param {*} [options] Override http request option.
156
+ * @throws {RequiredError}
157
+ */
158
+ getChatRoom(voteId: number, options?: RawAxiosRequestConfig): AxiosPromise<ChatRoomResponse>;
159
+ /**
160
+ * 채팅방에서 표시할 A/B 선택지 투표 비율과 참여자 수를 조회합니다. 비율 값은 0부터 100까지의 정수입니다.
161
+ * @summary 투표 게이지 조회
162
+ * @param {number} voteId 게이지를 조회할 투표 ID
163
+ * @param {*} [options] Override http request option.
164
+ * @throws {RequiredError}
165
+ */
166
+ getGauge(voteId: number, options?: RawAxiosRequestConfig): AxiosPromise<GaugeResponse>;
167
+ /**
168
+ * 채팅방 메시지를 커서 기반으로 조회합니다. cursor가 없으면 최신 메시지 기준으로 조회하고, nextCursor와 hasNext로 다음 페이지 요청 여부를 판단합니다.
169
+ * @summary 채팅 메시지 목록 조회
170
+ * @param {number} voteId 메시지를 조회할 투표 ID
171
+ * @param {number} [cursor] 이전 페이지의 nextCursor. 첫 조회 시 생략합니다.
172
+ * @param {number} [size] 조회할 메시지 수
173
+ * @param {*} [options] Override http request option.
174
+ * @throws {RequiredError}
175
+ */
176
+ getMessages(voteId: number, cursor?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<MessagePageResponse>;
177
+ /**
178
+ * 사용자가 마지막으로 읽은 메시지 ID를 저장해 이후 채팅방 목록의 unreadCount 계산에 사용합니다.
179
+ * @summary 채팅방 읽음 처리
180
+ * @param {number} voteId 읽음 처리할 투표 ID
181
+ * @param {MarkAsReadRequest} markAsReadRequest 마지막으로 읽은 메시지 ID
182
+ * @param {*} [options] Override http request option.
183
+ * @throws {RequiredError}
184
+ */
185
+ markAsRead(voteId: number, markAsReadRequest: MarkAsReadRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
186
+ /**
187
+ * 채팅방에 새 메시지를 전송하고 저장된 메시지 정보를 반환합니다.
188
+ * @summary 채팅 메시지 전송
189
+ * @param {number} voteId 메시지를 전송할 투표 ID
190
+ * @param {SendMessageRequest} sendMessageRequest 전송할 메시지 내용
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ */
194
+ sendMessage(voteId: number, sendMessageRequest: SendMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
195
+ };
196
+ /**
197
+ * ChatApi - object-oriented interface
198
+ * @export
199
+ * @class ChatApi
200
+ * @extends {BaseAPI}
201
+ */
202
+ export declare class ChatApi extends BaseAPI {
203
+ /**
204
+ * 로그인 사용자가 참여한 채팅방을 투표 진행 상태별로 조회합니다.
205
+ * @summary 채팅방 목록 조회
206
+ * @param {GetChatListStatusEnum} status 조회할 투표 상태
207
+ * @param {*} [options] Override http request option.
208
+ * @throws {RequiredError}
209
+ * @memberof ChatApi
210
+ */
211
+ getChatList(status: GetChatListStatusEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatListResponse, any, {}>>;
212
+ /**
213
+ * 채팅방 상단에 표시할 투표 제목, 진행 상태, 선택지, 참여자 수, 종료 시간을 조회합니다.
214
+ * @summary 채팅방 상세 조회
215
+ * @param {number} voteId 채팅방이 연결된 투표 ID
216
+ * @param {*} [options] Override http request option.
217
+ * @throws {RequiredError}
218
+ * @memberof ChatApi
219
+ */
220
+ getChatRoom(voteId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatRoomResponse, any, {}>>;
221
+ /**
222
+ * 채팅방에서 표시할 A/B 선택지 투표 비율과 참여자 수를 조회합니다. 비율 값은 0부터 100까지의 정수입니다.
223
+ * @summary 투표 게이지 조회
224
+ * @param {number} voteId 게이지를 조회할 투표 ID
225
+ * @param {*} [options] Override http request option.
226
+ * @throws {RequiredError}
227
+ * @memberof ChatApi
228
+ */
229
+ getGauge(voteId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GaugeResponse, any, {}>>;
230
+ /**
231
+ * 채팅방 메시지를 커서 기반으로 조회합니다. cursor가 없으면 최신 메시지 기준으로 조회하고, nextCursor와 hasNext로 다음 페이지 요청 여부를 판단합니다.
232
+ * @summary 채팅 메시지 목록 조회
233
+ * @param {number} voteId 메시지를 조회할 투표 ID
234
+ * @param {number} [cursor] 이전 페이지의 nextCursor. 첫 조회 시 생략합니다.
235
+ * @param {number} [size] 조회할 메시지 수
236
+ * @param {*} [options] Override http request option.
237
+ * @throws {RequiredError}
238
+ * @memberof ChatApi
239
+ */
240
+ getMessages(voteId: number, cursor?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessagePageResponse, any, {}>>;
241
+ /**
242
+ * 사용자가 마지막으로 읽은 메시지 ID를 저장해 이후 채팅방 목록의 unreadCount 계산에 사용합니다.
243
+ * @summary 채팅방 읽음 처리
244
+ * @param {number} voteId 읽음 처리할 투표 ID
245
+ * @param {MarkAsReadRequest} markAsReadRequest 마지막으로 읽은 메시지 ID
246
+ * @param {*} [options] Override http request option.
247
+ * @throws {RequiredError}
248
+ * @memberof ChatApi
249
+ */
250
+ markAsRead(voteId: number, markAsReadRequest: MarkAsReadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
251
+ /**
252
+ * 채팅방에 새 메시지를 전송하고 저장된 메시지 정보를 반환합니다.
253
+ * @summary 채팅 메시지 전송
254
+ * @param {number} voteId 메시지를 전송할 투표 ID
255
+ * @param {SendMessageRequest} sendMessageRequest 전송할 메시지 내용
256
+ * @param {*} [options] Override http request option.
257
+ * @throws {RequiredError}
258
+ * @memberof ChatApi
259
+ */
260
+ sendMessage(voteId: number, sendMessageRequest: SendMessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
261
+ }
262
+ /**
263
+ * @export
264
+ */
265
+ export declare const GetChatListStatusEnum: {
266
+ readonly Ongoing: "ONGOING";
267
+ readonly Ended: "ENDED";
268
+ };
269
+ export type GetChatListStatusEnum = typeof GetChatListStatusEnum[keyof typeof GetChatListStatusEnum];
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
16
16
  return (mod && mod.__esModule) ? mod : { "default": mod };
17
17
  };
18
18
  Object.defineProperty(exports, "__esModule", { value: true });
19
- exports.GetChatListStatusEnum = exports.ChatControllerApi = exports.ChatControllerApiFactory = exports.ChatControllerApiFp = exports.ChatControllerApiAxiosParamCreator = void 0;
19
+ exports.GetChatListStatusEnum = exports.ChatApi = exports.ChatApiFactory = exports.ChatApiFp = exports.ChatApiAxiosParamCreator = void 0;
20
20
  const axios_1 = __importDefault(require("axios"));
21
21
  // Some imports not used depending on template conditions
22
22
  // @ts-ignore
@@ -24,14 +24,15 @@ const common_1 = require("../common");
24
24
  // @ts-ignore
25
25
  const base_1 = require("../base");
26
26
  /**
27
- * ChatControllerApi - axios parameter creator
27
+ * ChatApi - axios parameter creator
28
28
  * @export
29
29
  */
30
- const ChatControllerApiAxiosParamCreator = function (configuration) {
30
+ const ChatApiAxiosParamCreator = function (configuration) {
31
31
  return {
32
32
  /**
33
- *
34
- * @param {GetChatListStatusEnum} status
33
+ * 로그인 사용자가 참여한 채팅방을 투표 진행 상태별로 조회합니다.
34
+ * @summary 채팅방 목록 조회
35
+ * @param {GetChatListStatusEnum} status 조회할 투표 상태
35
36
  * @param {*} [options] Override http request option.
36
37
  * @throws {RequiredError}
37
38
  */
@@ -63,8 +64,9 @@ const ChatControllerApiAxiosParamCreator = function (configuration) {
63
64
  };
64
65
  },
65
66
  /**
66
- *
67
- * @param {number} voteId
67
+ * 채팅방 상단에 표시할 투표 제목, 진행 상태, 선택지, 참여자 수, 종료 시간을 조회합니다.
68
+ * @summary 채팅방 상세 조회
69
+ * @param {number} voteId 채팅방이 연결된 투표 ID
68
70
  * @param {*} [options] Override http request option.
69
71
  * @throws {RequiredError}
70
72
  */
@@ -94,8 +96,9 @@ const ChatControllerApiAxiosParamCreator = function (configuration) {
94
96
  };
95
97
  },
96
98
  /**
97
- *
98
- * @param {number} voteId
99
+ * 채팅방에서 표시할 A/B 선택지 투표 비율과 참여자 수를 조회합니다. 비율 값은 0부터 100까지의 정수입니다.
100
+ * @summary 투표 게이지 조회
101
+ * @param {number} voteId 게이지를 조회할 투표 ID
99
102
  * @param {*} [options] Override http request option.
100
103
  * @throws {RequiredError}
101
104
  */
@@ -125,10 +128,11 @@ const ChatControllerApiAxiosParamCreator = function (configuration) {
125
128
  };
126
129
  },
127
130
  /**
128
- *
129
- * @param {number} voteId
130
- * @param {number} [cursor]
131
- * @param {number} [size]
131
+ * 채팅방 메시지를 커서 기반으로 조회합니다. cursor가 없으면 최신 메시지 기준으로 조회하고, nextCursor와 hasNext로 다음 페이지 요청 여부를 판단합니다.
132
+ * @summary 채팅 메시지 목록 조회
133
+ * @param {number} voteId 메시지를 조회할 투표 ID
134
+ * @param {number} [cursor] 이전 페이지의 nextCursor. 첫 조회 시 생략합니다.
135
+ * @param {number} [size] 조회할 메시지 수
132
136
  * @param {*} [options] Override http request option.
133
137
  * @throws {RequiredError}
134
138
  */
@@ -164,9 +168,10 @@ const ChatControllerApiAxiosParamCreator = function (configuration) {
164
168
  };
165
169
  },
166
170
  /**
167
- *
168
- * @param {number} voteId
169
- * @param {MarkAsReadRequest} markAsReadRequest
171
+ * 사용자가 마지막으로 읽은 메시지 ID를 저장해 이후 채팅방 목록의 unreadCount 계산에 사용합니다.
172
+ * @summary 채팅방 읽음 처리
173
+ * @param {number} voteId 읽음 처리할 투표 ID
174
+ * @param {MarkAsReadRequest} markAsReadRequest 마지막으로 읽은 메시지 ID
170
175
  * @param {*} [options] Override http request option.
171
176
  * @throws {RequiredError}
172
177
  */
@@ -200,9 +205,10 @@ const ChatControllerApiAxiosParamCreator = function (configuration) {
200
205
  };
201
206
  },
202
207
  /**
203
- *
204
- * @param {number} voteId
205
- * @param {SendMessageRequest} sendMessageRequest
208
+ * 채팅방에 새 메시지를 전송하고 저장된 메시지 정보를 반환합니다.
209
+ * @summary 채팅 메시지 전송
210
+ * @param {number} voteId 메시지를 전송할 투표 ID
211
+ * @param {SendMessageRequest} sendMessageRequest 전송할 메시지 내용
206
212
  * @param {*} [options] Override http request option.
207
213
  * @throws {RequiredError}
208
214
  */
@@ -237,103 +243,110 @@ const ChatControllerApiAxiosParamCreator = function (configuration) {
237
243
  },
238
244
  };
239
245
  };
240
- exports.ChatControllerApiAxiosParamCreator = ChatControllerApiAxiosParamCreator;
246
+ exports.ChatApiAxiosParamCreator = ChatApiAxiosParamCreator;
241
247
  /**
242
- * ChatControllerApi - functional programming interface
248
+ * ChatApi - functional programming interface
243
249
  * @export
244
250
  */
245
- const ChatControllerApiFp = function (configuration) {
246
- const localVarAxiosParamCreator = (0, exports.ChatControllerApiAxiosParamCreator)(configuration);
251
+ const ChatApiFp = function (configuration) {
252
+ const localVarAxiosParamCreator = (0, exports.ChatApiAxiosParamCreator)(configuration);
247
253
  return {
248
254
  /**
249
- *
250
- * @param {GetChatListStatusEnum} status
255
+ * 로그인 사용자가 참여한 채팅방을 투표 진행 상태별로 조회합니다.
256
+ * @summary 채팅방 목록 조회
257
+ * @param {GetChatListStatusEnum} status 조회할 투표 상태
251
258
  * @param {*} [options] Override http request option.
252
259
  * @throws {RequiredError}
253
260
  */
254
261
  async getChatList(status, options) {
255
262
  const localVarAxiosArgs = await localVarAxiosParamCreator.getChatList(status, options);
256
263
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
257
- const localVarOperationServerBasePath = base_1.operationServerMap['ChatControllerApi.getChatList']?.[localVarOperationServerIndex]?.url;
264
+ const localVarOperationServerBasePath = base_1.operationServerMap['ChatApi.getChatList']?.[localVarOperationServerIndex]?.url;
258
265
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
259
266
  },
260
267
  /**
261
- *
262
- * @param {number} voteId
268
+ * 채팅방 상단에 표시할 투표 제목, 진행 상태, 선택지, 참여자 수, 종료 시간을 조회합니다.
269
+ * @summary 채팅방 상세 조회
270
+ * @param {number} voteId 채팅방이 연결된 투표 ID
263
271
  * @param {*} [options] Override http request option.
264
272
  * @throws {RequiredError}
265
273
  */
266
274
  async getChatRoom(voteId, options) {
267
275
  const localVarAxiosArgs = await localVarAxiosParamCreator.getChatRoom(voteId, options);
268
276
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
269
- const localVarOperationServerBasePath = base_1.operationServerMap['ChatControllerApi.getChatRoom']?.[localVarOperationServerIndex]?.url;
277
+ const localVarOperationServerBasePath = base_1.operationServerMap['ChatApi.getChatRoom']?.[localVarOperationServerIndex]?.url;
270
278
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
271
279
  },
272
280
  /**
273
- *
274
- * @param {number} voteId
281
+ * 채팅방에서 표시할 A/B 선택지 투표 비율과 참여자 수를 조회합니다. 비율 값은 0부터 100까지의 정수입니다.
282
+ * @summary 투표 게이지 조회
283
+ * @param {number} voteId 게이지를 조회할 투표 ID
275
284
  * @param {*} [options] Override http request option.
276
285
  * @throws {RequiredError}
277
286
  */
278
287
  async getGauge(voteId, options) {
279
288
  const localVarAxiosArgs = await localVarAxiosParamCreator.getGauge(voteId, options);
280
289
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
281
- const localVarOperationServerBasePath = base_1.operationServerMap['ChatControllerApi.getGauge']?.[localVarOperationServerIndex]?.url;
290
+ const localVarOperationServerBasePath = base_1.operationServerMap['ChatApi.getGauge']?.[localVarOperationServerIndex]?.url;
282
291
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
283
292
  },
284
293
  /**
285
- *
286
- * @param {number} voteId
287
- * @param {number} [cursor]
288
- * @param {number} [size]
294
+ * 채팅방 메시지를 커서 기반으로 조회합니다. cursor가 없으면 최신 메시지 기준으로 조회하고, nextCursor와 hasNext로 다음 페이지 요청 여부를 판단합니다.
295
+ * @summary 채팅 메시지 목록 조회
296
+ * @param {number} voteId 메시지를 조회할 투표 ID
297
+ * @param {number} [cursor] 이전 페이지의 nextCursor. 첫 조회 시 생략합니다.
298
+ * @param {number} [size] 조회할 메시지 수
289
299
  * @param {*} [options] Override http request option.
290
300
  * @throws {RequiredError}
291
301
  */
292
302
  async getMessages(voteId, cursor, size, options) {
293
303
  const localVarAxiosArgs = await localVarAxiosParamCreator.getMessages(voteId, cursor, size, options);
294
304
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
295
- const localVarOperationServerBasePath = base_1.operationServerMap['ChatControllerApi.getMessages']?.[localVarOperationServerIndex]?.url;
305
+ const localVarOperationServerBasePath = base_1.operationServerMap['ChatApi.getMessages']?.[localVarOperationServerIndex]?.url;
296
306
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
297
307
  },
298
308
  /**
299
- *
300
- * @param {number} voteId
301
- * @param {MarkAsReadRequest} markAsReadRequest
309
+ * 사용자가 마지막으로 읽은 메시지 ID를 저장해 이후 채팅방 목록의 unreadCount 계산에 사용합니다.
310
+ * @summary 채팅방 읽음 처리
311
+ * @param {number} voteId 읽음 처리할 투표 ID
312
+ * @param {MarkAsReadRequest} markAsReadRequest 마지막으로 읽은 메시지 ID
302
313
  * @param {*} [options] Override http request option.
303
314
  * @throws {RequiredError}
304
315
  */
305
316
  async markAsRead(voteId, markAsReadRequest, options) {
306
317
  const localVarAxiosArgs = await localVarAxiosParamCreator.markAsRead(voteId, markAsReadRequest, options);
307
318
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
308
- const localVarOperationServerBasePath = base_1.operationServerMap['ChatControllerApi.markAsRead']?.[localVarOperationServerIndex]?.url;
319
+ const localVarOperationServerBasePath = base_1.operationServerMap['ChatApi.markAsRead']?.[localVarOperationServerIndex]?.url;
309
320
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
310
321
  },
311
322
  /**
312
- *
313
- * @param {number} voteId
314
- * @param {SendMessageRequest} sendMessageRequest
323
+ * 채팅방에 새 메시지를 전송하고 저장된 메시지 정보를 반환합니다.
324
+ * @summary 채팅 메시지 전송
325
+ * @param {number} voteId 메시지를 전송할 투표 ID
326
+ * @param {SendMessageRequest} sendMessageRequest 전송할 메시지 내용
315
327
  * @param {*} [options] Override http request option.
316
328
  * @throws {RequiredError}
317
329
  */
318
330
  async sendMessage(voteId, sendMessageRequest, options) {
319
331
  const localVarAxiosArgs = await localVarAxiosParamCreator.sendMessage(voteId, sendMessageRequest, options);
320
332
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
321
- const localVarOperationServerBasePath = base_1.operationServerMap['ChatControllerApi.sendMessage']?.[localVarOperationServerIndex]?.url;
333
+ const localVarOperationServerBasePath = base_1.operationServerMap['ChatApi.sendMessage']?.[localVarOperationServerIndex]?.url;
322
334
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
323
335
  },
324
336
  };
325
337
  };
326
- exports.ChatControllerApiFp = ChatControllerApiFp;
338
+ exports.ChatApiFp = ChatApiFp;
327
339
  /**
328
- * ChatControllerApi - factory interface
340
+ * ChatApi - factory interface
329
341
  * @export
330
342
  */
331
- const ChatControllerApiFactory = function (configuration, basePath, axios) {
332
- const localVarFp = (0, exports.ChatControllerApiFp)(configuration);
343
+ const ChatApiFactory = function (configuration, basePath, axios) {
344
+ const localVarFp = (0, exports.ChatApiFp)(configuration);
333
345
  return {
334
346
  /**
335
- *
336
- * @param {GetChatListStatusEnum} status
347
+ * 로그인 사용자가 참여한 채팅방을 투표 진행 상태별로 조회합니다.
348
+ * @summary 채팅방 목록 조회
349
+ * @param {GetChatListStatusEnum} status 조회할 투표 상태
337
350
  * @param {*} [options] Override http request option.
338
351
  * @throws {RequiredError}
339
352
  */
@@ -341,8 +354,9 @@ const ChatControllerApiFactory = function (configuration, basePath, axios) {
341
354
  return localVarFp.getChatList(status, options).then((request) => request(axios, basePath));
342
355
  },
343
356
  /**
344
- *
345
- * @param {number} voteId
357
+ * 채팅방 상단에 표시할 투표 제목, 진행 상태, 선택지, 참여자 수, 종료 시간을 조회합니다.
358
+ * @summary 채팅방 상세 조회
359
+ * @param {number} voteId 채팅방이 연결된 투표 ID
346
360
  * @param {*} [options] Override http request option.
347
361
  * @throws {RequiredError}
348
362
  */
@@ -350,8 +364,9 @@ const ChatControllerApiFactory = function (configuration, basePath, axios) {
350
364
  return localVarFp.getChatRoom(voteId, options).then((request) => request(axios, basePath));
351
365
  },
352
366
  /**
353
- *
354
- * @param {number} voteId
367
+ * 채팅방에서 표시할 A/B 선택지 투표 비율과 참여자 수를 조회합니다. 비율 값은 0부터 100까지의 정수입니다.
368
+ * @summary 투표 게이지 조회
369
+ * @param {number} voteId 게이지를 조회할 투표 ID
355
370
  * @param {*} [options] Override http request option.
356
371
  * @throws {RequiredError}
357
372
  */
@@ -359,10 +374,11 @@ const ChatControllerApiFactory = function (configuration, basePath, axios) {
359
374
  return localVarFp.getGauge(voteId, options).then((request) => request(axios, basePath));
360
375
  },
361
376
  /**
362
- *
363
- * @param {number} voteId
364
- * @param {number} [cursor]
365
- * @param {number} [size]
377
+ * 채팅방 메시지를 커서 기반으로 조회합니다. cursor가 없으면 최신 메시지 기준으로 조회하고, nextCursor와 hasNext로 다음 페이지 요청 여부를 판단합니다.
378
+ * @summary 채팅 메시지 목록 조회
379
+ * @param {number} voteId 메시지를 조회할 투표 ID
380
+ * @param {number} [cursor] 이전 페이지의 nextCursor. 첫 조회 시 생략합니다.
381
+ * @param {number} [size] 조회할 메시지 수
366
382
  * @param {*} [options] Override http request option.
367
383
  * @throws {RequiredError}
368
384
  */
@@ -370,9 +386,10 @@ const ChatControllerApiFactory = function (configuration, basePath, axios) {
370
386
  return localVarFp.getMessages(voteId, cursor, size, options).then((request) => request(axios, basePath));
371
387
  },
372
388
  /**
373
- *
374
- * @param {number} voteId
375
- * @param {MarkAsReadRequest} markAsReadRequest
389
+ * 사용자가 마지막으로 읽은 메시지 ID를 저장해 이후 채팅방 목록의 unreadCount 계산에 사용합니다.
390
+ * @summary 채팅방 읽음 처리
391
+ * @param {number} voteId 읽음 처리할 투표 ID
392
+ * @param {MarkAsReadRequest} markAsReadRequest 마지막으로 읽은 메시지 ID
376
393
  * @param {*} [options] Override http request option.
377
394
  * @throws {RequiredError}
378
395
  */
@@ -380,9 +397,10 @@ const ChatControllerApiFactory = function (configuration, basePath, axios) {
380
397
  return localVarFp.markAsRead(voteId, markAsReadRequest, options).then((request) => request(axios, basePath));
381
398
  },
382
399
  /**
383
- *
384
- * @param {number} voteId
385
- * @param {SendMessageRequest} sendMessageRequest
400
+ * 채팅방에 새 메시지를 전송하고 저장된 메시지 정보를 반환합니다.
401
+ * @summary 채팅 메시지 전송
402
+ * @param {number} voteId 메시지를 전송할 투표 ID
403
+ * @param {SendMessageRequest} sendMessageRequest 전송할 메시지 내용
386
404
  * @param {*} [options] Override http request option.
387
405
  * @throws {RequiredError}
388
406
  */
@@ -391,80 +409,86 @@ const ChatControllerApiFactory = function (configuration, basePath, axios) {
391
409
  },
392
410
  };
393
411
  };
394
- exports.ChatControllerApiFactory = ChatControllerApiFactory;
412
+ exports.ChatApiFactory = ChatApiFactory;
395
413
  /**
396
- * ChatControllerApi - object-oriented interface
414
+ * ChatApi - object-oriented interface
397
415
  * @export
398
- * @class ChatControllerApi
416
+ * @class ChatApi
399
417
  * @extends {BaseAPI}
400
418
  */
401
- class ChatControllerApi extends base_1.BaseAPI {
419
+ class ChatApi extends base_1.BaseAPI {
402
420
  /**
403
- *
404
- * @param {GetChatListStatusEnum} status
421
+ * 로그인 사용자가 참여한 채팅방을 투표 진행 상태별로 조회합니다.
422
+ * @summary 채팅방 목록 조회
423
+ * @param {GetChatListStatusEnum} status 조회할 투표 상태
405
424
  * @param {*} [options] Override http request option.
406
425
  * @throws {RequiredError}
407
- * @memberof ChatControllerApi
426
+ * @memberof ChatApi
408
427
  */
409
428
  getChatList(status, options) {
410
- return (0, exports.ChatControllerApiFp)(this.configuration).getChatList(status, options).then((request) => request(this.axios, this.basePath));
429
+ return (0, exports.ChatApiFp)(this.configuration).getChatList(status, options).then((request) => request(this.axios, this.basePath));
411
430
  }
412
431
  /**
413
- *
414
- * @param {number} voteId
432
+ * 채팅방 상단에 표시할 투표 제목, 진행 상태, 선택지, 참여자 수, 종료 시간을 조회합니다.
433
+ * @summary 채팅방 상세 조회
434
+ * @param {number} voteId 채팅방이 연결된 투표 ID
415
435
  * @param {*} [options] Override http request option.
416
436
  * @throws {RequiredError}
417
- * @memberof ChatControllerApi
437
+ * @memberof ChatApi
418
438
  */
419
439
  getChatRoom(voteId, options) {
420
- return (0, exports.ChatControllerApiFp)(this.configuration).getChatRoom(voteId, options).then((request) => request(this.axios, this.basePath));
440
+ return (0, exports.ChatApiFp)(this.configuration).getChatRoom(voteId, options).then((request) => request(this.axios, this.basePath));
421
441
  }
422
442
  /**
423
- *
424
- * @param {number} voteId
443
+ * 채팅방에서 표시할 A/B 선택지 투표 비율과 참여자 수를 조회합니다. 비율 값은 0부터 100까지의 정수입니다.
444
+ * @summary 투표 게이지 조회
445
+ * @param {number} voteId 게이지를 조회할 투표 ID
425
446
  * @param {*} [options] Override http request option.
426
447
  * @throws {RequiredError}
427
- * @memberof ChatControllerApi
448
+ * @memberof ChatApi
428
449
  */
429
450
  getGauge(voteId, options) {
430
- return (0, exports.ChatControllerApiFp)(this.configuration).getGauge(voteId, options).then((request) => request(this.axios, this.basePath));
451
+ return (0, exports.ChatApiFp)(this.configuration).getGauge(voteId, options).then((request) => request(this.axios, this.basePath));
431
452
  }
432
453
  /**
433
- *
434
- * @param {number} voteId
435
- * @param {number} [cursor]
436
- * @param {number} [size]
454
+ * 채팅방 메시지를 커서 기반으로 조회합니다. cursor가 없으면 최신 메시지 기준으로 조회하고, nextCursor와 hasNext로 다음 페이지 요청 여부를 판단합니다.
455
+ * @summary 채팅 메시지 목록 조회
456
+ * @param {number} voteId 메시지를 조회할 투표 ID
457
+ * @param {number} [cursor] 이전 페이지의 nextCursor. 첫 조회 시 생략합니다.
458
+ * @param {number} [size] 조회할 메시지 수
437
459
  * @param {*} [options] Override http request option.
438
460
  * @throws {RequiredError}
439
- * @memberof ChatControllerApi
461
+ * @memberof ChatApi
440
462
  */
441
463
  getMessages(voteId, cursor, size, options) {
442
- return (0, exports.ChatControllerApiFp)(this.configuration).getMessages(voteId, cursor, size, options).then((request) => request(this.axios, this.basePath));
464
+ return (0, exports.ChatApiFp)(this.configuration).getMessages(voteId, cursor, size, options).then((request) => request(this.axios, this.basePath));
443
465
  }
444
466
  /**
445
- *
446
- * @param {number} voteId
447
- * @param {MarkAsReadRequest} markAsReadRequest
467
+ * 사용자가 마지막으로 읽은 메시지 ID를 저장해 이후 채팅방 목록의 unreadCount 계산에 사용합니다.
468
+ * @summary 채팅방 읽음 처리
469
+ * @param {number} voteId 읽음 처리할 투표 ID
470
+ * @param {MarkAsReadRequest} markAsReadRequest 마지막으로 읽은 메시지 ID
448
471
  * @param {*} [options] Override http request option.
449
472
  * @throws {RequiredError}
450
- * @memberof ChatControllerApi
473
+ * @memberof ChatApi
451
474
  */
452
475
  markAsRead(voteId, markAsReadRequest, options) {
453
- return (0, exports.ChatControllerApiFp)(this.configuration).markAsRead(voteId, markAsReadRequest, options).then((request) => request(this.axios, this.basePath));
476
+ return (0, exports.ChatApiFp)(this.configuration).markAsRead(voteId, markAsReadRequest, options).then((request) => request(this.axios, this.basePath));
454
477
  }
455
478
  /**
456
- *
457
- * @param {number} voteId
458
- * @param {SendMessageRequest} sendMessageRequest
479
+ * 채팅방에 새 메시지를 전송하고 저장된 메시지 정보를 반환합니다.
480
+ * @summary 채팅 메시지 전송
481
+ * @param {number} voteId 메시지를 전송할 투표 ID
482
+ * @param {SendMessageRequest} sendMessageRequest 전송할 메시지 내용
459
483
  * @param {*} [options] Override http request option.
460
484
  * @throws {RequiredError}
461
- * @memberof ChatControllerApi
485
+ * @memberof ChatApi
462
486
  */
463
487
  sendMessage(voteId, sendMessageRequest, options) {
464
- return (0, exports.ChatControllerApiFp)(this.configuration).sendMessage(voteId, sendMessageRequest, options).then((request) => request(this.axios, this.basePath));
488
+ return (0, exports.ChatApiFp)(this.configuration).sendMessage(voteId, sendMessageRequest, options).then((request) => request(this.axios, this.basePath));
465
489
  }
466
490
  }
467
- exports.ChatControllerApi = ChatControllerApi;
491
+ exports.ChatApi = ChatApi;
468
492
  /**
469
493
  * @export
470
494
  */
package/dist/api.d.ts CHANGED
@@ -10,5 +10,5 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  export * from './api/auth-controller-api';
13
- export * from './api/chat-controller-api';
13
+ export * from './api/chat-api';
14
14
  export * from './api/hello-controller-api';
package/dist/api.js CHANGED
@@ -28,5 +28,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
28
28
  };
29
29
  Object.defineProperty(exports, "__esModule", { value: true });
30
30
  __exportStar(require("./api/auth-controller-api"), exports);
31
- __exportStar(require("./api/chat-controller-api"), exports);
31
+ __exportStar(require("./api/chat-api"), exports);
32
32
  __exportStar(require("./api/hello-controller-api"), exports);
@@ -9,15 +9,48 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ /**
13
+ * 채팅방 목록 항목 응답
14
+ */
12
15
  export interface ChatListItemResponse {
16
+ /**
17
+ * 채팅방이 연결된 투표 ID
18
+ */
13
19
  voteId?: number;
20
+ /**
21
+ * 투표 제목
22
+ */
14
23
  title?: string;
24
+ /**
25
+ * 투표 썸네일 이미지 URL
26
+ */
15
27
  thumbnailUrl?: string;
28
+ /**
29
+ * A 선택지 이름
30
+ */
16
31
  optionA?: string;
32
+ /**
33
+ * B 선택지 이름
34
+ */
17
35
  optionB?: string;
36
+ /**
37
+ * 투표 참여자 수
38
+ */
18
39
  participantCount?: number;
40
+ /**
41
+ * 채팅방의 마지막 메시지 내용
42
+ */
19
43
  lastMessage?: string;
44
+ /**
45
+ * 마지막 메시지가 전송된 시각. UTC 기준으로 내려가며 사용자 시간대에 맞춰 변환이 필요합니다.
46
+ */
20
47
  lastMessageAt?: string;
48
+ /**
49
+ * 투표 종료 시각. UTC 기준으로 내려가며 사용자 시간대에 맞춰 변환이 필요합니다.
50
+ */
21
51
  endAt?: string;
52
+ /**
53
+ * 현재 사용자가 아직 읽지 않은 메시지 수
54
+ */
22
55
  unreadCount?: number;
23
56
  }
@@ -10,6 +10,12 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { ChatListItemResponse } from './chat-list-item-response';
13
+ /**
14
+ * 채팅방 목록 응답
15
+ */
13
16
  export interface ChatListResponse {
17
+ /**
18
+ * 조회된 채팅방 목록
19
+ */
14
20
  chats?: Array<ChatListItemResponse>;
15
21
  }
@@ -9,13 +9,37 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ /**
13
+ * 채팅방 상세 응답
14
+ */
12
15
  export interface ChatRoomResponse {
16
+ /**
17
+ * 채팅방이 연결된 투표 ID
18
+ */
13
19
  voteId?: number;
20
+ /**
21
+ * 투표 제목
22
+ */
14
23
  title?: string;
24
+ /**
25
+ * 투표 진행 상태
26
+ */
15
27
  status?: ChatRoomResponseStatusEnum;
28
+ /**
29
+ * 투표 참여자 수
30
+ */
16
31
  participantCount?: number;
32
+ /**
33
+ * A 선택지 이름
34
+ */
17
35
  optionA?: string;
36
+ /**
37
+ * B 선택지 이름
38
+ */
18
39
  optionB?: string;
40
+ /**
41
+ * 투표 종료 시각. UTC 기준으로 내려가며 사용자 시간대에 맞춰 변환이 필요합니다.
42
+ */
19
43
  endAt?: string;
20
44
  }
21
45
  export declare const ChatRoomResponseStatusEnum: {
@@ -9,8 +9,20 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ /**
13
+ * 투표 게이지 응답
14
+ */
12
15
  export interface GaugeResponse {
16
+ /**
17
+ * A 선택지 투표 비율. 0부터 100까지의 정수입니다.
18
+ */
13
19
  optionARatio?: number;
20
+ /**
21
+ * B 선택지 투표 비율. 0부터 100까지의 정수입니다.
22
+ */
14
23
  optionBRatio?: number;
24
+ /**
25
+ * 투표 참여자 수
26
+ */
15
27
  participantCount?: number;
16
28
  }
@@ -9,6 +9,12 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ /**
13
+ * 채팅방 읽음 처리 요청
14
+ */
12
15
  export interface MarkAsReadRequest {
16
+ /**
17
+ * 현재 사용자가 마지막으로 읽은 메시지 ID
18
+ */
13
19
  lastReadMessageId: number;
14
20
  }
@@ -10,8 +10,20 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { MessageResponse } from './message-response';
13
+ /**
14
+ * 채팅 메시지 페이지 응답
15
+ */
13
16
  export interface MessagePageResponse {
17
+ /**
18
+ * 조회된 메시지 목록
19
+ */
14
20
  messages?: Array<MessageResponse>;
21
+ /**
22
+ * 다음 페이지 조회에 사용할 커서. 다음 페이지가 없으면 null입니다.
23
+ */
15
24
  nextCursor?: number;
25
+ /**
26
+ * 다음 페이지 존재 여부
27
+ */
16
28
  hasNext?: boolean;
17
29
  }
@@ -9,12 +9,41 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ /**
13
+ * 채팅 메시지 응답
14
+ */
12
15
  export interface MessageResponse {
16
+ /**
17
+ * 채팅 메시지 ID
18
+ */
13
19
  messageId?: number;
20
+ /**
21
+ * 메시지 내용
22
+ */
14
23
  content?: string;
24
+ /**
25
+ * 메시지 전송 시각. UTC 기준으로 내려가며 사용자 시간대에 맞춰 변환이 필요합니다.
26
+ */
15
27
  sentAt?: string;
28
+ /**
29
+ * 메시지를 보낸 사용자의 닉네임
30
+ */
16
31
  senderNickname?: string;
32
+ /**
33
+ * 메시지를 보낸 사용자의 프로필 아이콘
34
+ */
17
35
  senderProfileIcon?: string;
18
- senderVoteOption?: string;
36
+ /**
37
+ * 메시지를 보낸 사용자가 선택한 투표 선택지
38
+ */
39
+ senderVoteOption?: MessageResponseSenderVoteOptionEnum;
40
+ /**
41
+ * 현재 로그인 사용자가 보낸 메시지인지 여부
42
+ */
19
43
  isMine?: boolean;
20
44
  }
45
+ export declare const MessageResponseSenderVoteOptionEnum: {
46
+ readonly A: "A";
47
+ readonly B: "B";
48
+ };
49
+ export type MessageResponseSenderVoteOptionEnum = typeof MessageResponseSenderVoteOptionEnum[keyof typeof MessageResponseSenderVoteOptionEnum];
@@ -13,3 +13,8 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.MessageResponseSenderVoteOptionEnum = void 0;
17
+ exports.MessageResponseSenderVoteOptionEnum = {
18
+ A: 'A',
19
+ B: 'B'
20
+ };
@@ -9,6 +9,12 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ /**
13
+ * 채팅 메시지 전송 요청
14
+ */
12
15
  export interface SendMessageRequest {
13
- content?: string;
16
+ /**
17
+ * 전송할 메시지 내용
18
+ */
19
+ content: string;
14
20
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ject-4-vs-team/api-client",
3
- "version": "2026.0501.3",
3
+ "version": "2026.0501.4",
4
4
  "description": "VS Server API client generated from OpenAPI spec",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -1,245 +0,0 @@
1
- /**
2
- * VS Server API
3
- * JECT 4기 2팀 VS Server API
4
- *
5
- * The version of the OpenAPI document: 1.0.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import { type RequestArgs, BaseAPI } from '../base';
15
- import type { ChatListResponse } from '../models';
16
- import type { ChatRoomResponse } from '../models';
17
- import type { GaugeResponse } from '../models';
18
- import type { MarkAsReadRequest } from '../models';
19
- import type { MessagePageResponse } from '../models';
20
- import type { MessageResponse } from '../models';
21
- import type { SendMessageRequest } from '../models';
22
- /**
23
- * ChatControllerApi - axios parameter creator
24
- * @export
25
- */
26
- export declare const ChatControllerApiAxiosParamCreator: (configuration?: Configuration) => {
27
- /**
28
- *
29
- * @param {GetChatListStatusEnum} status
30
- * @param {*} [options] Override http request option.
31
- * @throws {RequiredError}
32
- */
33
- getChatList: (status: GetChatListStatusEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
34
- /**
35
- *
36
- * @param {number} voteId
37
- * @param {*} [options] Override http request option.
38
- * @throws {RequiredError}
39
- */
40
- getChatRoom: (voteId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
41
- /**
42
- *
43
- * @param {number} voteId
44
- * @param {*} [options] Override http request option.
45
- * @throws {RequiredError}
46
- */
47
- getGauge: (voteId: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
48
- /**
49
- *
50
- * @param {number} voteId
51
- * @param {number} [cursor]
52
- * @param {number} [size]
53
- * @param {*} [options] Override http request option.
54
- * @throws {RequiredError}
55
- */
56
- getMessages: (voteId: number, cursor?: number, size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
57
- /**
58
- *
59
- * @param {number} voteId
60
- * @param {MarkAsReadRequest} markAsReadRequest
61
- * @param {*} [options] Override http request option.
62
- * @throws {RequiredError}
63
- */
64
- markAsRead: (voteId: number, markAsReadRequest: MarkAsReadRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
65
- /**
66
- *
67
- * @param {number} voteId
68
- * @param {SendMessageRequest} sendMessageRequest
69
- * @param {*} [options] Override http request option.
70
- * @throws {RequiredError}
71
- */
72
- sendMessage: (voteId: number, sendMessageRequest: SendMessageRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
73
- };
74
- /**
75
- * ChatControllerApi - functional programming interface
76
- * @export
77
- */
78
- export declare const ChatControllerApiFp: (configuration?: Configuration) => {
79
- /**
80
- *
81
- * @param {GetChatListStatusEnum} status
82
- * @param {*} [options] Override http request option.
83
- * @throws {RequiredError}
84
- */
85
- getChatList(status: GetChatListStatusEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatListResponse>>;
86
- /**
87
- *
88
- * @param {number} voteId
89
- * @param {*} [options] Override http request option.
90
- * @throws {RequiredError}
91
- */
92
- getChatRoom(voteId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChatRoomResponse>>;
93
- /**
94
- *
95
- * @param {number} voteId
96
- * @param {*} [options] Override http request option.
97
- * @throws {RequiredError}
98
- */
99
- getGauge(voteId: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GaugeResponse>>;
100
- /**
101
- *
102
- * @param {number} voteId
103
- * @param {number} [cursor]
104
- * @param {number} [size]
105
- * @param {*} [options] Override http request option.
106
- * @throws {RequiredError}
107
- */
108
- getMessages(voteId: number, cursor?: number, size?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessagePageResponse>>;
109
- /**
110
- *
111
- * @param {number} voteId
112
- * @param {MarkAsReadRequest} markAsReadRequest
113
- * @param {*} [options] Override http request option.
114
- * @throws {RequiredError}
115
- */
116
- markAsRead(voteId: number, markAsReadRequest: MarkAsReadRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
117
- /**
118
- *
119
- * @param {number} voteId
120
- * @param {SendMessageRequest} sendMessageRequest
121
- * @param {*} [options] Override http request option.
122
- * @throws {RequiredError}
123
- */
124
- sendMessage(voteId: number, sendMessageRequest: SendMessageRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MessageResponse>>;
125
- };
126
- /**
127
- * ChatControllerApi - factory interface
128
- * @export
129
- */
130
- export declare const ChatControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
131
- /**
132
- *
133
- * @param {GetChatListStatusEnum} status
134
- * @param {*} [options] Override http request option.
135
- * @throws {RequiredError}
136
- */
137
- getChatList(status: GetChatListStatusEnum, options?: RawAxiosRequestConfig): AxiosPromise<ChatListResponse>;
138
- /**
139
- *
140
- * @param {number} voteId
141
- * @param {*} [options] Override http request option.
142
- * @throws {RequiredError}
143
- */
144
- getChatRoom(voteId: number, options?: RawAxiosRequestConfig): AxiosPromise<ChatRoomResponse>;
145
- /**
146
- *
147
- * @param {number} voteId
148
- * @param {*} [options] Override http request option.
149
- * @throws {RequiredError}
150
- */
151
- getGauge(voteId: number, options?: RawAxiosRequestConfig): AxiosPromise<GaugeResponse>;
152
- /**
153
- *
154
- * @param {number} voteId
155
- * @param {number} [cursor]
156
- * @param {number} [size]
157
- * @param {*} [options] Override http request option.
158
- * @throws {RequiredError}
159
- */
160
- getMessages(voteId: number, cursor?: number, size?: number, options?: RawAxiosRequestConfig): AxiosPromise<MessagePageResponse>;
161
- /**
162
- *
163
- * @param {number} voteId
164
- * @param {MarkAsReadRequest} markAsReadRequest
165
- * @param {*} [options] Override http request option.
166
- * @throws {RequiredError}
167
- */
168
- markAsRead(voteId: number, markAsReadRequest: MarkAsReadRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
169
- /**
170
- *
171
- * @param {number} voteId
172
- * @param {SendMessageRequest} sendMessageRequest
173
- * @param {*} [options] Override http request option.
174
- * @throws {RequiredError}
175
- */
176
- sendMessage(voteId: number, sendMessageRequest: SendMessageRequest, options?: RawAxiosRequestConfig): AxiosPromise<MessageResponse>;
177
- };
178
- /**
179
- * ChatControllerApi - object-oriented interface
180
- * @export
181
- * @class ChatControllerApi
182
- * @extends {BaseAPI}
183
- */
184
- export declare class ChatControllerApi extends BaseAPI {
185
- /**
186
- *
187
- * @param {GetChatListStatusEnum} status
188
- * @param {*} [options] Override http request option.
189
- * @throws {RequiredError}
190
- * @memberof ChatControllerApi
191
- */
192
- getChatList(status: GetChatListStatusEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatListResponse, any, {}>>;
193
- /**
194
- *
195
- * @param {number} voteId
196
- * @param {*} [options] Override http request option.
197
- * @throws {RequiredError}
198
- * @memberof ChatControllerApi
199
- */
200
- getChatRoom(voteId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ChatRoomResponse, any, {}>>;
201
- /**
202
- *
203
- * @param {number} voteId
204
- * @param {*} [options] Override http request option.
205
- * @throws {RequiredError}
206
- * @memberof ChatControllerApi
207
- */
208
- getGauge(voteId: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GaugeResponse, any, {}>>;
209
- /**
210
- *
211
- * @param {number} voteId
212
- * @param {number} [cursor]
213
- * @param {number} [size]
214
- * @param {*} [options] Override http request option.
215
- * @throws {RequiredError}
216
- * @memberof ChatControllerApi
217
- */
218
- getMessages(voteId: number, cursor?: number, size?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessagePageResponse, any, {}>>;
219
- /**
220
- *
221
- * @param {number} voteId
222
- * @param {MarkAsReadRequest} markAsReadRequest
223
- * @param {*} [options] Override http request option.
224
- * @throws {RequiredError}
225
- * @memberof ChatControllerApi
226
- */
227
- markAsRead(voteId: number, markAsReadRequest: MarkAsReadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
228
- /**
229
- *
230
- * @param {number} voteId
231
- * @param {SendMessageRequest} sendMessageRequest
232
- * @param {*} [options] Override http request option.
233
- * @throws {RequiredError}
234
- * @memberof ChatControllerApi
235
- */
236
- sendMessage(voteId: number, sendMessageRequest: SendMessageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MessageResponse, any, {}>>;
237
- }
238
- /**
239
- * @export
240
- */
241
- export declare const GetChatListStatusEnum: {
242
- readonly Ongoing: "ONGOING";
243
- readonly Ended: "ENDED";
244
- };
245
- export type GetChatListStatusEnum = typeof GetChatListStatusEnum[keyof typeof GetChatListStatusEnum];