SpacesClient

Client pour les opérations Spaces

Ce client fournit des méthodes pour interagir avec les endpoints Spaces de la X API. Il gère l’authentification, le formatage des requêtes et l’analyse des réponses pour toutes les opérations liées aux Spaces.

Constructeurs

constructor

• new SpacesClient(client): SpacesClient

Crée une nouvelle instance de SpacesClient

Paramètres

Nom	Type	Description
client	Client	L’instance principale de Client pour l’X API

Renvoie

SpacesClient

Défini dans

spaces/client.ts:316

Méthodes

getByIds

▸ getByIds(ids, options): Promise<Response>

Obtenir des Spaces par ID
Récupère les détails de plusieurs Spaces à partir de leurs ID.

Paramètres

Nom	Type	Description
ids	any[]	La liste des ID de Spaces à renvoyer.
options	GetByIdsOptions & { requestOptions: { raw: true } }	-

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est défini sur true

Défini dans

spaces/client.ts:361

▸ getByIds(ids, options?): Promise<Get2SpacesResponse>

Paramètres

Nom	Type
ids	any[]
options?	GetByIdsOptions

Renvoie

Promise<Get2SpacesResponse>

Définie dans

spaces/client.ts:374

---

getPosts

▸ getPosts(id, options): Promise<Response>

Obtenir les Publications d’un Space
Récupère la liste des Publications partagées dans un Space donné à partir de son identifiant.

Paramètres

Nom	Type	Description
id	string	L’identifiant de la Space à récupérer.
options	GetPostsOptions & { requestOptions: { raw: true } }	-

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

Défini dans

spaces/client.ts:572

▸ getPosts(id, options?): Promise<Get2SpacesIdTweetsResponse>

Paramètres

Nom	Type
id	string
options?	GetPostsOptions

Renvoie

Promise<Get2SpacesIdTweetsResponse>

Défini dans

spaces/client.ts:585

---

search

▸ search(query, options): Promise<Response>

Recherche de Spaces
Renvoie une liste de Spaces correspondant à la requête de recherche spécifiée.

Paramètres

Nom	Type	Description
query	string	La requête de recherche.
options	SearchOptions & { requestOptions: { raw: true } }	-

Renvoie

Promise<Response>

Promise résolue avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw est à true

Défini dans

spaces/client.ts:835

▸ search(query, options?): Promise<Get2SpacesSearchResponse>

Paramètres

Nom	Type
query	string
options?	SearchOptions

Renvoie

Promise<Get2SpacesSearchResponse>

Défini dans

spaces/client.ts:848

---

getBuyers

▸ getBuyers(id, options): Promise<Response>

Récupère les acheteurs de billets d’un Space Récupère une liste d’Utilisateurs ayant acheté des billets pour un Space spécifique, identifié par son id.

Paramètres

Nom	Type	Description
id	string	L’identifiant du Space à récupérer.
options	GetBuyersOptions & { requestOptions: { raw: true } }	-

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou avec l’objet Response brut si requestOptions.raw est à true

Défini dans

spaces/client.ts:1080

▸ getBuyers(id, options?): Promise<Get2SpacesIdBuyersResponse>

Paramètres

Nom	Type
id	string
options?	GetBuyersOptions

Renvoie

Promise<Get2SpacesIdBuyersResponse>

Défini dans

spaces/client.ts:1093

---

getById

▸ getById(id, options): Promise<Response>

Obtenir un espace par identifiant
Récupère les détails d’un espace spécifique à partir de son identifiant.

Paramètres

Nom	Type	Description
id	string	L’identifiant du Space à récupérer.
options	GetByIdOptions & { requestOptions: { raw: true } }	-

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

Défini dans

spaces/client.ts:1293

▸ getById(id, options?): Promise<Get2SpacesIdResponse>

Paramètres

Nom	Type
id	string
options?	GetByIdOptions

Renvoie

Promise<Get2SpacesIdResponse>

Défini dans

spaces/client.ts:1306

---

getByCreatorIds

▸ getByCreatorIds(userIds, options): Promise<Response>

Obtenir des Spaces à partir des identifiants de créateurs Récupère les détails des Spaces créés par les utilisateurs dont les identifiants sont spécifiés.

Paramètres

Nom	Type	Description
userIds	any[]	Les ID des utilisateurs dans lesquels effectuer la recherche.
options	GetByCreatorIdsOptions & { requestOptions: { raw: true } }	-

Renvoie

Promise<Response>

Promise qui se résout avec la réponse de l’API, ou l’objet Response brut si requestOptions.raw vaut true

Défini dans

spaces/client.ts:1495

▸ getByCreatorIds(userIds, options?): Promise<Get2SpacesByCreatorIdsResponse>

Paramètres

Nom	Type
userIds	any[]
options?	GetByCreatorIdsOptions

Renvoie

Promise<Get2SpacesByCreatorIdsResponse>

Définie dans

spaces/client.ts:1508