Cliente

Clase principal del cliente para la X API

Este es el punto de entrada principal para interactuar con la X API. Proporciona acceso a todos los endpoints de la API mediante módulos de cliente especializados y gestiona la autenticación, la configuración de las solicitudes y el manejo de errores.

Ejemplo

import { Client } from '@xdevplatform/xdk';

const client = new Client({
  bearerToken: 'tu-bearer-token'
});

// Obtener la información del usuario
const user = await client.users.getUser('783214');

// Obtener seguidores con paginación
const followers = await client.users.getFollowers('783214', {
  maxResults: 10,
  userFields: ['id', 'name', 'username']
});

// Iterar los seguidores
for await (const follower of followers) {
  console.log(follower.username);
}

​

Constructores

​

constructor

• new Client(config): Client

Crea una nueva instancia del cliente de la X API

​

Parámetros

Nombre	Tipo	Descripción
config	any	Opciones de configuración del cliente

​

Devuelve

Client

Ejemplo

// Autenticación con token Bearer
const client = new Client({
  bearerToken: 'tu-token-bearer'
});

// Autenticación con OAuth2
const client = new Client({
  accessToken: 'tu-token-de-acceso'
});

// Autenticación con OAuth1
const client = new Client({
  oauth1: oauth1Instance
});

client.ts:306

​

Propiedades

baseUrl · string · required

URL base para solicitudes a la API

bearerToken · string

Token Bearer para la autenticación

accessToken · string

Token de acceso de OAuth2

oauth1 · any

Instancia de OAuth1 para la autenticación

headers · Headers · required

Encabezados de las solicitudes

timeout · number · required

Tiempo de espera de la solicitud en milisegundos

retry · boolean · required

Si se deben reintentar automáticamente las solicitudes con error

maxRetries · number · required

Número máximo de reintentos

userAgent · string · required

Cadena del agente de usuario

httpClient · HttpClient = httpClient · required

Cliente HTTP para realizar solicitudes

users · UsersClient · required

cliente de users

communityNotes · CommunityNotesClient · required

cliente de community notes

lists · ListsClient · required

cliente de lists

connections · ConnectionsClient · required

cliente de connections

posts · PostsClient · required

cliente de posts

spaces · SpacesClient · required

cliente de spaces

media · MediaClient · required

cliente de media

directMessages · DirectMessagesClient · required

cliente de direct messages

communities · CommunitiesClient · required

cliente de communities

accountActivity · AccountActivityClient · required

cliente de account activity

webhooks · WebhooksClient · required

cliente de webhooks

trends · TrendsClient · required

cliente de trends

activity · ActivityClient · required

cliente de activity

stream · StreamClient · required

cliente de stream

usage · UsageClient · required

cliente de usage

compliance · ComplianceClient · required

cliente de compliance

general · GeneralClient · required

cliente de general

request · Promise<T> · required

Realizar una solicitud autenticada a la X API

Este método gestiona la autenticación, el formateo de la solicitud y el manejo de errores para todas las solicitudes a la API. Agrega automáticamente los encabezados de autenticación correspondientes según la configuración del cliente.

isTokenExpired · boolean · required

Comprobar si el token de OAuth2 está vencido

refreshToken · Promise<void> · required

Actualizar el token de OAuth2

isAuthenticated · boolean · required

Obtener el estado actual de autenticación

mapSecuritySchemeToAuthTypes · string[] · required

Mapear nombres de esquemas de seguridad de OpenAPI a tipos de autenticación internos

validateAuthentication · void · required

Validar que el método de autenticación requerido esté disponible

getAvailableAuthTypes · string[] · required

Obtener los tipos de autenticación disponibles