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

# ListsClient

> X API TypeScript SDK의 ListsClient 클래스에 대한 레퍼런스. X API v2 lists 엔드포인트에 대한 메서드, 매개변수 및 반환 타입.

lists 작업을 위한 클라이언트

이 클라이언트는 X API의 lists 엔드포인트와 상호작용하기 위한 메서드를
제공합니다. 모든 lists 관련 작업에 대한 인증, 요청 형식화 및 응답
파싱을 처리합니다.

## 생성자

### constructor

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

새 lists 클라이언트 인스턴스를 생성합니다

#### 매개변수

| 이름       | 타입                                                    | 설명                  |
| :------- | :---------------------------------------------------- | :------------------ |
| `client` | [`Client`](/xdks/typescript/reference/classes/Client) | 메인 X API 클라이언트 인스턴스 |

#### 반환값

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

#### 정의 위치

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

## 메서드

### getFollowers

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

Get List followers
ID로 특정 List를 팔로우하는 사용자 목록을 검색합니다.

#### 매개변수

| 이름        | 타입                                                                  | 설명           |
| :-------- | :------------------------------------------------------------------ | :----------- |
| `id`      | `string`                                                            | List의 ID입니다. |
| `options` | `GetFollowersOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### create

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

Create List
인증된 사용자에 대한 새 List를 생성합니다.

#### 매개변수

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

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

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

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

#### 매개변수

| 이름         | 타입              |
| :--------- | :-------------- |
| `options?` | `CreateOptions` |

#### 반환값

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

#### 정의 위치

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

***

### getMembers

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

Get List members
ID로 특정 List의 멤버인 사용자 목록을 검색합니다.

#### 매개변수

| 이름        | 타입                                                                | 설명           |
| :-------- | :---------------------------------------------------------------- | :----------- |
| `id`      | `string`                                                          | List의 ID입니다. |
| `options` | `GetMembersOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### addMember

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

Add List member
ID로 특정 List에 사용자를 추가합니다.

#### 매개변수

| 이름        | 타입                                                               | 설명                   |
| :-------- | :--------------------------------------------------------------- | :------------------- |
| `id`      | `string`                                                         | 멤버를 추가할 List의 ID입니다. |
| `options` | `AddMemberOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                    |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### getPosts

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

Get List Posts
ID로 특정 List와 연결된 Post 목록을 검색합니다.

#### 매개변수

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

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### removeMemberByUserId

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

Remove List member
ID와 사용자 ID로 특정 List에서 사용자를 제거합니다.

#### 매개변수

| 이름                           | 타입       | 설명                     |
| :--------------------------- | :------- | :--------------------- |
| `id`                         | `string` | 멤버를 제거할 List의 ID입니다.   |
| `userId`                     | `string` | List에서 제거할 사용자의 ID입니다. |
| `options`                    | `Object` | -                      |
| `options.requestOptions`     | `Object` | -                      |
| `options.requestOptions.raw` | `true`   | -                      |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### getById

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

Get List by ID
ID로 특정 List의 세부 정보를 검색합니다.

#### 매개변수

| 이름        | 타입                                                             | 설명           |
| :-------- | :------------------------------------------------------------- | :----------- |
| `id`      | `string`                                                       | List의 ID입니다. |
| `options` | `GetByIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### update

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

Update List
ID로 인증된 사용자가 소유한 특정 List의 세부 정보를 업데이트합니다.

#### 매개변수

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

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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

***

### delete

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

Delete List
ID로 인증된 사용자가 소유한 특정 List를 삭제합니다.

#### 매개변수

| 이름                           | 타입       | 설명               |
| :--------------------------- | :------- | :--------------- |
| `id`                         | `string` | 삭제할 List의 ID입니다. |
| `options`                    | `Object` | -                |
| `options.requestOptions`     | `Object` | -                |
| `options.requestOptions.raw` | `true`   | -                |

#### 반환값

`Promise`\<`Response`>

API 응답 또는 requestOptions.raw가 true인 경우 원본 Response로 해결되는 Promise

#### 정의 위치

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

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

#### 매개변수

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

#### 반환값

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

#### 정의 위치

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