Constructors
constructor
• new SpacesClient(client): SpacesClient
Creates a new spaces client instance
Parameters
| Name | Type | Description |
|---|---|---|
client | Client | The main X API client instance |
Returns
SpacesClient
Defined in
spaces/client.ts:190Methods
getByIds
▸ getByIds(ids, options?): Promise<Get2SpacesResponse>
Get Spaces by IDs
Retrieves details of multiple Spaces by their IDs.
Parameters
| Name | Type | Description |
|---|---|---|
ids | any[] | The list of Space IDs to return. |
options | GetByIdsOptions | - |
Returns
Promise<Get2SpacesResponse>
Promise resolving to the API response
Defined in
spaces/client.ts:207search
▸ search(query, options?): Promise<Get2SpacesSearchResponse>
Search Spaces
Retrieves a list of Spaces matching the specified search query.
Parameters
| Name | Type | Description |
|---|---|---|
query | string | The search query. |
options | SearchOptions | - |
Returns
Promise<Get2SpacesSearchResponse>
Promise resolving to the API response
Defined in
spaces/client.ts:277getBuyers
▸ getBuyers(id, options?): Promise<Get2SpacesIdBuyersResponse>
Get Space ticket buyers
Retrieves a list of Users who purchased tickets to a specific Space by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the Space to be retrieved. |
options | GetBuyersOptions | - |
Returns
Promise<Get2SpacesIdBuyersResponse>
Promise resolving to the API response
Defined in
spaces/client.ts:359getPosts
▸ getPosts(id, options?): Promise<Get2SpacesIdTweetsResponse>
Get Space Posts
Retrieves a list of Posts shared in a specific Space by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the Space to be retrieved. |
options | GetPostsOptions | - |
Returns
Promise<Get2SpacesIdTweetsResponse>
Promise resolving to the API response
Defined in
spaces/client.ts:433getById
▸ getById(id, options?): Promise<Get2SpacesIdResponse>
Get space by ID
Retrieves details of a specific space by its ID.
Parameters
| Name | Type | Description |
|---|---|---|
id | string | The ID of the Space to be retrieved. |
options | GetByIdOptions | - |
Returns
Promise<Get2SpacesIdResponse>
Promise resolving to the API response
Defined in
spaces/client.ts:519getByCreatorIds
▸ getByCreatorIds(userIds, options?): Promise<Get2SpacesByCreatorIdsResponse>
Get Spaces by creator IDs
Retrieves details of Spaces created by specified User IDs.
Parameters
| Name | Type | Description |
|---|---|---|
userIds | any[] | The IDs of Users to search through. |
options | GetByCreatorIdsOptions | - |
Returns
Promise<Get2SpacesByCreatorIdsResponse>
Promise resolving to the API response