Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
계정 활동 작업을 위한 Client
이 Client는 X API의 계정 활동 엔드포인트와 상호 작용하기 위한 메서드를 제공합니다. 계정 활동과 관련된 모든 작업에 대해 인증, 요청 포맷팅, 응답
파싱을 처리합니다.
• new AccountActivityClient(client): AccountActivityClient
새로운 AccountActivityClient 인스턴스를 생성합니다
| Name | Type | Description |
|---|
client | Client | 주요 X API Client 인스턴스 |
AccountActivityClient
정의 위치
account_activity/client.ts:70
▸ getSubscriptions(webhookId, options): Promise<Response>
구독 조회
지정된 webhook에 대한 모든 활성 구독의 목록을 조회합니다.
| Name | Type | Description |
|---|
webhookId | string | 구독 정보를 가져올 webhook ID입니다. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
API 응답으로 resolve되는 Promise, 또는 requestOptions.raw가 true인 경우 원시 Response
정의 위치
account_activity/client.ts:115
▸ getSubscriptions(webhookId): Promise<SubscriptionsListGetResponse>
Promise<SubscriptionsListGetResponse>
account_activity/client.ts:128
▸ deleteSubscription(webhookId, userId, options): Promise<Response>
구독 삭제
지정된 웹훅과 사용자 ID에 대한 Account Activity 구독을 삭제합니다.
| Name | Type | Description |
|---|
webhookId | string | 구독 상태를 확인할 webhook ID. |
userId | string | 구독을 해지할 사용자 ID. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
account_activity/client.ts:217
▸ deleteSubscription(webhookId, userId): Promise<SubscriptionsDeleteResponse>
| 이름 | 타입 |
|---|
webhookId | string |
userId | string |
Promise<SubscriptionsDeleteResponse>
정의 위치
account_activity/client.ts:234
▸ validateSubscription(webhookId, options): Promise<Response>
구독 검증
지정된 webhook에 대해 사용자의 Account Activity 구독이 유효한지 확인합니다.
| Name | Type | Description |
|---|
webhookId | string | 구독을 검증할 webhook ID입니다. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우에는 원시 Response가 반환됩니다.
account_activity/client.ts:331
▸ validateSubscription(webhookId): Promise<SubscriptionsGetResponse>
Promise<SubscriptionsGetResponse>
정의 위치
account_activity/client.ts:344
▸ createSubscription(webhookId, options): Promise<Response>
구독 생성
지정된 webhook에 대해 사용자용 Account Activity 구독을 생성합니다.
| Name | Type | Description |
|---|
webhookId | string | 구독 상태를 확인할 webhook ID입니다. |
options | CreateSubscriptionOptions & { requestOptions: { raw: true } } | - |
Promise<Response>
API 응답으로 resolve되는 Promise 또는 requestOptions.raw가 true인 경우 원시 Response
account_activity/client.ts:435
▸ createSubscription(webhookId, options?): Promise<SubscriptionsCreateResponse>
| 이름 | 유형 |
|---|
webhookId | string |
options? | CreateSubscriptionOptions |
Promise<SubscriptionsCreateResponse>
정의 위치
account_activity/client.ts:448
▸ createReplayJob(webhookId, fromDate, toDate, options): Promise<Response>
리플레이 작업 생성
지정된 webhook에 연결된 모든 구독에 대해 최근 최대 5일 동안의 활동을 가져오기 위한 리플레이 작업을 생성합니다.
| Name | Type | Description |
|---|
webhookId | string | webhook 구성의 고유 식별자입니다. |
fromDate | string | 이벤트가 제공되는 기준이 되는 가장 이른(시작) UTC 타임스탬프(포함)로, yyyymmddhhmm 형식입니다. |
toDate | string | 이벤트가 제공되는 기준이 되는 가장 늦은(종료) UTC 타임스탬프(미포함)로, yyyymmddhhmm 형식입니다. |
options | Object | - |
options.requestOptions | Object | - |
options.requestOptions.raw | true | - |
Promise<Response>
API 응답으로 resolve되는 Promise이거나, requestOptions.raw 가 true 인 경우 원시 Response
정의 위치
account_activity/client.ts:564
▸ createReplayJob(webhookId, fromDate, toDate): Promise<ReplayJobCreateResponse>
| 이름 | Type |
|---|
webhookId | string |
fromDate | string |
toDate | string |
Promise<ReplayJobCreateResponse>
정의 위치
account_activity/client.ts:585
▸ getSubscriptionCount(options): Promise<Response>
구독 수 조회
현재 활성 상태인 Account Activity 구독의 개수를 조회합니다.
| 이름 | type |
|---|
options | Object |
options.requestOptions | Object |
options.requestOptions.raw | true |
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response가 그대로 반환됩니다.
account_activity/client.ts:704
▸ getSubscriptionCount(): Promise<SubscriptionsCountGetResponse>
Promise<SubscriptionsCountGetResponse>
정의 위치
account_activity/client.ts:713