> ## 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.

# UsersClient

ユーザー操作用の Client

この Client は、X API の users エンドポイントとやり取りするためのメソッドを提供します。認証、リクエストのフォーマット、レスポンスの解析など、ユーザー関連のすべての操作を処理します。

<div id="constructors">
  ## コンストラクタ
</div>

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

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

新しい Users クライアントのインスタンスを生成します

#### パラメーター

| Name     | Type                                                     | Description                |
| :------- | :------------------------------------------------------- | :------------------------- |
| `client` | [`Client`](/ja/xdks/typescript/reference/classes/Client) | X API のメイン `Client` インスタンス |

#### 戻り値

[`UsersClient`](/ja/xdks/typescript/reference/classes/UsersClient)

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:1234](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L1234)

<div id="methods">
  ## メソッド
</div>

<div id="getbyusernames">
  ### getByUsernames
</div>

▸ **getByUsernames**(`usernames`, `options`): `Promise`\<`Response`>

ユーザー名からユーザーを取得する\
複数のユーザーの詳細をユーザー名で取得します。

#### パラメーター

| Name        | Type                                                                  | Description       |
| :---------- | :-------------------------------------------------------------------- | :---------------- |
| `usernames` | `any`\[]                                                              | カンマ区切りのユーザー名のリスト。 |
| `options`   | `GetByUsernamesOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                 |

#### 戻り値

`Promise`\<`Response`>

API レスポンスを返す Promise。requestOptions.raw が true の場合は、生の Response。

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:1279](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L1279)

▸ **getByUsernames**(`usernames`, `options?`): `Promise`\<[`Get2UsersByResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2UsersByResponse)>

#### パラメーター

| 名前          | 型                       |
| :---------- | :---------------------- |
| `usernames` | `any`\[]                |
| `options?`  | `GetByUsernamesOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:1292](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L1292)

***

<div id="getrepostsofme">
  ### getRepostsOfMe
</div>

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

自分のポストがリポストされた投稿を取得\
認証済みユーザーのポストをリポストしている投稿の一覧を取得します。

#### パラメーター

| 名前        | 型                                                                     |
| :-------- | :-------------------------------------------------------------------- |
| `options` | `GetRepostsOfMeOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### 戻り値

`Promise`\<`Response`>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response を返します

#### 定義元

[users/client.ts:1471](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L1471)

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

#### パラメータ

| 名前         | 型                       |
| :--------- | :---------------------- |
| `options?` | `GetRepostsOfMeOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:1480](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L1480)

***

<div id="unlikepost">
  ### unlikePost
</div>

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

ポストのいいねを取り消す\
認証済みユーザーが、指定されたIDのポストに対するいいねを取り消します。

#### パラメーター

| Name                         | Type     | Description                         |
| :--------------------------- | :------- | :---------------------------------- |
| `id`                         | `string` | いいねの取り消しをリクエストしている、認証済みの発信元ユーザーのID。 |
| `tweetId`                    | `string` | ユーザーがいいねを取り消そうとしているポストのID。          |
| `options`                    | `Object` | -                                   |
| `options.requestOptions`     | `Object` | -                                   |
| `options.requestOptions.raw` | `true`   | -                                   |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response に解決される Promise

#### 定義元

[users/client.ts:1741](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L1741)

▸ **unlikePost**(`id`, `tweetId`): `Promise`\<[`UsersLikesDeleteResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.UsersLikesDeleteResponse)>

#### パラメーター

| 名前        | 型        |
| :-------- | :------- |
| `id`      | `string` |
| `tweetId` | `string` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:1758](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L1758)

***

<div id="getbookmarks">
  ### getBookmarks
</div>

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

ブックマークを取得\
認証済みユーザーがブックマークに追加した投稿の一覧を取得します。

#### パラメーター

| Name      | Type                                                                | Description                |
| :-------- | :------------------------------------------------------------------ | :------------------------- |
| `id`      | `string`                                                            | 結果を返す対象となる認証済みソースユーザーの ID。 |
| `options` | `GetBookmarksOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                          |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response で解決される Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:1861](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L1861)

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

#### パラメータ

| 名前         | 型                     |
| :--------- | :-------------------- |
| `id`       | `string`              |
| `options?` | `GetBookmarksOptions` |

#### 戻り値

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

#### 定義箇所

[users/client.ts:1874](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L1874)

***

<div id="createbookmark">
  ### createBookmark
</div>

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

ブックマークを作成
認証済みのユーザーのブックマークにポストを追加します。

#### パラメーター

| Name                         | Type                                                                                        | Description                     |
| :--------------------------- | :------------------------------------------------------------------------------------------ | :------------------------------ |
| `id`                         | `string`                                                                                    | ブックマークを追加する対象となる、認証済みソースユーザーのID |
| `body`                       | [`BookmarkAddRequest`](/ja/xdks/typescript/reference/interfaces/Schemas.BookmarkAddRequest) | リクエストボディ                        |
| `options`                    | `Object`                                                                                    | -                               |
| `options.requestOptions`     | `Object`                                                                                    | -                               |
| `options.requestOptions.raw` | `true`                                                                                      | -                               |

#### 返り値

`Promise`\<`Response`>

API レスポンスで解決される `Promise`。`requestOptions.raw` が `true` の場合は生の `Response`。

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:2139](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2139)

▸ **createBookmark**(`id`, `body`): `Promise`\<[`BookmarkMutationResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.BookmarkMutationResponse)>

#### パラメータ

| 名前     | 型                                                                                           |
| :----- | :------------------------------------------------------------------------------------------ |
| `id`   | `string`                                                                                    |
| `body` | [`BookmarkAddRequest`](/ja/xdks/typescript/reference/interfaces/Schemas.BookmarkAddRequest) |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:2154](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2154)

***

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

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

フォロワーの取得\
特定のユーザーの `id` を指定して、そのユーザーのフォロワーの一覧を取得します。

#### パラメーター

| Name      | Type                                                                | Description  |
| :-------- | :------------------------------------------------------------------ | :----------- |
| `id`      | `string`                                                            | 取得するユーザーのID。 |
| `options` | `GetFollowersOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 戻り値

`Promise`\<`Response`>

API レスポンスに解決される Promise。`requestOptions.raw` が true の場合は、生の `Response` に解決される

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:2245](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2245)

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

#### パラメータ

| 名前         | 型                     |
| :--------- | :-------------------- |
| `id`       | `string`              |
| `options?` | `GetFollowersOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:2258](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2258)

***

<div id="unpinlist">
  ### unpinList
</div>

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

リストのピン留めを解除する\
認証されたユーザーが、指定したIDのリストのピン留めを解除します。

#### パラメータ

| Name                         | Type     | Description               |
| :--------------------------- | :------- | :------------------------ |
| `id`                         | `string` | 結果を返す対象となる認証済みソースユーザーのID。 |
| `listId`                     | `string` | ピン留めを解除するリストのID。          |
| `options`                    | `Object` | -                         |
| `options.requestOptions`     | `Object` | -                         |
| `options.requestOptions.raw` | `true`   | -                         |

#### 返り値

`Promise`\<`Response`>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

#### 定義元

[users/client.ts:2474](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2474)

▸ **unpinList**(`id`, `listId`): `Promise`\<[`ListUnpinResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.ListUnpinResponse)>

#### パラメーター

| 名前       | 型        |
| :------- | :------- |
| `id`     | `string` |
| `listId` | `string` |

#### 戻り値

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

#### 定義元

[users/client.ts:2491](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2491)

***

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

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

ID で User を取得します\
指定した User の詳細情報を、その id を用いて取得します。

#### パラメーター

| Name      | Type                                                           | Description   |
| :-------- | :------------------------------------------------------------- | :------------ |
| `id`      | `string`                                                       | 取得対象のユーザーのID。 |
| `options` | `GetByIdOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -             |

#### 返り値

`Promise`\<`Response`>

API レスポンスで解決される Promise。`requestOptions.raw` が true の場合は生の Response

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:2594](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2594)

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

#### パラメータ

| 名前         | 型                |
| :--------- | :--------------- |
| `id`       | `string`         |
| `options?` | `GetByIdOptions` |

#### 戻り値

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

#### 定義元

[users/client.ts:2607](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2607)

***

<div id="getmentions">
  ### getMentions
</div>

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

メンションを取得します
特定のユーザー ID を指定して、そのユーザーがメンションされている投稿の一覧を取得します。

#### パラメーター

| Name      | Type                                                               | Description  |
| :-------- | :----------------------------------------------------------------- | :----------- |
| `id`      | `string`                                                           | 取得するユーザーのID。 |
| `options` | `GetMentionsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 戻り値

`Promise`\<`Response`>

API レスポンスを返す Promise。`requestOptions.raw` が `true` の場合は生の `Response`

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:2781](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2781)

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

#### パラメーター

| 名前         | 型                    |
| :--------- | :------------------- |
| `id`       | `string`             |
| `options?` | `GetMentionsOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:2794](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L2794)

***

<div id="unrepostpost">
  ### unrepostPost
</div>

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

ポストのリポストを取り消す\
認証済みユーザーが、指定した ID のポストのリポストを取り消します。

<div id="parameters">
  #### Parameters
</div>

| Name                         | Type     | Description                     |
| :--------------------------- | :------- | :------------------------------ |
| `id`                         | `string` | ポストのリポストを要求している認証済みの発信元ユーザーのID。 |
| `sourceTweetId`              | `string` | ユーザーがリポストの取り消しを要求しているポストのID。    |
| `options`                    | `Object` | -                               |
| `options.requestOptions`     | `Object` | -                               |
| `options.requestOptions.raw` | `true`   | -                               |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response で解決される Promise

#### 定義元

[users/client.ts:3149](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3149)

▸ **unrepostPost**(`id`, `sourceTweetId`): `Promise`\<[`UsersRetweetsDeleteResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.UsersRetweetsDeleteResponse)>

#### パラメータ

| 名前              | 型        |
| :-------------- | :------- |
| `id`            | `string` |
| `sourceTweetId` | `string` |

#### 戻り値

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

#### 定義箇所

[users/client.ts:3166](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3166)

***

<div id="deletebookmark">
  ### deleteBookmark
</div>

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

ブックマークを削除
認証済みユーザーのブックマークから、IDで指定したポストを削除します。

#### パラメーター

| Name                         | Type     | Description                 |
| :--------------------------- | :------- | :-------------------------- |
| `id`                         | `string` | ブックマークを削除する認証済みソースユーザーのID。  |
| `tweetId`                    | `string` | ソースユーザーがブックマークから削除するポストのID。 |
| `options`                    | `Object` | -                           |
| `options.requestOptions`     | `Object` | -                           |
| `options.requestOptions.raw` | `true`   | -                           |

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

`Promise`\<`Response`>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response オブジェクト

#### 定義元

[users/client.ts:3273](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3273)

▸ **deleteBookmark**(`id`, `tweetId`): `Promise`\<[`BookmarkMutationResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.BookmarkMutationResponse)>

#### パラメーター

| 名前        | 型        |
| :-------- | :------- |
| `id`      | `string` |
| `tweetId` | `string` |

#### 戻り値

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

#### 定義元

[users/client.ts:3290](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3290)

***

<div id="unfollowlist">
  ### unfollowList
</div>

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

リストのフォローを解除する\
認証済みユーザーが、指定したリストIDのリストのフォローを解除します。

#### パラメーター

| Name                         | Type     | Description                   |
| :--------------------------- | :------- | :---------------------------- |
| `id`                         | `string` | リストのフォローを解除する、認証済みソースユーザーのID。 |
| `listId`                     | `string` | フォローを解除するリストのID。              |
| `options`                    | `Object` | -                             |
| `options.requestOptions`     | `Object` | -                             |
| `options.requestOptions.raw` | `true`   | -                             |

#### 戻り値

`Promise`\<`Response`>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response を返します。

#### 定義元

[users/client.ts:3391](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3391)

▸ **unfollowList**(`id`, `listId`): `Promise`\<[`ListFollowedResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.ListFollowedResponse)>

#### パラメータ

| 名前       | 型        |
| :------- | :------- |
| `id`     | `string` |
| `listId` | `string` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:3408](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3408)

***

<div id="unmuteuser">
  ### unmuteUser
</div>

▸ **unmuteUser**(`sourceUserId`, `targetUserId`, `options`): `Promise`\<`Response`>

ユーザーのミュートを解除
認証済みユーザーが、指定したユーザーidのミュートを解除します。

#### パラメータ

| Name                         | Type     | Description                        |
| :--------------------------- | :------- | :--------------------------------- |
| `sourceUserId`               | `string` | ミュート解除をリクエストしている認証済みのソースユーザーのID。   |
| `targetUserId`               | `string` | ソースユーザーがミュート解除をリクエストしている対象ユーザーのID。 |
| `options`                    | `Object` | -                                  |
| `options.requestOptions`     | `Object` | -                                  |
| `options.requestOptions.raw` | `true`   | -                                  |

#### 戻り値

`Promise`\<`Response`>

API レスポンスに解決される Promise。`requestOptions.raw` が `true` の場合は生の `Response` を返します。

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:3515](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3515)

▸ **unmuteUser**(`sourceUserId`, `targetUserId`): `Promise`\<[`MuteUserMutationResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.MuteUserMutationResponse)>

#### パラメータ

| 名前             | 型        |
| :------------- | :------- |
| `sourceUserId` | `string` |
| `targetUserId` | `string` |

#### 戻り値

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

#### 定義元

[users/client.ts:3532](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3532)

***

<div id="getme">
  ### getMe
</div>

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

自分のユーザー情報を取得します
認証済みのユーザーの詳細を取得します。

#### パラメータ

| 名前        | Type                                                         |
| :-------- | :----------------------------------------------------------- |
| `options` | `GetMeOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response オブジェクトに解決される Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:3631](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3631)

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

#### パラメータ

| 名前         | 型              |
| :--------- | :------------- |
| `options?` | `GetMeOptions` |

#### 戻り値

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

#### 定義元

[users/client.ts:3640](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3640)

***

<div id="getmuting">
  ### getMuting
</div>

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

ミュート中のユーザーの取得
認証済みユーザーがミュートしているユーザーのリストを取得します。

#### パラメーター

| Name      | Type                                                             | Description             |
| :-------- | :--------------------------------------------------------------- | :---------------------- |
| `id`      | `string`                                                         | 結果を返す対象の認証済みソースユーザーのID。 |
| `options` | `GetMutingOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                       |

#### 戻り値

`Promise`\<`Response`>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

#### 定義元

[users/client.ts:3796](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3796)

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

#### パラメーター

| 名前         | 型                  |
| :--------- | :----------------- |
| `id`       | `string`           |
| `options?` | `GetMutingOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:3809](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L3809)

***

<div id="muteuser">
  ### muteUser
</div>

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

ユーザーをミュートする\
認証済みのユーザーが、指定したidのユーザーをミュートします。

#### パラメーター

| Name      | Type                                                            | Description                                |
| :-------- | :-------------------------------------------------------------- | :----------------------------------------- |
| `id`      | `string`                                                        | ターゲット User のミュートをリクエストする認証済みソース User の ID。 |
| `options` | `MuteUserOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                          |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:4015](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4015)

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

#### パラメーター

| 名前         | 型                 |
| :--------- | :---------------- |
| `id`       | `string`          |
| `options?` | `MuteUserOptions` |

#### 戻り値

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

#### 定義元

[users/client.ts:4028](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4028)

***

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

▸ **search**(`query`, `options`): `Promise`\<`Response`>

ユーザーを検索
検索クエリに一致するユーザーの一覧を取得します。

#### パラメーター

| Name      | Type                                                          | Description         |
| :-------- | :------------------------------------------------------------ | :------------------ |
| `query`   | `string`                                                      | ユーザーを検索するためのクエリ文字列。 |
| `options` | `SearchOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                   |

#### 戻り値

`Promise`\<`Response`>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:4136](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4136)

▸ **search**(`query`, `options?`): `Promise`\<[`Get2UsersSearchResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2UsersSearchResponse)>

#### パラメーター

| 名前         | type            |
| :--------- | :-------------- |
| `query`    | `string`        |
| `options?` | `SearchOptions` |

#### 戻り値

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

#### 定義元

[users/client.ts:4149](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4149)

***

<div id="getblocking">
  ### getBlocking
</div>

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

ブロックしているユーザーの取得
指定したユーザーIDがブロックしているユーザーの一覧を取得します。

#### パラメーター

| Name      | Type                                                               | Description               |
| :-------- | :----------------------------------------------------------------- | :------------------------ |
| `id`      | `string`                                                           | 結果を返す対象となる認証済みソースユーザーのID。 |
| `options` | `GetBlockingOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                         |

#### 戻り値

`Promise`\<`Response`>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:4362](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4362)

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

#### パラメーター

| 名前         | 型                    |
| :--------- | :------------------- |
| `id`       | `string`             |
| `options?` | `GetBlockingOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:4375](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4375)

***

<div id="getbyids">
  ### getByIds
</div>

▸ **getByIds**(`ids`, `options`): `Promise`\<`Response`>

id でユーザーを取得する
複数のユーザーの詳細を、それぞれの id を指定して取得します。

<div id="parameters">
  #### Parameters
</div>

| Name      | Type                                                            | Description                       |
| :-------- | :-------------------------------------------------------------- | :-------------------------------- |
| `ids`     | `any`\[]                                                        | カンマ区切りのユーザーIDのリスト。最大100個まで指定できます。 |
| `options` | `GetByIdsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                 |

#### 戻り値

`Promise`\<`Response`>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は、生の Response が返されます

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:4581](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4581)

▸ **getByIds**(`ids`, `options?`): `Promise`\<[`Get2UsersResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2UsersResponse)>

#### パラメーター

| 名前         | 型                 |
| :--------- | :---------------- |
| `ids`      | `any`\[]          |
| `options?` | `GetByIdsOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:4594](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4594)

***

<div id="getfollowing">
  ### getFollowing
</div>

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

フォローしているUserを取得
特定のUserのidを指定して、そのUserがフォローしているUserのリストを取得します。

#### パラメーター

| 名前        | 型                                                                   | 説明           |
| :-------- | :------------------------------------------------------------------ | :----------- |
| `id`      | `string`                                                            | 取得するユーザーのID。 |
| `options` | `GetFollowingOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 戻り値

`Promise`\<`Response`>

API レスポンス (または requestOptions.raw が true の場合は生の Response) で解決される Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:4777](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4777)

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

#### パラメータ

| 名前         | 型                     |
| :--------- | :-------------------- |
| `id`       | `string`              |
| `options?` | `GetFollowingOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:4790](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L4790)

***

<div id="followuser">
  ### followUser
</div>

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

ユーザーをフォローする\
認証済みユーザーが、指定したユーザー ID を持つ特定のユーザーをフォローします。

#### パラメータ

| Name      | Type                                                              | Description                            |
| :-------- | :---------------------------------------------------------------- | :------------------------------------- |
| `id`      | `string`                                                          | 対象ユーザーのフォローをリクエストしている、認証済みのソースユーザーのID。 |
| `options` | `FollowUserOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                      |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

#### 定義元

[users/client.ts:5002](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5002)

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

#### パラメーター

| 名前         | 型                   |
| :--------- | :------------------ |
| `id`       | `string`            |
| `options?` | `FollowUserOptions` |

#### 戻り値

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

#### 定義元

[users/client.ts:5015](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5015)

***

<div id="likepost">
  ### likePost
</div>

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

ポストに「いいね」する\
認証済みユーザーが、特定の ID のポストに「いいね」します。

#### パラメーター

| Name      | Type                                                            | Description                         |
| :-------- | :-------------------------------------------------------------- | :---------------------------------- |
| `id`      | `string`                                                        | ポストへの「いいね」をリクエストしている認証済みソースユーザーのID。 |
| `options` | `LikePostOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                   |

#### 戻り値

`Promise`\<`Response`>

API レスポンス (または requestOptions.raw が true の場合は生の Response) で解決される Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:5123](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5123)

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

#### パラメータ

| 名前         | 型                 |
| :--------- | :---------------- |
| `id`       | `string`          |
| `options?` | `LikePostOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:5136](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5136)

***

<div id="getlikedposts">
  ### getLikedPosts
</div>

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

「いいね」した投稿を取得します
指定したユーザーIDが「いいね」した投稿の一覧を取得します。

#### パラメーター

| Name      | Type                                                                 | Description  |
| :-------- | :------------------------------------------------------------------- | :----------- |
| `id`      | `string`                                                             | 取得するユーザーのID。 |
| `options` | `GetLikedPostsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 戻り値

`Promise`\<`Response`>

API レスポンスを解決結果とする Promise。requestOptions.raw が true の場合は、生の Response が返されます

#### 定義元

[users/client.ts:5244](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5244)

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

#### パラメーター

| 名前         | 型                      |
| :--------- | :--------------------- |
| `id`       | `string`               |
| `options?` | `GetLikedPostsOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:5257](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5257)

***

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

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

投稿の取得
特定のユーザーが作成した投稿のリストを、そのユーザーのidを指定して取得します。

#### パラメーター

| Name      | Type                                                            | Description  |
| :-------- | :-------------------------------------------------------------- | :----------- |
| `id`      | `string`                                                        | 取得するユーザーのID。 |
| `options` | `GetPostsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 戻り値

`Promise`\<`Response`>

API レスポンスに解決される Promise、または `requestOptions.raw` が `true` の場合は生の `Response`

#### 定義元

[users/client.ts:5526](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5526)

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

#### パラメータ

| 名前         | 型                 |
| :--------- | :---------------- |
| `id`       | `string`          |
| `options?` | `GetPostsOptions` |

#### 戻り値

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

#### 定義元

[users/client.ts:5539](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5539)

***

<div id="blockdms">
  ### blockDms
</div>

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

DM をブロックする\
認証済みユーザーについて、特定の User の id を指定して、そのユーザーとの間で行われるダイレクトメッセージの送受信をブロックします。

<div id="parameters">
  #### Parameters
</div>

| Name                         | Type     | Description                                         |
| :--------------------------- | :------- | :-------------------------------------------------- |
| `id`                         | `string` | このメソッドを呼び出している認証済みユーザーがDMの受信をブロックしようとしている対象ユーザーのID。 |
| `options`                    | `Object` | -                                                   |
| `options.requestOptions`     | `Object` | -                                                   |
| `options.requestOptions.raw` | `true`   | -                                                   |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:5909](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5909)

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

#### パラメータ

| 名称   | 型        |
| :--- | :------- |
| `id` | `string` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:5922](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L5922)

***

<div id="getlistmemberships">
  ### getListMemberships
</div>

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

リストのメンバーシップ情報を取得します
指定したユーザーがメンバーになっているリストの一覧を、そのユーザーのIDで取得します。

<div id="parameters">
  #### Parameters
</div>

| Name      | Type                                                                      | Description  |
| :-------- | :------------------------------------------------------------------------ | :----------- |
| `id`      | `string`                                                                  | 取得するユーザーのID。 |
| `options` | `GetListMembershipsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 戻り値

`Promise`\<`Response`>

API レスポンスで解決される Promise。`requestOptions.raw` が true の場合は生の `Response`

#### 定義元

[users/client.ts:6013](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6013)

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

#### パラメーター

| 名前         | 型                           |
| :--------- | :-------------------------- |
| `id`       | `string`                    |
| `options?` | `GetListMembershipsOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:6026](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6026)

***

<div id="getpinnedlists">
  ### getPinnedLists
</div>

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

ピン留めされたリストを取得します\
認証済みユーザーがピン留めしているリストの一覧を取得します。

#### パラメーター

| Name      | Type                                                                  | Description             |
| :-------- | :-------------------------------------------------------------------- | :---------------------- |
| `id`      | `string`                                                              | 結果を返す対象の認証済みソースユーザーのID。 |
| `options` | `GetPinnedListsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                       |

#### 戻り値

`Promise`\<`Response`>

API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:6238](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6238)

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

#### パラメーター

| 名前         | 型                       |
| :--------- | :---------------------- |
| `id`       | `string`                |
| `options?` | `GetPinnedListsOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:6251](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6251)

***

<div id="pinlist">
  ### pinList
</div>

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

リストをピン留めする
認証済みユーザーが、指定したIDのリストをピン留めします。

#### パラメータ

| 名前                           | Type                                                                                      | 説明                         |
| :--------------------------- | :---------------------------------------------------------------------------------------- | :------------------------- |
| `id`                         | `string`                                                                                  | リストをピン留めする認証済みのソースユーザーのID。 |
| `body`                       | [`ListPinnedRequest`](/ja/xdks/typescript/reference/interfaces/Schemas.ListPinnedRequest) | リクエストボディ                   |
| `options`                    | `Object`                                                                                  | -                          |
| `options.requestOptions`     | `Object`                                                                                  | -                          |
| `options.requestOptions.raw` | `true`                                                                                    | -                          |

#### 戻り値

`Promise`\<`Response`>

API レスポンスで解決される Promise。requestOptions.raw が true の場合は生の Response

#### 定義元

[users/client.ts:6421](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6421)

▸ **pinList**(`id`, `body`): `Promise`\<[`ListPinnedResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.ListPinnedResponse)>

#### パラメーター

| 名前     | Type                                                                                      |
| :----- | :---------------------------------------------------------------------------------------- |
| `id`   | `string`                                                                                  |
| `body` | [`ListPinnedRequest`](/ja/xdks/typescript/reference/interfaces/Schemas.ListPinnedRequest) |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:6436](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6436)

***

<div id="getbyusername">
  ### getByUsername
</div>

▸ **getByUsername**(`username`, `options`): `Promise`\<`Response`>

ユーザー名で User を取得
指定したユーザー名の User の詳細情報を取得します。

#### パラメーター

| 名前         | type                                                                 | 説明     |
| :--------- | :------------------------------------------------------------------- | :----- |
| `username` | `string`                                                             | ユーザー名。 |
| `options`  | `GetByUsernameOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -      |

#### 戻り値

`Promise`\<`Response`>

API レスポンスに解決される Promise。`requestOptions.raw` が `true` の場合は生の `Response`

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:6533](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6533)

▸ **getByUsername**(`username`, `options?`): `Promise`\<[`Get2UsersByUsernameUsernameResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.Get2UsersByUsernameUsernameResponse)>

#### パラメーター

| 名前         | Type                   |
| :--------- | :--------------------- |
| `username` | `string`               |
| `options?` | `GetByUsernameOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:6546](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6546)

***

<div id="unfollowuser">
  ### unfollowUser
</div>

▸ **unfollowUser**(`sourceUserId`, `targetUserId`, `options`): `Promise`\<`Response`>

ユーザーのフォロー解除
認証済みユーザーが、指定したユーザーのidを基にそのユーザーのフォローを解除します。

#### パラメータ

| Name                         | Type     | Description                     |
| :--------------------------- | :------- | :------------------------------ |
| `sourceUserId`               | `string` | フォロー解除を要求している認証済みソースユーザーのID。    |
| `targetUserId`               | `string` | ソースユーザーがフォロー解除を要求している対象ユーザーのID。 |
| `options`                    | `Object` | -                               |
| `options.requestOptions`     | `Object` | -                               |
| `options.requestOptions.raw` | `true`   | -                               |

#### 戻り値

`Promise`\<`Response`>

API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:6724](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6724)

▸ **unfollowUser**(`sourceUserId`, `targetUserId`): `Promise`\<[`UsersFollowingDeleteResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.UsersFollowingDeleteResponse)>

#### パラメータ

| 名前             | 型        |
| :------------- | :------- |
| `sourceUserId` | `string` |
| `targetUserId` | `string` |

#### 戻り値

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

#### 定義元

[users/client.ts:6741](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6741)

***

<div id="gettimeline">
  ### getTimeline
</div>

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

タイムラインを取得
認証済みユーザーのタイムライン上の投稿を、新しいものから順に取得します。

#### パラメーター

| Name      | Type                                                               | Description                                |
| :-------- | :----------------------------------------------------------------- | :----------------------------------------- |
| `id`      | `string`                                                           | 逆時系列タイムラインの投稿を一覧取得する対象となる、認証済みソースユーザーの ID。 |
| `options` | `GetTimelineOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                                          |

#### 戻り値

`Promise`\<`Response`>

API レスポンスで解決される Promise オブジェクト。`requestOptions.raw` が `true` の場合は生の `Response`

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:6844](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6844)

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

#### パラメータ

| 名前         | 型                    |
| :--------- | :------------------- |
| `id`       | `string`             |
| `options?` | `GetTimelineOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:6857](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L6857)

***

<div id="getfollowedlists">
  ### getFollowedLists
</div>

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

フォローしているリストを取得
指定したユーザーの id に基づき、そのユーザーがフォローしているリストの一覧を取得します。

#### パラメータ

| Name      | Type                                                                    | Description  |
| :-------- | :---------------------------------------------------------------------- | :----------- |
| `id`      | `string`                                                                | 取得するユーザーのID。 |
| `options` | `GetFollowedListsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -            |

#### 戻り値

`Promise`\<`Response`>

API レスポンス (requestOptions.raw が true の場合は生の Response) で解決される Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:7221](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7221)

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

#### パラメータ

| 名前         | 型                         |
| :--------- | :------------------------ |
| `id`       | `string`                  |
| `options?` | `GetFollowedListsOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:7234](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7234)

***

<div id="followlist">
  ### followList
</div>

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

リストをフォロー\
認証済みユーザーが、指定されたIDの特定のリストをフォローします。

#### パラメーター

| Name      | Type                                                              | Description               |
| :-------- | :---------------------------------------------------------------- | :------------------------ |
| `id`      | `string`                                                          | リストをフォローする認証済みソースユーザーのID。 |
| `options` | `FollowListOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                         |

#### 戻り値

`Promise`\<`Response`>

API レスポンスへと解決される Promise。`requestOptions.raw` が `true` の場合は生の `Response`

#### 定義元

[users/client.ts:7446](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7446)

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

#### パラメーター

| 名前         | 型                   |
| :--------- | :------------------ |
| `id`       | `string`            |
| `options?` | `FollowListOptions` |

#### 戻り値

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

#### 定義元

[users/client.ts:7459](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7459)

***

<div id="unblockdms">
  ### unblockDms
</div>

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

DM のブロック解除
認証済みユーザーについて、指定したユーザー ID とのダイレクトメッセージの送受信ブロックを解除します。

#### パラメータ

| Name                         | Type     | Description                            |
| :--------------------------- | :------- | :------------------------------------- |
| `id`                         | `string` | 認証済みユーザーがDMのブロック解除をリクエストしている対象ユーザーのID。 |
| `options`                    | `Object` | -                                      |
| `options.requestOptions`     | `Object` | -                                      |
| `options.requestOptions.raw` | `true`   | -                                      |

#### 戻り値

`Promise`\<`Response`>

API レスポンスを返す Promise。requestOptions.raw が true の場合は生の Response。

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:7567](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7567)

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

#### パラメーター

| 名前   | 型        |
| :--- | :------- |
| `id` | `string` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:7580](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7580)

***

<div id="repostpost">
  ### repostPost
</div>

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

ポストをリポストする
認証済みユーザーが、指定したIDのポストをリポストします。

#### パラメーター

| Name      | Type                                                              | Description                     |
| :-------- | :---------------------------------------------------------------- | :------------------------------ |
| `id`      | `string`                                                          | ポストのリポストを要求している、認証済み送信元ユーザーのID。 |
| `options` | `RepostPostOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                               |

#### 戻り値

`Promise`\<`Response`>

API レスポンスを返す Promise、または requestOptions.raw が true の場合は生の Response

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:7671](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7671)

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

#### パラメーター

| 名前         | 型                   |
| :--------- | :------------------ |
| `id`       | `string`            |
| `options?` | `RepostPostOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:7684](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7684)

***

<div id="getbookmarkfolders">
  ### getBookmarkFolders
</div>

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

ブックマークフォルダを取得します\
認証されたユーザーが作成したブックマークフォルダの一覧を取得します。

#### パラメータ

| Name      | Type                                                                      | Description                 |
| :-------- | :------------------------------------------------------------------------ | :-------------------------- |
| `id`      | `string`                                                                  | 結果を返す対象となる、認証済みのソースユーザーのID。 |
| `options` | `GetBookmarkFoldersOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -                           |

#### 戻り値

`Promise`\<`Response`>

API レスポンス、または requestOptions.raw が true の場合は生の Response を返す Promise

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:7792](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7792)

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

#### パラメーター

| 名前         | 型                           |
| :--------- | :-------------------------- |
| `id`       | `string`                    |
| `options?` | `GetBookmarkFoldersOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:7805](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7805)

***

<div id="getownedlists">
  ### getOwnedLists
</div>

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

所有するリストを取得します\
ユーザーIDを指定して、そのユーザーが所有するリストの一覧を取得します。

#### パラメーター

| Name      | Type                                                                 | Description   |
| :-------- | :------------------------------------------------------------------- | :------------ |
| `id`      | `string`                                                             | 取得対象のユーザーのID。 |
| `options` | `GetOwnedListsOptions` & \{ `requestOptions`: \{ `raw`: `true`  }  } | -             |

#### 戻り値

`Promise`\<`Response`>

API レスポンス (`requestOptions.raw` が `true` の場合は生の `Response`) で解決される Promise

#### 定義元

[users/client.ts:7944](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7944)

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

#### パラメーター

| 名前         | 型                      |
| :--------- | :--------------------- |
| `id`       | `string`               |
| `options?` | `GetOwnedListsOptions` |

#### 戻り値

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

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:7957](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L7957)

***

<div id="getbookmarksbyfolderid">
  ### getBookmarksByFolderId
</div>

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

フォルダーIDでブックマークを取得\
認証済みユーザーの特定のブックマークフォルダーに含まれる投稿を、そのフォルダーのIDを指定して取得します。

#### パラメーター

| Name                         | Type     | Description                           |
| :--------------------------- | :------- | :------------------------------------ |
| `id`                         | `string` | 結果を返す対象となる、認証済みユーザーのID。               |
| `folderId`                   | `string` | 認証済みユーザーが投稿を取得しようとしているブックマークフォルダーのID。 |
| `options`                    | `Object` | -                                     |
| `options.requestOptions`     | `Object` | -                                     |
| `options.requestOptions.raw` | `true`   | -                                     |

#### 戻り値

`Promise`\<`Response`>

API レスポンスで解決される Promise。`requestOptions.raw` が `true` の場合は生の `Response`

<div id="defined-in">
  #### 定義場所
</div>

[users/client.ts:8173](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L8173)

▸ **getBookmarksByFolderId**(`id`, `folderId`): `Promise`\<[`BookmarkFolderPostsResponse`](/ja/xdks/typescript/reference/interfaces/Schemas.BookmarkFolderPostsResponse)>

#### パラメータ

| 名前         | 型        |
| :--------- | :------- |
| `id`       | `string` |
| `folderId` | `string` |

#### 戻り値

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

#### 定義元

[users/client.ts:8190](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/client.ts#L8190)