@taco_tsinghua/graphnode-sdk 0.1.8 → 0.1.10

package/dist/endpoints/health.d.ts

@@ -1,10 +1,30 @@
 import { RequestBuilder, type HttpResponse } from '../http-builder.js';
+/**
+ * 헬스 체크 응답 DTO
+ * @public
+ * @property ok 서버 상태 (true: 정상)
+ */
 export interface HealthResponse {
     ok: boolean;
 }
+/**
+ * 서버 상태 확인 API
+ * @public
+ */
 export declare class HealthApi {
     private rb;
     constructor(rb: RequestBuilder);
+    /**
+     * 서버의 헬스 상태를 확인합니다.
+     * @returns 헬스 체크 결과
+     * @example
+     * const response = await client.health.get();
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   ok: true
+     * }
+     */
     get(): Promise<HttpResponse<HealthResponse>>;
 }
 //# sourceMappingURL=health.d.ts.map

package/dist/endpoints/health.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../../src/endpoints/health.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvE,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,OAAO,CAAC;CACb;AAED,qBAAa,SAAS;IACR,OAAO,CAAC,EAAE;gBAAF,EAAE,EAAE,cAAc;IACtC,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;CAG7C"}
+{"version":3,"file":"health.d.ts","sourceRoot":"","sources":["../../src/endpoints/health.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,OAAO,CAAC;CACb;AAED;;;GAGG;AACH,qBAAa,SAAS;IACR,OAAO,CAAC,EAAE;gBAAF,EAAE,EAAE,cAAc;IAEtC;;;;;;;;;;OAUG;IACH,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC;CAG7C"}

package/dist/endpoints/health.js

@@ -1,8 +1,23 @@
 import { RequestBuilder } from '../http-builder.js';
+/**
+ * 서버 상태 확인 API
+ * @public
+ */
 export class HealthApi {
     constructor(rb) {
         this.rb = rb;
     }
+    /**
+     * 서버의 헬스 상태를 확인합니다.
+     * @returns 헬스 체크 결과
+     * @example
+     * const response = await client.health.get();
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   ok: true
+     * }
+     */
     get() {
         return this.rb.path('/healthz').get();
     }

package/dist/endpoints/health.js.map

@@ -1 +1 @@
-{"version":3,"file":"health.js","sourceRoot":"","sources":["../../src/endpoints/health.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAqB,MAAM,oBAAoB,CAAC;AAMvE,MAAM,OAAO,SAAS;IACpB,YAAoB,EAAkB;QAAlB,OAAE,GAAF,EAAE,CAAgB;IAAG,CAAC;IAC1C,GAAG;QACD,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,EAAkB,CAAC;IACxD,CAAC;CACF"}
+{"version":3,"file":"health.js","sourceRoot":"","sources":["../../src/endpoints/health.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAqB,MAAM,oBAAoB,CAAC;AAWvE;;;GAGG;AACH,MAAM,OAAO,SAAS;IACpB,YAAoB,EAAkB;QAAlB,OAAE,GAAF,EAAE,CAAgB;IAAG,CAAC;IAE1C;;;;;;;;;;OAUG;IACH,GAAG;QACD,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,EAAkB,CAAC;IACxD,CAAC;CACF"}

package/dist/endpoints/me.d.ts

@@ -1,12 +1,73 @@
 import { RequestBuilder, type HttpResponse } from '../http-builder.js';
 import type { MeResponseDto, ApiKeysResponseDto, ApiKeyModel } from '../types/me.js';
+/**
+ * 내 정보 관리 API
+ * @public
+ */
 export declare class MeApi {
     private rb;
     constructor(rb: RequestBuilder);
+    /**
+     * 내 프로필 정보를 조회합니다.
+     * @returns 내 정보
+     *    - `user` (UserProfileDto): 사용자 프로필 정보
+     *      - `id` (string): 사용자 ID
+     *      - `email` (string, optional): 이메일
+     *      - `displayName` (string): 표시 이름
+     *      - `avatarUrl` (string | null): 아바타 URL
+     *      - `createdAt` (string): 생성 일시 (ISO 8601)
+     * @example
+     * const response = await client.me.get();
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   userId: '1...',
+     *   profile: {
+     *     id: '1...',
+     *     email: 'john.doe@example.com',
+     *     displayName: 'John Doe',
+     *     avatarUrl: 'https://example.com/avatar.jpg'
+     *   }
+     * }
+     */
     get(): Promise<HttpResponse<MeResponseDto>>;
+    /**
+     * 로그아웃을 수행합니다.
+     * - 서버 세션을 무효화합니다.
+     * @example
+     * await client.me.logout();
+     * console.log('Logged out successfully');
+     */
     logout(): Promise<HttpResponse<void>>;
+    /**
+     * 특정 모델의 API 키를 조회합니다.
+     * @param model - 조회할 API 키 모델 ('openai' | 'deepseek')
+     * @returns 마스킹된 API 키 정보
+     *    - `apiKey` (string | null): 마스킹된 API 키 (설정되지 않은 경우 null)
+     * @example
+     * const response = await client.me.getApiKeys('openai');
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   apiKey: 'sk-proj-1234...' // Masked
+     * }
+     */
     getApiKeys(model: ApiKeyModel): Promise<HttpResponse<ApiKeysResponseDto>>;
+    /**
+     * 특정 모델의 API 키를 설정/업데이트합니다.
+     * @param model - 설정할 API 키 모델 ('openai' | 'deepseek')
+     * @param apiKey - 설정할 API 키 값 (string)
+     * @example
+     * await client.me.updateApiKey('openai', 'sk-proj-1234567890abcdef');
+     * console.log('OpenAI API key updated');
+     */
     updateApiKey(model: ApiKeyModel, apiKey: string): Promise<HttpResponse<void>>;
+    /**
+     * 특정 모델의 API 키를 삭제합니다.
+     * @example
+     * await client.me.deleteApiKey('openai');
+     * console.log('OpenAI API key deleted');
+     */
     deleteApiKey(model: ApiKeyModel): Promise<HttpResponse<void>>;
 }
 //# sourceMappingURL=me.d.ts.map

package/dist/endpoints/me.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"me.d.ts","sourceRoot":"","sources":["../../src/endpoints/me.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAErF,qBAAa,KAAK;IACJ,OAAO,CAAC,EAAE;gBAAF,EAAE,EAAE,cAAc;IAEtC,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAI3C,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAKrC,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAIzE,YAAY,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAI7E,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;CAG9D"}
+{"version":3,"file":"me.d.ts","sourceRoot":"","sources":["../../src/endpoints/me.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAErF;;;GAGG;AACH,qBAAa,KAAK;IACJ,OAAO,CAAC,EAAE;gBAAF,EAAE,EAAE,cAAc;IAEtC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,GAAG,IAAI,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IAI3C;;;;;;OAMG;IACH,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAKrC;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAIzE;;;;;;;OAOG;IACH,YAAY,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAI7E;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;CAG9D"}

package/dist/endpoints/me.js

@@ -1,21 +1,82 @@
 import { RequestBuilder } from '../http-builder.js';
+/**
+ * 내 정보 관리 API
+ * @public
+ */
 export class MeApi {
     constructor(rb) {
         this.rb = rb;
     }
+    /**
+     * 내 프로필 정보를 조회합니다.
+     * @returns 내 정보
+     *    - `user` (UserProfileDto): 사용자 프로필 정보
+     *      - `id` (string): 사용자 ID
+     *      - `email` (string, optional): 이메일
+     *      - `displayName` (string): 표시 이름
+     *      - `avatarUrl` (string | null): 아바타 URL
+     *      - `createdAt` (string): 생성 일시 (ISO 8601)
+     * @example
+     * const response = await client.me.get();
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   userId: '1...',
+     *   profile: {
+     *     id: '1...',
+     *     email: 'john.doe@example.com',
+     *     displayName: 'John Doe',
+     *     avatarUrl: 'https://example.com/avatar.jpg'
+     *   }
+     * }
+     */
     get() {
         return this.rb.path('/v1/me').get();
     }
+    /**
+     * 로그아웃을 수행합니다.
+     * - 서버 세션을 무효화합니다.
+     * @example
+     * await client.me.logout();
+     * console.log('Logged out successfully');
+     */
     logout() {
         // 204 No Content 예상
         return this.rb.path('/auth/logout').post();
     }
+    /**
+     * 특정 모델의 API 키를 조회합니다.
+     * @param model - 조회할 API 키 모델 ('openai' | 'deepseek')
+     * @returns 마스킹된 API 키 정보
+     *    - `apiKey` (string | null): 마스킹된 API 키 (설정되지 않은 경우 null)
+     * @example
+     * const response = await client.me.getApiKeys('openai');
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   apiKey: 'sk-proj-1234...' // Masked
+     * }
+     */
     getApiKeys(model) {
         return this.rb.path(`/v1/me/api-keys/${model}`).get();
     }
+    /**
+     * 특정 모델의 API 키를 설정/업데이트합니다.
+     * @param model - 설정할 API 키 모델 ('openai' | 'deepseek')
+     * @param apiKey - 설정할 API 키 값 (string)
+     * @example
+     * await client.me.updateApiKey('openai', 'sk-proj-1234567890abcdef');
+     * console.log('OpenAI API key updated');
+     */
     updateApiKey(model, apiKey) {
         return this.rb.path(`/v1/me/api-keys/${model}`).patch({ apiKey });
     }
+    /**
+     * 특정 모델의 API 키를 삭제합니다.
+     * @example
+     * await client.me.deleteApiKey('openai');
+     * console.log('OpenAI API key deleted');
+     */
     deleteApiKey(model) {
         return this.rb.path(`/v1/me/api-keys/${model}`).delete();
     }

package/dist/endpoints/me.js.map

@@ -1 +1 @@
-{"version":3,"file":"me.js","sourceRoot":"","sources":["../../src/endpoints/me.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAqB,MAAM,oBAAoB,CAAC;AAGvE,MAAM,OAAO,KAAK;IAChB,YAAoB,EAAkB;QAAlB,OAAE,GAAF,EAAE,CAAgB;IAAG,CAAC;IAE1C,GAAG;QACD,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAiB,CAAC;IACrD,CAAC;IAED,MAAM;QACJ,oBAAoB;QACpB,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,EAAQ,CAAC;IACnD,CAAC;IAED,UAAU,CAAC,KAAkB;QAC3B,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC,GAAG,EAAsB,CAAC;IAC5E,CAAC;IAED,YAAY,CAAC,KAAkB,EAAE,MAAc;QAC7C,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,YAAY,CAAC,KAAkB;QAC7B,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAQ,CAAC;IACjE,CAAC;CACF"}
+{"version":3,"file":"me.js","sourceRoot":"","sources":["../../src/endpoints/me.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAqB,MAAM,oBAAoB,CAAC;AAGvE;;;GAGG;AACH,MAAM,OAAO,KAAK;IAChB,YAAoB,EAAkB;QAAlB,OAAE,GAAF,EAAE,CAAgB;IAAG,CAAC;IAE1C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,GAAG;QACD,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,EAAiB,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACH,MAAM;QACJ,oBAAoB;QACpB,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,EAAQ,CAAC;IACnD,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,UAAU,CAAC,KAAkB;QAC3B,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC,GAAG,EAAsB,CAAC;IAC5E,CAAC;IAED;;;;;;;OAOG;IACH,YAAY,CAAC,KAAkB,EAAE,MAAc;QAC7C,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACH,YAAY,CAAC,KAAkB;QAC7B,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,mBAAmB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAQ,CAAC;IACjE,CAAC;CACF"}

package/dist/endpoints/note.d.ts

@@ -10,73 +10,261 @@ export declare class NoteApi {
     /**
      * 새 노트를 생성합니다.
      * @param dto - 생성할 노트 데이터
-     * @returns 생성된 노트
+     *    - `id` (string): 노트 고유 ID (UUID, 클라이언트 생성)
+     *    - `content` (string): 노트 내용 (Markdown)
+     *    - `title` (string, optional): 노트 제목
+     *    - `folderId` (string | null, optional): 상위 폴더 ID (없으면 최상위)
+     * @returns 생성된 노트 정보
+     *    - `id` (string): 노트 ID
+     *    - `ownerUserId` (string): 소유자 ID
+     *    - `title` (string): 제목
+     *    - `content` (string): 내용
+     *    - `folderId` (string | null): 폴더 ID
+     *    - `createdAt` (string): 생성 일시 (ISO 8601)
+     *    - `updatedAt` (string): 수정 일시 (ISO 8601)
+     * @example
+     * const response = await client.note.createNote({
+     *   id: '550e8400-e29b-41d4-a716-446655440000',
+     *   title: 'Meeting Notes',
+     *   content: '# Weekly Sync\n- Discussed Q3 goals\n- Reviewed metrics',
+     *   folderId: null
+     * });
+     *
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   id: '550e8400-e29b-41d4-a716-446655440000',
+     *   title: 'Meeting Notes',
+     *   content: '# Weekly Sync...',
+     *   folderId: null,
+     *   createdAt: '2023-10-27T10:00:00Z',
+     *   updatedAt: '2023-10-27T10:00:00Z',
+     *   ownerUserId: 'user-123'
+     * }
      */
     createNote(dto: NoteCreateDto): Promise<HttpResponse<NoteDto>>;
     /**
      * 사용자의 모든 노트를 가져옵니다.
-     * @returns 노트 목록
+     * @returns 노트 목록 (NoteDto 배열)
+     * @example
+     * const response = await client.note.listNotes();
+     *
+     * console.log(response.data);
+     * // Output:
+     * [
+     *   {
+     *     id: '550e8400-e29b-41d4-a716-446655440000',
+     *     title: 'Meeting Notes',
+     *     content: '...',
+     *     folderId: null,
+     *     createdAt: '...',
+     *     updatedAt: '...',
+     *     ownerUserId: 'user-123'
+     *   },
+     *   {
+     *     id: '661f9511-f30c-52e5-b827-557766551111',
+     *     title: 'Ideas',
+     *     content: '...',
+     *     folderId: 'folder-123',
+     *     createdAt: '...',
+     *     updatedAt: '...',
+     *     ownerUserId: 'user-123'
+     *   }
+     * ]
      */
     listNotes(): Promise<HttpResponse<NoteDto[]>>;
     /**
      * 특정 ID의 노트를 가져옵니다.
-     * @param id - 가져올 노트의 ID
-     * @returns 요청한 노트
+     * @param id - 가져올 노트의 ID (UUID)
+     * @returns 요청한 노트 상세 정보
+     * @example
+     * const response = await client.note.getNote('550e8400-e29b-41d4-a716-446655440000');
+     *
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   id: '550e8400-e29b-41d4-a716-446655440000',
+     *   title: 'Meeting Notes',
+     *   content: '# Weekly Sync\n- Discussed Q3 goals...',
+     *   folderId: null,
+     *   createdAt: '...',
+     *   updatedAt: '...',
+     *   ownerUserId: 'user-123'
+     * }
      */
     getNote(id: string): Promise<HttpResponse<NoteDto>>;
     /**
      * 특정 노드를 업데이트합니다.
      * @param id - 업데이트할 노트의 ID
      * @param dto - 업데이트할 데이터
-     * @returns 업데이트된 노트
+     *    - `title` (string, optional): 변경할 제목
+     *    - `content` (string, optional): 변경할 내용
+     *    - `folderId` (string | null, optional): 이동할 폴더 ID
+     * @returns 업데이트된 노트 정보
+     * @example
+     * const response = await client.note.updateNote('550e8400-e29b-41d4-a716-446655440000', {
+     *   title: 'Q3 Review Meeting',
+     *   content: '# Q3 Review\n- Goals achieved'
+     * });
+     *
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   id: '550e8400-e29b-41d4-a716-446655440000',
+     *   title: 'Q3 Review Meeting',
+     *   content: '# Q3 Review...',
+     *   folderId: null,
+     *   createdAt: '...',
+     *   updatedAt: '2023-10-27T11:30:00Z',
+     *   ownerUserId: 'user-123'
+     * }
      */
     updateNote(id: string, dto: NoteUpdateDto): Promise<HttpResponse<NoteDto>>;
     /**
      * 특정 노트를 삭제합니다.
      * @param id - 삭제할 노트의 ID
-     * @param permanent - 영구 삭제 여부 (true: 영구 삭제, false/undefined: 휴지통)
+     * @param permanent - 영구 삭제 여부 (true: 영구 삭제, false/undefined: 휴지통 이동)
+     * @returns 성공 시 빈 응답
+     * @example
+     * // 휴지통으로 이동 (Soft Delete)
+     * const response = await client.note.deleteNote('550e8400-e29b-41d4-a716-446655440000');
+     *
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   ok: true
+     * }
      */
     deleteNote(id: string, permanent?: boolean): Promise<HttpResponse<void>>;
     /**
      * 특정 노트를 복구합니다.
      * @param id - 복구할 노트의 ID
-     * @returns 복구된 노트
+     * @returns 복구된 노트 정보
+     * @example
+     * const response = await client.note.restoreNote('550e8400-e29b-41d4-a716-446655440000');
+     *
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   id: '550e8400-e29b-41d4-a716-446655440000',
+     *   title: 'Meeting Notes',
+     *   content: '...',
+     *   folderId: null,
+     *   createdAt: '...',
+     *   updatedAt: '...',
+     *   ownerUserId: 'user-123'
+     * }
      */
     restoreNote(id: string): Promise<HttpResponse<NoteDto>>;
     /**
      * 새 폴더를 생성합니다.
      * @param dto - 생성할 폴더 데이터
-     * @returns 생성된 폴더
+     *    - `name` (string): 폴더 이름
+     *    - `parentId` (string | null, optional): 상위 폴더 ID (없으면 최상위)
+     * @returns 생성된 폴더 정보
+     *    - `id` (string): 폴더 ID
+     *    - `ownerUserId` (string): 소유자 ID
+     *    - `name` (string): 폴더 이름
+     *    - `parentId` (string | null): 상위 폴더 ID
+     *    - `createdAt` (string): 생성 일시
+     *    - `updatedAt` (string): 수정 일시
+     * @example
+     * const response = await client.note.createFolder({
+     *   name: 'Work Projects',
+     *   parentId: null
+     * });
+     *
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   id: 'folder-123',
+     *   name: 'Work Projects',
+     *   parentId: null,
+     *   createdAt: '...',
+     *   updatedAt: '...',
+     *   ownerUserId: 'user-123'
+     * }
      */
     createFolder(dto: FolderCreateDto): Promise<HttpResponse<FolderDto>>;
     /**
      * 사용자의 모든 폴더를 가져옵니다.
-     * @returns 폴더 목록
+     * @returns 폴더 목록 (FolderDto 배열)
+     * @example
+     * const response = await client.note.listFolders();
+     *
+     * console.log(response.data);
+     * // Output:
+     * [
+     *   {
+     *     id: 'folder-123',
+     *     name: 'Work Projects',
+     *     parentId: null,
+     *     createdAt: '...',
+     *     updatedAt: '...',
+     *     ownerUserId: 'user-123'
+     *   },
+     *   {
+     *     id: 'folder-124',
+     *     name: 'Personal',
+     *     parentId: null,
+     *     createdAt: '...',
+     *     updatedAt: '...',
+     *     ownerUserId: 'user-123'
+     *   }
+     * ]
      */
     listFolders(): Promise<HttpResponse<FolderDto[]>>;
     /**
      * 특정 ID의 폴더를 가져옵니다.
      * @param id - 가져올 폴더의 ID
-     * @returns 요청한 폴더
+     * @returns 요청한 폴더 상세 정보
+     * @example
+     * const response = await client.note.getFolder('folder-123');
+     *
+     * console.log(response.data);
+     * // Output:
+     * {
+     *   id: 'folder-123',
+     *   name: 'Work Projects',
+     *   parentId: null,
+     *   createdAt: '...',
+     *   updatedAt: '...',
+     *   ownerUserId: 'user-123'
+     * }
      */
     getFolder(id: string): Promise<HttpResponse<FolderDto>>;
     /**
      * 특정 폴더를 업데이트합니다.
      * @param id - 업데이트할 폴더의 ID
      * @param dto - 업데이트할 데이터
-     * @returns 업데이트된 폴더
+     *    - `name` (string, optional): 변경할 폴더 이름
+     *    - `parentId` (string | null, optional): 이동할 상위 폴더 ID
+     * @returns 업데이트된 폴더 정보
+     * @example
+     * const response = await client.note.updateFolder('folder-123', {
+     *   name: 'Archived Projects',
+     *   parentId: 'folder-999' // Move to another folder
+     * });
+     * console.log(response.data.name); // 'Archived Projects'
+     * console.log(response.data.parentId); // 'folder-999'
      */
     updateFolder(id: string, dto: FolderUpdateDto): Promise<HttpResponse<FolderDto>>;
     /**
      * 특정 폴더를 삭제합니다.
      * @param id - 삭제할 폴더의 ID
-     * @param permanent - 영구 삭제 여부 (true: 영구 삭제, false/undefined: 휴지통)
+     * @param permanent - 영구 삭제 여부 (true: 영구 삭제, false/undefined: 휴지통 이동)
+     * @returns 성공 시 빈 응답
+     * @example
+     * await client.note.deleteFolder('folder-123');
      */
     deleteFolder(id: string, permanent?: boolean): Promise<HttpResponse<void>>;
     /**
      * 특정 폴더를 복구합니다.
      * @param id - 복구할 폴더의 ID
-     * @returns 복구된 폴더
+     * @returns 복구된 폴더 정보
+     * @example
+     * const response = await client.note.restoreFolder('folder-123');
+     * console.log(response.data.id); // 'folder-123'
      */
     restoreFolder(id: string): Promise<HttpResponse<FolderDto>>;
 }

package/dist/endpoints/note.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"note.d.ts","sourceRoot":"","sources":["../../src/endpoints/note.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,KAAK,EACV,OAAO,EACP,aAAa,EACb,aAAa,EACb,SAAS,EACT,eAAe,EACf,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAE1B;;;GAGG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAiB;gBAExB,EAAE,EAAE,cAAc;IAM9B;;;;OAIG;IACH,UAAU,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAI9D;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;IAI7C;;;;OAIG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAInD;;;;;OAKG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAI1E;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAIxE;;;;OAIG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAMvD;;;;OAIG;IACH,YAAY,CAAC,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAIpE;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;IAIjD;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAIvD;;;;;OAKG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAIhF;;;;OAIG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAI1E;;;;OAIG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;CAG5D"}
+{"version":3,"file":"note.d.ts","sourceRoot":"","sources":["../../src/endpoints/note.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,KAAK,EACV,OAAO,EACP,aAAa,EACb,aAAa,EACb,SAAS,EACT,eAAe,EACf,eAAe,EAChB,MAAM,kBAAkB,CAAC;AAE1B;;;GAGG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAiB;gBAExB,EAAE,EAAE,cAAc;IAM9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,UAAU,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAI9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,SAAS,IAAI,OAAO,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC,CAAC;IAI7C;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAInD;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAI1E;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAIxE;;;;;;;;;;;;;;;;;;OAkBG;IACH,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IAMvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,YAAY,CAAC,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAIpE;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,WAAW,IAAI,OAAO,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC;IAIjD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAIvD;;;;;;;;;;;;;;OAcG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IAIhF;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAI1E;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;CAG5D"}