> ## Documentation Index
> Fetch the complete documentation index at: https://generaltranslation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ListsClient

리스트 작업을 위한 Client

이 Client는 X API의 리스트 엔드포인트와 상호작용하기 위한 메서드를 제공합니다.
리스트 관련 모든 작업에 대해 인증, 요청 포맷 구성, 응답 파싱을 처리합니다.

<div id="constructors">
  ## 생성자
</div>

<div id="constructor">
  ### constructor
</div>

• **new ListsClient**(`client`): [`ListsClient`](/ko/xdks/typescript/reference/classes/ListsClient)

새로운 ListsClient 인스턴스를 생성합니다

<div id="parameters">
  #### 매개변수
</div>

| Name     | Type                                                     | Description           |
| :------- | :------------------------------------------------------- | :-------------------- |
| `client` | [`Client`](/ko/xdks/typescript/reference/classes/Client) | X API Client의 기본 인스턴스 |

#### 반환값

[`ListsClient`](/ko/xdks/typescript/reference/classes/ListsClient)

#### 정의 위치

[lists/client.ts:294](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L294)

<div id="methods">
  ## 메서드
</div>

<div id="getfollowers">
  ### getFollowers
</div>

▸ **getFollowers**(`id`, `options`): `Promise`\<`Response`>

리스트 팔로워 조회
지정한 리스트의 ID를 사용해, 해당 리스트를 팔로우하는 사용자 목록을 가져옵니다.

<div id="parameters">
  #### 매개변수
</div>

| Name      | Type                                                                | Description |
| :-------- | :------------------------------------------------------------------ | :---------- |
| `id`      | `string`                                                            | 리스트의 ID입니다. |
| `options` | `GetFollowersOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -           |

#### 반환

`Promise`\<`Response`>

API 응답을 resolve하는 Promise이며, `requestOptions.raw`가 `true`인 경우에는 원시 `Response`를 반환합니다.

#### 정의 위치

[lists/client.ts:339](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L339)

▸ **getFollowers**(`id`, `options?`): `Promise`\<[`Get2ListsIdFollowersResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdFollowersResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | 타입                    |
| :--------- | :-------------------- |
| `id`       | `string`              |
| `options?` | `GetFollowersOptions` |

#### 반환값

`Promise`\<[`Get2ListsIdFollowersResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdFollowersResponse)>

#### 정의 위치

[lists/client.ts:352](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L352)

***

<div id="create">
  ### create
</div>

▸ **create**(`options`): `Promise`\<`Response`>

리스트 생성
인증된 사용자에 대한 새 리스트를 생성합니다.

<div id="parameters">
  #### 매개변수
</div>

| 이름        | type                                                          |
| :-------- | :------------------------------------------------------------ |
| `options` | `CreateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

API 응답으로 resolve되는 Promise이며, `requestOptions.raw`가 `true`인 경우 원시 `Response`를 반환합니다

#### 정의 위치

[lists/client.ts:560](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L560)

▸ **create**(`options?`): `Promise`\<[`ListCreateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListCreateResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | type            |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

#### 반환 값

`Promise`\<[`ListCreateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListCreateResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[lists/client.ts:569](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L569)

***

<div id="getmembers">
  ### getMembers
</div>

▸ **getMembers**(`id`, `options`): `Promise`\<`Response`>

리스트 멤버 가져오기\
지정된 리스트의 ID를 사용해, 해당 리스트에 속한 사용자들을 조회합니다.

<div id="parameters">
  #### 매개변수
</div>

| 이름        | type                                                              | 설명               |
| :-------- | :---------------------------------------------------------------- | :--------------- |
| `id`      | `string`                                                          | 리스트의 식별자(id)입니다. |
| `options` | `GetMembersOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                |

#### 반환

`Promise`\<`Response`>

API 응답으로 resolve되는 Promise입니다. 단, requestOptions.raw가 true이면 원시 Response가 반환됩니다

#### 정의 위치

[lists/client.ts:665](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L665)

▸ **getMembers**(`id`, `options?`): `Promise`\<[`Get2ListsIdMembersResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdMembersResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | 타입                  |
| :--------- | :------------------ |
| `id`       | `string`            |
| `options?` | `GetMembersOptions` |

#### 반환

`Promise`\<[`Get2ListsIdMembersResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdMembersResponse)>

#### 정의 위치

[lists/client.ts:678](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L678)

***

<div id="addmember">
  ### addMember
</div>

▸ **addMember**(`id`, `options`): `Promise`\<`Response`>

리스트 멤버 추가
특정 id를 가진 리스트에 사용자를 추가합니다.

<div id="parameters">
  #### 매개변수
</div>

| Name      | Type                                                             | Description         |
| :-------- | :--------------------------------------------------------------- | :------------------ |
| `id`      | `string`                                                         | 멤버를 추가할 리스트의 ID입니다. |
| `options` | `AddMemberOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                   |

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

API 응답으로 resolve되는 `Promise`이며, `requestOptions.raw`가 true인 경우에는 원시 `Response`

#### 정의 위치

[lists/client.ts:890](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L890)

▸ **addMember**(`id`, `options?`): `Promise`\<[`ListMutateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListMutateResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | Type               |
| :--------- | :----------------- |
| `id`       | `string`           |
| `options?` | `AddMemberOptions` |

#### 반환값

`Promise`\<[`ListMutateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListMutateResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[lists/client.ts:903](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L903)

***

<div id="getposts">
  ### getPosts
</div>

▸ **getPosts**(`id`, `options`): `Promise`\<`Response`>

리스트 포스트 가져오기
특정 리스트와 연관된 포스트 목록을 해당 리스트의 id로 조회합니다.

<div id="parameters">
  #### 매개변수
</div>

| 이름        | 타입                                                              | 설명          |
| :-------- | :-------------------------------------------------------------- | :---------- |
| `id`      | `string`                                                        | 리스트의 id입니다. |
| `options` | `GetPostsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -           |

#### 반환

`Promise`\<`Response`>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response가 반환됩니다.

#### 정의 위치

[lists/client.ts:1011](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1011)

▸ **getPosts**(`id`, `options?`): `Promise`\<[`Get2ListsIdTweetsResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdTweetsResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | type              |
| :--------- | :---------------- |
| `id`       | `string`          |
| `options?` | `GetPostsOptions` |

#### 반환

`Promise`\<[`Get2ListsIdTweetsResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdTweetsResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[lists/client.ts:1024](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1024)

***

<div id="removememberbyuserid">
  ### removeMemberByUserId
</div>

▸ **removeMemberByUserId**(`id`, `userId`, `options`): `Promise`\<`Response`>

리스트 멤버 제거
리스트 ID와 사용자 ID를 사용해 특정 리스트에서 사용자를 제거합니다.

<div id="parameters">
  #### 매개변수
</div>

| Name                         | Type     | Description           |
| :--------------------------- | :------- | :-------------------- |
| `id`                         | `string` | 멤버를 제거할 리스트의 ID입니다.   |
| `userId`                     | `string` | 리스트에서 제거할 사용자의 ID입니다. |
| `options`                    | `Object` | -                     |
| `options.requestOptions`     | `Object` | -                     |
| `options.requestOptions.raw` | `true`   | -                     |

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response입니다

#### 정의 위치

[lists/client.ts:1303](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1303)

▸ **removeMemberByUserId**(`id`, `userId`): `Promise`\<[`ListMutateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListMutateResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름       | type     |
| :------- | :------- |
| `id`     | `string` |
| `userId` | `string` |

#### 반환값

`Promise`\<[`ListMutateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListMutateResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[lists/client.ts:1320](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1320)

***

<div id="getbyid">
  ### getById
</div>

▸ **getById**(`id`, `options`): `Promise`\<`Response`>

ID로 리스트 조회
지정한 리스트의 ID로 해당 리스트의 상세 정보를 조회합니다.

<div id="parameters">
  #### 매개변수
</div>

| Name      | Type                                                           | Description |
| :-------- | :------------------------------------------------------------- | :---------- |
| `id`      | `string`                                                       | 리스트의 id입니다. |
| `options` | `GetByIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -           |

#### 반환값

`Promise`\<`Response`>

API 응답으로 resolve되는 `Promise`입니다. `requestOptions.raw`가 true인 경우에는 원본 `Response`를 반환합니다

#### 정의 위치

[lists/client.ts:1423](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1423)

▸ **getById**(`id`, `options?`): `Promise`\<[`Get2ListsIdResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | 타입               |
| :--------- | :--------------- |
| `id`       | `string`         |
| `options?` | `GetByIdOptions` |

#### 반환

`Promise`\<[`Get2ListsIdResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.Get2ListsIdResponse)>

<div id="defined-in">
  #### 정의된 위치
</div>

[lists/client.ts:1436](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1436)

***

<div id="update">
  ### update
</div>

▸ **update**(`id`, `options`): `Promise`\<`Response`>

리스트 업데이트
인증된 사용자가 소유한 특정 리스트의 세부 정보를 해당 ID를 사용하여 업데이트합니다.

<div id="parameters">
  #### 매개변수
</div>

| 이름        | 타입                                                            | 설명              |
| :-------- | :------------------------------------------------------------ | :-------------- |
| `id`      | `string`                                                      | 수정할 리스트의 id입니다. |
| `options` | `UpdateOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -               |

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response

#### 정의 위치

[lists/client.ts:1610](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1610)

▸ **update**(`id`, `options?`): `Promise`\<[`ListUpdateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListUpdateResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름         | 타입              |
| :--------- | :-------------- |
| `id`       | `string`        |
| `options?` | `UpdateOptions` |

#### 반환

`Promise`\<[`ListUpdateResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListUpdateResponse)>

#### 정의 위치

[lists/client.ts:1623](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1623)

***

<div id="delete">
  ### delete
</div>

▸ **delete**(`id`, `options`): `Promise`\<`Response`>

리스트 삭제
인증된 사용자가 소유한 특정 리스트를 해당 ID로 삭제합니다.

<div id="parameters">
  #### 매개변수
</div>

| Name                         | Type     | Description     |
| :--------------------------- | :------- | :-------------- |
| `id`                         | `string` | 삭제할 리스트의 ID입니다. |
| `options`                    | `Object` | -               |
| `options.requestOptions`     | `Object` | -               |
| `options.requestOptions.raw` | `true`   | -               |

<div id="returns">
  #### Returns
</div>

`Promise`\<`Response`>

API 응답으로 resolve되는 `Promise` 또는 `requestOptions.raw`가 true인 경우 원시 `Response`

#### 정의 위치

[lists/client.ts:1731](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1731)

▸ **delete**(`id`): `Promise`\<[`ListDeleteResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListDeleteResponse)>

<div id="parameters">
  #### 매개변수
</div>

| 이름   | 타입       |
| :--- | :------- |
| `id` | `string` |

#### 반환값

`Promise`\<[`ListDeleteResponse`](/ko/xdks/typescript/reference/interfaces/Schemas.ListDeleteResponse)>

#### 정의 위치

[lists/client.ts:1744](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/lists/client.ts#L1744)