생성자
constructor
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>
매개변수
| 이름 | 타입 |
|---|---|
webhookId | string |
반환값
Promise<SubscriptionsListGetResponse>
정의된 위치
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
정의된 위치
webhookId, userId): Promise<SubscriptionsDeleteResponse>
매개변수
| 이름 | 타입 |
|---|---|
webhookId | string |
userId | string |
반환값
Promise<SubscriptionsDeleteResponse>
정의 위치
account_activity/client.ts:234validateSubscription
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가 반환됩니다.
정의된 위치
webhookId): Promise<SubscriptionsGetResponse>
매개변수
| 이름 | 타입 |
|---|---|
webhookId | string |
반환값
Promise<SubscriptionsGetResponse>
정의 위치
account_activity/client.ts:344createSubscription
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
정의된 위치
webhookId, options?): Promise<SubscriptionsCreateResponse>
매개변수
| 이름 | 유형 |
|---|---|
webhookId | string |
options? | CreateSubscriptionOptions |
반환값
Promise<SubscriptionsCreateResponse>
정의 위치
account_activity/client.ts:448createReplayJob
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:585getSubscriptionCount
options): Promise<Response>
구독 수 조회현재 활성 상태인 Account Activity 구독의 개수를 조회합니다.
매개변수
| 이름 | type |
|---|---|
options | Object |
options.requestOptions | Object |
options.requestOptions.raw | true |
반환값
Promise<Response>
API 응답으로 resolve되는 Promise이며, requestOptions.raw가 true인 경우 원시 Response가 그대로 반환됩니다.
정의된 위치
Promise<SubscriptionsCountGetResponse>
반환값
Promise<SubscriptionsCountGetResponse>