ActivityClient

Reference for the ActivityClient class in the X API TypeScript SDK. Methods, parameters, and return types for the X API v2 activity endpoints.

Client for activity operations

This client provides methods for interacting with the activity endpoints of the X API. It handles authentication, request formatting, and response parsing for all activity related operations.

Constructors

constructor

• new ActivityClient(client): ActivityClient

Creates a new activity client instance

Parameters

Name	Type	Description
client	Client	The main X API client instance

Returns

ActivityClient

Defined in

activity/client.ts:118

Methods

getSubscriptions

▸ getSubscriptions(options): Promise<Response>

Get X activity subscriptions Get a list of active subscriptions for XAA

Parameters

Name	Type
options	Object
options.requestOptions	Object
options.requestOptions.raw	true

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

activity/client.ts:159

▸ getSubscriptions(): Promise<ActivitySubscriptionGetResponse>

Returns

Promise<ActivitySubscriptionGetResponse>

Defined in

activity/client.ts:168

---

createSubscription

▸ createSubscription(options): Promise<Response>

Create X activity subscription Creates a subscription for an X activity event

Parameters

Name	Type
options	CreateSubscriptionOptions & { requestOptions: { raw: true } }

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

activity/client.ts:237

▸ createSubscription(options?): Promise<ActivitySubscriptionCreateResponse>

Parameters

Name	Type
options?	CreateSubscriptionOptions

Returns

Promise<ActivitySubscriptionCreateResponse>

Defined in

activity/client.ts:246

---

stream

▸ stream(options): Promise<Response>

Activity Stream Stream of X Activities

Parameters

Name	Type
options	StreamOptions & { requestOptions: { raw: true } }

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

activity/client.ts:332

▸ stream(options?): Promise<ActivityStreamingResponse>

Parameters

Name	Type
options?	StreamOptions

Returns

Promise<ActivityStreamingResponse>

Defined in

activity/client.ts:341

---

updateSubscription

▸ updateSubscription(subscriptionId, options): Promise<Response>

Update X activity subscription Updates a subscription for an X activity event

Parameters

Name	Type	Description
subscriptionId	string	The ID of the subscription to update.
options	UpdateSubscriptionOptions & { requestOptions: { raw: true } }	-

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

activity/client.ts:487

▸ updateSubscription(subscriptionId, options?): Promise<ActivitySubscriptionUpdateResponse>

Parameters

Name	Type
subscriptionId	string
options?	UpdateSubscriptionOptions

Returns

Promise<ActivitySubscriptionUpdateResponse>

Defined in

activity/client.ts:500

---

deleteSubscription

▸ deleteSubscription(subscriptionId, options): Promise<Response>

Deletes X activity subscription Deletes a subscription for an X activity event

Parameters

Name	Type	Description
subscriptionId	string	The ID of the subscription to delete.
options	Object	-
options.requestOptions	Object	-
options.requestOptions.raw	true	-

Returns

Promise<Response>

Promise resolving to the API response, or raw Response if requestOptions.raw is true

Defined in

activity/client.ts:602

▸ deleteSubscription(subscriptionId): Promise<ActivitySubscriptionDeleteResponse>

Parameters

Name	Type
subscriptionId	string

Returns

Promise<ActivitySubscriptionDeleteResponse>

Defined in

activity/client.ts:615