Client

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 a través de 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: 'your-bearer-token'
});

// Obtener 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 por los seguidores
for await (const follower of followers) {
  console.log(follower.username);
}

Constructores

constructor

• new Client(config): Client

Crea una nueva instancia del Client de X API

Parámetros

Nombre	Type	Descripción
config	any	Opciones de configuración para el Client

Devuelve

Client

Ejemplo

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

// OAuth2 authentication
const client = new Client({
  accessToken: 'your-access-token'
});

// OAuth1 authentication
const client = new Client({
  oauth1: oauth1Instance
});

client.ts:401

Propiedades

baseUrl · string · requerido

URL base para solicitudes a la API

bearerToken · string

Bearer Token para la autenticación

accessToken · string

Token de acceso OAuth2

oauth1 · any

Instancia OAuth1 para la autenticación

headers · Headers · requerido

Encabezados para las solicitudes

timeout · number · requerido

Tiempo de espera de la solicitud en milisegundos

retry · boolean · requerido

Indica si se deben reintentar automáticamente las solicitudes fallidas

maxRetries · number · requerido

Número máximo de intentos de reintento

httpClient · HttpClient = httpClient · requerido

Cliente HTTP para realizar solicitudes

general · GeneralClient · requerido

cliente general

accountActivity · AccountActivityClient · requerido

cliente de actividad de cuenta

communityNotes · CommunityNotesClient · requerido

cliente de Community Notes

compliance · ComplianceClient · requerido

cliente de cumplimiento (compliance)

connections · ConnectionsClient · requerido

cliente de conexiones

users · UsersClient · requerido

cliente de usuarios

news · NewsClient · requerido

cliente de noticias

spaces · SpacesClient · requerido

cliente de Spaces

activity · ActivityClient · requerido

cliente de actividad

usage · UsageClient · requerido

cliente de uso

trends · TrendsClient · requerido

cliente de tendencias

posts · PostsClient · requerido

cliente de publicaciones

directMessages · DirectMessagesClient · requerido

cliente de mensajes directos

communities · CommunitiesClient · requerido

cliente de comunidades

media · MediaClient · requerido

cliente de medios

webhooks · WebhooksClient · requerido

cliente de webhooks

stream · StreamClient · requerido

cliente de stream

lists · ListsClient · requerido

cliente de listas

request · Promise<T> · requerido

Realiza 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 apropiados según la configuración del cliente.

isTokenExpired · boolean · requerido

Comprueba si el token OAuth2 ha expirado

refreshToken · Promise<void> · requerido

Actualiza el token OAuth2

isAuthenticated · boolean · requerido

Obtiene el estado de autenticación actual

mapSecuritySchemeToAuthTypes · string[] · requerido

Asocia los nombres de los esquemas de seguridad de OpenAPI con los tipos de autenticación internos

validateAuthentication · void · requerido

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

getAvailableAuthTypes · string[] · requerido

Obtiene los tipos de autenticación disponibles