Class EsaApi

EsaApi - object-oriented interface

Export

Hierarchy

BaseAPI
- EsaApi
  - Client

Constructors

constructor

new EsaApi(configuration?, basePath?, axios?): EsaApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns EsaApi
Inherited from BaseAPI.constructor
- Defined in client/base.ts:51

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

batchMoveCategory

batchMoveCategory(requestParameters, options?): Promise<AxiosResponse<BatchMoveResult, any>>
指定されたカテゴリを配下のカテゴリを含めて一括で変更します。
Parameters
- requestParameters: EsaApiBatchMoveCategoryRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<BatchMoveResult, any>>

Summary
カテゴリを一括移動する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5262

createComment

createComment(requestParameters, options?): Promise<AxiosResponse<Comment, any>>
記事に新しいコメントを作成します。
Parameters
- requestParameters: EsaApiCreateCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Comment, any>>

Summary
コメントを投稿する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5283

createEmoji

createEmoji(requestParameters, options?): Promise<AxiosResponse<CreatedEmoji, any>>
新しい絵文字を登録します。
Parameters
- requestParameters: EsaApiCreateEmojiRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<CreatedEmoji, any>>

Summary
絵文字を登録する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5307

createPost

createPost(requestParameters, options?): Promise<AxiosResponse<Post, any>>
Parameters
- requestParameters: EsaApiCreatePostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Post, any>>

Summary
記事を投稿する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5328

deleteComment

deleteComment(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定されたコメントを削除します。
Parameters
- requestParameters: EsaApiDeleteCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
コメントを削除する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5346

deleteEmoji

deleteEmoji(requestParameters, options?): Promise<AxiosResponse<void, any>>
登録したチーム固有の絵文字を削除します。
Parameters
- requestParameters: EsaApiDeleteEmojiRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
絵文字を削除する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5367

deleteMember

deleteMember(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定した screen_name のメンバーをチームから削除します。 - チームの owner である必要があります - APIで自分自身をチームから削除することはできません。
Parameters
- requestParameters: EsaApiDeleteMemberRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
メンバーを削除する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5384

deletePost

deletePost(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定された記事を削除します。
Parameters
- requestParameters: EsaApiDeletePostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
記事を削除する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5405

disinvite

disinvite(requestParameters, options?): Promise<AxiosResponse<void, any>>
招待中のメンバーの招待を削除します。招待時に送信されたメールに記載された招待用のURLは無効となります。このAPIはteamのownerだけがご利用可能です。
Parameters
- requestParameters: EsaApiDisinviteRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
招待を取り下げる

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5423

getAuthenticatedUser

getAuthenticatedUser(requestParameters?, options?): Promise<AxiosResponse<AuthenticatedUser, any>>
現在のアクセストークンで認証中のユーザーの情報を取得します。
Parameters
- requestParameters: EsaApiGetAuthenticatedUserRequest = {}
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<AuthenticatedUser, any>>

Summary
認証中のユーザーを取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5437

getComment

getComment(requestParameters, options?): Promise<AxiosResponse<Comment, any>>
指定されたコメントを取得します。
Parameters
- requestParameters: EsaApiGetCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Comment, any>>

Summary
コメントを取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5454

getCommentStargazers

getCommentStargazers(requestParameters, options?): Promise<AxiosResponse<PaginatedStargazers, any>>
指定されたコメントにStarをしたユーザ一覧を取得します。
Parameters
- requestParameters: EsaApiGetCommentStargazersRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedStargazers, any>>

Summary
コメントのStarを取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5473

getComments

getComments(requestParameters, options?): Promise<AxiosResponse<PaginatedComments, any>>
チーム全体のコメント一覧を作成日の降順で返却します。
Parameters
- requestParameters: EsaApiGetCommentsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedComments, any>>

Summary
コメント一覧を取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5496

getEmojis

getEmojis(requestParameters, options?): Promise<AxiosResponse<EmojiList, any>>
チームで利用可能な絵文字を取得します。URIクエリ文字列を含めない場合、チーム固有の絵文字だけを取得します。
Parameters
- requestParameters: EsaApiGetEmojisRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<EmojiList, any>>

Summary
絵文字一覧を取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5518

getInvitations

getInvitations(requestParameters, options?): Promise<AxiosResponse<InvitationList, any>>
招待中のメンバーの一覧を取得します。このAPIはteamのownerだけがご利用可能です。
Parameters
- requestParameters: EsaApiGetInvitationsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<InvitationList, any>>

Summary
招待中のメンバー一覧を取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5532

getMembers

getMembers(requestParameters, options?): Promise<AxiosResponse<PaginatedMembers, any>>
Parameters
- requestParameters: EsaApiGetMembersRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedMembers, any>>

Summary
メンバーを取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5549

getPost

getPost(requestParameters, options?): Promise<AxiosResponse<Post, any>>
指定された記事を取得します。
Parameters
- requestParameters: EsaApiGetPostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Post, any>>

Summary
記事を取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5570

getPostComments

getPostComments(requestParameters, options?): Promise<AxiosResponse<PaginatedComments, any>>
記事のコメント一覧を更新日の降順で返却します。
Parameters
- requestParameters: EsaApiGetPostCommentsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedComments, any>>

Summary
記事のコメント一覧を取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5589

getPostStargazers

getPostStargazers(requestParameters, options?): Promise<AxiosResponse<PaginatedStargazers, any>>
指定された記事にStarをしたユーザ一覧を取得します。
Parameters
- requestParameters: EsaApiGetPostStargazersRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedStargazers, any>>

Summary
記事のStarを取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5612

getPosts

getPosts(requestParameters, options?): Promise<AxiosResponse<PaginatedPosts, any>>
Parameters
- requestParameters: EsaApiGetPostsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedPosts, any>>

Summary
記事一覧を取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5635

getTags

getTags(requestParameters, options?): Promise<AxiosResponse<PaginatedTags, any>>
Parameters
- requestParameters: EsaApiGetTagsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedTags, any>>

Summary
タグ一覧をタグ付けされた記事数の降順で取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5658

getTeam

getTeam(requestParameters, options?): Promise<AxiosResponse<Team, any>>
Parameters
- requestParameters: EsaApiGetTeamRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Team, any>>

Summary
所属するチームを取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5677

getTeamStats

getTeamStats(requestParameters, options?): Promise<AxiosResponse<TeamStats, any>>
Parameters
- requestParameters: EsaApiGetTeamStatsRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<TeamStats, any>>

Summary
チームの統計情報を取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5691

getTeams

getTeams(requestParameters?, options?): Promise<AxiosResponse<PaginatedTeams, any>>
Parameters
- requestParameters: EsaApiGetTeamsRequest = {}
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedTeams, any>>

Summary
所属するチーム一覧を取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5708

getWatchers

getWatchers(requestParameters, options?): Promise<AxiosResponse<PaginatedWatchers, any>>
指定された記事にWatchをしたユーザ一覧を取得します。
Parameters
- requestParameters: EsaApiGetWatchersRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<PaginatedWatchers, any>>

Summary
Watchしたユーザー一覧を取得する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5725

invite

invite(requestParameters, options?): Promise<AxiosResponse<InvitationList, any>>
招待したいメンバーへ個別の招待URLを発行し、指定したEメールアドレスへ送信します。このAPIはteamのownerだけがご利用可能です。
Parameters
- requestParameters: EsaApiInviteRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<InvitationList, any>>

Summary
Emailで招待する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5748

starComment

starComment(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定されたコメントにStarをします。
Parameters
- requestParameters: EsaApiStarCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
コメントをStarする

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5762

starPost

starPost(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定された記事にStarをします。
Parameters
- requestParameters: EsaApiStarPostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
記事をStarする

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5784

unstarComment

unstarComment(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定されたコメントへのStarを取り消します。
Parameters
- requestParameters: EsaApiUnstarCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
コメントのStarを取り消す

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5803

unstarPost

unstarPost(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定された記事へのStarを取り消します。
Parameters
- requestParameters: EsaApiUnstarPostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
記事のStarを取り消す

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5824

unwachPost

unwachPost(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定された記事へのWatchを取り消します。
Parameters
- requestParameters: EsaApiUnwachPostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
記事のWatchを取り消す

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5842

updateComment

updateComment(requestParameters, options?): Promise<AxiosResponse<Comment, any>>
指定されたコメントを更新します。
Parameters
- requestParameters: EsaApiUpdateCommentRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Comment, any>>

Summary
コメントを更新する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5860

updatePost

updatePost(requestParameters, options?): Promise<AxiosResponse<Post, any>>
指定された記事を編集します。
Parameters
- requestParameters: EsaApiUpdatePostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<Post, any>>

Summary
記事を編集する

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5882

watchPost

watchPost(requestParameters, options?): Promise<AxiosResponse<void, any>>
指定された記事にWatchをします。
Parameters
- requestParameters: EsaApiWatchPostRequest
  
  Request parameters.
- Optional options: any
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
記事をWatchする

Throws

Memberof
EsaApi
- Defined in client/api/esa-api.ts:5901

Generated using TypeDoc